AWS SDK for C++  1.9.17
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::Cluster Class Reference

#include <Cluster.h>

Public Member Functions

 Cluster ()
 
 Cluster (Aws::Utils::Json::JsonView jsonValue)
 
Clusteroperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetClusterArn () const
 
bool ClusterArnHasBeenSet () const
 
void SetClusterArn (const Aws::String &value)
 
void SetClusterArn (Aws::String &&value)
 
void SetClusterArn (const char *value)
 
ClusterWithClusterArn (const Aws::String &value)
 
ClusterWithClusterArn (Aws::String &&value)
 
ClusterWithClusterArn (const char *value)
 
const Aws::StringGetClusterName () const
 
bool ClusterNameHasBeenSet () const
 
void SetClusterName (const Aws::String &value)
 
void SetClusterName (Aws::String &&value)
 
void SetClusterName (const char *value)
 
ClusterWithClusterName (const Aws::String &value)
 
ClusterWithClusterName (Aws::String &&value)
 
ClusterWithClusterName (const char *value)
 
const ClusterConfigurationGetConfiguration () const
 
bool ConfigurationHasBeenSet () const
 
void SetConfiguration (const ClusterConfiguration &value)
 
void SetConfiguration (ClusterConfiguration &&value)
 
ClusterWithConfiguration (const ClusterConfiguration &value)
 
ClusterWithConfiguration (ClusterConfiguration &&value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
ClusterWithStatus (const Aws::String &value)
 
ClusterWithStatus (Aws::String &&value)
 
ClusterWithStatus (const char *value)
 
int GetRegisteredContainerInstancesCount () const
 
bool RegisteredContainerInstancesCountHasBeenSet () const
 
void SetRegisteredContainerInstancesCount (int value)
 
ClusterWithRegisteredContainerInstancesCount (int value)
 
int GetRunningTasksCount () const
 
bool RunningTasksCountHasBeenSet () const
 
void SetRunningTasksCount (int value)
 
ClusterWithRunningTasksCount (int value)
 
int GetPendingTasksCount () const
 
bool PendingTasksCountHasBeenSet () const
 
void SetPendingTasksCount (int value)
 
ClusterWithPendingTasksCount (int value)
 
int GetActiveServicesCount () const
 
bool ActiveServicesCountHasBeenSet () const
 
void SetActiveServicesCount (int value)
 
ClusterWithActiveServicesCount (int value)
 
const Aws::Vector< KeyValuePair > & GetStatistics () const
 
bool StatisticsHasBeenSet () const
 
void SetStatistics (const Aws::Vector< KeyValuePair > &value)
 
void SetStatistics (Aws::Vector< KeyValuePair > &&value)
 
ClusterWithStatistics (const Aws::Vector< KeyValuePair > &value)
 
ClusterWithStatistics (Aws::Vector< KeyValuePair > &&value)
 
ClusterAddStatistics (const KeyValuePair &value)
 
ClusterAddStatistics (KeyValuePair &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
ClusterWithTags (const Aws::Vector< Tag > &value)
 
ClusterWithTags (Aws::Vector< Tag > &&value)
 
ClusterAddTags (const Tag &value)
 
ClusterAddTags (Tag &&value)
 
const Aws::Vector< ClusterSetting > & GetSettings () const
 
bool SettingsHasBeenSet () const
 
void SetSettings (const Aws::Vector< ClusterSetting > &value)
 
void SetSettings (Aws::Vector< ClusterSetting > &&value)
 
ClusterWithSettings (const Aws::Vector< ClusterSetting > &value)
 
ClusterWithSettings (Aws::Vector< ClusterSetting > &&value)
 
ClusterAddSettings (const ClusterSetting &value)
 
ClusterAddSettings (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)
 
ClusterWithCapacityProviders (const Aws::Vector< Aws::String > &value)
 
ClusterWithCapacityProviders (Aws::Vector< Aws::String > &&value)
 
ClusterAddCapacityProviders (const Aws::String &value)
 
ClusterAddCapacityProviders (Aws::String &&value)
 
ClusterAddCapacityProviders (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)
 
ClusterWithDefaultCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)
 
ClusterWithDefaultCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)
 
