com.amazonaws.services.batch.model.UpdateComputeEnvironmentRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-batch Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.batch.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Contains the parameters for UpdateComputeEnvironment.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateComputeEnvironmentRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name or full Amazon Resource Name (ARN) of the compute environment to update.
*
*/
private String computeEnvironment;
/**
*
* 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.
*
*/
private String state;
/**
*
* 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.
*
*/
private Integer unmanagedvCpus;
/**
*
* 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.
*
*/
private ComputeResourceUpdate computeResources;
/**
*
* 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.
*
*
*/
private String serviceRole;
/**
*
* 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.
*
*/
private UpdatePolicy updatePolicy;
/**
*
* The name or full Amazon Resource Name (ARN) of the compute environment to update.
*
*
* @param computeEnvironment
* The name or full Amazon Resource Name (ARN) of the compute environment to update.
*/
public void setComputeEnvironment(String computeEnvironment) {
this.computeEnvironment = computeEnvironment;
}
/**
*
* The name or full Amazon Resource Name (ARN) of the compute environment to update.
*
*
* @return The name or full Amazon Resource Name (ARN) of the compute environment to update.
*/
public String getComputeEnvironment() {
return this.computeEnvironment;
}
/**
*
* The name or full Amazon Resource Name (ARN) of the compute environment to update.
*
*
* @param computeEnvironment
* The name or full Amazon Resource Name (ARN) of the compute environment to update.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateComputeEnvironmentRequest withComputeEnvironment(String computeEnvironment) {
setComputeEnvironment(computeEnvironment);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see CEState
*/
public void setState(String state) {
this.state = 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.
*
*
* @return 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.
* @see CEState
*/
public String getState() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CEState
*/
public UpdateComputeEnvironmentRequest withState(String state) {
setState(state);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see CEState
*/
public void setState(CEState state) {
withState(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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CEState
*/
public UpdateComputeEnvironmentRequest withState(CEState state) {
this.state = state.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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 setUnmanagedvCpus(Integer unmanagedvCpus) {
this.unmanagedvCpus = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateComputeEnvironmentRequest withUnmanagedvCpus(Integer unmanagedvCpus) {
setUnmanagedvCpus(unmanagedvCpus);
return this;
}
/**
*
* 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.
*
*
* @param 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 setComputeResources(ComputeResourceUpdate computeResources) {
this.computeResources = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateComputeEnvironmentRequest withComputeResources(ComputeResourceUpdate computeResources) {
setComputeResources(computeResources);
return this;
}
/**
*
* 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.
*
*
*
* @param 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 setServiceRole(String serviceRole) {
this.serviceRole = 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.
*
*
*
* @return 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() {
return this.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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateComputeEnvironmentRequest withServiceRole(String serviceRole) {
setServiceRole(serviceRole);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setUpdatePolicy(UpdatePolicy updatePolicy) {
this.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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateComputeEnvironmentRequest withUpdatePolicy(UpdatePolicy updatePolicy) {
setUpdatePolicy(updatePolicy);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getComputeEnvironment() != null)
sb.append("ComputeEnvironment: ").append(getComputeEnvironment()).append(",");
if (getState() != null)
sb.append("State: ").append(getState()).append(",");
if (getUnmanagedvCpus() != null)
sb.append("UnmanagedvCpus: ").append(getUnmanagedvCpus()).append(",");
if (getComputeResources() != null)
sb.append("ComputeResources: ").append(getComputeResources()).append(",");
if (getServiceRole() != null)
sb.append("ServiceRole: ").append(getServiceRole()).append(",");
if (getUpdatePolicy() != null)
sb.append("UpdatePolicy: ").append(getUpdatePolicy());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateComputeEnvironmentRequest == false)
return false;
UpdateComputeEnvironmentRequest other = (UpdateComputeEnvironmentRequest) obj;
if (other.getComputeEnvironment() == null ^ this.getComputeEnvironment() == null)
return false;
if (other.getComputeEnvironment() != null && other.getComputeEnvironment().equals(this.getComputeEnvironment()) == false)
return false;
if (other.getState() == null ^ this.getState() == null)
return false;
if (other.getState() != null && other.getState().equals(this.getState()) == false)
return false;
if (other.getUnmanagedvCpus() == null ^ this.getUnmanagedvCpus() == null)
return false;
if (other.getUnmanagedvCpus() != null && other.getUnmanagedvCpus().equals(this.getUnmanagedvCpus()) == false)
return false;
if (other.getComputeResources() == null ^ this.getComputeResources() == null)
return false;
if (other.getComputeResources() != null && other.getComputeResources().equals(this.getComputeResources()) == false)
return false;
if (other.getServiceRole() == null ^ this.getServiceRole() == null)
return false;
if (other.getServiceRole() != null && other.getServiceRole().equals(this.getServiceRole()) == false)
return false;
if (other.getUpdatePolicy() == null ^ this.getUpdatePolicy() == null)
return false;
if (other.getUpdatePolicy() != null && other.getUpdatePolicy().equals(this.getUpdatePolicy()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getComputeEnvironment() == null) ? 0 : getComputeEnvironment().hashCode());
hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
hashCode = prime * hashCode + ((getUnmanagedvCpus() == null) ? 0 : getUnmanagedvCpus().hashCode());
hashCode = prime * hashCode + ((getComputeResources() == null) ? 0 : getComputeResources().hashCode());
hashCode = prime * hashCode + ((getServiceRole() == null) ? 0 : getServiceRole().hashCode());
hashCode = prime * hashCode + ((getUpdatePolicy() == null) ? 0 : getUpdatePolicy().hashCode());
return hashCode;
}
@Override
public UpdateComputeEnvironmentRequest clone() {
return (UpdateComputeEnvironmentRequest) super.clone();
}
}