Aws::ECS::Model::CreateClusterRequest Class Reference

#include <CreateClusterRequest.h>

Inheritance diagram for Aws::ECS::Model::CreateClusterRequest:

Public Member Functions
	CreateClusterRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetClusterName () const
bool	ClusterNameHasBeenSet () const
void	SetClusterName (const Aws::String &value)
void	SetClusterName (Aws::String &&value)
void	SetClusterName (const char *value)
CreateClusterRequest &	WithClusterName (const Aws::String &value)
CreateClusterRequest &	WithClusterName (Aws::String &&value)
CreateClusterRequest &	WithClusterName (const char *value)
const Aws::Vector< Tag > &	GetTags () const
bool	TagsHasBeenSet () const
void	SetTags (const Aws::Vector< Tag > &value)
void	SetTags (Aws::Vector< Tag > &&value)
CreateClusterRequest &	WithTags (const Aws::Vector< Tag > &value)
CreateClusterRequest &	WithTags (Aws::Vector< Tag > &&value)
CreateClusterRequest &	AddTags (const Tag &value)
CreateClusterRequest &	AddTags (Tag &&value)
const Aws::Vector< ClusterSetting > &	GetSettings () const
bool	SettingsHasBeenSet () const
void	SetSettings (const Aws::Vector< ClusterSetting > &value)
void	SetSettings (Aws::Vector< ClusterSetting > &&value)
CreateClusterRequest &	WithSettings (const Aws::Vector< ClusterSetting > &value)
CreateClusterRequest &	WithSettings (Aws::Vector< ClusterSetting > &&value)
CreateClusterRequest &	AddSettings (const ClusterSetting &value)
CreateClusterRequest &	AddSettings (ClusterSetting &&value)
const Aws::Vector< Aws::String > &	GetCapacityProviders () const
bool	CapacityProvidersHasBeenSet () const
void	SetCapacityProviders (const Aws::Vector< Aws::String > &value)
void	SetCapacityProviders (Aws::Vector< Aws::String > &&value)
CreateClusterRequest &	WithCapacityProviders (const Aws::Vector< Aws::String > &value)
CreateClusterRequest &	WithCapacityProviders (Aws::Vector< Aws::String > &&value)
CreateClusterRequest &	AddCapacityProviders (const Aws::String &value)
CreateClusterRequest &	AddCapacityProviders (Aws::String &&value)
CreateClusterRequest &	AddCapacityProviders (const char *value)
const Aws::Vector< CapacityProviderStrategyItem > &	GetDefaultCapacityProviderStrategy () const
bool	DefaultCapacityProviderStrategyHasBeenSet () const
void	SetDefaultCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)
void	SetDefaultCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)
CreateClusterRequest &	WithDefaultCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)
CreateClusterRequest &	WithDefaultCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)
CreateClusterRequest &	AddDefaultCapacityProviderStrategy (const CapacityProviderStrategyItem &value)
CreateClusterRequest &	AddDefaultCapacityProviderStrategy (CapacityProviderStrategyItem &&value)
Public Member Functions inherited from Aws::ECS::ECSRequest
virtual	~ECSRequest ()
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::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Definition at line 25 of file CreateClusterRequest.h.

Constructor & Destructor Documentation

CreateClusterRequest()

Aws::ECS::Model::CreateClusterRequest::CreateClusterRequest

(

)

Member Function Documentation

AddCapacityProviders() [1/3]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::AddCapacityProviders ( const Aws::String &  value )

inline

The short name of one or more capacity providers to associate with the cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 427 of file CreateClusterRequest.h.

AddCapacityProviders() [2/3]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::AddCapacityProviders ( Aws::String &&  value )

inline

The short name of one or more capacity providers to associate with the cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 442 of file CreateClusterRequest.h.

AddCapacityProviders() [3/3]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::AddCapacityProviders ( const char *  value )

inline

The short name of one or more capacity providers to associate with the cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 457 of file CreateClusterRequest.h.

AddDefaultCapacityProviderStrategy() [1/2]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::AddDefaultCapacityProviderStrategy ( const CapacityProviderStrategyItem &  value )

inline

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.

Definition at line 612 of file CreateClusterRequest.h.

