Skip to content

Command

This class encapsulates and extends the ROS resource type ALIYUN::ECS::Command, which is used to create a Cloud Assistant 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)
//  .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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
type java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property type: The type of command.
commandContent java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property commandContent: The content of command.
contentEncoding java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property contentEncoding: The encoding mode of script content (CommandContent).
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of command.
enableParameter java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableParameter: Specifies whether the script contains custom parameters.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The name of command.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group id.
tags java.util.List<TagsProperty> Property tags: Tags to attach to command.
timeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property timeout: Total timeout when the command is executed in the instance.
workingDir java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property workingDir: The path where command will be executed in the instance.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

typeRequired

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

Property type: The type of command.

commandContentOptional

  • 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.

contentEncodingOptional

  • 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.

descriptionOptional

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

Property description: The description of command.

enableParameterOptional

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

Property enableParameter: Specifies whether the script contains custom parameters.

Default value: false

nameOptional

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

Property name: The name of command.

resourceGroupIdOptional

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

Property resourceGroupId: Resource group id.

tagsOptional

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.

timeoutOptional

  • 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.

workingDirOptional

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

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

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.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrCommandId com.aliyun.ros.cdk.core.IResolvable Attribute CommandId: The id of command created.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrCommandIdRequired 

public IResolvable getAttrCommandId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CommandId: The id of command created.