@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateComputeEnvironmentRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Contains the parameters for UpdateComputeEnvironment.
NOOP | Constructor and Description |
|---|
UpdateComputeEnvironmentRequest () |
| Modifier and Type | Method and Description |
|---|---|
UpdateComputeEnvironmentRequest |
clone ()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals (Object obj) |
String |
getComputeEnvironment ()
The name or full Amazon Resource Name (ARN) of the compute environment to update.
|
ComputeResourceUpdate |
getComputeResources ()
Details of the compute resources managed by the compute environment.
|
String |
getServiceRole ()
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.
|
String |
getState ()
The state of the compute environment.
|
Integer |
getUnmanagedvCpus ()
The maximum number of vCPUs expected to be used for an unmanaged compute environment.
|
UpdatePolicy |
getUpdatePolicy ()
Specifies the updated infrastructure update policy for the compute environment.
|
int |
hashCode () |
void |
setComputeEnvironment (String computeEnvironment)
The name or full Amazon Resource Name (ARN) of the compute environment to update.
|
void |
setComputeResources (ComputeResourceUpdate computeResources)
Details of the compute resources managed by the compute environment.
|
void |
setServiceRole (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.
|
void |
setState (CEState state)
The state of the compute environment.
|
void |
setState (String state)
The state of the compute environment.
|
void |
setUnmanagedvCpus (Integer unmanagedvCpus)
The maximum number of vCPUs expected to be used for an unmanaged compute environment.
|
void |
setUpdatePolicy (UpdatePolicy updatePolicy)
Specifies the updated infrastructure update policy for the compute environment.
|
String |
toString ()
Returns a string representation of this object.
|
UpdateComputeEnvironmentRequest |
withComputeEnvironment (String computeEnvironment)
The name or full Amazon Resource Name (ARN) of the compute environment to update.
|
UpdateComputeEnvironmentRequest |
withComputeResources (ComputeResourceUpdate computeResources)
Details of the compute resources managed by the compute environment.
|
UpdateComputeEnvironmentRequest |
withServiceRole (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.
|
UpdateComputeEnvironmentRequest |
withState (CEState state)
The state of the compute environment.
|
UpdateComputeEnvironmentRequest |
withState (String state)
The state of the compute environment.
|
UpdateComputeEnvironmentRequest |
withUnmanagedvCpus (Integer unmanagedvCpus)
The maximum number of vCPUs expected to be used for an unmanaged compute environment.
|
UpdateComputeEnvironmentRequest |
withUpdatePolicy (UpdatePolicy updatePolicy)
Specifies the updated infrastructure update policy for the compute environment.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout public UpdateComputeEnvironmentRequest()
public void setComputeEnvironment(String computeEnvironment)
The name or full Amazon Resource Name (ARN) of the compute environment to update.
computeEnvironment - The name or full Amazon Resource Name (ARN) of the compute environment to update.public String getComputeEnvironment()
The name or full Amazon Resource Name (ARN) of the compute environment to update.
public UpdateComputeEnvironmentRequest withComputeEnvironment(String computeEnvironment)
The name or full Amazon Resource Name (ARN) of the compute environment to update.
computeEnvironment - The name or full Amazon Resource Name (ARN) of the compute environment to update.public void setState(String 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.
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.
CEState public String getState()
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.
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.
CEState public UpdateComputeEnvironmentRequest withState(String 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.
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.
CEState public void setState(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.
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.
CEState public UpdateComputeEnvironmentRequest withState(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.
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.
CEState public void setUnmanagedvCpus(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.
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 Integer getUnmanagedvCpus()
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 UpdateComputeEnvironmentRequest withUnmanagedvCpus(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.
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 void setComputeResources(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.
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 ComputeResourceUpdate getComputeResources()
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 UpdateComputeEnvironmentRequest withComputeResources(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.
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 void setServiceRole(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.
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.
public String getServiceRole()
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 UpdateComputeEnvironmentRequest withServiceRole(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.
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.
public void setUpdatePolicy(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.
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 UpdatePolicy getUpdatePolicy()
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 withUpdatePolicy(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.
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 String toString()
toString in class Object Object.toString() public UpdateComputeEnvironmentRequest clone()
AmazonWebServiceRequest clone in class AmazonWebServiceRequest Object.clone()