ClusterAddDefaultCapacityProviderStrategy (const CapacityProviderStrategyItem &value)
 
ClusterAddDefaultCapacityProviderStrategy (CapacityProviderStrategyItem &&value)
 
const Aws::Vector< Attachment > & GetAttachments () const
 
bool AttachmentsHasBeenSet () const
 
void SetAttachments (const Aws::Vector< Attachment > &value)
 
void SetAttachments (Aws::Vector< Attachment > &&value)
 
ClusterWithAttachments (const Aws::Vector< Attachment > &value)
 
ClusterWithAttachments (Aws::Vector< Attachment > &&value)
 
ClusterAddAttachments (const Attachment &value)
 
ClusterAddAttachments (Attachment &&value)
 
const Aws::StringGetAttachmentsStatus () const
 
bool AttachmentsStatusHasBeenSet () const
 
void SetAttachmentsStatus (const Aws::String &value)
 
void SetAttachmentsStatus (Aws::String &&value)
 
void SetAttachmentsStatus (const char *value)
 
ClusterWithAttachmentsStatus (const Aws::String &value)
 
ClusterWithAttachmentsStatus (Aws::String &&value)
 
ClusterWithAttachmentsStatus (const char *value)
 

Detailed Description

A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

See Also:


AWS API Reference

Definition at line 41 of file Cluster.h.

Constructor & Destructor Documentation

◆ Cluster() [1/2]

Aws::ECS::Model::Cluster::Cluster ( )

◆ Cluster() [2/2]

Aws::ECS::Model::Cluster::Cluster ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ActiveServicesCountHasBeenSet()

bool Aws::ECS::Model::Cluster::ActiveServicesCountHasBeenSet ( ) const
inline

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

Definition at line 431 of file Cluster.h.

◆ AddAttachments() [1/2]

Cluster& Aws::ECS::Model::Cluster::AddAttachments ( Attachment &&  value)
inline

The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.

Definition at line 904 of file Cluster.h.

◆ AddAttachments() [2/2]

Cluster& Aws::ECS::Model::Cluster::AddAttachments ( const Attachment value)
inline

The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.

Definition at line 897 of file Cluster.h.

◆ AddCapacityProviders() [1/3]

Cluster& Aws::ECS::Model::Cluster::AddCapacityProviders ( Aws::String &&  value)
inline

The capacity providers associated with the cluster.

Definition at line 785 of file Cluster.h.

◆ AddCapacityProviders() [2/3]

Cluster& Aws::ECS::Model::Cluster::AddCapacityProviders ( const Aws::String value)
inline

The capacity providers associated with the cluster.

Definition at line 780 of file Cluster.h.

◆ AddCapacityProviders() [3/3]

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

The capacity providers associated with the cluster.

Definition at line 790 of file Cluster.h.

◆ AddDefaultCapacityProviderStrategy() [1/2]

Cluster& Aws::ECS::Model::Cluster::AddDefaultCapacityProviderStrategy ( CapacityProviderStrategyItem &&  value)
inline

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

Definition at line 847 of file Cluster.h.

◆ AddDefaultCapacityProviderStrategy() [2/2]

Cluster& Aws::ECS::Model::Cluster::AddDefaultCapacityProviderStrategy ( const CapacityProviderStrategyItem value)
inline

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

Definition at line 840 of file Cluster.h.

◆ AddSettings() [1/2]

Cluster& Aws::ECS::Model::Cluster::AddSettings ( ClusterSetting &&  value)
inline

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

Definition at line 744 of file Cluster.h.

◆ AddSettings() [2/2]

Cluster& Aws::ECS::Model::Cluster::AddSettings ( const ClusterSetting value)
inline

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

Definition at line 738 of file Cluster.h.

◆ AddStatistics() [1/2]

Cluster& Aws::ECS::Model::Cluster::AddStatistics ( const KeyValuePair value)
inline

Additional information about your clusters that are separated by launch type, including:

  • runningEC2TasksCount

  • RunningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

Definition at line 523 of file Cluster.h.

◆ AddStatistics() [2/2]

Cluster& Aws::ECS::Model::Cluster::AddStatistics ( KeyValuePair &&  value)
inline

