Commands

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Commands, which is used to query all available commands that you created.

Initializers

import com.aliyun.ros.cdk.ecs.datasource.Commands;
Commands.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .commandId(java.lang.String)
//  .commandId(IResolvable)
//  .commandName(java.lang.String)
//  .commandName(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .type(java.lang.String)
//  .type(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: The ID of the command.
commandName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property commandName: The name of the command.
description	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property description: Command description.
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.
type	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property type: The command type.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

commandId^Optional

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

Property commandId: The ID of the command.

---

commandName^Optional

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

Property commandName: The name of the command.

Partial command names are not supported.

---

description^Optional

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

Property description: Command description.

---

refreshOptions^Optional

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

---

type^Optional

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

Property type: The command type.

Valid values: RunBatScript: batch command, applicable to Windows instances RunPowerShellScript: PowerShell command, applicable to Windows instances RunShellScript: shell command, applicable to Linux instances

---

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.

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

---

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

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

---

isConstruct

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

Return whether the given object is a Construct.

x^Required

• 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.
attrCommandIds	com.aliyun.ros.cdk.core.IResolvable	Attribute CommandIds: The list of command IDs.
attrCommands	com.aliyun.ros.cdk.core.IResolvable	Attribute Commands: The list of commands.

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

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

---

attrCommandIds^Required

public IResolvable getAttrCommandIds();

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

Attribute CommandIds: The list of command IDs.

---

attrCommands^Required

public IResolvable getAttrCommands();

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

Attribute Commands: The list of commands.

---