com.aliyun.ros.cdk.ecs.RunCommandProps Maven / Gradle / Ivy
package com.aliyun.ros.cdk.ecs;
/**
* Properties for defining a RunCommand.
*
* See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-runcommand
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.85.0 (build 08ee592)", date = "2024-08-22T08:56:20.349Z")
@software.amazon.jsii.Jsii(module = com.aliyun.ros.cdk.ecs.$Module.class, fqn = "@alicloud/ros-cdk-ecs.RunCommandProps")
@software.amazon.jsii.Jsii.Proxy(RunCommandProps.Jsii$Proxy.class)
public interface RunCommandProps extends software.amazon.jsii.JsiiSerializable {
/**
* 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.
*/
@org.jetbrains.annotations.NotNull java.lang.Object getCommandContent();
/**
* Property instanceIds: The instance id list.
*
* Instances status must be running.
*/
@org.jetbrains.annotations.NotNull java.lang.Object getInstanceIds();
/**
* 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
*/
@org.jetbrains.annotations.NotNull java.lang.Object getType();
/**
* 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.
*
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getContainerId() {
return null;
}
/**
* 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.
*
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getContainerName() {
return null;
}
/**
* 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.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getContentEncoding() {
return null;
}
/**
* Property description: The description of the script, which supports all character sets.
*
* It can be up to 512 characters in length.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getDescription() {
return null;
}
/**
* Property enableParameter: Specifies whether the script contains custom parameters.
*
* Default value: false
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getEnableParameter() {
return null;
}
/**
* 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.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getFrequency() {
return null;
}
/**
* 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
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getKeepCommand() {
return null;
}
/**
* Property name: The name of the script, which supports all character sets.
*
* It can be up to 128 characters in length.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getName() {
return null;
}
/**
* 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.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getParameters() {
return null;
}
/**
* 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.
*
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getRepeatMode() {
return null;
}
/**
* 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.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getResourceGroupId() {
return null;
}
/**
* Property runAgainOn: The stage of executing the command again.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getRunAgainOn() {
return null;
}
/**
* Property sync: Whether to invoke synchronously.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getSync() {
return null;
}
/**
* 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.
*/
default @org.jetbrains.annotations.Nullable java.util.List getTags() {
return null;
}
/**
* 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.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getTimeout() {
return null;
}
/**
* 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.
*
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getUsername() {
return null;
}
/**
* 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.
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getWindowsPasswordName() {
return null;
}
/**
* 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).
*/
default @org.jetbrains.annotations.Nullable java.lang.Object getWorkingDir() {
return null;
}
/**
* @return a {@link Builder} of {@link RunCommandProps}
*/
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link RunCommandProps}
*/
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.Object commandContent;
java.lang.Object instanceIds;
java.lang.Object type;
java.lang.Object containerId;
java.lang.Object containerName;
java.lang.Object contentEncoding;
java.lang.Object description;
java.lang.Object enableParameter;
java.lang.Object frequency;
java.lang.Object keepCommand;
java.lang.Object name;
java.lang.Object parameters;
java.lang.Object repeatMode;
java.lang.Object resourceGroupId;
java.lang.Object runAgainOn;
java.lang.Object sync;
java.util.List tags;
java.lang.Object timeout;
java.lang.Object username;
java.lang.Object windowsPasswordName;
java.lang.Object workingDir;
/**
* Sets the value of {@link RunCommandProps#getCommandContent}
* @param commandContent Property commandContent: The plaintext content or the Base64-encoded content of the script. This parameter is required.
* 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}
*/
public Builder commandContent(java.lang.String commandContent) {
this.commandContent = commandContent;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getCommandContent}
* @param commandContent Property commandContent: The plaintext content or the Base64-encoded content of the script. This parameter is required.
* 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}
*/
public Builder commandContent(com.aliyun.ros.cdk.core.IResolvable commandContent) {
this.commandContent = commandContent;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getInstanceIds}
* @param instanceIds Property instanceIds: The instance id list. This parameter is required.
* Instances status must be running.
* @return {@code this}
*/
public Builder instanceIds(com.aliyun.ros.cdk.core.IResolvable instanceIds) {
this.instanceIds = instanceIds;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getInstanceIds}
* @param instanceIds Property instanceIds: The instance id list. This parameter is required.
* Instances status must be running.
* @return {@code this}
*/
public Builder instanceIds(java.util.List instanceIds) {
this.instanceIds = instanceIds;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getType}
* @param type Property type: The language type of the O&M script. This parameter is required.
* Valid values:
* RunBatScript: batch scripts for Windows instances
* RunPowerShellScript: PowerShell scripts for Windows instances
* RunShellScript: shell scripts for Linux instances
* @return {@code this}
*/
public Builder type(java.lang.String type) {
this.type = type;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getType}
* @param type Property type: The language type of the O&M script. This parameter is required.
* Valid values:
* RunBatScript: batch scripts for Windows instances
* RunPowerShellScript: PowerShell scripts for Windows instances
* RunShellScript: shell scripts for Linux instances
* @return {@code this}
*/
public Builder type(com.aliyun.ros.cdk.core.IResolvable type) {
this.type = type;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getContainerId}
* @param containerId 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}
*/
public Builder containerId(java.lang.String containerId) {
this.containerId = containerId;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getContainerId}
* @param containerId 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}
*/
public Builder containerId(com.aliyun.ros.cdk.core.IResolvable containerId) {
this.containerId = containerId;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getContainerName}
* @param containerName 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}
*/
public Builder containerName(java.lang.String containerName) {
this.containerName = containerName;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getContainerName}
* @param containerName 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}
*/
public Builder containerName(com.aliyun.ros.cdk.core.IResolvable containerName) {
this.containerName = containerName;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getContentEncoding}
* @param contentEncoding 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}
*/
public Builder contentEncoding(java.lang.String contentEncoding) {
this.contentEncoding = contentEncoding;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getContentEncoding}
* @param contentEncoding 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}
*/
public Builder contentEncoding(com.aliyun.ros.cdk.core.IResolvable contentEncoding) {
this.contentEncoding = contentEncoding;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getDescription}
* @param description Property description: The description of the script, which supports all character sets.
* It can be up to 512 characters in length.
* @return {@code this}
*/
public Builder description(java.lang.String description) {
this.description = description;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getDescription}
* @param description Property description: The description of the script, which supports all character sets.
* It can be up to 512 characters in length.
* @return {@code this}
*/
public Builder description(com.aliyun.ros.cdk.core.IResolvable description) {
this.description = description;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getEnableParameter}
* @param enableParameter Property enableParameter: Specifies whether the script contains custom parameters.
* Default value: false
* @return {@code this}
*/
public Builder enableParameter(java.lang.Boolean enableParameter) {
this.enableParameter = enableParameter;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getEnableParameter}
* @param enableParameter Property enableParameter: Specifies whether the script contains custom parameters.
* Default value: false
* @return {@code this}
*/
public Builder enableParameter(com.aliyun.ros.cdk.core.IResolvable enableParameter) {
this.enableParameter = enableParameter;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getFrequency}
* @param frequency 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}
*/
public Builder frequency(java.lang.String frequency) {
this.frequency = frequency;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getFrequency}
* @param frequency 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}
*/
public Builder frequency(com.aliyun.ros.cdk.core.IResolvable frequency) {
this.frequency = frequency;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getKeepCommand}
* @param keepCommand 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}
*/
public Builder keepCommand(java.lang.Boolean keepCommand) {
this.keepCommand = keepCommand;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getKeepCommand}
* @param keepCommand 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}
*/
public Builder keepCommand(com.aliyun.ros.cdk.core.IResolvable keepCommand) {
this.keepCommand = keepCommand;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getName}
* @param name Property name: The name of the script, which supports all character sets.
* It can be up to 128 characters in length.
* @return {@code this}
*/
public Builder name(java.lang.String name) {
this.name = name;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getName}
* @param name Property name: The name of the script, which supports all character sets.
* It can be up to 128 characters in length.
* @return {@code this}
*/
public Builder name(com.aliyun.ros.cdk.core.IResolvable name) {
this.name = name;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getParameters}
* @param parameters 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}
*/
public Builder parameters(com.aliyun.ros.cdk.core.IResolvable parameters) {
this.parameters = parameters;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getParameters}
* @param parameters 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}
*/
public Builder parameters(java.util.Map parameters) {
this.parameters = parameters;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getRepeatMode}
* @param repeatMode 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}
*/
public Builder repeatMode(java.lang.String repeatMode) {
this.repeatMode = repeatMode;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getRepeatMode}
* @param repeatMode 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}
*/
public Builder repeatMode(com.aliyun.ros.cdk.core.IResolvable repeatMode) {
this.repeatMode = repeatMode;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getResourceGroupId}
* @param resourceGroupId 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}
*/
public Builder resourceGroupId(java.lang.String resourceGroupId) {
this.resourceGroupId = resourceGroupId;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getResourceGroupId}
* @param resourceGroupId 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}
*/
public Builder resourceGroupId(com.aliyun.ros.cdk.core.IResolvable resourceGroupId) {
this.resourceGroupId = resourceGroupId;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getRunAgainOn}
* @param runAgainOn Property runAgainOn: The stage of executing the command again.
* @return {@code this}
*/
public Builder runAgainOn(com.aliyun.ros.cdk.core.IResolvable runAgainOn) {
this.runAgainOn = runAgainOn;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getRunAgainOn}
* @param runAgainOn Property runAgainOn: The stage of executing the command again.
* @return {@code this}
*/
public Builder runAgainOn(java.util.List runAgainOn) {
this.runAgainOn = runAgainOn;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getSync}
* @param sync Property sync: Whether to invoke synchronously.
* @return {@code this}
*/
public Builder sync(java.lang.Boolean sync) {
this.sync = sync;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getSync}
* @param sync Property sync: Whether to invoke synchronously.
* @return {@code this}
*/
public Builder sync(com.aliyun.ros.cdk.core.IResolvable sync) {
this.sync = sync;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getTags}
* @param tags 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}
*/
@SuppressWarnings("unchecked")
public Builder tags(java.util.List tags) {
this.tags = (java.util.List)tags;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getTimeout}
* @param timeout 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}
*/
public Builder timeout(java.lang.Number timeout) {
this.timeout = timeout;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getTimeout}
* @param timeout 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}
*/
public Builder timeout(com.aliyun.ros.cdk.core.IResolvable timeout) {
this.timeout = timeout;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getUsername}
* @param username 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}
*/
public Builder username(java.lang.String username) {
this.username = username;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getUsername}
* @param username 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}
*/
public Builder username(com.aliyun.ros.cdk.core.IResolvable username) {
this.username = username;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getWindowsPasswordName}
* @param windowsPasswordName 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}
*/
public Builder windowsPasswordName(java.lang.String windowsPasswordName) {
this.windowsPasswordName = windowsPasswordName;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getWindowsPasswordName}
* @param windowsPasswordName 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}
*/
public Builder windowsPasswordName(com.aliyun.ros.cdk.core.IResolvable windowsPasswordName) {
this.windowsPasswordName = windowsPasswordName;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getWorkingDir}
* @param workingDir 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}
*/
public Builder workingDir(java.lang.String workingDir) {
this.workingDir = workingDir;
return this;
}
/**
* Sets the value of {@link RunCommandProps#getWorkingDir}
* @param workingDir 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}
*/
public Builder workingDir(com.aliyun.ros.cdk.core.IResolvable workingDir) {
this.workingDir = workingDir;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link RunCommandProps}
* @throws NullPointerException if any required attribute was not provided
*/
@Override
public RunCommandProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link RunCommandProps}
*/
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements RunCommandProps {
private final java.lang.Object commandContent;
private final java.lang.Object instanceIds;
private final java.lang.Object type;
private final java.lang.Object containerId;
private final java.lang.Object containerName;
private final java.lang.Object contentEncoding;
private final java.lang.Object description;
private final java.lang.Object enableParameter;
private final java.lang.Object frequency;
private final java.lang.Object keepCommand;
private final java.lang.Object name;
private final java.lang.Object parameters;
private final java.lang.Object repeatMode;
private final java.lang.Object resourceGroupId;
private final java.lang.Object runAgainOn;
private final java.lang.Object sync;
private final java.util.List tags;
private final java.lang.Object timeout;
private final java.lang.Object username;
private final java.lang.Object windowsPasswordName;
private final java.lang.Object workingDir;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.commandContent = software.amazon.jsii.Kernel.get(this, "commandContent", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.instanceIds = software.amazon.jsii.Kernel.get(this, "instanceIds", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.type = software.amazon.jsii.Kernel.get(this, "type", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.containerId = software.amazon.jsii.Kernel.get(this, "containerId", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.containerName = software.amazon.jsii.Kernel.get(this, "containerName", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.contentEncoding = software.amazon.jsii.Kernel.get(this, "contentEncoding", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.description = software.amazon.jsii.Kernel.get(this, "description", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.enableParameter = software.amazon.jsii.Kernel.get(this, "enableParameter", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.frequency = software.amazon.jsii.Kernel.get(this, "frequency", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.keepCommand = software.amazon.jsii.Kernel.get(this, "keepCommand", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.name = software.amazon.jsii.Kernel.get(this, "name", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.parameters = software.amazon.jsii.Kernel.get(this, "parameters", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.repeatMode = software.amazon.jsii.Kernel.get(this, "repeatMode", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.resourceGroupId = software.amazon.jsii.Kernel.get(this, "resourceGroupId", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.runAgainOn = software.amazon.jsii.Kernel.get(this, "runAgainOn", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.sync = software.amazon.jsii.Kernel.get(this, "sync", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.tags = software.amazon.jsii.Kernel.get(this, "tags", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.ecs.RosRunCommand.TagsProperty.class)));
this.timeout = software.amazon.jsii.Kernel.get(this, "timeout", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.username = software.amazon.jsii.Kernel.get(this, "username", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.windowsPasswordName = software.amazon.jsii.Kernel.get(this, "windowsPasswordName", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
this.workingDir = software.amazon.jsii.Kernel.get(this, "workingDir", software.amazon.jsii.NativeType.forClass(java.lang.Object.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
@SuppressWarnings("unchecked")
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.commandContent = java.util.Objects.requireNonNull(builder.commandContent, "commandContent is required");
this.instanceIds = java.util.Objects.requireNonNull(builder.instanceIds, "instanceIds is required");
this.type = java.util.Objects.requireNonNull(builder.type, "type is required");
this.containerId = builder.containerId;
this.containerName = builder.containerName;
this.contentEncoding = builder.contentEncoding;
this.description = builder.description;
this.enableParameter = builder.enableParameter;
this.frequency = builder.frequency;
this.keepCommand = builder.keepCommand;
this.name = builder.name;
this.parameters = builder.parameters;
this.repeatMode = builder.repeatMode;
this.resourceGroupId = builder.resourceGroupId;
this.runAgainOn = builder.runAgainOn;
this.sync = builder.sync;
this.tags = (java.util.List)builder.tags;
this.timeout = builder.timeout;
this.username = builder.username;
this.windowsPasswordName = builder.windowsPasswordName;
this.workingDir = builder.workingDir;
}
@Override
public final java.lang.Object getCommandContent() {
return this.commandContent;
}
@Override
public final java.lang.Object getInstanceIds() {
return this.instanceIds;
}
@Override
public final java.lang.Object getType() {
return this.type;
}
@Override
public final java.lang.Object getContainerId() {
return this.containerId;
}
@Override
public final java.lang.Object getContainerName() {
return this.containerName;
}
@Override
public final java.lang.Object getContentEncoding() {
return this.contentEncoding;
}
@Override
public final java.lang.Object getDescription() {
return this.description;
}
@Override
public final java.lang.Object getEnableParameter() {
return this.enableParameter;
}
@Override
public final java.lang.Object getFrequency() {
return this.frequency;
}
@Override
public final java.lang.Object getKeepCommand() {
return this.keepCommand;
}
@Override
public final java.lang.Object getName() {
return this.name;
}
@Override
public final java.lang.Object getParameters() {
return this.parameters;
}
@Override
public final java.lang.Object getRepeatMode() {
return this.repeatMode;
}
@Override
public final java.lang.Object getResourceGroupId() {
return this.resourceGroupId;
}
@Override
public final java.lang.Object getRunAgainOn() {
return this.runAgainOn;
}
@Override
public final java.lang.Object getSync() {
return this.sync;
}
@Override
public final java.util.List getTags() {
return this.tags;
}
@Override
public final java.lang.Object getTimeout() {
return this.timeout;
}
@Override
public final java.lang.Object getUsername() {
return this.username;
}
@Override
public final java.lang.Object getWindowsPasswordName() {
return this.windowsPasswordName;
}
@Override
public final java.lang.Object getWorkingDir() {
return this.workingDir;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("commandContent", om.valueToTree(this.getCommandContent()));
data.set("instanceIds", om.valueToTree(this.getInstanceIds()));
data.set("type", om.valueToTree(this.getType()));
if (this.getContainerId() != null) {
data.set("containerId", om.valueToTree(this.getContainerId()));
}
if (this.getContainerName() != null) {
data.set("containerName", om.valueToTree(this.getContainerName()));
}
if (this.getContentEncoding() != null) {
data.set("contentEncoding", om.valueToTree(this.getContentEncoding()));
}
if (this.getDescription() != null) {
data.set("description", om.valueToTree(this.getDescription()));
}
if (this.getEnableParameter() != null) {
data.set("enableParameter", om.valueToTree(this.getEnableParameter()));
}
if (this.getFrequency() != null) {
data.set("frequency", om.valueToTree(this.getFrequency()));
}
if (this.getKeepCommand() != null) {
data.set("keepCommand", om.valueToTree(this.getKeepCommand()));
}
if (this.getName() != null) {
data.set("name", om.valueToTree(this.getName()));
}
if (this.getParameters() != null) {
data.set("parameters", om.valueToTree(this.getParameters()));
}
if (this.getRepeatMode() != null) {
data.set("repeatMode", om.valueToTree(this.getRepeatMode()));
}
if (this.getResourceGroupId() != null) {
data.set("resourceGroupId", om.valueToTree(this.getResourceGroupId()));
}
if (this.getRunAgainOn() != null) {
data.set("runAgainOn", om.valueToTree(this.getRunAgainOn()));
}
if (this.getSync() != null) {
data.set("sync", om.valueToTree(this.getSync()));
}
if (this.getTags() != null) {
data.set("tags", om.valueToTree(this.getTags()));
}
if (this.getTimeout() != null) {
data.set("timeout", om.valueToTree(this.getTimeout()));
}
if (this.getUsername() != null) {
data.set("username", om.valueToTree(this.getUsername()));
}
if (this.getWindowsPasswordName() != null) {
data.set("windowsPasswordName", om.valueToTree(this.getWindowsPasswordName()));
}
if (this.getWorkingDir() != null) {
data.set("workingDir", om.valueToTree(this.getWorkingDir()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@alicloud/ros-cdk-ecs.RunCommandProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
RunCommandProps.Jsii$Proxy that = (RunCommandProps.Jsii$Proxy) o;
if (!commandContent.equals(that.commandContent)) return false;
if (!instanceIds.equals(that.instanceIds)) return false;
if (!type.equals(that.type)) return false;
if (this.containerId != null ? !this.containerId.equals(that.containerId) : that.containerId != null) return false;
if (this.containerName != null ? !this.containerName.equals(that.containerName) : that.containerName != null) return false;
if (this.contentEncoding != null ? !this.contentEncoding.equals(that.contentEncoding) : that.contentEncoding != null) return false;
if (this.description != null ? !this.description.equals(that.description) : that.description != null) return false;
if (this.enableParameter != null ? !this.enableParameter.equals(that.enableParameter) : that.enableParameter != null) return false;
if (this.frequency != null ? !this.frequency.equals(that.frequency) : that.frequency != null) return false;
if (this.keepCommand != null ? !this.keepCommand.equals(that.keepCommand) : that.keepCommand != null) return false;
if (this.name != null ? !this.name.equals(that.name) : that.name != null) return false;
if (this.parameters != null ? !this.parameters.equals(that.parameters) : that.parameters != null) return false;
if (this.repeatMode != null ? !this.repeatMode.equals(that.repeatMode) : that.repeatMode != null) return false;
if (this.resourceGroupId != null ? !this.resourceGroupId.equals(that.resourceGroupId) : that.resourceGroupId != null) return false;
if (this.runAgainOn != null ? !this.runAgainOn.equals(that.runAgainOn) : that.runAgainOn != null) return false;
if (this.sync != null ? !this.sync.equals(that.sync) : that.sync != null) return false;
if (this.tags != null ? !this.tags.equals(that.tags) : that.tags != null) return false;
if (this.timeout != null ? !this.timeout.equals(that.timeout) : that.timeout != null) return false;
if (this.username != null ? !this.username.equals(that.username) : that.username != null) return false;
if (this.windowsPasswordName != null ? !this.windowsPasswordName.equals(that.windowsPasswordName) : that.windowsPasswordName != null) return false;
return this.workingDir != null ? this.workingDir.equals(that.workingDir) : that.workingDir == null;
}
@Override
public final int hashCode() {
int result = this.commandContent.hashCode();
result = 31 * result + (this.instanceIds.hashCode());
result = 31 * result + (this.type.hashCode());
result = 31 * result + (this.containerId != null ? this.containerId.hashCode() : 0);
result = 31 * result + (this.containerName != null ? this.containerName.hashCode() : 0);
result = 31 * result + (this.contentEncoding != null ? this.contentEncoding.hashCode() : 0);
result = 31 * result + (this.description != null ? this.description.hashCode() : 0);
result = 31 * result + (this.enableParameter != null ? this.enableParameter.hashCode() : 0);
result = 31 * result + (this.frequency != null ? this.frequency.hashCode() : 0);
result = 31 * result + (this.keepCommand != null ? this.keepCommand.hashCode() : 0);
result = 31 * result + (this.name != null ? this.name.hashCode() : 0);
result = 31 * result + (this.parameters != null ? this.parameters.hashCode() : 0);
result = 31 * result + (this.repeatMode != null ? this.repeatMode.hashCode() : 0);
result = 31 * result + (this.resourceGroupId != null ? this.resourceGroupId.hashCode() : 0);
result = 31 * result + (this.runAgainOn != null ? this.runAgainOn.hashCode() : 0);
result = 31 * result + (this.sync != null ? this.sync.hashCode() : 0);
result = 31 * result + (this.tags != null ? this.tags.hashCode() : 0);
result = 31 * result + (this.timeout != null ? this.timeout.hashCode() : 0);
result = 31 * result + (this.username != null ? this.username.hashCode() : 0);
result = 31 * result + (this.windowsPasswordName != null ? this.windowsPasswordName.hashCode() : 0);
result = 31 * result + (this.workingDir != null ? this.workingDir.hashCode() : 0);
return result;
}
}
}