#include <UpdateComputeEnvironmentRequest.h>

Inheritance diagram for Aws::Batch::Model::UpdateComputeEnvironmentRequest:

Public Member Functions
	UpdateComputeEnvironmentRequest ()

virtual const char *	GetServiceRequestName () const override

Aws::String	SerializePayload () const override

const Aws::String &	GetComputeEnvironment () const

bool	ComputeEnvironmentHasBeenSet () const

void	SetComputeEnvironment (const Aws::String &value)

void	SetComputeEnvironment (Aws::String &&value)

void	SetComputeEnvironment (const char *value)

UpdateComputeEnvironmentRequest &	WithComputeEnvironment (const Aws::String &value)

UpdateComputeEnvironmentRequest &	WithComputeEnvironment (Aws::String &&value)

UpdateComputeEnvironmentRequest &	WithComputeEnvironment (const char *value)

const CEState &	GetState () const

bool	StateHasBeenSet () const

void	SetState (const CEState &value)

void	SetState (CEState &&value)

UpdateComputeEnvironmentRequest &	WithState (const CEState &value)

UpdateComputeEnvironmentRequest &	WithState (CEState &&value)

const ComputeResourceUpdate &	GetComputeResources () const

bool	ComputeResourcesHasBeenSet () const

void	SetComputeResources (const ComputeResourceUpdate &value)

void	SetComputeResources (ComputeResourceUpdate &&value)

UpdateComputeEnvironmentRequest &	WithComputeResources (const ComputeResourceUpdate &value)

UpdateComputeEnvironmentRequest &	WithComputeResources (ComputeResourceUpdate &&value)

const Aws::String &	GetServiceRole () const

bool	ServiceRoleHasBeenSet () const

void	SetServiceRole (const Aws::String &value)

void	SetServiceRole (Aws::String &&value)

void	SetServiceRole (const char *value)

UpdateComputeEnvironmentRequest &	WithServiceRole (const Aws::String &value)

UpdateComputeEnvironmentRequest &	WithServiceRole (Aws::String &&value)

UpdateComputeEnvironmentRequest &	WithServiceRole (const char *value)

Public Member Functions inherited from Aws::Batch::BatchRequest
virtual	~BatchRequest ()

void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const

Aws::Http::HeaderValueCollection	GetHeaders () const override

Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()

virtual	~AmazonSerializableWebServiceRequest ()

std::shared_ptr< Aws::IOStream >	GetBody () const override

Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()

virtual	~AmazonWebServiceRequest ()=default

virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const

virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const

virtual bool	IsStreaming () const

virtual bool	IsEventStreamRequest () const

virtual bool	SignBody () const

virtual bool	IsChunked () const

virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)

virtual const RequestSignedHandler &	GetRequestSignedHandler () const

const Aws::IOStreamFactory &	GetResponseStreamFactory () const

void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)

virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)

virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const

virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const

virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const

virtual const RequestRetryHandler &	GetRequestRetryHandler () const

virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::Batch::BatchRequest
virtual Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const

Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Contains the parameters for UpdateComputeEnvironment.

Constructor & Destructor Documentation

◆ UpdateComputeEnvironmentRequest()

Aws::Batch::Model::UpdateComputeEnvironmentRequest::UpdateComputeEnvironmentRequest ( )

Member Function Documentation

◆ ComputeEnvironmentHasBeenSet()

bool Aws::Batch::Model::UpdateComputeEnvironmentRequest::ComputeEnvironmentHasBeenSet ( ) const

inline

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

Definition at line 51 of file UpdateComputeEnvironmentRequest.h.

◆ ComputeResourcesHasBeenSet()

bool Aws::Batch::Model::UpdateComputeEnvironmentRequest::ComputeResourcesHasBeenSet ( ) const

inline

Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 201 of file UpdateComputeEnvironmentRequest.h.

◆ GetComputeEnvironment()

const Aws::String& Aws::Batch::Model::UpdateComputeEnvironmentRequest::GetComputeEnvironment ( ) const

inline

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

Definition at line 45 of file UpdateComputeEnvironmentRequest.h.

◆ GetComputeResources()

const ComputeResourceUpdate& Aws::Batch::Model::UpdateComputeEnvironmentRequest::GetComputeResources ( ) const

inline

Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 193 of file UpdateComputeEnvironmentRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Batch::Model::UpdateComputeEnvironmentRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file UpdateComputeEnvironmentRequest.h.

◆ GetServiceRole()

const Aws::String& Aws::Batch::Model::UpdateComputeEnvironmentRequest::GetServiceRole ( ) const

inline

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.

If the compute environment has a service-linked role, it cannot be changed to use a regular IAM role. If the compute environment has a regular IAM role, it cannot be changed to use a service-linked role.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, AWS 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.

