Command
- Implements: @alicloud/ros-cdk-ecs.datasource.ICommand
This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Command.
Initializers
import { datasource } from '@alicloud/ros-cdk-ecs'
new datasource.Command(scope: Construct, id: string, props: CommandProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | CommandProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: CommandProps
enableResourcePropertyConstraintOptional
- Type: boolean
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
toString
public toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { datasource } from '@alicloud/ros-cdk-ecs'
datasource.Command.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
ref | string | No description. |
stack | @alicloud/ros-cdk-core.Stack | The stack in which this resource is defined. |
resource | @alicloud/ros-cdk-core.RosResource | No description. |
attrCommandContent | string | @alicloud/ros-cdk-core.IResolvable | Attribute CommandContent: Command content, encoded in Base64 and transmitted. |
attrCommandId | string | @alicloud/ros-cdk-core.IResolvable | Attribute CommandId: Command ID. |
attrCommandName | string | @alicloud/ros-cdk-core.IResolvable | Attribute CommandName: Command name. |
attrCreateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: Command creation time. |
attrDescription | string | @alicloud/ros-cdk-core.IResolvable | Attribute Description: Command description. |
attrEnableParameter | string | @alicloud/ros-cdk-core.IResolvable | Attribute EnableParameter: Whether to use parameters. |
attrParameterNames | string | @alicloud/ros-cdk-core.IResolvable | Attribute ParameterNames: Parameter name. |
attrTags | string | @alicloud/ros-cdk-core.IResolvable | Attribute Tags: The label information of the command. |
attrTimeout | string | @alicloud/ros-cdk-core.IResolvable | Attribute Timeout: Timeout. |
attrType | string | @alicloud/ros-cdk-core.IResolvable | Attribute Type: Command type. |
attrWorkingDir | string | @alicloud/ros-cdk-core.IResolvable | Attribute WorkingDir: Execution path. |
props | CommandProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/ros-cdk-core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
refRequired
public readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrCommandContentRequired
public readonly attrCommandContent: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CommandContent: Command content, encoded in Base64 and transmitted.
attrCommandIdRequired
public readonly attrCommandId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CommandId: Command ID.
attrCommandNameRequired
public readonly attrCommandName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CommandName: Command name.
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: Command creation time.
attrDescriptionRequired
public readonly attrDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Description: Command description.
attrEnableParameterRequired
public readonly attrEnableParameter: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute EnableParameter: Whether to use parameters.
attrParameterNamesRequired
public readonly attrParameterNames: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ParameterNames: Parameter name.
attrTagsRequired
public readonly attrTags: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Tags: The label information of the command.
attrTimeoutRequired
public readonly attrTimeout: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Timeout: Timeout.
attrTypeRequired
public readonly attrType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Type: Command type.
attrWorkingDirRequired
public readonly attrWorkingDir: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute WorkingDir: Execution path.
propsRequired
public readonly props: CommandProps;
- Type: CommandProps