Additional information about your clusters that are separated by launch type, including:

  • runningEC2TasksCount

  • RunningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

Definition at line 534 of file Cluster.h.

◆ AddTags() [1/2]

Cluster& Aws::ECS::Model::Cluster::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 675 of file Cluster.h.

◆ AddTags() [2/2]

Cluster& Aws::ECS::Model::Cluster::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 695 of file Cluster.h.

◆ AttachmentsHasBeenSet()

bool Aws::ECS::Model::Cluster::AttachmentsHasBeenSet ( ) const
inline

The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.

Definition at line 862 of file Cluster.h.

◆ AttachmentsStatusHasBeenSet()

bool Aws::ECS::Model::Cluster::AttachmentsStatusHasBeenSet ( ) const
inline

The status of the capacity providers associated with the cluster. The following are the states that will be returned:

UPDATE_IN_PROGRESS

The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.

UPDATE_COMPLETE

The capacity providers have successfully updated.

UPDATE_FAILED

The capacity provider updates failed.

Definition at line 927 of file Cluster.h.

◆ CapacityProvidersHasBeenSet()

bool Aws::ECS::Model::Cluster::CapacityProvidersHasBeenSet ( ) const
inline

The capacity providers associated with the cluster.

Definition at line 755 of file Cluster.h.

◆ ClusterArnHasBeenSet()

bool Aws::ECS::Model::Cluster::ClusterArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

Definition at line 66 of file Cluster.h.

◆ ClusterNameHasBeenSet()

bool Aws::ECS::Model::Cluster::ClusterNameHasBeenSet ( ) const
inline

A user-generated string that you use to identify your cluster.

Definition at line 131 of file Cluster.h.

◆ ConfigurationHasBeenSet()

bool Aws::ECS::Model::Cluster::ConfigurationHasBeenSet ( ) const
inline

The execute command configuration for the cluster.

Definition at line 172 of file Cluster.h.

◆ DefaultCapacityProviderStrategyHasBeenSet()

bool Aws::ECS::Model::Cluster::DefaultCapacityProviderStrategyHasBeenSet ( ) const
inline

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

Definition at line 805 of file Cluster.h.

◆ GetActiveServicesCount()

int Aws::ECS::Model::Cluster::GetActiveServicesCount ( ) const
inline

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

Definition at line 424 of file Cluster.h.

◆ GetAttachments()

const Aws::Vector<Attachment>& Aws::ECS::Model::Cluster::GetAttachments ( ) const
inline

The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.

Definition at line 855 of file Cluster.h.

◆ GetAttachmentsStatus()

const Aws::String& Aws::ECS::Model::Cluster::GetAttachmentsStatus ( ) const
inline

The status of the capacity providers associated with the cluster. The following are the states that will be returned:

UPDATE_IN_PROGRESS

The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.

UPDATE_COMPLETE

The capacity providers have successfully updated.

UPDATE_FAILED

The capacity provider updates failed.

Definition at line 916 of file Cluster.h.

◆ GetCapacityProviders()

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

The capacity providers associated with the cluster.

Definition at line 750 of file Cluster.h.

◆ GetClusterArn()

const Aws::String& Aws::ECS::Model::Cluster::GetClusterArn ( ) const
inline

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

Definition at line 57 of file Cluster.h.

◆ GetClusterName()

const Aws::String& Aws::ECS::Model::Cluster::GetClusterName ( ) const
inline

A user-generated string that you use to identify your cluster.

Definition at line 126 of file Cluster.h.

◆ GetConfiguration()

const ClusterConfiguration& Aws::ECS::Model::Cluster::GetConfiguration ( ) const
inline

The execute command configuration for the cluster.

Definition at line 167 of file Cluster.h.

◆ GetDefaultCapacityProviderStrategy()

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

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

Definition at line 798 of file Cluster.h.

◆ GetPendingTasksCount()

int Aws::ECS::Model::Cluster::GetPendingTasksCount ( ) const
inline

The number of tasks in the cluster that are in the PENDING state.

Definition at line 398 of file Cluster.h.

◆ GetRegisteredContainerInstancesCount()

int Aws::ECS::Model::Cluster::GetRegisteredContainerInstancesCount ( ) const
inline

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

