/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Batch { namespace Model { /** *

Contains the parameters for * UpdateComputeEnvironment.

See Also:

AWS * API Reference

*/ class UpdateComputeEnvironmentRequest : public BatchRequest { public: AWS_BATCH_API UpdateComputeEnvironmentRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "UpdateComputeEnvironment"; } AWS_BATCH_API Aws::String SerializePayload() const override; /** *

The name or full Amazon Resource Name (ARN) of the compute environment to * update.

*/ inline const Aws::String& GetComputeEnvironment() const{ return m_computeEnvironment; } /** *

The name or full Amazon Resource Name (ARN) of the compute environment to * update.

*/ inline bool ComputeEnvironmentHasBeenSet() const { return m_computeEnvironmentHasBeenSet; } /** *

The name or full Amazon Resource Name (ARN) of the compute environment to * update.

*/ inline void SetComputeEnvironment(const Aws::String& value) { m_computeEnvironmentHasBeenSet = true; m_computeEnvironment = value; } /** *

The name or full Amazon Resource Name (ARN) of the compute environment to * update.

*/ inline void SetComputeEnvironment(Aws::String&& value) { m_computeEnvironmentHasBeenSet = true; m_computeEnvironment = std::move(value); } /** *

The name or full Amazon Resource Name (ARN) of the compute environment to * update.

*/ inline void SetComputeEnvironment(const char* value) { m_computeEnvironmentHasBeenSet = true; m_computeEnvironment.assign(value); } /** *

The name or full Amazon Resource Name (ARN) of the compute environment to * update.

*/ inline UpdateComputeEnvironmentRequest& WithComputeEnvironment(const Aws::String& value) { SetComputeEnvironment(value); return *this;} /** *

The name or full Amazon Resource Name (ARN) of the compute environment to * update.

*/ inline UpdateComputeEnvironmentRequest& WithComputeEnvironment(Aws::String&& value) { SetComputeEnvironment(std::move(value)); return *this;} /** *

The name or full Amazon Resource Name (ARN) of the compute environment to * update.

*/ inline UpdateComputeEnvironmentRequest& WithComputeEnvironment(const char* value) { SetComputeEnvironment(value); 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.

*/ inline const CEState& GetState() const{ return m_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.

*/ inline bool StateHasBeenSet() const { return m_stateHasBeenSet; } /** *

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.

*/ inline void SetState(const CEState& value) { m_stateHasBeenSet = true; m_state = value; } /** *

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.

*/ inline void SetState(CEState&& value) { m_stateHasBeenSet = true; m_state = std::move(value); } /** *

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.

*/ inline UpdateComputeEnvironmentRequest& WithState(const CEState& value) { SetState(value); 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.

*/ inline UpdateComputeEnvironmentRequest& WithState(CEState&& value) { SetState(std::move(value)); 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.

*/ inline int GetUnmanagedvCpus() const{ return m_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.

*/ inline bool UnmanagedvCpusHasBeenSet() const { return m_unmanagedvCpusHasBeenSet; } /** *

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.

*/ inline void SetUnmanagedvCpus(int value) { m_unmanagedvCpusHasBeenSet = true; m_unmanagedvCpus = value; } /** *

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.

*/ inline UpdateComputeEnvironmentRequest& WithUnmanagedvCpus(int value) { SetUnmanagedvCpus(value); 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.

*/ inline const ComputeResourceUpdate& GetComputeResources() const{ return m_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.

*/ inline bool ComputeResourcesHasBeenSet() const { return m_computeResourcesHasBeenSet; } /** *

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.

*/ inline void SetComputeResources(const ComputeResourceUpdate& value) { m_computeResourcesHasBeenSet = true; m_computeResources = value; } /** *

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.

*/ inline void SetComputeResources(ComputeResourceUpdate&& value) { m_computeResourcesHasBeenSet = true; m_computeResources = std::move(value); } /** *

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.

*/ inline UpdateComputeEnvironmentRequest& WithComputeResources(const ComputeResourceUpdate& value) { SetComputeResources(value); 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.

*/ inline UpdateComputeEnvironmentRequest& WithComputeResources(ComputeResourceUpdate&& value) { SetComputeResources(std::move(value)); 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.

*/ inline const Aws::String& GetServiceRole() const{ return m_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.

*/ inline bool ServiceRoleHasBeenSet() const { return m_serviceRoleHasBeenSet; } /** *

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.

*/ inline void SetServiceRole(const Aws::String& value) { m_serviceRoleHasBeenSet = true; m_serviceRole = value; } /** *

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.

*/ inline void SetServiceRole(Aws::String&& value) { m_serviceRoleHasBeenSet = true; m_serviceRole = std::move(value); } /** *

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.

*/ inline void SetServiceRole(const char* value) { m_serviceRoleHasBeenSet = true; m_serviceRole.assign(value); } /** *

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.

*/ inline UpdateComputeEnvironmentRequest& WithServiceRole(const Aws::String& value) { SetServiceRole(value); 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.

*/ inline UpdateComputeEnvironmentRequest& WithServiceRole(Aws::String&& value) { SetServiceRole(std::move(value)); 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.

*/ inline UpdateComputeEnvironmentRequest& WithServiceRole(const char* value) { SetServiceRole(value); 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.

*/ inline const UpdatePolicy& GetUpdatePolicy() const{ return m_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.

*/ inline bool UpdatePolicyHasBeenSet() const { return m_updatePolicyHasBeenSet; } /** *

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.

*/ inline void SetUpdatePolicy(const UpdatePolicy& value) { m_updatePolicyHasBeenSet = true; m_updatePolicy = value; } /** *

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.

*/ inline void SetUpdatePolicy(UpdatePolicy&& value) { m_updatePolicyHasBeenSet = true; m_updatePolicy = std::move(value); } /** *

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.

*/ inline UpdateComputeEnvironmentRequest& WithUpdatePolicy(const UpdatePolicy& value) { SetUpdatePolicy(value); 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.

*/ inline UpdateComputeEnvironmentRequest& WithUpdatePolicy(UpdatePolicy&& value) { SetUpdatePolicy(std::move(value)); return *this;} private: Aws::String m_computeEnvironment; bool m_computeEnvironmentHasBeenSet = false; CEState m_state; bool m_stateHasBeenSet = false; int m_unmanagedvCpus; bool m_unmanagedvCpusHasBeenSet = false; ComputeResourceUpdate m_computeResources; bool m_computeResourcesHasBeenSet = false; Aws::String m_serviceRole; bool m_serviceRoleHasBeenSet = false; UpdatePolicy m_updatePolicy; bool m_updatePolicyHasBeenSet = false; }; } // namespace Model } // namespace Batch } // namespace Aws