AddDefaultCapacityProviderStrategy() [2/2]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::AddDefaultCapacityProviderStrategy ( CapacityProviderStrategyItem &&  value )

inline

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.

Definition at line 634 of file CreateClusterRequest.h.

AddSettings() [1/2]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::AddSettings ( const ClusterSetting &  value )

inline

The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

Definition at line 313 of file CreateClusterRequest.h.

AddSettings() [2/2]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::AddSettings ( ClusterSetting &&  value )

inline

The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

Definition at line 321 of file CreateClusterRequest.h.

AddTags() [1/2]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::AddTags ( const Tag &  value )

inline

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / .

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 236 of file CreateClusterRequest.h.

AddTags() [2/2]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::AddTags ( Tag &&  value )

inline

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / .

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 256 of file CreateClusterRequest.h.

CapacityProvidersHasBeenSet()

bool Aws::ECS::Model::CreateClusterRequest::CapacityProvidersHasBeenSet ( ) const

inline

The short name of one or more capacity providers to associate with the cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 352 of file CreateClusterRequest.h.

ClusterNameHasBeenSet()

bool Aws::ECS::Model::CreateClusterRequest::ClusterNameHasBeenSet ( ) const

inline

The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.

Definition at line 53 of file CreateClusterRequest.h.

DefaultCapacityProviderStrategyHasBeenSet()

bool Aws::ECS::Model::CreateClusterRequest::DefaultCapacityProviderStrategyHasBeenSet ( ) const

inline

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.

Definition at line 502 of file CreateClusterRequest.h.

GetCapacityProviders()

const Aws::Vector<Aws::String>& Aws::ECS::Model::CreateClusterRequest::GetCapacityProviders ( ) const

inline

The short name of one or more capacity providers to associate with the cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 337 of file CreateClusterRequest.h.

GetClusterName()

const Aws::String& Aws::ECS::Model::CreateClusterRequest::GetClusterName ( ) const

inline

The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.

Definition at line 46 of file CreateClusterRequest.h.

GetDefaultCapacityProviderStrategy()

const Aws::Vector<CapacityProviderStrategyItem>& Aws::ECS::Model::CreateClusterRequest::GetDefaultCapacityProviderStrategy ( ) const

inline

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.

Definition at line 480 of file CreateClusterRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ECS::Model::CreateClusterRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::ECS::ECSRequest.

GetServiceRequestName()

virtual const char* Aws::ECS::Model::CreateClusterRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CreateClusterRequest.h.

GetSettings()

const Aws::Vector<ClusterSetting>& Aws::ECS::Model::CreateClusterRequest::GetSettings ( ) const

inline

The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

Definition at line 265 of file CreateClusterRequest.h.

GetTags()

const Aws::Vector<Tag>& Aws::ECS::Model::CreateClusterRequest::GetTags ( ) const

inline

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / .

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 116 of file CreateClusterRequest.h.

SerializePayload()

Aws::String Aws::ECS::Model::CreateClusterRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetCapacityProviders() [1/2]

void Aws::ECS::Model::CreateClusterRequest::SetCapacityProviders ( const Aws::Vector< Aws::String > &  value )

inline

The short name of one or more capacity providers to associate with the cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 367 of file CreateClusterRequest.h.

SetCapacityProviders() [2/2]

void Aws::ECS::Model::CreateClusterRequest::SetCapacityProviders ( Aws::Vector< Aws::String > &&  value )

inline

The short name of one or more capacity providers to associate with the cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 382 of file CreateClusterRequest.h.

SetClusterName() [1/3]

void Aws::ECS::Model::CreateClusterRequest::SetClusterName ( const Aws::String &  value )

inline

The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.

Definition at line 60 of file CreateClusterRequest.h.

SetClusterName() [2/3]

void Aws::ECS::Model::CreateClusterRequest::SetClusterName ( Aws::String &&  value )

inline

The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.

Definition at line 67 of file CreateClusterRequest.h.

SetClusterName() [3/3]

void Aws::ECS::Model::CreateClusterRequest::SetClusterName ( const char *  value )

inline

The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.

Definition at line 74 of file CreateClusterRequest.h.

SetDefaultCapacityProviderStrategy() [1/2]

void Aws::ECS::Model::CreateClusterRequest::SetDefaultCapacityProviderStrategy ( const Aws::Vector< CapacityProviderStrategyItem > &  value )

