#include <CreateComputeEnvironmentRequest.h>

Inheritance diagram for Aws::Batch::Model::CreateComputeEnvironmentRequest:

Public Member Functions
	CreateComputeEnvironmentRequest ()

virtual const char *	GetServiceRequestName () const override

Aws::String	SerializePayload () const override

const Aws::String &	GetComputeEnvironmentName () const

bool	ComputeEnvironmentNameHasBeenSet () const

void	SetComputeEnvironmentName (const Aws::String &value)

void	SetComputeEnvironmentName (Aws::String &&value)

void	SetComputeEnvironmentName (const char *value)

CreateComputeEnvironmentRequest &	WithComputeEnvironmentName (const Aws::String &value)

CreateComputeEnvironmentRequest &	WithComputeEnvironmentName (Aws::String &&value)

CreateComputeEnvironmentRequest &	WithComputeEnvironmentName (const char *value)

const CEType &	GetType () const

bool	TypeHasBeenSet () const

void	SetType (const CEType &value)

void	SetType (CEType &&value)

CreateComputeEnvironmentRequest &	WithType (const CEType &value)

CreateComputeEnvironmentRequest &	WithType (CEType &&value)

const CEState &	GetState () const

bool	StateHasBeenSet () const

void	SetState (const CEState &value)

void	SetState (CEState &&value)

CreateComputeEnvironmentRequest &	WithState (const CEState &value)

CreateComputeEnvironmentRequest &	WithState (CEState &&value)

const ComputeResource &	GetComputeResources () const

bool	ComputeResourcesHasBeenSet () const

void	SetComputeResources (const ComputeResource &value)

void	SetComputeResources (ComputeResource &&value)

CreateComputeEnvironmentRequest &	WithComputeResources (const ComputeResource &value)

CreateComputeEnvironmentRequest &	WithComputeResources (ComputeResource &&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)

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

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

CreateComputeEnvironmentRequest &	WithServiceRole (const char *value)

const Aws::Map< Aws::String, Aws::String > &	GetTags () const

bool	TagsHasBeenSet () const

void	SetTags (const Aws::Map< Aws::String, Aws::String > &value)

void	SetTags (Aws::Map< Aws::String, Aws::String > &&value)

CreateComputeEnvironmentRequest &	WithTags (const Aws::Map< Aws::String, Aws::String > &value)

CreateComputeEnvironmentRequest &	WithTags (Aws::Map< Aws::String, Aws::String > &&value)

CreateComputeEnvironmentRequest &	AddTags (const Aws::String &key, const Aws::String &value)

CreateComputeEnvironmentRequest &	AddTags (Aws::String &&key, const Aws::String &value)

CreateComputeEnvironmentRequest &	AddTags (const Aws::String &key, Aws::String &&value)

CreateComputeEnvironmentRequest &	AddTags (Aws::String &&key, Aws::String &&value)

CreateComputeEnvironmentRequest &	AddTags (const char *key, Aws::String &&value)

CreateComputeEnvironmentRequest &	AddTags (Aws::String &&key, const char *value)

