com.aliyun.ros.cdk.ecs.RunCommand Maven / Gradle / Ivy
package com.aliyun.ros.cdk.ecs;
/**
* This class encapsulates and extends the ROS resource type ALIYUN::ECS::RunCommand, which is used to run a shell, PowerShell, or batch command on Elastic Compute Service (ECS) instances.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.85.0 (build 08ee592)", date = "2024-08-22T08:56:20.342Z")
@software.amazon.jsii.Jsii(module = com.aliyun.ros.cdk.ecs.$Module.class, fqn = "@alicloud/ros-cdk-ecs.RunCommand")
public class RunCommand extends com.aliyun.ros.cdk.core.Resource {
protected RunCommand(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected RunCommand(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
* Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
* @param enableResourcePropertyConstraint
*/
public RunCommand(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.ecs.RunCommandProps props, final @org.jetbrains.annotations.Nullable java.lang.Boolean enableResourcePropertyConstraint) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required"), enableResourcePropertyConstraint });
}
/**
* Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.
*
* @param scope This parameter is required.
* @param id This parameter is required.
* @param props This parameter is required.
*/
public RunCommand(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct scope, final @org.jetbrains.annotations.NotNull java.lang.String id, final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.ecs.RunCommandProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required"), java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* Attribute CommandId: The id of command created.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrCommandId() {
return software.amazon.jsii.Kernel.get(this, "attrCommandId", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* Attribute InvokeId: The invoke id of command.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrInvokeId() {
return software.amazon.jsii.Kernel.get(this, "attrInvokeId", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* Attribute InvokeInstances: The InvokeInstances of command.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrInvokeInstances() {
return software.amazon.jsii.Kernel.get(this, "attrInvokeInstances", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
/**
* Attribute InvokeResults: The results of invoke command.
*/
public @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.IResolvable getAttrInvokeResults() {
return software.amazon.jsii.Kernel.get(this, "attrInvokeResults", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.IResolvable.class));
}
protected @org.jetbrains.annotations.NotNull java.lang.Boolean getEnableResourcePropertyConstraint() {
return software.amazon.jsii.Kernel.get(this, "enableResourcePropertyConstraint", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
protected void setEnableResourcePropertyConstraint(final @org.jetbrains.annotations.NotNull java.lang.Boolean value) {
software.amazon.jsii.Kernel.set(this, "enableResourcePropertyConstraint", java.util.Objects.requireNonNull(value, "enableResourcePropertyConstraint is required"));
}
protected @org.jetbrains.annotations.NotNull java.lang.String getId() {
return software.amazon.jsii.Kernel.get(this, "id", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
protected void setId(final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "id", java.util.Objects.requireNonNull(value, "id is required"));
}
protected @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.ecs.RunCommandProps getProps() {
return software.amazon.jsii.Kernel.get(this, "props", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.ecs.RunCommandProps.class));
}
protected void setProps(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.ecs.RunCommandProps value) {
software.amazon.jsii.Kernel.set(this, "props", java.util.Objects.requireNonNull(value, "props is required"));
}
protected @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct getScope() {
return software.amazon.jsii.Kernel.get(this, "scope", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.core.Construct.class));
}
protected void setScope(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.core.Construct value) {
software.amazon.jsii.Kernel.set(this, "scope", java.util.Objects.requireNonNull(value, "scope is required"));
}
/**
* A fluent builder for {@link com.aliyun.ros.cdk.ecs.RunCommand}.
*/
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
* @param enableResourcePropertyConstraint
*/
public static Builder create(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id, final java.lang.Boolean enableResourcePropertyConstraint) {
return new Builder(scope, id, enableResourcePropertyConstraint);
}
/**
* @return a new instance of {@link Builder}.
* @param scope This parameter is required.
* @param id This parameter is required.
*/
public static Builder create(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id) {
return new Builder(scope, id, null);
}
private final com.aliyun.ros.cdk.core.Construct scope;
private final java.lang.String id;
private final java.lang.Boolean enableResourcePropertyConstraint;
private final com.aliyun.ros.cdk.ecs.RunCommandProps.Builder props;
private Builder(final com.aliyun.ros.cdk.core.Construct scope, final java.lang.String id, final java.lang.Boolean enableResourcePropertyConstraint) {
this.scope = scope;
this.id = id;
this.enableResourcePropertyConstraint = enableResourcePropertyConstraint;
this.props = new com.aliyun.ros.cdk.ecs.RunCommandProps.Builder();
}
/**
* Property commandContent: The plaintext content or the Base64-encoded content of the script.
*
* The Base64-encoded script content cannot exceed 16 KB.
* You can enable the custom parameter function by setting EnableParameter=true in the script content:
* Define custom parameters in the {{}} format. Within {{}}, the spaces and line breaks before and after the name of the parameter are ignored.
* The number of custom parameters cannot exceed 20.
* A custom parameter name can contain only letters, digits, underscores (_), and hyphens (-). It is case insensitive.
* Each custom parameter key cannot exceed 64 bytes.
*
* @return {@code this}
* @param commandContent Property commandContent: The plaintext content or the Base64-encoded content of the script. This parameter is required.
*/
public Builder commandContent(final java.lang.String commandContent) {
this.props.commandContent(commandContent);
return this;
}
/**
* Property commandContent: The plaintext content or the Base64-encoded content of the script.
*
* The Base64-encoded script content cannot exceed 16 KB.
* You can enable the custom parameter function by setting EnableParameter=true in the script content:
* Define custom parameters in the {{}} format. Within {{}}, the spaces and line breaks before and after the name of the parameter are ignored.
* The number of custom parameters cannot exceed 20.
* A custom parameter name can contain only letters, digits, underscores (_), and hyphens (-). It is case insensitive.
* Each custom parameter key cannot exceed 64 bytes.
*
* @return {@code this}
* @param commandContent Property commandContent: The plaintext content or the Base64-encoded content of the script. This parameter is required.
*/
public Builder commandContent(final com.aliyun.ros.cdk.core.IResolvable commandContent) {
this.props.commandContent(commandContent);
return this;
}
/**
* Property instanceIds: The instance id list.
*
* Instances status must be running.
*
* @return {@code this}
* @param instanceIds Property instanceIds: The instance id list. This parameter is required.
*/
public Builder instanceIds(final com.aliyun.ros.cdk.core.IResolvable instanceIds) {
this.props.instanceIds(instanceIds);
return this;
}
/**
* Property instanceIds: The instance id list.
*
* Instances status must be running.
*
* @return {@code this}
* @param instanceIds Property instanceIds: The instance id list. This parameter is required.
*/
public Builder instanceIds(final java.util.List instanceIds) {
this.props.instanceIds(instanceIds);
return this;
}
/**
* Property type: The language type of the O&M script.
*
* Valid values:
* RunBatScript: batch scripts for Windows instances
* RunPowerShellScript: PowerShell scripts for Windows instances
* RunShellScript: shell scripts for Linux instances
*
* @return {@code this}
* @param type Property type: The language type of the O&M script. This parameter is required.
*/
public Builder type(final java.lang.String type) {
this.props.type(type);
return this;
}
/**
* Property type: The language type of the O&M script.
*
* Valid values:
* RunBatScript: batch scripts for Windows instances
* RunPowerShellScript: PowerShell scripts for Windows instances
* RunShellScript: shell scripts for Linux instances
*
* @return {@code this}
* @param type Property type: The language type of the O&M script. This parameter is required.
*/
public Builder type(final com.aliyun.ros.cdk.core.IResolvable type) {
this.props.type(type);
return this;
}
/**
* Property containerId: The ID of the container.
*
* Only 64-bit hexadecimal strings are supported. You can use container IDs that are prefixed with docker://, containerd://, or cri-o:// to specify container runtimes.
* Take note of the following items:
*
*
* - If you specify this parameter, Cloud Assistant runs scripts in the specified container of the instance.
* - If you specify this parameter, make sure that the version of Cloud Assistant Agent installed on Linux instances is 2.2.3.344 or later.- If you specify this parameter, Username that is specified in a request to call this operation and WorkingDir that is specified in a request to call the CreateCommand operation do not take effect. You can run the command only in the default working directory of the container by using the default user of the container.
* - If you specify this parameter, only shell scripts can be run in Linux containers. You cannot add a command in the format similar to #!/usr/bin/python at the beginning of a script to specify a script interpreter.
*
*
* @return {@code this}
* @param containerId Property containerId: The ID of the container. This parameter is required.
*/
public Builder containerId(final java.lang.String containerId) {
this.props.containerId(containerId);
return this;
}
/**
* Property containerId: The ID of the container.
*
* Only 64-bit hexadecimal strings are supported. You can use container IDs that are prefixed with docker://, containerd://, or cri-o:// to specify container runtimes.
* Take note of the following items:
*
*
* - If you specify this parameter, Cloud Assistant runs scripts in the specified container of the instance.
* - If you specify this parameter, make sure that the version of Cloud Assistant Agent installed on Linux instances is 2.2.3.344 or later.- If you specify this parameter, Username that is specified in a request to call this operation and WorkingDir that is specified in a request to call the CreateCommand operation do not take effect. You can run the command only in the default working directory of the container by using the default user of the container.
* - If you specify this parameter, only shell scripts can be run in Linux containers. You cannot add a command in the format similar to #!/usr/bin/python at the beginning of a script to specify a script interpreter.
*
*
* @return {@code this}
* @param containerId Property containerId: The ID of the container. This parameter is required.
*/
public Builder containerId(final com.aliyun.ros.cdk.core.IResolvable containerId) {
this.props.containerId(containerId);
return this;
}
/**
* Property containerName: The name of the container.
*
* Take note of the following items:
*
*
* - If you specify this parameter, Cloud Assistant runs scripts in the specified container of the instance.
* - If you specify this parameter, make sure that the version of Cloud Assistant Agent installed on Linux instances is 2.2.3.344 or later.
* - If you specify this parameter, Username that is specified in a request to call this operation and WorkingDir that is specified in a request to call the CreateCommand operation do not take effect. You can run the command only in the default working directory of the container by using the default user of the container.
* - If you specify this parameter, only shell scripts can be run in Linux containers. You cannot add a command in the format similar to #!/usr/bin/python at the beginning of a script to specify a script interpreter.
*
*
* @return {@code this}
* @param containerName Property containerName: The name of the container. This parameter is required.
*/
public Builder containerName(final java.lang.String containerName) {
this.props.containerName(containerName);
return this;
}
/**
* Property containerName: The name of the container.
*
* Take note of the following items:
*
*
* - If you specify this parameter, Cloud Assistant runs scripts in the specified container of the instance.
* - If you specify this parameter, make sure that the version of Cloud Assistant Agent installed on Linux instances is 2.2.3.344 or later.
* - If you specify this parameter, Username that is specified in a request to call this operation and WorkingDir that is specified in a request to call the CreateCommand operation do not take effect. You can run the command only in the default working directory of the container by using the default user of the container.
* - If you specify this parameter, only shell scripts can be run in Linux containers. You cannot add a command in the format similar to #!/usr/bin/python at the beginning of a script to specify a script interpreter.
*
*
* @return {@code this}
* @param containerName Property containerName: The name of the container. This parameter is required.
*/
public Builder containerName(final com.aliyun.ros.cdk.core.IResolvable containerName) {
this.props.containerName(containerName);
return this;
}
/**
* 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: PlainText. If the specified value of this parameter is invalid, PlainText is used by default.
*
* @return {@code this}
* @param contentEncoding Property contentEncoding: The encoding mode of script content (CommandContent). This parameter is required.
*/
public Builder contentEncoding(final java.lang.String contentEncoding) {
this.props.contentEncoding(contentEncoding);
return this;
}
/**
* 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: PlainText. If the specified value of this parameter is invalid, PlainText is used by default.
*
* @return {@code this}
* @param contentEncoding Property contentEncoding: The encoding mode of script content (CommandContent). This parameter is required.
*/
public Builder contentEncoding(final com.aliyun.ros.cdk.core.IResolvable contentEncoding) {
this.props.contentEncoding(contentEncoding);
return this;
}
/**
* Property description: The description of the script, which supports all character sets.
*
* It can be up to 512 characters in length.
*
* @return {@code this}
* @param description Property description: The description of the script, which supports all character sets. This parameter is required.
*/
public Builder description(final java.lang.String description) {
this.props.description(description);
return this;
}
/**
* Property description: The description of the script, which supports all character sets.
*
* It can be up to 512 characters in length.
*
* @return {@code this}
* @param description Property description: The description of the script, which supports all character sets. This parameter is required.
*/
public Builder description(final com.aliyun.ros.cdk.core.IResolvable description) {
this.props.description(description);
return this;
}
/**
* Property enableParameter: Specifies whether the script contains custom parameters.
*
* Default value: false
*
* @return {@code this}
* @param enableParameter Property enableParameter: Specifies whether the script contains custom parameters. This parameter is required.
*/
public Builder enableParameter(final java.lang.Boolean enableParameter) {
this.props.enableParameter(enableParameter);
return this;
}
/**
* Property enableParameter: Specifies whether the script contains custom parameters.
*
* Default value: false
*
* @return {@code this}
* @param enableParameter Property enableParameter: Specifies whether the script contains custom parameters. This parameter is required.
*/
public Builder enableParameter(final com.aliyun.ros.cdk.core.IResolvable enableParameter) {
this.props.enableParameter(enableParameter);
return this;
}
/**
* Property frequency: The execution period of recurring tasks.
*
* If the Timed parameter is set to True, you must specify the Frequency parameter. The interval between two recurring tasks cannot be less than 10 seconds.
* The parameter value follows the cron expression. For more information, see Configure scheduled commands.
*
* @return {@code this}
* @param frequency Property frequency: The execution period of recurring tasks. This parameter is required.
*/
public Builder frequency(final java.lang.String frequency) {
this.props.frequency(frequency);
return this;
}
/**
* Property frequency: The execution period of recurring tasks.
*
* If the Timed parameter is set to True, you must specify the Frequency parameter. The interval between two recurring tasks cannot be less than 10 seconds.
* The parameter value follows the cron expression. For more information, see Configure scheduled commands.
*
* @return {@code this}
* @param frequency Property frequency: The execution period of recurring tasks. This parameter is required.
*/
public Builder frequency(final com.aliyun.ros.cdk.core.IResolvable frequency) {
this.props.frequency(frequency);
return this;
}
/**
* Property keepCommand: Specifies whether to retain the script after it is run.
*
* Valid values:
* true: The script is retained. You can call the InvokeCommand operation to run the script again, call the DescribeCommands operation to query the script, and call the DeleteCommands operation to delete the script. The retained script takes up the quota of Cloud Assistant scripts.
* false: The script is not retained. It is automatically deleted after running, without taking up the quota of Cloud Assistant scripts.
* Default value: false
*
* @return {@code this}
* @param keepCommand Property keepCommand: Specifies whether to retain the script after it is run. This parameter is required.
*/
public Builder keepCommand(final java.lang.Boolean keepCommand) {
this.props.keepCommand(keepCommand);
return this;
}
/**
* Property keepCommand: Specifies whether to retain the script after it is run.
*
* Valid values:
* true: The script is retained. You can call the InvokeCommand operation to run the script again, call the DescribeCommands operation to query the script, and call the DeleteCommands operation to delete the script. The retained script takes up the quota of Cloud Assistant scripts.
* false: The script is not retained. It is automatically deleted after running, without taking up the quota of Cloud Assistant scripts.
* Default value: false
*
* @return {@code this}
* @param keepCommand Property keepCommand: Specifies whether to retain the script after it is run. This parameter is required.
*/
public Builder keepCommand(final com.aliyun.ros.cdk.core.IResolvable keepCommand) {
this.props.keepCommand(keepCommand);
return this;
}
/**
* Property name: The name of the script, which supports all character sets.
*
* It can be up to 128 characters in length.
*
* @return {@code this}
* @param name Property name: The name of the script, which supports all character sets. This parameter is required.
*/
public Builder name(final java.lang.String name) {
this.props.name(name);
return this;
}
/**
* Property name: The name of the script, which supports all character sets.
*
* It can be up to 128 characters in length.
*
* @return {@code this}
* @param name Property name: The name of the script, which supports all character sets. This parameter is required.
*/
public Builder name(final com.aliyun.ros.cdk.core.IResolvable name) {
this.props.name(name);
return this;
}
/**
* Property parameters: The key-value pairs of custom parameters passed in when the script contains custom parameters.
*
* Number of custom parameters: 0 to 10.
* 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 script 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 script. 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.
*
* @return {@code this}
* @param parameters Property parameters: The key-value pairs of custom parameters passed in when the script contains custom parameters. This parameter is required.
*/
public Builder parameters(final com.aliyun.ros.cdk.core.IResolvable parameters) {
this.props.parameters(parameters);
return this;
}
/**
* Property parameters: The key-value pairs of custom parameters passed in when the script contains custom parameters.
*
* Number of custom parameters: 0 to 10.
* 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 script 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 script. 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.
*
* @return {@code this}
* @param parameters Property parameters: The key-value pairs of custom parameters passed in when the script contains custom parameters. This parameter is required.
*/
public Builder parameters(final java.util.Map parameters) {
this.props.parameters(parameters);
return this;
}
/**
* Property repeatMode: Specifies how to run the command.
*
* Valid values:
*
*
* - Once: immediately runs the command.
* - Period: runs the command on a schedule. If you set this parameter to Period, you must specify Frequency.
* - NextRebootOnly: runs the command the next time the instance is started.
* - *EveryReboot: runs the command every time the instance is started.
* Default value:
* - If you do not specify Frequency, the default value is Once.
* - If you specify Frequency, Period is used as the value of RepeatMode regardless of whether RepeatMode is set to Period.
*
*
* @return {@code this}
* @param repeatMode Property repeatMode: Specifies how to run the command. This parameter is required.
*/
public Builder repeatMode(final java.lang.String repeatMode) {
this.props.repeatMode(repeatMode);
return this;
}
/**
* Property repeatMode: Specifies how to run the command.
*
* Valid values:
*
*
* - Once: immediately runs the command.
* - Period: runs the command on a schedule. If you set this parameter to Period, you must specify Frequency.
* - NextRebootOnly: runs the command the next time the instance is started.
* - *EveryReboot: runs the command every time the instance is started.
* Default value:
* - If you do not specify Frequency, the default value is Once.
* - If you specify Frequency, Period is used as the value of RepeatMode regardless of whether RepeatMode is set to Period.
*
*
* @return {@code this}
* @param repeatMode Property repeatMode: Specifies how to run the command. This parameter is required.
*/
public Builder repeatMode(final com.aliyun.ros.cdk.core.IResolvable repeatMode) {
this.props.repeatMode(repeatMode);
return this;
}
/**
* Property resourceGroupId: The ID of the resource group to which to assign the command executions.
*
* The instances specified by InstanceIds must belong to the specified resource group.
*
* @return {@code this}
* @param resourceGroupId Property resourceGroupId: The ID of the resource group to which to assign the command executions. This parameter is required.
*/
public Builder resourceGroupId(final java.lang.String resourceGroupId) {
this.props.resourceGroupId(resourceGroupId);
return this;
}
/**
* Property resourceGroupId: The ID of the resource group to which to assign the command executions.
*
* The instances specified by InstanceIds must belong to the specified resource group.
*
* @return {@code this}
* @param resourceGroupId Property resourceGroupId: The ID of the resource group to which to assign the command executions. This parameter is required.
*/
public Builder resourceGroupId(final com.aliyun.ros.cdk.core.IResolvable resourceGroupId) {
this.props.resourceGroupId(resourceGroupId);
return this;
}
/**
* Property runAgainOn: The stage of executing the command again.
*
* @return {@code this}
* @param runAgainOn Property runAgainOn: The stage of executing the command again. This parameter is required.
*/
public Builder runAgainOn(final com.aliyun.ros.cdk.core.IResolvable runAgainOn) {
this.props.runAgainOn(runAgainOn);
return this;
}
/**
* Property runAgainOn: The stage of executing the command again.
*
* @return {@code this}
* @param runAgainOn Property runAgainOn: The stage of executing the command again. This parameter is required.
*/
public Builder runAgainOn(final java.util.List runAgainOn) {
this.props.runAgainOn(runAgainOn);
return this;
}
/**
* Property sync: Whether to invoke synchronously.
*
* @return {@code this}
* @param sync Property sync: Whether to invoke synchronously. This parameter is required.
*/
public Builder sync(final java.lang.Boolean sync) {
this.props.sync(sync);
return this;
}
/**
* Property sync: Whether to invoke synchronously.
*
* @return {@code this}
* @param sync Property sync: Whether to invoke synchronously. This parameter is required.
*/
public Builder sync(final com.aliyun.ros.cdk.core.IResolvable sync) {
this.props.sync(sync);
return this;
}
/**
* Property tags: Tags to attach to run_command.
*
* Max support 20 tags to add during create run_command. Each tag with two properties Key and Value, and Key is required.
*
* @return {@code this}
* @param tags Property tags: Tags to attach to run_command. This parameter is required.
*/
public Builder tags(final java.util.List tags) {
this.props.tags(tags);
return this;
}
/**
* Property timeout: The timeout period for script execution.
*
* Unit: seconds. A timeout error occurs when a script cannot be run because the process slows down, a specific module or the Cloud Assistant client does not exist. When the script times out, the script process is forcibly terminated.
* Default value: 60.
*
* @return {@code this}
* @param timeout Property timeout: The timeout period for script execution. This parameter is required.
*/
public Builder timeout(final java.lang.Number timeout) {
this.props.timeout(timeout);
return this;
}
/**
* Property timeout: The timeout period for script execution.
*
* Unit: seconds. A timeout error occurs when a script cannot be run because the process slows down, a specific module or the Cloud Assistant client does not exist. When the script times out, the script process is forcibly terminated.
* Default value: 60.
*
* @return {@code this}
* @param timeout Property timeout: The timeout period for script execution. This parameter is required.
*/
public Builder timeout(final com.aliyun.ros.cdk.core.IResolvable timeout) {
this.props.timeout(timeout);
return this;
}
/**
* Property username: The username to use to run the command on instances.
*
* The username can be up to 255 characters in length.
*
*
* - For Linux instances, the root username is used by default.
* - For Windows instances, the System username is used by default.
* You can also specify other usernames that already exist in the instances to run the command. For security purposes, we recommend that you run Cloud Assistant commands as a regular user.
*
*
* @return {@code this}
* @param username Property username: The username to use to run the command on instances. This parameter is required.
*/
public Builder username(final java.lang.String username) {
this.props.username(username);
return this;
}
/**
* Property username: The username to use to run the command on instances.
*
* The username can be up to 255 characters in length.
*
*
* - For Linux instances, the root username is used by default.
* - For Windows instances, the System username is used by default.
* You can also specify other usernames that already exist in the instances to run the command. For security purposes, we recommend that you run Cloud Assistant commands as a regular user.
*
*
* @return {@code this}
* @param username Property username: The username to use to run the command on instances. This parameter is required.
*/
public Builder username(final com.aliyun.ros.cdk.core.IResolvable username) {
this.props.username(username);
return this;
}
/**
* 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 Username. 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.
*
* @return {@code this}
* @param windowsPasswordName Property windowsPasswordName: The name of the password to use to run the command on Windows instances. This parameter is required.
*/
public Builder windowsPasswordName(final java.lang.String windowsPasswordName) {
this.props.windowsPasswordName(windowsPasswordName);
return this;
}
/**
* 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 Username. 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.
*
* @return {@code this}
* @param windowsPasswordName Property windowsPasswordName: The name of the password to use to run the command on Windows instances. This parameter is required.
*/
public Builder windowsPasswordName(final com.aliyun.ros.cdk.core.IResolvable windowsPasswordName) {
this.props.windowsPasswordName(windowsPasswordName);
return this;
}
/**
* Property workingDir: The running directory of the script in the ECS instance.
*
* Default value:
* Linux instances: under the home directory of the administrator (root user): /root.
* Windows instances: under the directory where the process of the Cloud Assistant client is located, such as C:\ProgramData\aliyun\assist$(version).
*
* @return {@code this}
* @param workingDir Property workingDir: The running directory of the script in the ECS instance. This parameter is required.
*/
public Builder workingDir(final java.lang.String workingDir) {
this.props.workingDir(workingDir);
return this;
}
/**
* Property workingDir: The running directory of the script in the ECS instance.
*
* Default value:
* Linux instances: under the home directory of the administrator (root user): /root.
* Windows instances: under the directory where the process of the Cloud Assistant client is located, such as C:\ProgramData\aliyun\assist$(version).
*
* @return {@code this}
* @param workingDir Property workingDir: The running directory of the script in the ECS instance. This parameter is required.
*/
public Builder workingDir(final com.aliyun.ros.cdk.core.IResolvable workingDir) {
this.props.workingDir(workingDir);
return this;
}
/**
* @return a newly built instance of {@link com.aliyun.ros.cdk.ecs.RunCommand}.
*/
@Override
public com.aliyun.ros.cdk.ecs.RunCommand build() {
return new com.aliyun.ros.cdk.ecs.RunCommand(
this.scope,
this.id,
this.props.build(),
this.enableResourcePropertyConstraint
);
}
}
}