Skip to content

Command

  • Implements: com.aliyun.ros.cdk.ecs.datasource.ICommand

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

Initializers

import com.aliyun.ros.cdk.ecs.datasource.Command;
Command.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .commandId(java.lang.String)
    .commandId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
commandId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property commandId: Command ID.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

commandIdRequired

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

Property commandId: Command ID.


refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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

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)

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.datasource.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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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.
attrCommandContent java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CommandContent: Command content, encoded in Base64 and transmitted.
attrCommandId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CommandId: Command ID.
attrCommandName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CommandName: Command name.
attrCreateTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: Command creation time.
attrDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Description: Command description.
attrEnableParameter java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute EnableParameter: Whether to use parameters.
attrParameterNames java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ParameterNames: Parameter name.
attrTags java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Tags: The label information of the command.
attrTimeout java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Timeout: Timeout.
attrType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Type: Command type.
attrWorkingDir java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute WorkingDir: Execution path.
props CommandProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

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.


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

attrCommandContentRequired

public java.lang.Object getAttrCommandContent();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CommandContent: Command content, encoded in Base64 and transmitted.


attrCommandIdRequired

public java.lang.Object getAttrCommandId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CommandId: Command ID.


attrCommandNameRequired

public java.lang.Object getAttrCommandName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CommandName: Command name.


attrCreateTimeRequired

public java.lang.Object getAttrCreateTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: Command creation time.


attrDescriptionRequired

public java.lang.Object getAttrDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Description: Command description.


attrEnableParameterRequired

public java.lang.Object getAttrEnableParameter();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EnableParameter: Whether to use parameters.


attrParameterNamesRequired

public java.lang.Object getAttrParameterNames();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ParameterNames: Parameter name.


attrTagsRequired

public java.lang.Object getAttrTags();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: The label information of the command.


attrTimeoutRequired

public java.lang.Object getAttrTimeout();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Timeout: Timeout.


attrTypeRequired

public java.lang.Object getAttrType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Type: Command type.


attrWorkingDirRequired

public java.lang.Object getAttrWorkingDir();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute WorkingDir: Execution path.


propsRequired

public CommandProps getProps();