com.aliyun.ros.cdk.ecs.Command Maven / Gradle / Ivy
Show all versions of ros-cdk-ecs Show documentation
package com.aliyun.ros.cdk.ecs;
/**
* This class encapsulates and extends the ROS resource type ALIYUN::ECS::Command, which is used to create a Cloud Assistant command.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.85.0 (build 08ee592)", date = "2024-08-22T08:56:19.826Z")
@software.amazon.jsii.Jsii(module = com.aliyun.ros.cdk.ecs.$Module.class, fqn = "@alicloud/ros-cdk-ecs.Command")
public class Command extends com.aliyun.ros.cdk.core.Resource {
protected Command(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected Command(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 Command(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.CommandProps 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 Command(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.CommandProps 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));
}
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.CommandProps getProps() {
return software.amazon.jsii.Kernel.get(this, "props", software.amazon.jsii.NativeType.forClass(com.aliyun.ros.cdk.ecs.CommandProps.class));
}
protected void setProps(final @org.jetbrains.annotations.NotNull com.aliyun.ros.cdk.ecs.CommandProps 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.Command}.
*/
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.CommandProps.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.CommandProps.Builder();
}
/**
* Property type: The type of command.
*
* @return {@code this}
* @param type Property type: The type of command. This parameter is required.
*/
public Builder type(final java.lang.String type) {
this.props.type(type);
return this;
}
/**
* Property type: The type of command.
*
* @return {@code this}
* @param type Property type: The type of command. This parameter is required.
*/
public Builder type(final com.aliyun.ros.cdk.core.IResolvable type) {
this.props.type(type);
return this;
}
/**
* Property commandContent: The content of command.
*
* Content requires base64 encoding. Maximum size support 16KB.
*
* @return {@code this}
* @param commandContent Property commandContent: The content of command. This parameter is required.
*/
public Builder commandContent(final java.lang.String commandContent) {
this.props.commandContent(commandContent);
return this;
}
/**
* Property commandContent: The content of command.
*
* Content requires base64 encoding. Maximum size support 16KB.
*
* @return {@code this}
* @param commandContent Property commandContent: The content of command. This parameter is required.
*/
public Builder commandContent(final com.aliyun.ros.cdk.core.IResolvable commandContent) {
this.props.commandContent(commandContent);
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: Base64. If the specified value of this parameter is invalid, Base64 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: Base64. If the specified value of this parameter is invalid, Base64 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 command.
*
* @return {@code this}
* @param description Property description: The description of command. This parameter is required.
*/
public Builder description(final java.lang.String description) {
this.props.description(description);
return this;
}
/**
* Property description: The description of command.
*
* @return {@code this}
* @param description Property description: The description of command. 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 name: The name of command.
*
* @return {@code this}
* @param name Property name: The name of command. This parameter is required.
*/
public Builder name(final java.lang.String name) {
this.props.name(name);
return this;
}
/**
* Property name: The name of command.
*
* @return {@code this}
* @param name Property name: The name of command. This parameter is required.
*/
public Builder name(final com.aliyun.ros.cdk.core.IResolvable name) {
this.props.name(name);
return this;
}
/**
* Property resourceGroupId: Resource group id.
*
* @return {@code this}
* @param resourceGroupId Property resourceGroupId: Resource group id. This parameter is required.
*/
public Builder resourceGroupId(final java.lang.String resourceGroupId) {
this.props.resourceGroupId(resourceGroupId);
return this;
}
/**
* Property resourceGroupId: Resource group id.
*
* @return {@code this}
* @param resourceGroupId Property resourceGroupId: Resource group id. This parameter is required.
*/
public Builder resourceGroupId(final com.aliyun.ros.cdk.core.IResolvable resourceGroupId) {
this.props.resourceGroupId(resourceGroupId);
return this;
}
/**
* Property tags: Tags to attach to command.
*
* Max support 20 tags to add during create command. Each tag with two properties Key and Value, and Key is required.
*
* @return {@code this}
* @param tags Property tags: Tags to attach to command. This parameter is required.
*/
public Builder tags(final java.util.List tags) {
this.props.tags(tags);
return this;
}
/**
* Property timeout: Total timeout when the command is executed in the instance.
*
* Input the time unit as second. Default is 60s.
*
* @return {@code this}
* @param timeout Property timeout: Total timeout when the command is executed in the instance. This parameter is required.
*/
public Builder timeout(final java.lang.Number timeout) {
this.props.timeout(timeout);
return this;
}
/**
* Property timeout: Total timeout when the command is executed in the instance.
*
* Input the time unit as second. Default is 60s.
*
* @return {@code this}
* @param timeout Property timeout: Total timeout when the command is executed in the instance. This parameter is required.
*/
public Builder timeout(final com.aliyun.ros.cdk.core.IResolvable timeout) {
this.props.timeout(timeout);
return this;
}
/**
* Property workingDir: The path where command will be executed in the instance.
*
* @return {@code this}
* @param workingDir Property workingDir: The path where command will be executed in the instance. This parameter is required.
*/
public Builder workingDir(final java.lang.String workingDir) {
this.props.workingDir(workingDir);
return this;
}
/**
* Property workingDir: The path where command will be executed in the instance.
*
* @return {@code this}
* @param workingDir Property workingDir: The path where command will be executed in the 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.Command}.
*/
@Override
public com.aliyun.ros.cdk.ecs.Command build() {
return new com.aliyun.ros.cdk.ecs.Command(
this.scope,
this.id,
this.props.build(),
this.enableResourcePropertyConstraint
);
}
}
}