inline

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.

Definition at line 524 of file CreateClusterRequest.h.

SetDefaultCapacityProviderStrategy() [2/2]

void Aws::ECS::Model::CreateClusterRequest::SetDefaultCapacityProviderStrategy ( Aws::Vector< CapacityProviderStrategyItem > &&  value )

inline

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.

Definition at line 546 of file CreateClusterRequest.h.

SetSettings() [1/2]

void Aws::ECS::Model::CreateClusterRequest::SetSettings ( const Aws::Vector< ClusterSetting > &  value )

inline

The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

Definition at line 281 of file CreateClusterRequest.h.

SetSettings() [2/2]

void Aws::ECS::Model::CreateClusterRequest::SetSettings ( Aws::Vector< ClusterSetting > &&  value )

inline

The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

Definition at line 289 of file CreateClusterRequest.h.

SetTags() [1/2]

void Aws::ECS::Model::CreateClusterRequest::SetTags ( const Aws::Vector< Tag > &  value )

inline

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / .

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 156 of file CreateClusterRequest.h.

SetTags() [2/2]

void Aws::ECS::Model::CreateClusterRequest::SetTags ( Aws::Vector< Tag > &&  value )

inline

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / .

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 176 of file CreateClusterRequest.h.

SettingsHasBeenSet()

bool Aws::ECS::Model::CreateClusterRequest::SettingsHasBeenSet ( ) const

inline

The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

Definition at line 273 of file CreateClusterRequest.h.

TagsHasBeenSet()

bool Aws::ECS::Model::CreateClusterRequest::TagsHasBeenSet ( ) const

inline

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / .

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 136 of file CreateClusterRequest.h.

WithCapacityProviders() [1/2]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::WithCapacityProviders ( const Aws::Vector< Aws::String > &  value )

inline

The short name of one or more capacity providers to associate with the cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 397 of file CreateClusterRequest.h.

WithCapacityProviders() [2/2]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::WithCapacityProviders ( Aws::Vector< Aws::String > &&  value )

inline

The short name of one or more capacity providers to associate with the cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Definition at line 412 of file CreateClusterRequest.h.

WithClusterName() [1/3]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::WithClusterName ( const Aws::String &  value )

inline

The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.

Definition at line 81 of file CreateClusterRequest.h.

WithClusterName() [2/3]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::WithClusterName ( Aws::String &&  value )

inline

The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.

Definition at line 88 of file CreateClusterRequest.h.

WithClusterName() [3/3]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::WithClusterName ( const char *  value )

inline

The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.

Definition at line 95 of file CreateClusterRequest.h.

WithDefaultCapacityProviderStrategy() [1/2]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::WithDefaultCapacityProviderStrategy ( const Aws::Vector< CapacityProviderStrategyItem > &  value )

inline

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.

Definition at line 568 of file CreateClusterRequest.h.

WithDefaultCapacityProviderStrategy() [2/2]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::WithDefaultCapacityProviderStrategy ( Aws::Vector< CapacityProviderStrategyItem > &&  value )

inline

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.

Definition at line 590 of file CreateClusterRequest.h.

WithSettings() [1/2]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::WithSettings ( const Aws::Vector< ClusterSetting > &  value )

inline

The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

Definition at line 297 of file CreateClusterRequest.h.

WithSettings() [2/2]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::WithSettings ( Aws::Vector< ClusterSetting > &&  value )

inline

The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

Definition at line 305 of file CreateClusterRequest.h.

WithTags() [1/2]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::WithTags ( const Aws::Vector< Tag > &  value )

inline

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / .

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 196 of file CreateClusterRequest.h.

WithTags() [2/2]

CreateClusterRequest& Aws::ECS::Model::CreateClusterRequest::WithTags ( Aws::Vector< Tag > &&  value )

inline

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50

• For each resource, each tag key must be unique, and each tag key can have only one value.

• Maximum key length - 128 Unicode characters in UTF-8

• Maximum value length - 256 Unicode characters in UTF-8

• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / .

• Tag keys and values are case-sensitive.

• Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Definition at line 216 of file CreateClusterRequest.h.

---

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

• aws-cpp-sdk-ecs/include/aws/ecs/model/CreateClusterRequest.h