Definition at line 253 of file UpdateComputeEnvironmentRequest.h.

◆ GetState()

const CEState& Aws::Batch::Model::UpdateComputeEnvironmentRequest::GetState ( ) const

inline

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 AWS 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 AWS 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. However, they scale in to minvCpus value after instances become idle.

Definition at line 104 of file UpdateComputeEnvironmentRequest.h.

◆ SerializePayload()

Aws::String Aws::Batch::Model::UpdateComputeEnvironmentRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServiceRoleHasBeenSet()

bool Aws::Batch::Model::UpdateComputeEnvironmentRequest::ServiceRoleHasBeenSet ( ) const

inline

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.

If the compute environment has a service-linked role, it cannot be changed to use a regular IAM role. If the compute environment has a regular IAM role, it cannot be changed to use a service-linked role.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, AWS 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.

Definition at line 272 of file UpdateComputeEnvironmentRequest.h.

◆ SetComputeEnvironment() [1/3]

void Aws::Batch::Model::UpdateComputeEnvironmentRequest::SetComputeEnvironment ( Aws::String && value )

inline

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

Definition at line 63 of file UpdateComputeEnvironmentRequest.h.

◆ SetComputeEnvironment() [2/3]

void Aws::Batch::Model::UpdateComputeEnvironmentRequest::SetComputeEnvironment ( const Aws::String & value )

inline

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

Definition at line 57 of file UpdateComputeEnvironmentRequest.h.

◆ SetComputeEnvironment() [3/3]

void Aws::Batch::Model::UpdateComputeEnvironmentRequest::SetComputeEnvironment ( const char * value )

inline

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

Definition at line 69 of file UpdateComputeEnvironmentRequest.h.

◆ SetComputeResources() [1/2]

void Aws::Batch::Model::UpdateComputeEnvironmentRequest::SetComputeResources ( ComputeResourceUpdate && value )

inline

Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 217 of file UpdateComputeEnvironmentRequest.h.

◆ SetComputeResources() [2/2]

void Aws::Batch::Model::UpdateComputeEnvironmentRequest::SetComputeResources ( const ComputeResourceUpdate & value )

inline

Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 209 of file UpdateComputeEnvironmentRequest.h.

◆ SetServiceRole() [1/3]

void Aws::Batch::Model::UpdateComputeEnvironmentRequest::SetServiceRole ( Aws::String && value )

inline

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.

If the compute environment has a service-linked role, it cannot be changed to use a regular IAM role. If the compute environment has a regular IAM role, it cannot be changed to use a service-linked role.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, AWS 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.

Definition at line 310 of file UpdateComputeEnvironmentRequest.h.

◆ SetServiceRole() [2/3]

void Aws::Batch::Model::UpdateComputeEnvironmentRequest::SetServiceRole ( const Aws::String & value )

inline

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.

If the compute environment has a service-linked role, it cannot be changed to use a regular IAM role. If the compute environment has a regular IAM role, it cannot be changed to use a service-linked role.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, AWS 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.

Definition at line 291 of file UpdateComputeEnvironmentRequest.h.

◆ SetServiceRole() [3/3]

void Aws::Batch::Model::UpdateComputeEnvironmentRequest::SetServiceRole ( const char * value )

inline

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.

If the compute environment has a service-linked role, it cannot be changed to use a regular IAM role. If the compute environment has a regular IAM role, it cannot be changed to use a service-linked role.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, AWS 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.

Definition at line 329 of file UpdateComputeEnvironmentRequest.h.

◆ SetState() [1/2]

void Aws::Batch::Model::UpdateComputeEnvironmentRequest::SetState ( CEState && value )

inline

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 AWS 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 AWS 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. However, they scale in to minvCpus value after instances become idle.

Definition at line 152 of file UpdateComputeEnvironmentRequest.h.

◆ SetState() [2/2]

void Aws::Batch::Model::UpdateComputeEnvironmentRequest::SetState ( const CEState & value )

inline

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 AWS 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 AWS 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. However, they scale in to minvCpus value after instances become idle.

Definition at line 136 of file UpdateComputeEnvironmentRequest.h.

◆ StateHasBeenSet()

bool Aws::Batch::Model::UpdateComputeEnvironmentRequest::StateHasBeenSet ( ) const

inline

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 AWS 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 AWS 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. However, they scale in to minvCpus value after instances become idle.

Definition at line 120 of file UpdateComputeEnvironmentRequest.h.

◆ WithComputeEnvironment() [1/3]

UpdateComputeEnvironmentRequest& Aws::Batch::Model::UpdateComputeEnvironmentRequest::WithComputeEnvironment ( Aws::String && value )

inline

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

Definition at line 81 of file UpdateComputeEnvironmentRequest.h.

◆ WithComputeEnvironment() [2/3]