Definition at line 345 of file Cluster.h.

◆ GetRunningTasksCount()

int Aws::ECS::Model::Cluster::GetRunningTasksCount ( ) const
inline

The number of tasks in the cluster that are in the RUNNING state.

Definition at line 373 of file Cluster.h.

◆ GetSettings()

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

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

Definition at line 702 of file Cluster.h.

◆ GetStatistics()

const Aws::Vector<KeyValuePair>& Aws::ECS::Model::Cluster::GetStatistics ( ) const
inline

Additional information about your clusters that are separated by launch type, including:

  • runningEC2TasksCount

  • RunningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

Definition at line 457 of file Cluster.h.

◆ GetStatus()

const Aws::String& Aws::ECS::Model::Cluster::GetStatus ( ) const
inline

The status of the cluster. The following are the possible states that will be returned.

ACTIVE

The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

PROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.

DEPROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.

FAILED

The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.

INACTIVE

The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE clusters persisting.

Definition at line 211 of file Cluster.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::ECS::Model::Cluster::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 555 of file Cluster.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ECS::Model::Cluster::Jsonize ( ) const

◆ operator=()

Cluster& Aws::ECS::Model::Cluster::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PendingTasksCountHasBeenSet()

bool Aws::ECS::Model::Cluster::PendingTasksCountHasBeenSet ( ) const
inline

The number of tasks in the cluster that are in the PENDING state.

Definition at line 404 of file Cluster.h.

◆ RegisteredContainerInstancesCountHasBeenSet()

bool Aws::ECS::Model::Cluster::RegisteredContainerInstancesCountHasBeenSet ( ) const
inline

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

Definition at line 352 of file Cluster.h.

◆ RunningTasksCountHasBeenSet()

bool Aws::ECS::Model::Cluster::RunningTasksCountHasBeenSet ( ) const
inline

The number of tasks in the cluster that are in the RUNNING state.

Definition at line 379 of file Cluster.h.

◆ SetActiveServicesCount()

void Aws::ECS::Model::Cluster::SetActiveServicesCount ( int  value)
inline

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

Definition at line 438 of file Cluster.h.

◆ SetAttachments() [1/2]

void Aws::ECS::Model::Cluster::SetAttachments ( Aws::Vector< Attachment > &&  value)
inline

The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.

Definition at line 876 of file Cluster.h.

◆ SetAttachments() [2/2]

void Aws::ECS::Model::Cluster::SetAttachments ( const Aws::Vector< Attachment > &  value)
inline

The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.

Definition at line 869 of file Cluster.h.

◆ SetAttachmentsStatus() [1/3]

void Aws::ECS::Model::Cluster::SetAttachmentsStatus ( Aws::String &&  value)
inline

The status of the capacity providers associated with the cluster. The following are the states that will be returned:

UPDATE_IN_PROGRESS

The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.

UPDATE_COMPLETE

The capacity providers have successfully updated.

UPDATE_FAILED

The capacity provider updates failed.

Definition at line 949 of file Cluster.h.

◆ SetAttachmentsStatus() [2/3]

void Aws::ECS::Model::Cluster::SetAttachmentsStatus ( const Aws::String value)
inline

The status of the capacity providers associated with the cluster. The following are the states that will be returned:

UPDATE_IN_PROGRESS

The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.

UPDATE_COMPLETE

The capacity providers have successfully updated.

UPDATE_FAILED

The capacity provider updates failed.

Definition at line 938 of file Cluster.h.

◆ SetAttachmentsStatus() [3/3]

void Aws::ECS::Model::Cluster::SetAttachmentsStatus ( const char *  value)
inline

The status of the capacity providers associated with the cluster. The following are the states that will be returned:

UPDATE_IN_PROGRESS

The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.

UPDATE_COMPLETE

The capacity providers have successfully updated.

UPDATE_FAILED

The capacity provider updates failed.

Definition at line 960 of file Cluster.h.

◆ SetCapacityProviders() [1/2]

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

The capacity providers associated with the cluster.

Definition at line 765 of file Cluster.h.

◆ SetCapacityProviders() [2/2]

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

The capacity providers associated with the cluster.

Definition at line 760 of file Cluster.h.

