Aws::ECS::Model::PutClusterCapacityProvidersRequest Class Reference

#include <PutClusterCapacityProvidersRequest.h>

Inheritance diagram for Aws::ECS::Model::PutClusterCapacityProvidersRequest:

Public Member Functions
	PutClusterCapacityProvidersRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetCluster () const
bool	ClusterHasBeenSet () const
void	SetCluster (const Aws::String &value)
void	SetCluster (Aws::String &&value)
void	SetCluster (const char *value)
PutClusterCapacityProvidersRequest &	WithCluster (const Aws::String &value)
PutClusterCapacityProvidersRequest &	WithCluster (Aws::String &&value)
PutClusterCapacityProvidersRequest &	WithCluster (const char *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)
PutClusterCapacityProvidersRequest &	WithCapacityProviders (const Aws::Vector< Aws::String > &value)
PutClusterCapacityProvidersRequest &	WithCapacityProviders (Aws::Vector< Aws::String > &&value)
PutClusterCapacityProvidersRequest &	AddCapacityProviders (const Aws::String &value)
PutClusterCapacityProvidersRequest &	AddCapacityProviders (Aws::String &&value)
PutClusterCapacityProvidersRequest &	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)
PutClusterCapacityProvidersRequest &	WithDefaultCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)
PutClusterCapacityProvidersRequest &	WithDefaultCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)
PutClusterCapacityProvidersRequest &	AddDefaultCapacityProviderStrategy (const CapacityProviderStrategyItem &value)
PutClusterCapacityProvidersRequest &	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 23 of file PutClusterCapacityProvidersRequest.h.

Constructor & Destructor Documentation

PutClusterCapacityProvidersRequest()

Aws::ECS::Model::PutClusterCapacityProvidersRequest::PutClusterCapacityProvidersRequest

(

)

Member Function Documentation

AddCapacityProviders() [1/3]

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

inline

The 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. 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.

Definition at line 190 of file PutClusterCapacityProvidersRequest.h.

AddCapacityProviders() [2/3]

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

inline

The 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. 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.

Definition at line 178 of file PutClusterCapacityProvidersRequest.h.

AddCapacityProviders() [3/3]

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

inline

The 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. 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.

Definition at line 202 of file PutClusterCapacityProvidersRequest.h.

AddDefaultCapacityProviderStrategy() [1/2]

PutClusterCapacityProvidersRequest& Aws::ECS::Model::PutClusterCapacityProvidersRequest::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.

Definition at line 363 of file PutClusterCapacityProvidersRequest.h.

AddDefaultCapacityProviderStrategy() [2/2]

PutClusterCapacityProvidersRequest& Aws::ECS::Model::PutClusterCapacityProvidersRequest::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.

Definition at line 343 of file PutClusterCapacityProvidersRequest.h.

CapacityProvidersHasBeenSet()

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

inline

The 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. 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.

Definition at line 118 of file PutClusterCapacityProvidersRequest.h.

ClusterHasBeenSet()

bool Aws::ECS::Model::PutClusterCapacityProvidersRequest::ClusterHasBeenSet ( ) const

inline

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.

Definition at line 51 of file PutClusterCapacityProvidersRequest.h.

DefaultCapacityProviderStrategyHasBeenSet()

bool Aws::ECS::Model::PutClusterCapacityProvidersRequest::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.

Definition at line 243 of file PutClusterCapacityProvidersRequest.h.

GetCapacityProviders()

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

inline

The 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. 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.

Definition at line 106 of file PutClusterCapacityProvidersRequest.h.

GetCluster()

const Aws::String& Aws::ECS::Model::PutClusterCapacityProvidersRequest::GetCluster ( ) const

inline

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.

Definition at line 44 of file PutClusterCapacityProvidersRequest.h.

GetDefaultCapacityProviderStrategy()

const Aws::Vector<CapacityProviderStrategyItem>& Aws::ECS::Model::PutClusterCapacityProvidersRequest::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.

Definition at line 223 of file PutClusterCapacityProvidersRequest.h.

GetRequestSpecificHeaders()

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

overridevirtual

Reimplemented from Aws::ECS::ECSRequest.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file PutClusterCapacityProvidersRequest.h.

SerializePayload()

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

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetCapacityProviders() [1/2]

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

inline

The 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. 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.

Definition at line 142 of file PutClusterCapacityProvidersRequest.h.

SetCapacityProviders() [2/2]

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

inline

The 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. 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.

Definition at line 130 of file PutClusterCapacityProvidersRequest.h.

SetCluster() [1/3]

void Aws::ECS::Model::PutClusterCapacityProvidersRequest::SetCluster ( Aws::String &&  value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.

Definition at line 65 of file PutClusterCapacityProvidersRequest.h.

SetCluster() [2/3]

void Aws::ECS::Model::PutClusterCapacityProvidersRequest::SetCluster ( const Aws::String &  value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.

Definition at line 58 of file PutClusterCapacityProvidersRequest.h.

SetCluster() [3/3]

void Aws::ECS::Model::PutClusterCapacityProvidersRequest::SetCluster ( const char *  value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.

Definition at line 72 of file PutClusterCapacityProvidersRequest.h.

SetDefaultCapacityProviderStrategy() [1/2]

void Aws::ECS::Model::PutClusterCapacityProvidersRequest::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.

Definition at line 283 of file PutClusterCapacityProvidersRequest.h.

SetDefaultCapacityProviderStrategy() [2/2]

void Aws::ECS::Model::PutClusterCapacityProvidersRequest::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.

Definition at line 263 of file PutClusterCapacityProvidersRequest.h.

WithCapacityProviders() [1/2]

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

inline

The 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. 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.

Definition at line 166 of file PutClusterCapacityProvidersRequest.h.

WithCapacityProviders() [2/2]

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

inline

The 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. 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.

Definition at line 154 of file PutClusterCapacityProvidersRequest.h.

WithCluster() [1/3]

PutClusterCapacityProvidersRequest& Aws::ECS::Model::PutClusterCapacityProvidersRequest::WithCluster ( Aws::String &&  value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.

Definition at line 86 of file PutClusterCapacityProvidersRequest.h.

WithCluster() [2/3]

PutClusterCapacityProvidersRequest& Aws::ECS::Model::PutClusterCapacityProvidersRequest::WithCluster ( const Aws::String &  value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.

Definition at line 79 of file PutClusterCapacityProvidersRequest.h.

WithCluster() [3/3]

PutClusterCapacityProvidersRequest& Aws::ECS::Model::PutClusterCapacityProvidersRequest::WithCluster ( const char *  value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.

Definition at line 93 of file PutClusterCapacityProvidersRequest.h.

WithDefaultCapacityProviderStrategy() [1/2]

PutClusterCapacityProvidersRequest& Aws::ECS::Model::PutClusterCapacityProvidersRequest::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.

Definition at line 323 of file PutClusterCapacityProvidersRequest.h.

WithDefaultCapacityProviderStrategy() [2/2]

PutClusterCapacityProvidersRequest& Aws::ECS::Model::PutClusterCapacityProvidersRequest::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.

Definition at line 303 of file PutClusterCapacityProvidersRequest.h.

---

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

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