UpdateComputeEnvironmentRequest& Aws::Batch::Model::UpdateComputeEnvironmentRequest::WithComputeEnvironment ( const Aws::String & value )

inline

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

Definition at line 75 of file UpdateComputeEnvironmentRequest.h.

◆ WithComputeEnvironment() [3/3]

UpdateComputeEnvironmentRequest& Aws::Batch::Model::UpdateComputeEnvironmentRequest::WithComputeEnvironment ( const char * value )

inline

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

Definition at line 87 of file UpdateComputeEnvironmentRequest.h.

◆ WithComputeResources() [1/2]

UpdateComputeEnvironmentRequest& Aws::Batch::Model::UpdateComputeEnvironmentRequest::WithComputeResources ( ComputeResourceUpdate && value )

inline

Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 233 of file UpdateComputeEnvironmentRequest.h.

◆ WithComputeResources() [2/2]

UpdateComputeEnvironmentRequest& Aws::Batch::Model::UpdateComputeEnvironmentRequest::WithComputeResources ( const ComputeResourceUpdate & value )

inline

Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 225 of file UpdateComputeEnvironmentRequest.h.

◆ WithServiceRole() [1/3]

UpdateComputeEnvironmentRequest& Aws::Batch::Model::UpdateComputeEnvironmentRequest::WithServiceRole ( Aws::String && value )

inline

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.

If the compute environment has a service-linked role, it cannot be changed to use a regular IAM role. If the compute environment has a regular IAM role, it cannot be changed to use a service-linked role.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, AWS 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.

Definition at line 367 of file UpdateComputeEnvironmentRequest.h.

◆ WithServiceRole() [2/3]

UpdateComputeEnvironmentRequest& Aws::Batch::Model::UpdateComputeEnvironmentRequest::WithServiceRole ( const Aws::String & value )

inline

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.

If the compute environment has a service-linked role, it cannot be changed to use a regular IAM role. If the compute environment has a regular IAM role, it cannot be changed to use a service-linked role.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, AWS 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.

Definition at line 348 of file UpdateComputeEnvironmentRequest.h.

◆ WithServiceRole() [3/3]

UpdateComputeEnvironmentRequest& Aws::Batch::Model::UpdateComputeEnvironmentRequest::WithServiceRole ( const char * value )

inline

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see AWS Batch service IAM role in the AWS Batch User Guide.

If the compute environment has a service-linked role, it cannot be changed to use a regular IAM role. If the compute environment has a regular IAM role, it cannot be changed to use a service-linked role.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, AWS 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.

Definition at line 386 of file UpdateComputeEnvironmentRequest.h.

◆ WithState() [1/2]

UpdateComputeEnvironmentRequest& Aws::Batch::Model::UpdateComputeEnvironmentRequest::WithState ( CEState && value )

inline

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 AWS 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 AWS 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. However, they scale in to minvCpus value after instances become idle.

Definition at line 184 of file UpdateComputeEnvironmentRequest.h.

◆ WithState() [2/2]

UpdateComputeEnvironmentRequest& Aws::Batch::Model::UpdateComputeEnvironmentRequest::WithState ( const CEState & value )

inline

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 AWS 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 AWS 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. However, they scale in to minvCpus value after instances become idle.

Definition at line 168 of file UpdateComputeEnvironmentRequest.h.

The documentation for this class was generated from the following file:

aws-cpp-sdk-batch/include/aws/batch/model/UpdateComputeEnvironmentRequest.h

Public Member Functions

Additional Inherited Members

Detailed Description

See Also:

Constructor & Destructor Documentation

◆ UpdateComputeEnvironmentRequest()

Member Function Documentation

◆ ComputeEnvironmentHasBeenSet()

◆ ComputeResourcesHasBeenSet()

◆ GetComputeEnvironment()

◆ GetComputeResources()

◆ GetServiceRequestName()

◆ GetServiceRole()

◆ GetState()

◆ SerializePayload()

◆ ServiceRoleHasBeenSet()

◆ SetComputeEnvironment() [1/3]

◆ SetComputeEnvironment() [2/3]

◆ SetComputeEnvironment() [3/3]

◆ SetComputeResources() [1/2]

◆ SetComputeResources() [2/2]

◆ SetServiceRole() [1/3]

◆ SetServiceRole() [2/3]

◆ SetServiceRole() [3/3]

◆ SetState() [1/2]

◆ SetState() [2/2]

◆ StateHasBeenSet()

◆ WithComputeEnvironment() [1/3]

◆ WithComputeEnvironment() [2/3]

◆ WithComputeEnvironment() [3/3]

◆ WithComputeResources() [1/2]

◆ WithComputeResources() [2/2]

◆ WithServiceRole() [1/3]

◆ WithServiceRole() [2/3]

◆ WithServiceRole() [3/3]

◆ WithState() [1/2]

◆ WithState() [2/2]