◆ SetClusterArn() [1/3]

void Aws::ECS::Model::Cluster::SetClusterArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

Definition at line 84 of file Cluster.h.

◆ SetClusterArn() [2/3]

void Aws::ECS::Model::Cluster::SetClusterArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

Definition at line 75 of file Cluster.h.

◆ SetClusterArn() [3/3]

void Aws::ECS::Model::Cluster::SetClusterArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

Definition at line 93 of file Cluster.h.

◆ SetClusterName() [1/3]

void Aws::ECS::Model::Cluster::SetClusterName ( Aws::String &&  value)
inline

A user-generated string that you use to identify your cluster.

Definition at line 141 of file Cluster.h.

◆ SetClusterName() [2/3]

void Aws::ECS::Model::Cluster::SetClusterName ( const Aws::String value)
inline

A user-generated string that you use to identify your cluster.

Definition at line 136 of file Cluster.h.

◆ SetClusterName() [3/3]

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

A user-generated string that you use to identify your cluster.

Definition at line 146 of file Cluster.h.

◆ SetConfiguration() [1/2]

void Aws::ECS::Model::Cluster::SetConfiguration ( ClusterConfiguration &&  value)
inline

The execute command configuration for the cluster.

Definition at line 182 of file Cluster.h.

◆ SetConfiguration() [2/2]

void Aws::ECS::Model::Cluster::SetConfiguration ( const ClusterConfiguration value)
inline

The execute command configuration for the cluster.

Definition at line 177 of file Cluster.h.

◆ SetDefaultCapacityProviderStrategy() [1/2]

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

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

Definition at line 819 of file Cluster.h.

◆ SetDefaultCapacityProviderStrategy() [2/2]

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

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

Definition at line 812 of file Cluster.h.

◆ SetPendingTasksCount()

void Aws::ECS::Model::Cluster::SetPendingTasksCount ( int  value)
inline

The number of tasks in the cluster that are in the PENDING state.

Definition at line 410 of file Cluster.h.

◆ SetRegisteredContainerInstancesCount()

void Aws::ECS::Model::Cluster::SetRegisteredContainerInstancesCount ( int  value)
inline

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

Definition at line 359 of file Cluster.h.

◆ SetRunningTasksCount()

void Aws::ECS::Model::Cluster::SetRunningTasksCount ( int  value)
inline

The number of tasks in the cluster that are in the RUNNING state.

Definition at line 385 of file Cluster.h.

◆ SetSettings() [1/2]

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

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

Definition at line 720 of file Cluster.h.

◆ SetSettings() [2/2]

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

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

Definition at line 714 of file Cluster.h.

◆ SetStatistics() [1/2]

void Aws::ECS::Model::Cluster::SetStatistics ( Aws::Vector< KeyValuePair > &&  value)
inline

Additional information about your clusters that are separated by launch type, including:

  • runningEC2TasksCount

  • RunningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

Definition at line 490 of file Cluster.h.

◆ SetStatistics() [2/2]

void Aws::ECS::Model::Cluster::SetStatistics ( const Aws::Vector< KeyValuePair > &  value)
inline

Additional information about your clusters that are separated by launch type, including:

  • runningEC2TasksCount

  • RunningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

Definition at line 479 of file Cluster.h.

◆ SetStatus() [1/3]

void Aws::ECS::Model::Cluster::SetStatus ( Aws::String &&  value)
inline

The status of the cluster. The following are the possible states that will be returned.

ACTIVE

The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

PROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.

DEPROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.

FAILED

The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.

INACTIVE

The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE clusters persisting.

Definition at line 265 of file Cluster.h.

◆ SetStatus() [2/3]

void Aws::ECS::Model::Cluster::SetStatus ( const Aws::String value)
inline

The status of the cluster. The following are the possible states that will be returned.

ACTIVE

The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

PROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.

DEPROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.

FAILED

The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.

INACTIVE

The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE clusters persisting.

Definition at line 247 of file Cluster.h.

◆ SetStatus() [3/3]

void Aws::ECS::Model::Cluster::SetStatus ( const char *  value)
inline

The status of the cluster. The following are the possible states that will be returned.

ACTIVE

The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

PROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.

DEPROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.

FAILED

The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.

INACTIVE

The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE clusters persisting.

Definition at line 283 of file Cluster.h.

◆ SetTags() [1/2]

void Aws::ECS::Model::Cluster::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 615 of file Cluster.h.

◆ SetTags() [2/2]

void Aws::ECS::Model::Cluster::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 595 of file Cluster.h.

◆ SettingsHasBeenSet()

bool Aws::ECS::Model::Cluster::SettingsHasBeenSet ( ) const
inline

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

Definition at line 708 of file Cluster.h.

◆ StatisticsHasBeenSet()

bool Aws::ECS::Model::Cluster::StatisticsHasBeenSet ( ) const
inline

Additional information about your clusters that are separated by launch type, including:

  • runningEC2TasksCount

  • RunningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

Definition at line 468 of file Cluster.h.

◆ StatusHasBeenSet()

bool Aws::ECS::Model::Cluster::StatusHasBeenSet ( ) const
inline

The status of the cluster. The following are the possible states that will be returned.

ACTIVE

The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

PROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.

DEPROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.

FAILED

The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.

INACTIVE

The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE clusters persisting.

Definition at line 229 of file Cluster.h.

◆ TagsHasBeenSet()

bool Aws::ECS::Model::Cluster::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 575 of file Cluster.h.

◆ WithActiveServicesCount()

Cluster& Aws::ECS::Model::Cluster::WithActiveServicesCount ( int  value)
inline

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

Definition at line 445 of file Cluster.h.

◆ WithAttachments() [1/2]

Cluster& Aws::ECS::Model::Cluster::WithAttachments ( Aws::Vector< Attachment > &&  value)
inline

The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.

Definition at line 890 of file Cluster.h.

◆ WithAttachments() [2/2]

Cluster& Aws::ECS::Model::Cluster::WithAttachments ( const Aws::Vector< Attachment > &  value)
inline

The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.

Definition at line 883 of file Cluster.h.

◆ WithAttachmentsStatus() [1/3]

Cluster& Aws::ECS::Model::Cluster::WithAttachmentsStatus ( Aws::String &&  value)
inline

The status of the capacity providers associated with the cluster. The following are the states that will be returned:

UPDATE_IN_PROGRESS

The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.

UPDATE_COMPLETE

The capacity providers have successfully updated.

UPDATE_FAILED

The capacity provider updates failed.

Definition at line 982 of file Cluster.h.

◆ WithAttachmentsStatus() [2/3]

Cluster& Aws::ECS::Model::Cluster::WithAttachmentsStatus ( const Aws::String value)
inline

The status of the capacity providers associated with the cluster. The following are the states that will be returned:

UPDATE_IN_PROGRESS

The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.

UPDATE_COMPLETE

The capacity providers have successfully updated.

UPDATE_FAILED

The capacity provider updates failed.

Definition at line 971 of file Cluster.h.

◆ WithAttachmentsStatus() [3/3]

Cluster& Aws::ECS::Model::Cluster::WithAttachmentsStatus ( const char *  value)
inline

The status of the capacity providers associated with the cluster. The following are the states that will be returned:

UPDATE_IN_PROGRESS

The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.

UPDATE_COMPLETE

The capacity providers have successfully updated.

UPDATE_FAILED

The capacity provider updates failed.

Definition at line 993 of file Cluster.h.

◆ WithCapacityProviders() [1/2]

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

The capacity providers associated with the cluster.

Definition at line 775 of file Cluster.h.

◆ WithCapacityProviders() [2/2]

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

The capacity providers associated with the cluster.

Definition at line 770 of file Cluster.h.

◆ WithClusterArn() [1/3]

Cluster& Aws::ECS::Model::Cluster::WithClusterArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

Definition at line 111 of file Cluster.h.

◆ WithClusterArn() [2/3]

Cluster& Aws::ECS::Model::Cluster::WithClusterArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

Definition at line 102 of file Cluster.h.

◆ WithClusterArn() [3/3]

Cluster& Aws::ECS::Model::Cluster::WithClusterArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

Definition at line 120 of file Cluster.h.

◆ WithClusterName() [1/3]

