RunCommand

• Implements: IRunCommand

This class encapsulates and extends the ROS resource type ALIYUN::SWAS::RunCommand.

Initializers

import com.aliyun.ros.cdk.swas.RunCommand;
RunCommand.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .commandContent(java.lang.String)
    .commandContent(IResolvable)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
    .name(java.lang.String)
    .name(IResolvable)
    .type(java.lang.String)
    .type(IResolvable)
//  .contentEncoding(java.lang.String)
//  .contentEncoding(IResolvable)
//  .enableParameter(java.lang.Boolean)
//  .enableParameter(IResolvable)
//  .parameters(IResolvable)
//  .parameters(java.util.Map<java.lang.String, java.lang.Object>)
//  .sync(java.lang.Boolean)
//  .sync(IResolvable)
//  .timeout(java.lang.Number)
//  .timeout(IResolvable)
//  .windowsPasswordName(java.lang.String)
//  .windowsPasswordName(IResolvable)
//  .workingDir(java.lang.String)
//  .workingDir(IResolvable)
//  .workingUser(java.lang.String)
//  .workingUser(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

commandContent^Required

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

Property commandContent: The content of the command.

Take note of the following items:

• If you set EnableParameter to true, the custom parameter feature is enabled in the command content and you can configure custom parameters based on the following rules:
• Define custom parameters in the {{}} format. Within {{}}, the spaces and line feeds before and after the parameter names are ignored.
• The number of custom parameters cannot be greater than 20.
• A custom parameter name can contain only letters, digits, underscores (_), and hyphens (-). The name is case-insensitive.
• Each custom parameter name cannot exceed 64 bytes in length.

instanceId^Required

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

Property instanceId: The ID of the SWAS instance on which to run the command.

The instance must be in 'Running' status.

name^Required

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

Property name: The name of the command to run.

type^Required

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

Property type: The language type of the O&M script.

Valid values: RunShellScript: shell scripts for Linux instances RunBatScript: batch scripts for Windows instances RunPowerShellScript: PowerShell scripts for Windows instances

contentEncoding^Optional

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

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

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

enableParameter^Optional

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

Property enableParameter: Specifies whether the command contains custom parameters.

Default value: false

parameters^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property parameters: The key-value pairs of custom parameters passed in when the command contains custom parameters.

Number of custom parameters: 0 to 20. The key cannot be an empty string. It can be up to 64 characters in length. The value can be an empty string. After the custom parameters and the original command content are Base64 encoded, the total size cannot exceed 16 KB. The set of custom parameter names must be a subset of the parameter set that is defined when you created the command. You can use an empty string to represent the parameters that are not passed in. Default value: null, indicating that this parameter is canceled and customer parameters are disabled.

sync^Optional

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

Property sync: Whether to run the command synchronously.

timeout^Optional

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

Property timeout: The timeout period for command execution.

Unit: seconds. Valid values: 10 to 86400. Default value: 60.

windowsPasswordName^Optional

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

Property windowsPasswordName: The name of the password to use to run the command on Windows instances.

The name can be up to 255 characters in length. If you do not want to use the default System user to run the command on Windows instances, specify both WindowsPasswordName and WorkingUser. To mitigate the risk of password leaks, the password is stored in plaintext in Operation Orchestration Service (OOS) Parameter Store, and only the name of the password is passed in by using WindowsPasswordName.

workingDir^Optional

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

Property workingDir: The execution path of the command.

Custom paths are supported. Default execution paths vary based on the operating systems of the servers.

• For Linux servers, the default path is /root of the root user.
• For Windows servers, the default path is C:\Windows\system32.

workingUser^Optional

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

Property workingUser: The user with which to run the command on the instance.

Default value: 'root' for Linux instances, 'system' for Windows instances. You can specify other existing users to run the command to reduce security risks.

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.swas.RunCommand;
RunCommand.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

attrInvokeId^Required

public java.lang.Object getAttrInvokeId();

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

Attribute InvokeId: The ID of the command execution.

attrInvokeResult^Required

public java.lang.Object getAttrInvokeResult();

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

Attribute InvokeResult: The result of the command execution.

props^Required

public RunCommandProps getProps();

• Type: RunCommandProps

Structs