Class ComputeEnvironmentDetail
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ComputeEnvironmentDetail.Builder,
ComputeEnvironmentDetail>
An object that represents an Batch compute environment.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The Amazon Resource Name (ARN) of the compute environment.final String
The name of the compute environment.final ComputeResource
The compute resources defined for the compute environment.final OrchestrationType
The orchestration type of the compute environment.final String
The orchestration type of the compute environment.final String
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.final EksConfiguration
The configuration for the Amazon EKS cluster that supports the Batch compute environment.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.static Class
<? extends ComputeEnvironmentDetail.Builder> final String
The service role that's associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf.final CEState
state()
The state of the compute environment.final String
The state of the compute environment.final CEStatus
status()
The current status of the compute environment (for example,CREATING
orVALID
).final String
The current status of the compute environment (for example,CREATING
orVALID
).final String
A short, human-readable string to provide additional details for the current status of the compute environment.tags()
The tags applied to the compute environment.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final CEType
type()
The type of the compute environment:MANAGED
orUNMANAGED
.final String
The type of the compute environment:MANAGED
orUNMANAGED
.final Integer
The maximum number of VCPUs expected to be used for an unmanaged compute environment.final UpdatePolicy
Specifies the infrastructure update policy for the compute environment.final String
uuid()
Unique identifier for the compute environment.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
computeEnvironmentName
The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
- Returns:
- The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
-
computeEnvironmentArn
The Amazon Resource Name (ARN) of the compute environment.
- Returns:
- The Amazon Resource Name (ARN) of the compute environment.
-
unmanagedvCpus
The maximum number of VCPUs expected to be used for an unmanaged compute environment.
- Returns:
- The maximum number of VCPUs expected to be used for an unmanaged compute environment.
-
ecsClusterArn
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.
- Returns:
- The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
The tags applied to the compute environment.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- The tags applied to the compute environment.
-
type
The type of the compute environment:
MANAGED
orUNMANAGED
. For more information, see Compute environments in the Batch User Guide.If the service returns an enum value that is not available in the current SDK version,
type
will returnCEType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the compute environment:
MANAGED
orUNMANAGED
. For more information, see Compute environments in the Batch User Guide. - See Also:
-
typeAsString
The type of the compute environment:
MANAGED
orUNMANAGED
. For more information, see Compute environments in the Batch User Guide.If the service returns an enum value that is not available in the current SDK version,
type
will returnCEType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the compute environment:
MANAGED
orUNMANAGED
. For more information, see Compute environments in the Batch User Guide. - See Also:
-
state
The state of the compute environment. The valid values are
ENABLED
orDISABLED
.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 aSTARTING
orRUNNING
state continue to progress normally. Managed compute environments in theDISABLED
state don't scale out.Compute environments in a
DISABLED
state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.When an instance is idle, the instance scales down to the
minvCpus
value. However, the instance size doesn't change. For example, consider ac5.8xlarge
instance with aminvCpus
value of4
and adesiredvCpus
value of36
. This instance doesn't scale down to ac5.large
instance.If the service returns an enum value that is not available in the current SDK version,
state
will returnCEState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the compute environment. The valid values are
ENABLED
orDISABLED
.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 aSTARTING
orRUNNING
state continue to progress normally. Managed compute environments in theDISABLED
state don't scale out.Compute environments in a
DISABLED
state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.When an instance is idle, the instance scales down to the
minvCpus
value. However, the instance size doesn't change. For example, consider ac5.8xlarge
instance with aminvCpus
value of4
and adesiredvCpus
value of36
. This instance doesn't scale down to ac5.large
instance. - See Also:
-
stateAsString
The state of the compute environment. The valid values are
ENABLED
orDISABLED
.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 aSTARTING
orRUNNING
state continue to progress normally. Managed compute environments in theDISABLED
state don't scale out.Compute environments in a
DISABLED
state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.When an instance is idle, the instance scales down to the
minvCpus
value. However, the instance size doesn't change. For example, consider ac5.8xlarge
instance with aminvCpus
value of4
and adesiredvCpus
value of36
. This instance doesn't scale down to ac5.large
instance.If the service returns an enum value that is not available in the current SDK version,
state
will returnCEState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the compute environment. The valid values are
ENABLED
orDISABLED
.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 aSTARTING
orRUNNING
state continue to progress normally. Managed compute environments in theDISABLED
state don't scale out.Compute environments in a
DISABLED
state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.When an instance is idle, the instance scales down to the
minvCpus
value. However, the instance size doesn't change. For example, consider ac5.8xlarge
instance with aminvCpus
value of4
and adesiredvCpus
value of36
. This instance doesn't scale down to ac5.large
instance. - See Also:
-
status
The current status of the compute environment (for example,
CREATING
orVALID
).If the service returns an enum value that is not available in the current SDK version,
status
will returnCEStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the compute environment (for example,
CREATING
orVALID
). - See Also:
-
statusAsString
The current status of the compute environment (for example,
CREATING
orVALID
).If the service returns an enum value that is not available in the current SDK version,
status
will returnCEStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the compute environment (for example,
CREATING
orVALID
). - See Also:
-
statusReason
A short, human-readable string to provide additional details for the current status of the compute environment.
- Returns:
- A short, human-readable string to provide additional details for the current status of the compute environment.
-
computeResources
The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.
- Returns:
- The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.
-
serviceRole
The service role that's 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.
- Returns:
- The service role that's 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.
-
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.
- Returns:
- Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
-
eksConfiguration
The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the
containerOrchestrationType
isEKS
.- Returns:
- The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify
this parameter if the
containerOrchestrationType
isEKS
.
-
containerOrchestrationType
The orchestration type of the compute environment. The valid values are
ECS
(default) orEKS
.If the service returns an enum value that is not available in the current SDK version,
containerOrchestrationType
will returnOrchestrationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontainerOrchestrationTypeAsString()
.- Returns:
- The orchestration type of the compute environment. The valid values are
ECS
(default) orEKS
. - See Also:
-
containerOrchestrationTypeAsString
The orchestration type of the compute environment. The valid values are
ECS
(default) orEKS
.If the service returns an enum value that is not available in the current SDK version,
containerOrchestrationType
will returnOrchestrationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontainerOrchestrationTypeAsString()
.- Returns:
- The orchestration type of the compute environment. The valid values are
ECS
(default) orEKS
. - See Also:
-
uuid
Unique identifier for the compute environment.
- Returns:
- Unique identifier for the compute environment.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ComputeEnvironmentDetail.Builder,
ComputeEnvironmentDetail> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-