Cluster& Aws::ECS::Model::Cluster::WithClusterName ( Aws::String &&  value)
inline

A user-generated string that you use to identify your cluster.

Definition at line 156 of file Cluster.h.

◆ WithClusterName() [2/3]

Cluster& Aws::ECS::Model::Cluster::WithClusterName ( const Aws::String value)
inline

A user-generated string that you use to identify your cluster.

Definition at line 151 of file Cluster.h.

◆ WithClusterName() [3/3]

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

A user-generated string that you use to identify your cluster.

Definition at line 161 of file Cluster.h.

◆ WithConfiguration() [1/2]

Cluster& Aws::ECS::Model::Cluster::WithConfiguration ( ClusterConfiguration &&  value)
inline

The execute command configuration for the cluster.

Definition at line 192 of file Cluster.h.

◆ WithConfiguration() [2/2]

Cluster& Aws::ECS::Model::Cluster::WithConfiguration ( const ClusterConfiguration value)
inline

The execute command configuration for the cluster.

Definition at line 187 of file Cluster.h.

◆ WithDefaultCapacityProviderStrategy() [1/2]

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

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

Definition at line 833 of file Cluster.h.

◆ WithDefaultCapacityProviderStrategy() [2/2]

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

The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

Definition at line 826 of file Cluster.h.

◆ WithPendingTasksCount()

Cluster& Aws::ECS::Model::Cluster::WithPendingTasksCount ( int  value)
inline

The number of tasks in the cluster that are in the PENDING state.

Definition at line 416 of file Cluster.h.

◆ WithRegisteredContainerInstancesCount()

Cluster& Aws::ECS::Model::Cluster::WithRegisteredContainerInstancesCount ( int  value)
inline

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

Definition at line 366 of file Cluster.h.

◆ WithRunningTasksCount()

Cluster& Aws::ECS::Model::Cluster::WithRunningTasksCount ( int  value)
inline

The number of tasks in the cluster that are in the RUNNING state.

Definition at line 391 of file Cluster.h.

◆ WithSettings() [1/2]

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

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

Definition at line 732 of file Cluster.h.

◆ WithSettings() [2/2]

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

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

Definition at line 726 of file Cluster.h.

◆ WithStatistics() [1/2]

Cluster& Aws::ECS::Model::Cluster::WithStatistics ( Aws::Vector< KeyValuePair > &&  value)
inline

Additional information about your clusters that are separated by launch type, including:

  • runningEC2TasksCount

  • RunningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

Definition at line 512 of file Cluster.h.

◆ WithStatistics() [2/2]

Cluster& Aws::ECS::Model::Cluster::WithStatistics ( const Aws::Vector< KeyValuePair > &  value)
inline

Additional information about your clusters that are separated by launch type, including:

  • runningEC2TasksCount

  • RunningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

Definition at line 501 of file Cluster.h.

◆ WithStatus() [1/3]

Cluster& Aws::ECS::Model::Cluster::WithStatus ( Aws::String &&  value)
inline

The status of the cluster. The following are the possible states that will be returned.

ACTIVE

The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

PROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.

DEPROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.

FAILED

The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.

INACTIVE

The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE clusters persisting.

Definition at line 319 of file Cluster.h.

◆ WithStatus() [2/3]

Cluster& Aws::ECS::Model::Cluster::WithStatus ( const Aws::String value)
inline

The status of the cluster. The following are the possible states that will be returned.

ACTIVE

The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

PROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.

DEPROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.

FAILED

The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.

INACTIVE

The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE clusters persisting.

Definition at line 301 of file Cluster.h.

◆ WithStatus() [3/3]

Cluster& Aws::ECS::Model::Cluster::WithStatus ( const char *  value)
inline

The status of the cluster. The following are the possible states that will be returned.

ACTIVE

The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.

PROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.

DEPROVISIONING

The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.

FAILED

The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.

INACTIVE

The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE clusters persisting.

Definition at line 337 of file Cluster.h.

◆ WithTags() [1/2]

Cluster& Aws::ECS::Model::Cluster::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 655 of file Cluster.h.

◆ WithTags() [2/2]

Cluster& Aws::ECS::Model::Cluster::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 635 of file Cluster.h.


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