CreateComputeEnvironmentRequest &	AddTags (const char key, 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 CreateComputeEnvironment.

Constructor & Destructor Documentation

◆ CreateComputeEnvironmentRequest()

Aws::Batch::Model::CreateComputeEnvironmentRequest::CreateComputeEnvironmentRequest ( )

Member Function Documentation

◆ AddTags() [1/7]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::AddTags	(	Aws::String &&	key,
		Aws::String &&	value
	)

inline

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

Definition at line 642 of file CreateComputeEnvironmentRequest.h.

◆ AddTags() [2/7]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::AddTags	(	Aws::String &&	key,
		const Aws::String &	value
	)

inline

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

Definition at line 612 of file CreateComputeEnvironmentRequest.h.

◆ AddTags() [3/7]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::AddTags	(	Aws::String &&	key,
		const char *	value
	)

inline

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

Definition at line 672 of file CreateComputeEnvironmentRequest.h.

◆ AddTags() [4/7]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::AddTags	(	const Aws::String &	key,
		Aws::String &&	value
	)

inline

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

Definition at line 627 of file CreateComputeEnvironmentRequest.h.

◆ AddTags() [5/7]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::AddTags	(	const Aws::String &	key,
		const Aws::String &	value
	)

inline

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

Definition at line 597 of file CreateComputeEnvironmentRequest.h.

◆ AddTags() [6/7]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::AddTags	(	const char *	key,
		Aws::String &&	value
	)

inline

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

Definition at line 657 of file CreateComputeEnvironmentRequest.h.

◆ AddTags() [7/7]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::AddTags	(	const char *	key,
		const char *	value
	)

inline

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

Definition at line 687 of file CreateComputeEnvironmentRequest.h.

◆ ComputeEnvironmentNameHasBeenSet()

bool Aws::Batch::Model::CreateComputeEnvironmentRequest::ComputeEnvironmentNameHasBeenSet ( ) const

inline

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 53 of file CreateComputeEnvironmentRequest.h.

◆ ComputeResourcesHasBeenSet()

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

inline

Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 254 of file CreateComputeEnvironmentRequest.h.

◆ GetComputeEnvironmentName()

const Aws::String& Aws::Batch::Model::CreateComputeEnvironmentRequest::GetComputeEnvironmentName ( ) const

inline

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 47 of file CreateComputeEnvironmentRequest.h.

◆ GetComputeResources()

const ComputeResource& Aws::Batch::Model::CreateComputeEnvironmentRequest::GetComputeResources ( ) const

inline

Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 245 of file CreateComputeEnvironmentRequest.h.

◆ GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file CreateComputeEnvironmentRequest.h.

◆ GetServiceRole()

const Aws::String& Aws::Batch::Model::CreateComputeEnvironmentRequest::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 your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try to create the AWS Batch service-linked role in your account.

If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

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 316 of file CreateComputeEnvironmentRequest.h.

◆ GetState()

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

inline

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on 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 155 of file CreateComputeEnvironmentRequest.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::Batch::Model::CreateComputeEnvironmentRequest::GetTags ( ) const

inline

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

Definition at line 507 of file CreateComputeEnvironmentRequest.h.

◆ GetType()

const CEType& Aws::Batch::Model::CreateComputeEnvironmentRequest::GetType ( ) const

inline

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 98 of file CreateComputeEnvironmentRequest.h.

◆ SerializePayload()

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

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServiceRoleHasBeenSet()

bool Aws::Batch::Model::CreateComputeEnvironmentRequest::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 your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try to create the AWS Batch service-linked role in your account.

If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

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 341 of file CreateComputeEnvironmentRequest.h.

◆ SetComputeEnvironmentName() [1/3]

void Aws::Batch::Model::CreateComputeEnvironmentRequest::SetComputeEnvironmentName ( Aws::String && value )

inline

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 65 of file CreateComputeEnvironmentRequest.h.

◆ SetComputeEnvironmentName() [2/3]

void Aws::Batch::Model::CreateComputeEnvironmentRequest::SetComputeEnvironmentName ( const Aws::String & value )

inline

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 59 of file CreateComputeEnvironmentRequest.h.

◆ SetComputeEnvironmentName() [3/3]

void Aws::Batch::Model::CreateComputeEnvironmentRequest::SetComputeEnvironmentName ( const char * value )

inline

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 71 of file CreateComputeEnvironmentRequest.h.

◆ SetComputeResources() [1/2]

void Aws::Batch::Model::CreateComputeEnvironmentRequest::SetComputeResources ( ComputeResource && value )

inline

Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 272 of file CreateComputeEnvironmentRequest.h.

◆ SetComputeResources() [2/2]

void Aws::Batch::Model::CreateComputeEnvironmentRequest::SetComputeResources ( const ComputeResource & value )

inline

Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 263 of file CreateComputeEnvironmentRequest.h.

◆ SetServiceRole() [1/3]

void Aws::Batch::Model::CreateComputeEnvironmentRequest::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 your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try to create the AWS Batch service-linked role in your account.

If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

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 391 of file CreateComputeEnvironmentRequest.h.

◆ SetServiceRole() [2/3]

void Aws::Batch::Model::CreateComputeEnvironmentRequest::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 your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try to create the AWS Batch service-linked role in your account.

If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

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 366 of file CreateComputeEnvironmentRequest.h.

◆ SetServiceRole() [3/3]

void Aws::Batch::Model::CreateComputeEnvironmentRequest::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 your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try to create the AWS Batch service-linked role in your account.

If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

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 416 of file CreateComputeEnvironmentRequest.h.

◆ SetState() [1/2]

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

inline

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on 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 203 of file CreateComputeEnvironmentRequest.h.

◆ SetState() [2/2]

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

inline

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on 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 187 of file CreateComputeEnvironmentRequest.h.

◆ SetTags() [1/2]

void Aws::Batch::Model::CreateComputeEnvironmentRequest::SetTags ( Aws::Map< Aws::String, Aws::String > && value )

inline

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

Definition at line 552 of file CreateComputeEnvironmentRequest.h.

◆ SetTags() [2/2]

void Aws::Batch::Model::CreateComputeEnvironmentRequest::SetTags ( const Aws::Map< Aws::String, Aws::String > & value )

inline

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

Definition at line 537 of file CreateComputeEnvironmentRequest.h.

◆ SetType() [1/2]

void Aws::Batch::Model::CreateComputeEnvironmentRequest::SetType ( CEType && value )

inline

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 122 of file CreateComputeEnvironmentRequest.h.

◆ SetType() [2/2]

void Aws::Batch::Model::CreateComputeEnvironmentRequest::SetType ( const CEType & value )

inline

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 114 of file CreateComputeEnvironmentRequest.h.

◆ StateHasBeenSet()

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

inline

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on 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 171 of file CreateComputeEnvironmentRequest.h.

◆ TagsHasBeenSet()

bool Aws::Batch::Model::CreateComputeEnvironmentRequest::TagsHasBeenSet ( ) const

inline

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

Definition at line 522 of file CreateComputeEnvironmentRequest.h.

◆ TypeHasBeenSet()

bool Aws::Batch::Model::CreateComputeEnvironmentRequest::TypeHasBeenSet ( ) const

inline

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 106 of file CreateComputeEnvironmentRequest.h.

◆ WithComputeEnvironmentName() [1/3]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::WithComputeEnvironmentName ( Aws::String && value )

inline

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 83 of file CreateComputeEnvironmentRequest.h.

◆ WithComputeEnvironmentName() [2/3]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::WithComputeEnvironmentName ( const Aws::String & value )

inline

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 77 of file CreateComputeEnvironmentRequest.h.

◆ WithComputeEnvironmentName() [3/3]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::WithComputeEnvironmentName ( const char * value )

inline

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Definition at line 89 of file CreateComputeEnvironmentRequest.h.

◆ WithComputeResources() [1/2]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::WithComputeResources ( ComputeResource && value )

inline

Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 290 of file CreateComputeEnvironmentRequest.h.

◆ WithComputeResources() [2/2]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::WithComputeResources ( const ComputeResource & value )

inline

Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 281 of file CreateComputeEnvironmentRequest.h.

◆ WithServiceRole() [1/3]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::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 your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try to create the AWS Batch service-linked role in your account.

If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

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 466 of file CreateComputeEnvironmentRequest.h.

◆ WithServiceRole() [2/3]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::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 your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try to create the AWS Batch service-linked role in your account.

If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

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 441 of file CreateComputeEnvironmentRequest.h.

◆ WithServiceRole() [3/3]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::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 your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try to create the AWS Batch service-linked role in your account.

If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

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 491 of file CreateComputeEnvironmentRequest.h.

◆ WithState() [1/2]

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

inline

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on 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 235 of file CreateComputeEnvironmentRequest.h.

◆ WithState() [2/2]

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

inline

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on 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 219 of file CreateComputeEnvironmentRequest.h.

◆ WithTags() [1/2]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::WithTags ( Aws::Map< Aws::String, Aws::String > && value )

inline

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

Definition at line 582 of file CreateComputeEnvironmentRequest.h.

◆ WithTags() [2/2]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::WithTags ( const Aws::Map< Aws::String, Aws::String > & value )

inline

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

Definition at line 567 of file CreateComputeEnvironmentRequest.h.

◆ WithType() [1/2]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::WithType ( CEType && value )

inline

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 138 of file CreateComputeEnvironmentRequest.h.

◆ WithType() [2/2]

CreateComputeEnvironmentRequest& Aws::Batch::Model::CreateComputeEnvironmentRequest::WithType ( const CEType & value )

inline

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the AWS Batch User Guide.

Definition at line 130 of file CreateComputeEnvironmentRequest.h.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

See Also:

Constructor & Destructor Documentation

◆ CreateComputeEnvironmentRequest()

Member Function Documentation

◆ AddTags() [1/7]

◆ AddTags() [2/7]

◆ AddTags() [3/7]

◆ AddTags() [4/7]

◆ AddTags() [5/7]

◆ AddTags() [6/7]

◆ AddTags() [7/7]

◆ ComputeEnvironmentNameHasBeenSet()

◆ ComputeResourcesHasBeenSet()

◆ GetComputeEnvironmentName()

◆ GetComputeResources()

◆ GetServiceRequestName()

◆ GetServiceRole()

◆ GetState()

◆ GetTags()

◆ GetType()

◆ SerializePayload()

◆ ServiceRoleHasBeenSet()

◆ SetComputeEnvironmentName() [1/3]

◆ SetComputeEnvironmentName() [2/3]

◆ SetComputeEnvironmentName() [3/3]

◆ SetComputeResources() [1/2]

◆ SetComputeResources() [2/2]

◆ SetServiceRole() [1/3]

◆ SetServiceRole() [2/3]

◆ SetServiceRole() [3/3]

◆ SetState() [1/2]

◆ SetState() [2/2]

◆ SetTags() [1/2]

◆ SetTags() [2/2]

◆ SetType() [1/2]

◆ SetType() [2/2]

◆ StateHasBeenSet()

◆ TagsHasBeenSet()

◆ TypeHasBeenSet()

◆ WithComputeEnvironmentName() [1/3]

◆ WithComputeEnvironmentName() [2/3]

◆ WithComputeEnvironmentName() [3/3]

◆ WithComputeResources() [1/2]

◆ WithComputeResources() [2/2]

◆ WithServiceRole() [1/3]

◆ WithServiceRole() [2/3]

◆ WithServiceRole() [3/3]

◆ WithState() [1/2]

◆ WithState() [2/2]

◆ WithTags() [1/2]

◆ WithTags() [2/2]

◆ WithType() [1/2]

◆ WithType() [2/2]