@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ComputeEnvironmentDetail extends Object implements Serializable, Cloneable, StructuredPojo
An object representing an Batch compute environment.
| Constructor and Description |
|---|
ComputeEnvironmentDetail() |
| Modifier and Type | Method and Description |
|---|---|
ComputeEnvironmentDetail |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
ComputeEnvironmentDetail |
clearTagsEntries()
Removes all the entries added into Tags.
|
ComputeEnvironmentDetail |
clone() |
boolean |
equals(Object obj) |
String |
getComputeEnvironmentArn()
The Amazon Resource Name (ARN) of the compute environment.
|
String |
getComputeEnvironmentName()
The name of the compute environment.
|
ComputeResource |
getComputeResources()
The compute resources defined for the compute environment.
|
String |
getEcsClusterArn()
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
|
String |
getServiceRole()
The service role associated with the compute environment that allows Batch to make calls to Amazon Web Services
API operations on your behalf.
|
String |
getState()
The state of the compute environment.
|
String |
getStatus()
The current status of the compute environment (for example,
CREATING or VALID). |
String |
getStatusReason()
A short, human-readable string to provide additional details about the current status of the compute environment.
|
Map<String,String> |
getTags()
The tags applied to the compute environment.
|
String |
getType()
The type of the compute environment:
MANAGED or UNMANAGED. |
Integer |
getUnmanagedvCpus()
The maximum number of VCPUs expected to be used for an unmanaged compute environment.
|
UpdatePolicy |
getUpdatePolicy()
Specifies the infrastructure update policy for the compute environment.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller) |
void |
setComputeEnvironmentArn(String computeEnvironmentArn)
The Amazon Resource Name (ARN) of the compute environment.
|
void |
setComputeEnvironmentName(String computeEnvironmentName)
The name of the compute environment.
|
void |
setComputeResources(ComputeResource computeResources)
The compute resources defined for the compute environment.
|
void |
setEcsClusterArn(String ecsClusterArn)
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
|
void |
setServiceRole(String serviceRole)
The service role associated with the compute environment that allows Batch to make calls to Amazon Web Services
API operations on your behalf.
|
void |
setState(CEState state)
The state of the compute environment.
|
void |
setState(String state)
The state of the compute environment.
|
void |
setStatus(CEStatus status)
The current status of the compute environment (for example,
CREATING or VALID). |
void |
setStatus(String status)
The current status of the compute environment (for example,
CREATING or VALID). |
void |
setStatusReason(String statusReason)
A short, human-readable string to provide additional details about the current status of the compute environment.
|
void |
setTags(Map<String,String> tags)
The tags applied to the compute environment.
|
void |
setType(CEType type)
The type of the compute environment:
MANAGED or UNMANAGED. |
void |
setType(String type)
The type of the compute environment:
MANAGED or UNMANAGED. |
void |
setUnmanagedvCpus(Integer unmanagedvCpus)
The maximum number of VCPUs expected to be used for an unmanaged compute environment.
|
void |
setUpdatePolicy(UpdatePolicy updatePolicy)
Specifies the infrastructure update policy for the compute environment.
|
String |
toString()
Returns a string representation of this object.
|
ComputeEnvironmentDetail |
withComputeEnvironmentArn(String computeEnvironmentArn)
The Amazon Resource Name (ARN) of the compute environment.
|
ComputeEnvironmentDetail |
withComputeEnvironmentName(String computeEnvironmentName)
The name of the compute environment.
|
ComputeEnvironmentDetail |
withComputeResources(ComputeResource computeResources)
The compute resources defined for the compute environment.
|
ComputeEnvironmentDetail |
withEcsClusterArn(String ecsClusterArn)
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
|
ComputeEnvironmentDetail |
withServiceRole(String serviceRole)
The service role associated with the compute environment that allows Batch to make calls to Amazon Web Services
API operations on your behalf.
|
ComputeEnvironmentDetail |
withState(CEState state)
The state of the compute environment.
|
ComputeEnvironmentDetail |
withState(String state)
The state of the compute environment.
|
ComputeEnvironmentDetail |
withStatus(CEStatus status)
The current status of the compute environment (for example,
CREATING or VALID). |
ComputeEnvironmentDetail |
withStatus(String status)
The current status of the compute environment (for example,
CREATING or VALID). |
ComputeEnvironmentDetail |
withStatusReason(String statusReason)
A short, human-readable string to provide additional details about the current status of the compute environment.
|
ComputeEnvironmentDetail |
withTags(Map<String,String> tags)
The tags applied to the compute environment.
|
ComputeEnvironmentDetail |
withType(CEType type)
The type of the compute environment:
MANAGED or UNMANAGED. |
ComputeEnvironmentDetail |
withType(String type)
The type of the compute environment:
MANAGED or UNMANAGED. |
ComputeEnvironmentDetail |
withUnmanagedvCpus(Integer unmanagedvCpus)
The maximum number of VCPUs expected to be used for an unmanaged compute environment.
|
ComputeEnvironmentDetail |
withUpdatePolicy(UpdatePolicy updatePolicy)
Specifies the infrastructure update policy for the compute environment.
|
public void setComputeEnvironmentName(String computeEnvironmentName)
The name of the compute environment. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
computeEnvironmentName - The name of the compute environment. It can be up to 128 letters long. It can contain uppercase and
lowercase letters, numbers, hyphens (-), and underscores (_).public String getComputeEnvironmentName()
The name of the compute environment. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
public ComputeEnvironmentDetail withComputeEnvironmentName(String computeEnvironmentName)
The name of the compute environment. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
computeEnvironmentName - The name of the compute environment. It can be up to 128 letters long. It can contain uppercase and
lowercase letters, numbers, hyphens (-), and underscores (_).public void setComputeEnvironmentArn(String computeEnvironmentArn)
The Amazon Resource Name (ARN) of the compute environment.
computeEnvironmentArn - The Amazon Resource Name (ARN) of the compute environment.public String getComputeEnvironmentArn()
The Amazon Resource Name (ARN) of the compute environment.
public ComputeEnvironmentDetail withComputeEnvironmentArn(String computeEnvironmentArn)
The Amazon Resource Name (ARN) of the compute environment.
computeEnvironmentArn - The Amazon Resource Name (ARN) of the compute environment.public void setUnmanagedvCpus(Integer unmanagedvCpus)
The maximum number of VCPUs expected to be used for an unmanaged compute environment.
unmanagedvCpus - The maximum number of VCPUs expected to be used for an unmanaged compute environment.public Integer getUnmanagedvCpus()
The maximum number of VCPUs expected to be used for an unmanaged compute environment.
public ComputeEnvironmentDetail withUnmanagedvCpus(Integer unmanagedvCpus)
The maximum number of VCPUs expected to be used for an unmanaged compute environment.
unmanagedvCpus - The maximum number of VCPUs expected to be used for an unmanaged compute environment.public void setEcsClusterArn(String ecsClusterArn)
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
ecsClusterArn - The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.public String getEcsClusterArn()
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
public ComputeEnvironmentDetail withEcsClusterArn(String ecsClusterArn)
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
ecsClusterArn - The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.public Map<String,String> getTags()
The tags applied to the compute environment.
public void setTags(Map<String,String> tags)
The tags applied to the compute environment.
tags - The tags applied to the compute environment.public ComputeEnvironmentDetail withTags(Map<String,String> tags)
The tags applied to the compute environment.
tags - The tags applied to the compute environment.public ComputeEnvironmentDetail addTagsEntry(String key, String value)
public ComputeEnvironmentDetail clearTagsEntries()
public void setType(String type)
The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in
the Batch User Guide.
type - The type of the compute environment: MANAGED or UNMANAGED. For more information,
see Compute
environments in the Batch User Guide.CETypepublic String getType()
The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in
the Batch User Guide.
MANAGED or UNMANAGED. For more
information, see Compute
environments in the Batch User Guide.CETypepublic ComputeEnvironmentDetail withType(String type)
The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in
the Batch User Guide.
type - The type of the compute environment: MANAGED or UNMANAGED. For more information,
see Compute
environments in the Batch User Guide.CETypepublic void setType(CEType type)
The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in
the Batch User Guide.
type - The type of the compute environment: MANAGED or UNMANAGED. For more information,
see Compute
environments in the Batch User Guide.CETypepublic ComputeEnvironmentDetail withType(CEType type)
The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in
the Batch User Guide.
type - The type of the compute environment: MANAGED or UNMANAGED. For more information,
see Compute
environments in the Batch User Guide.CETypepublic void setState(String state)
The state of the compute environment. The valid values are ENABLED or DISABLED.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job
queue on the compute resources within the environment. If the compute environment is managed, then it can scale
its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the
environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed
compute environments in the DISABLED state don't scale out. However, they scale in to
minvCpus value after instances become idle.
state - The state of the compute environment. The valid values are ENABLED or DISABLED
.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an
associated job queue on the compute resources within the environment. If the compute environment is
managed, then it can scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the
environment. Jobs in a STARTING or RUNNING state continue to progress normally.
Managed compute environments in the DISABLED state don't scale out. However, they scale in to
minvCpus value after instances become idle.
CEStatepublic String getState()
The state of the compute environment. The valid values are ENABLED or DISABLED.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job
queue on the compute resources within the environment. If the compute environment is managed, then it can scale
its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the
environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed
compute environments in the DISABLED state don't scale out. However, they scale in to
minvCpus value after instances become idle.
ENABLED or DISABLED
.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an
associated job queue on the compute resources within the environment. If the compute environment is
managed, then it can scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the
environment. Jobs in a STARTING or RUNNING state continue to progress normally.
Managed compute environments in the DISABLED state don't scale out. However, they scale in
to minvCpus value after instances become idle.
CEStatepublic ComputeEnvironmentDetail withState(String state)
The state of the compute environment. The valid values are ENABLED or DISABLED.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job
queue on the compute resources within the environment. If the compute environment is managed, then it can scale
its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the
environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed
compute environments in the DISABLED state don't scale out. However, they scale in to
minvCpus value after instances become idle.
state - The state of the compute environment. The valid values are ENABLED or DISABLED
.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an
associated job queue on the compute resources within the environment. If the compute environment is
managed, then it can scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the
environment. Jobs in a STARTING or RUNNING state continue to progress normally.
Managed compute environments in the DISABLED state don't scale out. However, they scale in to
minvCpus value after instances become idle.
CEStatepublic void setState(CEState state)
The state of the compute environment. The valid values are ENABLED or DISABLED.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job
queue on the compute resources within the environment. If the compute environment is managed, then it can scale
its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the
environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed
compute environments in the DISABLED state don't scale out. However, they scale in to
minvCpus value after instances become idle.
state - The state of the compute environment. The valid values are ENABLED or DISABLED
.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an
associated job queue on the compute resources within the environment. If the compute environment is
managed, then it can scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the
environment. Jobs in a STARTING or RUNNING state continue to progress normally.
Managed compute environments in the DISABLED state don't scale out. However, they scale in to
minvCpus value after instances become idle.
CEStatepublic ComputeEnvironmentDetail withState(CEState state)
The state of the compute environment. The valid values are ENABLED or DISABLED.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job
queue on the compute resources within the environment. If the compute environment is managed, then it can scale
its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the
environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed
compute environments in the DISABLED state don't scale out. However, they scale in to
minvCpus value after instances become idle.
state - The state of the compute environment. The valid values are ENABLED or DISABLED
.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an
associated job queue on the compute resources within the environment. If the compute environment is
managed, then it can scale its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the
environment. Jobs in a STARTING or RUNNING state continue to progress normally.
Managed compute environments in the DISABLED state don't scale out. However, they scale in to
minvCpus value after instances become idle.
CEStatepublic void setStatus(String status)
The current status of the compute environment (for example, CREATING or VALID).
status - The current status of the compute environment (for example, CREATING or VALID).CEStatuspublic String getStatus()
The current status of the compute environment (for example, CREATING or VALID).
CREATING or VALID).CEStatuspublic ComputeEnvironmentDetail withStatus(String status)
The current status of the compute environment (for example, CREATING or VALID).
status - The current status of the compute environment (for example, CREATING or VALID).CEStatuspublic void setStatus(CEStatus status)
The current status of the compute environment (for example, CREATING or VALID).
status - The current status of the compute environment (for example, CREATING or VALID).CEStatuspublic ComputeEnvironmentDetail withStatus(CEStatus status)
The current status of the compute environment (for example, CREATING or VALID).
status - The current status of the compute environment (for example, CREATING or VALID).CEStatuspublic void setStatusReason(String statusReason)
A short, human-readable string to provide additional details about the current status of the compute environment.
statusReason - A short, human-readable string to provide additional details about the current status of the compute
environment.public String getStatusReason()
A short, human-readable string to provide additional details about the current status of the compute environment.
public ComputeEnvironmentDetail withStatusReason(String statusReason)
A short, human-readable string to provide additional details about the current status of the compute environment.
statusReason - A short, human-readable string to provide additional details about the current status of the compute
environment.public void setComputeResources(ComputeResource computeResources)
The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.
computeResources - The compute resources defined for the compute environment. For more information, see Compute
environments in the Batch User Guide.public ComputeResource getComputeResources()
The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.
public ComputeEnvironmentDetail withComputeResources(ComputeResource computeResources)
The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.
computeResources - The compute resources defined for the compute environment. For more information, see Compute
environments in the Batch User Guide.public void setServiceRole(String serviceRole)
The service role associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
serviceRole - The service role associated with the compute environment that allows Batch to make calls to Amazon Web
Services API operations on your behalf. For more information, see Batch service IAM role
in the Batch User Guide.public String getServiceRole()
The service role associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
public ComputeEnvironmentDetail withServiceRole(String serviceRole)
The service role associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
serviceRole - The service role associated with the compute environment that allows Batch to make calls to Amazon Web
Services API operations on your behalf. For more information, see Batch service IAM role
in the Batch User Guide.public void setUpdatePolicy(UpdatePolicy updatePolicy)
Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
updatePolicy - Specifies the infrastructure update policy for the compute environment. For more information about
infrastructure updates, see Updating
compute environments in the Batch User Guide.public UpdatePolicy getUpdatePolicy()
Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
public ComputeEnvironmentDetail withUpdatePolicy(UpdatePolicy updatePolicy)
Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
updatePolicy - Specifies the infrastructure update policy for the compute environment. For more information about
infrastructure updates, see Updating
compute environments in the Batch User Guide.public String toString()
toString in class ObjectObject.toString()public ComputeEnvironmentDetail clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall in interface StructuredPojoCopyright © 2022. All rights reserved.