@Generated(value="software.amazon.awssdk:codegen") public final class UpdateComputeEnvironmentRequest extends BatchRequest implements ToCopyableBuilder<UpdateComputeEnvironmentRequest.Builder,UpdateComputeEnvironmentRequest>
Contains the parameters for UpdateComputeEnvironment.
| Modifier and Type | Class and Description |
|---|---|
static interface |
UpdateComputeEnvironmentRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static UpdateComputeEnvironmentRequest.Builder |
builder() |
String |
computeEnvironment()
The name or full Amazon Resource Name (ARN) of the compute environment to update.
|
ComputeResourceUpdate |
computeResources()
Details of the compute resources managed by the compute environment.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateComputeEnvironmentRequest.Builder> |
serializableBuilderClass() |
String |
serviceRole()
The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services
services on your behalf.
|
CEState |
state()
The state of the compute environment.
|
String |
stateAsString()
The state of the compute environment.
|
UpdateComputeEnvironmentRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
Integer |
unmanagedvCpus()
The maximum number of vCPUs expected to be used for an unmanaged compute environment.
|
UpdatePolicy |
updatePolicy()
Specifies the updated infrastructure update policy for the compute environment.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String computeEnvironment()
The name or full Amazon Resource Name (ARN) of the compute environment to update.
public final CEState state()
The state of the compute environment. Compute environments in the ENABLED state can accept jobs from
a queue and scale in or out automatically based on the workload demand of its associated queues.
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.
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 a c5.8xlarge instance with a minvCpus value of
4 and a desiredvCpus value of 36. This instance doesn't scale down to a
c5.large instance.
If the service returns an enum value that is not available in the current SDK version, state will return
CEState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
stateAsString().
ENABLED state can accept
jobs from a queue and scale in or out automatically based on the workload demand of its associated
queues.
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.
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 a c5.8xlarge instance with a
minvCpus value of 4 and a desiredvCpus value of 36.
This instance doesn't scale down to a c5.large instance.
CEStatepublic final String stateAsString()
The state of the compute environment. Compute environments in the ENABLED state can accept jobs from
a queue and scale in or out automatically based on the workload demand of its associated queues.
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.
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 a c5.8xlarge instance with a minvCpus value of
4 and a desiredvCpus value of 36. This instance doesn't scale down to a
c5.large instance.
If the service returns an enum value that is not available in the current SDK version, state will return
CEState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
stateAsString().
ENABLED state can accept
jobs from a queue and scale in or out automatically based on the workload demand of its associated
queues.
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.
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 a c5.8xlarge instance with a
minvCpus value of 4 and a desiredvCpus value of 36.
This instance doesn't scale down to a c5.large instance.
CEStatepublic final Integer unmanagedvCpus()
The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.
public final ComputeResourceUpdate computeResources()
Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the Batch User Guide.
public final String serviceRole()
The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.
If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.
If your specified role has a path other than /, then you must either specify the full role ARN
(recommended) or prefix the role name with the path.
Depending on how you created your Batch service role, its ARN might contain the service-role path
prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the
service-role path prefix. Because of this, we recommend that you specify the full ARN of your
service role when you create compute environments.
If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.
If your specified role has a path other than /, then you must either specify the full role
ARN (recommended) or prefix the role name with the path.
Depending on how you created your Batch service role, its ARN might contain the service-role
path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use
the service-role path prefix. Because of this, we recommend that you specify the full ARN of
your service role when you create compute environments.
public final UpdatePolicy updatePolicy()
Specifies the updated infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.
public UpdateComputeEnvironmentRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<UpdateComputeEnvironmentRequest.Builder,UpdateComputeEnvironmentRequest>toBuilder in class BatchRequestpublic static UpdateComputeEnvironmentRequest.Builder builder()
public static Class<? extends UpdateComputeEnvironmentRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.