Command

• Implements: ICommand

This class encapsulates and extends the ROS resource type ALIYUN::ECS::Command.

Initializers

import com.aliyun.ros.cdk.ecs.Command;
Command.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .type(java.lang.String)
    .type(IResolvable)
//  .commandContent(java.lang.String)
//  .commandContent(IResolvable)
//  .contentEncoding(java.lang.String)
//  .contentEncoding(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .enableParameter(java.lang.Boolean)
//  .enableParameter(IResolvable)
//  .launcher(java.lang.String)
//  .launcher(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .timeout(java.lang.Number)
//  .timeout(IResolvable)
//  .workingDir(java.lang.String)
//  .workingDir(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

type^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property type: The type of command.

commandContent^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property commandContent: The content of command.

Content requires base64 encoding. Maximum size support 16KB.

contentEncoding^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property contentEncoding: The encoding mode of script content (CommandContent).

Valid values (case insensitive): PlainText: The script content is not encoded, and transmitted in plaintext. Base64: base64-encoded. Default value: Base64. If the specified value of this parameter is invalid, Base64 is used by default.

description^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of command.

enableParameter^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property enableParameter: Specifies whether the script contains custom parameters.

Default value: false

launcher^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property launcher: A bootloader for script execution.

The length cannot exceed 1 KB.

name^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property name: The name of command.

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: Tags to attach to command.

Max support 20 tags to add during create command. Each tag with two properties Key and Value, and Key is required.

timeout^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property timeout: Total timeout when the command is executed in the instance.

Input the time unit as second. Default is 60s.

workingDir^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property workingDir: The path where command will be executed in the instance.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.ecs.Command;
Command.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrCommandId^Required

public java.lang.Object getAttrCommandId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CommandId: The id of command created.

props^Required

public CommandProps getProps();

• Type: CommandProps