Commands
- Implements: com.aliyun.ros.cdk.ecs.datasource.ICommands
This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Commands.
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. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
commandIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property commandId: The ID of the command.
commandNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property commandName: The name of the command.
Partial command names are not supported.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: Command description.
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.
typeOptional
- 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. |
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- 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.
- 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. |
attrCommandIds | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CommandIds: The list of command IDs. |
attrCommands | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Commands: The list of commands. |
props | CommandsProps | 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
attrCommandIdsRequired
public java.lang.Object getAttrCommandIds();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CommandIds: The list of command IDs.
attrCommandsRequired
public java.lang.Object getAttrCommands();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Commands: The list of commands.
propsRequired
public CommandsProps getProps();
- Type: CommandsProps