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

#include <TaskSet.h>

Public Member Functions

 TaskSet ()
 
 TaskSet (Aws::Utils::Json::JsonView jsonValue)
 
TaskSetoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
TaskSetWithId (const Aws::String &value)
 
TaskSetWithId (Aws::String &&value)
 
TaskSetWithId (const char *value)
 
const Aws::StringGetTaskSetArn () const
 
bool TaskSetArnHasBeenSet () const
 
void SetTaskSetArn (const Aws::String &value)
 
void SetTaskSetArn (Aws::String &&value)
 
void SetTaskSetArn (const char *value)
 
TaskSetWithTaskSetArn (const Aws::String &value)
 
TaskSetWithTaskSetArn (Aws::String &&value)
 
TaskSetWithTaskSetArn (const char *value)
 
const Aws::StringGetServiceArn () const
 
bool ServiceArnHasBeenSet () const
 
void SetServiceArn (const Aws::String &value)
 
void SetServiceArn (Aws::String &&value)
 
void SetServiceArn (const char *value)
 
TaskSetWithServiceArn (const Aws::String &value)
 
TaskSetWithServiceArn (Aws::String &&value)
 
TaskSetWithServiceArn (const char *value)
 
const Aws::StringGetClusterArn () const
 
bool ClusterArnHasBeenSet () const
 
void SetClusterArn (const Aws::String &value)
 
void SetClusterArn (Aws::String &&value)
 
void SetClusterArn (const char *value)
 
TaskSetWithClusterArn (const Aws::String &value)
 
TaskSetWithClusterArn (Aws::String &&value)
 
TaskSetWithClusterArn (const char *value)
 
const Aws::StringGetStartedBy () const
 
bool StartedByHasBeenSet () const
 
void SetStartedBy (const Aws::String &value)
 
void SetStartedBy (Aws::String &&value)
 
void SetStartedBy (const char *value)
 
TaskSetWithStartedBy (const Aws::String &value)
 
TaskSetWithStartedBy (Aws::String &&value)
 
TaskSetWithStartedBy (const char *value)
 
const Aws::StringGetExternalId () const
 
bool ExternalIdHasBeenSet () const
 
void SetExternalId (const Aws::String &value)
 
void SetExternalId (Aws::String &&value)
 
void SetExternalId (const char *value)
 
TaskSetWithExternalId (const Aws::String &value)
 
TaskSetWithExternalId (Aws::String &&value)
 
TaskSetWithExternalId (const char *value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
TaskSetWithStatus (const Aws::String &value)
 
TaskSetWithStatus (Aws::String &&value)
 
TaskSetWithStatus (const char *value)
 
const Aws::StringGetTaskDefinition () const
 
bool TaskDefinitionHasBeenSet () const
 
void SetTaskDefinition (const Aws::String &value)
 
void SetTaskDefinition (Aws::String &&value)
 
void SetTaskDefinition (const char *value)
 
TaskSetWithTaskDefinition (const Aws::String &value)
 
TaskSetWithTaskDefinition (Aws::String &&value)
 
TaskSetWithTaskDefinition (const char *value)
 
int GetComputedDesiredCount () const
 
bool ComputedDesiredCountHasBeenSet () const
 
void SetComputedDesiredCount (int value)
 
TaskSetWithComputedDesiredCount (int value)
 
int GetPendingCount () const
 
bool PendingCountHasBeenSet () const
 
void SetPendingCount (int value)
 
TaskSetWithPendingCount (int value)
 
int GetRunningCount () const
 
bool RunningCountHasBeenSet () const
 
void SetRunningCount (int value)
 
TaskSetWithRunningCount (int value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
TaskSetWithCreatedAt (const Aws::Utils::DateTime &value)
 
TaskSetWithCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetUpdatedAt () const
 
bool UpdatedAtHasBeenSet () const
 
void SetUpdatedAt (const Aws::Utils::DateTime &value)
 
void SetUpdatedAt (Aws::Utils::DateTime &&value)
 
TaskSetWithUpdatedAt (const Aws::Utils::DateTime &value)
 
TaskSetWithUpdatedAt (Aws::Utils::DateTime &&value)
 
const LaunchTypeGetLaunchType () const
 
bool LaunchTypeHasBeenSet () const
 
void SetLaunchType (const LaunchType &value)
 
void SetLaunchType (LaunchType &&value)
 
TaskSetWithLaunchType (const LaunchType &value)
 
TaskSetWithLaunchType (LaunchType &&value)
 
const Aws::Vector< CapacityProviderStrategyItem > & GetCapacityProviderStrategy () const
 
bool CapacityProviderStrategyHasBeenSet () const
 
void SetCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)
 
void SetCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)
 
TaskSetWithCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)
 
TaskSetWithCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)
 
TaskSetAddCapacityProviderStrategy (const CapacityProviderStrategyItem &value)
 
TaskSetAddCapacityProviderStrategy (CapacityProviderStrategyItem &&value)
 
const Aws::StringGetPlatformVersion () const
 
bool PlatformVersionHasBeenSet () const
 
void SetPlatformVersion (const Aws::String &value)
 
void SetPlatformVersion (Aws::String &&value)
 
void SetPlatformVersion (const char *value)
 
TaskSetWithPlatformVersion (const Aws::String &value)
 
TaskSetWithPlatformVersion (Aws::String &&value)
 
TaskSetWithPlatformVersion (const char *value)
 
const NetworkConfigurationGetNetworkConfiguration () const
 
bool NetworkConfigurationHasBeenSet () const
 
void SetNetworkConfiguration (const NetworkConfiguration &value)
 
void SetNetworkConfiguration (NetworkConfiguration &&value)
 
TaskSetWithNetworkConfiguration (const NetworkConfiguration &value)
 
TaskSetWithNetworkConfiguration (NetworkConfiguration &&value)
 
const Aws::Vector< LoadBalancer > & GetLoadBalancers () const
 
bool LoadBalancersHasBeenSet () const
 
void SetLoadBalancers (const Aws::Vector< LoadBalancer > &value)
 
void SetLoadBalancers (Aws::Vector< LoadBalancer > &&value)
 
TaskSetWithLoadBalancers (const Aws::Vector< LoadBalancer > &value)
 
TaskSetWithLoadBalancers (Aws::Vector< LoadBalancer > &&value)
 
TaskSetAddLoadBalancers (const LoadBalancer &value)
 
TaskSetAddLoadBalancers (LoadBalancer &&value)
 
const Aws::Vector< ServiceRegistry > & GetServiceRegistries () const
 
bool ServiceRegistriesHasBeenSet () const
 
void SetServiceRegistries (const Aws::Vector< ServiceRegistry > &value)
 
void SetServiceRegistries (Aws::Vector< ServiceRegistry > &&value)
 
TaskSetWithServiceRegistries (const Aws::Vector< ServiceRegistry > &value)
 
TaskSetWithServiceRegistries (Aws::Vector< ServiceRegistry > &&value)
 
TaskSetAddServiceRegistries (const ServiceRegistry &value)
 
TaskSetAddServiceRegistries (ServiceRegistry &&value)
 
const ScaleGetScale () const
 
bool ScaleHasBeenSet () const
 
void SetScale (const Scale &value)
 
void SetScale (Scale &&value)
 
TaskSetWithScale (const Scale &value)
 
TaskSetWithScale (Scale &&value)
 
const StabilityStatusGetStabilityStatus () const
 
bool StabilityStatusHasBeenSet () const
 
void SetStabilityStatus (const StabilityStatus &value)
 
void SetStabilityStatus (StabilityStatus &&value)
 
TaskSetWithStabilityStatus (const StabilityStatus &value)
 
TaskSetWithStabilityStatus (StabilityStatus &&value)
 
const Aws::Utils::DateTimeGetStabilityStatusAt () const
 
bool StabilityStatusAtHasBeenSet () const
 
void SetStabilityStatusAt (const Aws::Utils::DateTime &value)
 
void SetStabilityStatusAt (Aws::Utils::DateTime &&value)
 
TaskSetWithStabilityStatusAt (const Aws::Utils::DateTime &value)
 
TaskSetWithStabilityStatusAt (Aws::Utils::DateTime &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
TaskSetWithTags (const Aws::Vector< Tag > &value)
 
TaskSetWithTags (Aws::Vector< Tag > &&value)
 
TaskSetAddTags (const Tag &value)
 
TaskSetAddTags (Tag &&value)
 

Detailed Description

Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

See Also:

AWS API Reference

Definition at line 44 of file TaskSet.h.

Constructor & Destructor Documentation

◆ TaskSet() [1/2]

Aws::ECS::Model::TaskSet::TaskSet ( )

◆ TaskSet() [2/2]

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

Member Function Documentation

◆ AddCapacityProviderStrategy() [1/2]

TaskSet& Aws::ECS::Model::TaskSet::AddCapacityProviderStrategy ( const CapacityProviderStrategyItem value)
inline

The capacity provider strategy associated with the task set.

Definition at line 742 of file TaskSet.h.

◆ AddCapacityProviderStrategy() [2/2]

TaskSet& Aws::ECS::Model::TaskSet::AddCapacityProviderStrategy ( CapacityProviderStrategyItem &&  value)
inline

The capacity provider strategy associated with the task set.

Definition at line 747 of file TaskSet.h.

◆ AddLoadBalancers() [1/2]

TaskSet& Aws::ECS::Model::TaskSet::AddLoadBalancers ( const LoadBalancer value)
inline

Details on a load balancer that is used with a task set.

Definition at line 903 of file TaskSet.h.

◆ AddLoadBalancers() [2/2]

TaskSet& Aws::ECS::Model::TaskSet::AddLoadBalancers ( LoadBalancer &&  value)
inline

Details on a load balancer that is used with a task set.

Definition at line 908 of file TaskSet.h.

◆ AddServiceRegistries() [1/2]

TaskSet& Aws::ECS::Model::TaskSet::AddServiceRegistries ( const ServiceRegistry value)
inline

The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.

Definition at line 965 of file TaskSet.h.

◆ AddServiceRegistries() [2/2]

TaskSet& Aws::ECS::Model::TaskSet::AddServiceRegistries ( ServiceRegistry &&  value)
inline

The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.

Definition at line 973 of file TaskSet.h.

◆ AddTags() [1/2]

TaskSet& Aws::ECS::Model::TaskSet::AddTags ( const Tag value)
inline

The metadata that you apply to the task set 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 1267 of file TaskSet.h.

◆ AddTags() [2/2]

TaskSet& Aws::ECS::Model::TaskSet::AddTags ( Tag &&  value)
inline

The metadata that you apply to the task set 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 1287 of file TaskSet.h.

◆ CapacityProviderStrategyHasBeenSet()

bool Aws::ECS::Model::TaskSet::CapacityProviderStrategyHasBeenSet ( ) const
inline

The capacity provider strategy associated with the task set.

Definition at line 717 of file TaskSet.h.

◆ ClusterArnHasBeenSet()

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

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

Definition at line 186 of file TaskSet.h.

◆ ComputedDesiredCountHasBeenSet()

bool Aws::ECS::Model::TaskSet::ComputedDesiredCountHasBeenSet ( ) const
inline

The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

Definition at line 507 of file TaskSet.h.

◆ CreatedAtHasBeenSet()

bool Aws::ECS::Model::TaskSet::CreatedAtHasBeenSet ( ) const
inline

The Unix timestamp for when the task set was created.

Definition at line 600 of file TaskSet.h.

◆ ExternalIdHasBeenSet()

bool Aws::ECS::Model::TaskSet::ExternalIdHasBeenSet ( ) const
inline

The external ID associated with the task set.

If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.

Definition at line 308 of file TaskSet.h.

◆ GetCapacityProviderStrategy()

const Aws::Vector<CapacityProviderStrategyItem>& Aws::ECS::Model::TaskSet::GetCapacityProviderStrategy ( ) const
inline

The capacity provider strategy associated with the task set.

Definition at line 712 of file TaskSet.h.

◆ GetClusterArn()

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

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

Definition at line 180 of file TaskSet.h.

◆ GetComputedDesiredCount()

int Aws::ECS::Model::TaskSet::GetComputedDesiredCount ( ) const
inline

The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

Definition at line 499 of file TaskSet.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::ECS::Model::TaskSet::GetCreatedAt ( ) const
inline

The Unix timestamp for when the task set was created.

Definition at line 595 of file TaskSet.h.

◆ GetExternalId()

const Aws::String& Aws::ECS::Model::TaskSet::GetExternalId ( ) const
inline

The external ID associated with the task set.

If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.

Definition at line 298 of file TaskSet.h.

◆ GetId()

const Aws::String& Aws::ECS::Model::TaskSet::GetId ( ) const
inline

The ID of the task set.

Definition at line 56 of file TaskSet.h.

◆ GetLaunchType()

const LaunchType& Aws::ECS::Model::TaskSet::GetLaunchType ( ) const
inline

The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Definition at line 661 of file TaskSet.h.

◆ GetLoadBalancers()

const Aws::Vector<LoadBalancer>& Aws::ECS::Model::TaskSet::GetLoadBalancers ( ) const
inline

Details on a load balancer that is used with a task set.

Definition at line 873 of file TaskSet.h.

◆ GetNetworkConfiguration()

const NetworkConfiguration& Aws::ECS::Model::TaskSet::GetNetworkConfiguration ( ) const
inline

The network configuration for the task set.

Definition at line 842 of file TaskSet.h.

◆ GetPendingCount()

int Aws::ECS::Model::TaskSet::GetPendingCount ( ) const
inline

The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it is restarted after being in the STOPPED state.

Definition at line 533 of file TaskSet.h.

◆ GetPlatformVersion()

const Aws::String& Aws::ECS::Model::TaskSet::GetPlatformVersion ( ) const
inline

The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 759 of file TaskSet.h.

◆ GetRunningCount()

int Aws::ECS::Model::TaskSet::GetRunningCount ( ) const
inline

The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

Definition at line 568 of file TaskSet.h.

◆ GetScale()

const Scale& Aws::ECS::Model::TaskSet::GetScale ( ) const
inline

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

Definition at line 980 of file TaskSet.h.

◆ GetServiceArn()

const Aws::String& Aws::ECS::Model::TaskSet::GetServiceArn ( ) const
inline

The Amazon Resource Name (ARN) of the service the task set exists in.

Definition at line 138 of file TaskSet.h.

◆ GetServiceRegistries()

const Aws::Vector<ServiceRegistry>& Aws::ECS::Model::TaskSet::GetServiceRegistries ( ) const
inline

The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.

Definition at line 917 of file TaskSet.h.

◆ GetStabilityStatus()

const StabilityStatus& Aws::ECS::Model::TaskSet::GetStabilityStatus ( ) const
inline

The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:

  • The task runningCount is equal to the computedDesiredCount.

  • The pendingCount is 0.

  • There are no tasks running on container instances in the DRAINING status.

  • All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

If any of those conditions are not met, the stability status returns STABILIZING.

Definition at line 1025 of file TaskSet.h.

◆ GetStabilityStatusAt()

const Aws::Utils::DateTime& Aws::ECS::Model::TaskSet::GetStabilityStatusAt ( ) const
inline

The Unix timestamp for when the task set stability status was retrieved.

Definition at line 1101 of file TaskSet.h.

◆ GetStartedBy()

const Aws::String& Aws::ECS::Model::TaskSet::GetStartedBy ( ) const
inline

The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY. For a task set created for an external deployment, the startedBy field isn't used.

Definition at line 231 of file TaskSet.h.

◆ GetStatus()

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

The status of the task set. The following describes each state:

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set is not serving production traffic.

DRAINING

The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

Definition at line 379 of file TaskSet.h.

◆ GetTags()

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

The metadata that you apply to the task set 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 1147 of file TaskSet.h.

◆ GetTaskDefinition()

const Aws::String& Aws::ECS::Model::TaskSet::GetTaskDefinition ( ) const
inline

The task definition the task set is using.

Definition at line 455 of file TaskSet.h.

◆ GetTaskSetArn()

const Aws::String& Aws::ECS::Model::TaskSet::GetTaskSetArn ( ) const
inline

The Amazon Resource Name (ARN) of the task set.

Definition at line 97 of file TaskSet.h.

◆ GetUpdatedAt()

const Aws::Utils::DateTime& Aws::ECS::Model::TaskSet::GetUpdatedAt ( ) const
inline

The Unix timestamp for when the task set was last updated.

Definition at line 626 of file TaskSet.h.

◆ IdHasBeenSet()

bool Aws::ECS::Model::TaskSet::IdHasBeenSet ( ) const
inline

The ID of the task set.

Definition at line 61 of file TaskSet.h.

◆ Jsonize()

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

◆ LaunchTypeHasBeenSet()

bool Aws::ECS::Model::TaskSet::LaunchTypeHasBeenSet ( ) const
inline

The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Definition at line 670 of file TaskSet.h.

◆ LoadBalancersHasBeenSet()

bool Aws::ECS::Model::TaskSet::LoadBalancersHasBeenSet ( ) const
inline

Details on a load balancer that is used with a task set.

Definition at line 878 of file TaskSet.h.

◆ NetworkConfigurationHasBeenSet()

bool Aws::ECS::Model::TaskSet::NetworkConfigurationHasBeenSet ( ) const
inline

The network configuration for the task set.

Definition at line 847 of file TaskSet.h.

◆ operator=()

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

◆ PendingCountHasBeenSet()

bool Aws::ECS::Model::TaskSet::PendingCountHasBeenSet ( ) const
inline

The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it is restarted after being in the STOPPED state.

Definition at line 542 of file TaskSet.h.

◆ PlatformVersionHasBeenSet()

bool Aws::ECS::Model::TaskSet::PlatformVersionHasBeenSet ( ) const
inline

The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 770 of file TaskSet.h.

◆ RunningCountHasBeenSet()

bool Aws::ECS::Model::TaskSet::RunningCountHasBeenSet ( ) const
inline

The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

Definition at line 575 of file TaskSet.h.

◆ ScaleHasBeenSet()

bool Aws::ECS::Model::TaskSet::ScaleHasBeenSet ( ) const
inline

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

Definition at line 986 of file TaskSet.h.

◆ ServiceArnHasBeenSet()

bool Aws::ECS::Model::TaskSet::ServiceArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the service the task set exists in.

Definition at line 143 of file TaskSet.h.

◆ ServiceRegistriesHasBeenSet()

bool Aws::ECS::Model::TaskSet::ServiceRegistriesHasBeenSet ( ) const
inline

The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.

Definition at line 925 of file TaskSet.h.

◆ SetCapacityProviderStrategy() [1/2]

void Aws::ECS::Model::TaskSet::SetCapacityProviderStrategy ( const Aws::Vector< CapacityProviderStrategyItem > &  value)
inline

The capacity provider strategy associated with the task set.

Definition at line 722 of file TaskSet.h.

◆ SetCapacityProviderStrategy() [2/2]

void Aws::ECS::Model::TaskSet::SetCapacityProviderStrategy ( Aws::Vector< CapacityProviderStrategyItem > &&  value)
inline

The capacity provider strategy associated with the task set.

Definition at line 727 of file TaskSet.h.

◆ SetClusterArn() [1/3]

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

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

Definition at line 192 of file TaskSet.h.

◆ SetClusterArn() [2/3]

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

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

Definition at line 198 of file TaskSet.h.

◆ SetClusterArn() [3/3]

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

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

Definition at line 204 of file TaskSet.h.

◆ SetComputedDesiredCount()

void Aws::ECS::Model::TaskSet::SetComputedDesiredCount ( int  value)
inline

The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

Definition at line 515 of file TaskSet.h.

◆ SetCreatedAt() [1/2]

void Aws::ECS::Model::TaskSet::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

The Unix timestamp for when the task set was created.

Definition at line 605 of file TaskSet.h.

◆ SetCreatedAt() [2/2]

void Aws::ECS::Model::TaskSet::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The Unix timestamp for when the task set was created.

Definition at line 610 of file TaskSet.h.

◆ SetExternalId() [1/3]

void Aws::ECS::Model::TaskSet::SetExternalId ( const Aws::String value)
inline

The external ID associated with the task set.

If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.

Definition at line 318 of file TaskSet.h.

◆ SetExternalId() [2/3]

void Aws::ECS::Model::TaskSet::SetExternalId ( Aws::String &&  value)
inline

The external ID associated with the task set.

If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.

Definition at line 328 of file TaskSet.h.

◆ SetExternalId() [3/3]

void Aws::ECS::Model::TaskSet::SetExternalId ( const char *  value)
inline

The external ID associated with the task set.

If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.

Definition at line 338 of file TaskSet.h.

◆ SetId() [1/3]

void Aws::ECS::Model::TaskSet::SetId ( const Aws::String value)
inline

The ID of the task set.

Definition at line 66 of file TaskSet.h.

◆ SetId() [2/3]

void Aws::ECS::Model::TaskSet::SetId ( Aws::String &&  value)
inline

The ID of the task set.

Definition at line 71 of file TaskSet.h.

◆ SetId() [3/3]

void Aws::ECS::Model::TaskSet::SetId ( const char *  value)
inline

The ID of the task set.

Definition at line 76 of file TaskSet.h.

◆ SetLaunchType() [1/2]

void Aws::ECS::Model::TaskSet::SetLaunchType ( const LaunchType value)
inline

The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Definition at line 679 of file TaskSet.h.

◆ SetLaunchType() [2/2]

void Aws::ECS::Model::TaskSet::SetLaunchType ( LaunchType &&  value)
inline

The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Definition at line 688 of file TaskSet.h.

◆ SetLoadBalancers() [1/2]

void Aws::ECS::Model::TaskSet::SetLoadBalancers ( const Aws::Vector< LoadBalancer > &  value)
inline

Details on a load balancer that is used with a task set.

Definition at line 883 of file TaskSet.h.

◆ SetLoadBalancers() [2/2]

void Aws::ECS::Model::TaskSet::SetLoadBalancers ( Aws::Vector< LoadBalancer > &&  value)
inline

Details on a load balancer that is used with a task set.

Definition at line 888 of file TaskSet.h.

◆ SetNetworkConfiguration() [1/2]

void Aws::ECS::Model::TaskSet::SetNetworkConfiguration ( const NetworkConfiguration value)
inline

The network configuration for the task set.

Definition at line 852 of file TaskSet.h.

◆ SetNetworkConfiguration() [2/2]

void Aws::ECS::Model::TaskSet::SetNetworkConfiguration ( NetworkConfiguration &&  value)
inline

The network configuration for the task set.

Definition at line 857 of file TaskSet.h.

◆ SetPendingCount()

void Aws::ECS::Model::TaskSet::SetPendingCount ( int  value)
inline

The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it is restarted after being in the STOPPED state.

Definition at line 551 of file TaskSet.h.

◆ SetPlatformVersion() [1/3]

void Aws::ECS::Model::TaskSet::SetPlatformVersion ( const Aws::String value)
inline

The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 781 of file TaskSet.h.

◆ SetPlatformVersion() [2/3]

void Aws::ECS::Model::TaskSet::SetPlatformVersion ( Aws::String &&  value)
inline

The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 792 of file TaskSet.h.

◆ SetPlatformVersion() [3/3]

void Aws::ECS::Model::TaskSet::SetPlatformVersion ( const char *  value)
inline

The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 803 of file TaskSet.h.

◆ SetRunningCount()

void Aws::ECS::Model::TaskSet::SetRunningCount ( int  value)
inline

The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

Definition at line 582 of file TaskSet.h.

◆ SetScale() [1/2]

void Aws::ECS::Model::TaskSet::SetScale ( const Scale value)
inline

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

Definition at line 992 of file TaskSet.h.

◆ SetScale() [2/2]

void Aws::ECS::Model::TaskSet::SetScale ( Scale &&  value)
inline

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

Definition at line 998 of file TaskSet.h.

◆ SetServiceArn() [1/3]

void Aws::ECS::Model::TaskSet::SetServiceArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the service the task set exists in.

Definition at line 148 of file TaskSet.h.

◆ SetServiceArn() [2/3]

void Aws::ECS::Model::TaskSet::SetServiceArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the service the task set exists in.

Definition at line 153 of file TaskSet.h.

◆ SetServiceArn() [3/3]

void Aws::ECS::Model::TaskSet::SetServiceArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the service the task set exists in.

Definition at line 158 of file TaskSet.h.

◆ SetServiceRegistries() [1/2]

void Aws::ECS::Model::TaskSet::SetServiceRegistries ( const Aws::Vector< ServiceRegistry > &  value)
inline

The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.

Definition at line 933 of file TaskSet.h.

◆ SetServiceRegistries() [2/2]

void Aws::ECS::Model::TaskSet::SetServiceRegistries ( Aws::Vector< ServiceRegistry > &&  value)
inline

The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.

Definition at line 941 of file TaskSet.h.

◆ SetStabilityStatus() [1/2]

void Aws::ECS::Model::TaskSet::SetStabilityStatus ( const StabilityStatus value)
inline

The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:

  • The task runningCount is equal to the computedDesiredCount.

  • The pendingCount is 0.

  • There are no tasks running on container instances in the DRAINING status.

  • All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

If any of those conditions are not met, the stability status returns STABILIZING.

Definition at line 1053 of file TaskSet.h.

◆ SetStabilityStatus() [2/2]

void Aws::ECS::Model::TaskSet::SetStabilityStatus ( StabilityStatus &&  value)
inline

The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:

  • The task runningCount is equal to the computedDesiredCount.

  • The pendingCount is 0.

  • There are no tasks running on container instances in the DRAINING status.

  • All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

If any of those conditions are not met, the stability status returns STABILIZING.

Definition at line 1067 of file TaskSet.h.

◆ SetStabilityStatusAt() [1/2]

void Aws::ECS::Model::TaskSet::SetStabilityStatusAt ( const Aws::Utils::DateTime value)
inline

The Unix timestamp for when the task set stability status was retrieved.

Definition at line 1111 of file TaskSet.h.

◆ SetStabilityStatusAt() [2/2]

void Aws::ECS::Model::TaskSet::SetStabilityStatusAt ( Aws::Utils::DateTime &&  value)
inline

The Unix timestamp for when the task set stability status was retrieved.

Definition at line 1116 of file TaskSet.h.

◆ SetStartedBy() [1/3]

void Aws::ECS::Model::TaskSet::SetStartedBy ( const Aws::String value)
inline

The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY. For a task set created for an external deployment, the startedBy field isn't used.

Definition at line 247 of file TaskSet.h.

◆ SetStartedBy() [2/3]

void Aws::ECS::Model::TaskSet::SetStartedBy ( Aws::String &&  value)
inline

The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY. For a task set created for an external deployment, the startedBy field isn't used.

Definition at line 255 of file TaskSet.h.

◆ SetStartedBy() [3/3]

void Aws::ECS::Model::TaskSet::SetStartedBy ( const char *  value)
inline

The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY. For a task set created for an external deployment, the startedBy field isn't used.

Definition at line 263 of file TaskSet.h.

◆ SetStatus() [1/3]

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

The status of the task set. The following describes each state:

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set is not serving production traffic.

DRAINING

The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

Definition at line 399 of file TaskSet.h.

◆ SetStatus() [2/3]

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

The status of the task set. The following describes each state:

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set is not serving production traffic.

DRAINING

The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

Definition at line 409 of file TaskSet.h.

◆ SetStatus() [3/3]

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

The status of the task set. The following describes each state:

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set is not serving production traffic.

DRAINING

The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

Definition at line 419 of file TaskSet.h.

◆ SetTags() [1/2]

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

The metadata that you apply to the task set 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 1187 of file TaskSet.h.

◆ SetTags() [2/2]

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

The metadata that you apply to the task set 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 1207 of file TaskSet.h.

◆ SetTaskDefinition() [1/3]

void Aws::ECS::Model::TaskSet::SetTaskDefinition ( const Aws::String value)
inline

The task definition the task set is using.

Definition at line 465 of file TaskSet.h.

◆ SetTaskDefinition() [2/3]

void Aws::ECS::Model::TaskSet::SetTaskDefinition ( Aws::String &&  value)
inline

The task definition the task set is using.

Definition at line 470 of file TaskSet.h.

◆ SetTaskDefinition() [3/3]

void Aws::ECS::Model::TaskSet::SetTaskDefinition ( const char *  value)
inline

The task definition the task set is using.

Definition at line 475 of file TaskSet.h.

◆ SetTaskSetArn() [1/3]

void Aws::ECS::Model::TaskSet::SetTaskSetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the task set.

Definition at line 107 of file TaskSet.h.

◆ SetTaskSetArn() [2/3]

void Aws::ECS::Model::TaskSet::SetTaskSetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the task set.

Definition at line 112 of file TaskSet.h.

◆ SetTaskSetArn() [3/3]

void Aws::ECS::Model::TaskSet::SetTaskSetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the task set.

Definition at line 117 of file TaskSet.h.

◆ SetUpdatedAt() [1/2]

void Aws::ECS::Model::TaskSet::SetUpdatedAt ( const Aws::Utils::DateTime value)
inline

The Unix timestamp for when the task set was last updated.

Definition at line 636 of file TaskSet.h.

◆ SetUpdatedAt() [2/2]

void Aws::ECS::Model::TaskSet::SetUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The Unix timestamp for when the task set was last updated.

Definition at line 641 of file TaskSet.h.

◆ StabilityStatusAtHasBeenSet()

bool Aws::ECS::Model::TaskSet::StabilityStatusAtHasBeenSet ( ) const
inline

The Unix timestamp for when the task set stability status was retrieved.

Definition at line 1106 of file TaskSet.h.

◆ StabilityStatusHasBeenSet()

bool Aws::ECS::Model::TaskSet::StabilityStatusHasBeenSet ( ) const
inline

The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:

  • The task runningCount is equal to the computedDesiredCount.

  • The pendingCount is 0.

  • There are no tasks running on container instances in the DRAINING status.

  • All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

If any of those conditions are not met, the stability status returns STABILIZING.

Definition at line 1039 of file TaskSet.h.

◆ StartedByHasBeenSet()

bool Aws::ECS::Model::TaskSet::StartedByHasBeenSet ( ) const
inline

The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY. For a task set created for an external deployment, the startedBy field isn't used.

Definition at line 239 of file TaskSet.h.

◆ StatusHasBeenSet()

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

The status of the task set. The following describes each state:

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set is not serving production traffic.

DRAINING

The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

Definition at line 389 of file TaskSet.h.

◆ TagsHasBeenSet()

bool Aws::ECS::Model::TaskSet::TagsHasBeenSet ( ) const
inline

The metadata that you apply to the task set 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 1167 of file TaskSet.h.

◆ TaskDefinitionHasBeenSet()

bool Aws::ECS::Model::TaskSet::TaskDefinitionHasBeenSet ( ) const
inline

The task definition the task set is using.

Definition at line 460 of file TaskSet.h.

◆ TaskSetArnHasBeenSet()

bool Aws::ECS::Model::TaskSet::TaskSetArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the task set.

Definition at line 102 of file TaskSet.h.

◆ UpdatedAtHasBeenSet()

bool Aws::ECS::Model::TaskSet::UpdatedAtHasBeenSet ( ) const
inline

The Unix timestamp for when the task set was last updated.

Definition at line 631 of file TaskSet.h.

◆ WithCapacityProviderStrategy() [1/2]

TaskSet& Aws::ECS::Model::TaskSet::WithCapacityProviderStrategy ( const Aws::Vector< CapacityProviderStrategyItem > &  value)
inline

The capacity provider strategy associated with the task set.

Definition at line 732 of file TaskSet.h.

◆ WithCapacityProviderStrategy() [2/2]

TaskSet& Aws::ECS::Model::TaskSet::WithCapacityProviderStrategy ( Aws::Vector< CapacityProviderStrategyItem > &&  value)
inline

The capacity provider strategy associated with the task set.

Definition at line 737 of file TaskSet.h.

◆ WithClusterArn() [1/3]

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

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

Definition at line 210 of file TaskSet.h.

◆ WithClusterArn() [2/3]

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

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

Definition at line 216 of file TaskSet.h.

◆ WithClusterArn() [3/3]

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

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

Definition at line 222 of file TaskSet.h.

◆ WithComputedDesiredCount()

TaskSet& Aws::ECS::Model::TaskSet::WithComputedDesiredCount ( int  value)
inline

The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

Definition at line 523 of file TaskSet.h.

◆ WithCreatedAt() [1/2]

TaskSet& Aws::ECS::Model::TaskSet::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

The Unix timestamp for when the task set was created.

Definition at line 615 of file TaskSet.h.

◆ WithCreatedAt() [2/2]

TaskSet& Aws::ECS::Model::TaskSet::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The Unix timestamp for when the task set was created.

Definition at line 620 of file TaskSet.h.

◆ WithExternalId() [1/3]

TaskSet& Aws::ECS::Model::TaskSet::WithExternalId ( const Aws::String value)
inline

The external ID associated with the task set.

If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.

Definition at line 348 of file TaskSet.h.

◆ WithExternalId() [2/3]

TaskSet& Aws::ECS::Model::TaskSet::WithExternalId ( Aws::String &&  value)
inline

The external ID associated with the task set.

If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.

Definition at line 358 of file TaskSet.h.

◆ WithExternalId() [3/3]

TaskSet& Aws::ECS::Model::TaskSet::WithExternalId ( const char *  value)
inline

The external ID associated with the task set.

If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.

Definition at line 368 of file TaskSet.h.

◆ WithId() [1/3]

TaskSet& Aws::ECS::Model::TaskSet::WithId ( const Aws::String value)
inline

The ID of the task set.

Definition at line 81 of file TaskSet.h.

◆ WithId() [2/3]

TaskSet& Aws::ECS::Model::TaskSet::WithId ( Aws::String &&  value)
inline

The ID of the task set.

Definition at line 86 of file TaskSet.h.

◆ WithId() [3/3]

TaskSet& Aws::ECS::Model::TaskSet::WithId ( const char *  value)
inline

The ID of the task set.

Definition at line 91 of file TaskSet.h.

◆ WithLaunchType() [1/2]

TaskSet& Aws::ECS::Model::TaskSet::WithLaunchType ( const LaunchType value)
inline

The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Definition at line 697 of file TaskSet.h.

◆ WithLaunchType() [2/2]

TaskSet& Aws::ECS::Model::TaskSet::WithLaunchType ( LaunchType &&  value)
inline

The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Definition at line 706 of file TaskSet.h.

◆ WithLoadBalancers() [1/2]

TaskSet& Aws::ECS::Model::TaskSet::WithLoadBalancers ( const Aws::Vector< LoadBalancer > &  value)
inline

Details on a load balancer that is used with a task set.

Definition at line 893 of file TaskSet.h.

◆ WithLoadBalancers() [2/2]

TaskSet& Aws::ECS::Model::TaskSet::WithLoadBalancers ( Aws::Vector< LoadBalancer > &&  value)
inline

Details on a load balancer that is used with a task set.

Definition at line 898 of file TaskSet.h.

◆ WithNetworkConfiguration() [1/2]

TaskSet& Aws::ECS::Model::TaskSet::WithNetworkConfiguration ( const NetworkConfiguration value)
inline

The network configuration for the task set.

Definition at line 862 of file TaskSet.h.

◆ WithNetworkConfiguration() [2/2]

TaskSet& Aws::ECS::Model::TaskSet::WithNetworkConfiguration ( NetworkConfiguration &&  value)
inline

The network configuration for the task set.

Definition at line 867 of file TaskSet.h.

◆ WithPendingCount()

TaskSet& Aws::ECS::Model::TaskSet::WithPendingCount ( int  value)
inline

The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it is restarted after being in the STOPPED state.

Definition at line 560 of file TaskSet.h.

◆ WithPlatformVersion() [1/3]

TaskSet& Aws::ECS::Model::TaskSet::WithPlatformVersion ( const Aws::String value)
inline

The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 814 of file TaskSet.h.

◆ WithPlatformVersion() [2/3]

TaskSet& Aws::ECS::Model::TaskSet::WithPlatformVersion ( Aws::String &&  value)
inline

The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 825 of file TaskSet.h.

◆ WithPlatformVersion() [3/3]

TaskSet& Aws::ECS::Model::TaskSet::WithPlatformVersion ( const char *  value)
inline

The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Definition at line 836 of file TaskSet.h.

◆ WithRunningCount()

TaskSet& Aws::ECS::Model::TaskSet::WithRunningCount ( int  value)
inline

The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

Definition at line 589 of file TaskSet.h.

◆ WithScale() [1/2]

TaskSet& Aws::ECS::Model::TaskSet::WithScale ( const Scale value)
inline

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

Definition at line 1004 of file TaskSet.h.

◆ WithScale() [2/2]

TaskSet& Aws::ECS::Model::TaskSet::WithScale ( Scale &&  value)
inline

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

Definition at line 1010 of file TaskSet.h.

◆ WithServiceArn() [1/3]

TaskSet& Aws::ECS::Model::TaskSet::WithServiceArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the service the task set exists in.

Definition at line 163 of file TaskSet.h.

◆ WithServiceArn() [2/3]

TaskSet& Aws::ECS::Model::TaskSet::WithServiceArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the service the task set exists in.

Definition at line 168 of file TaskSet.h.

◆ WithServiceArn() [3/3]

TaskSet& Aws::ECS::Model::TaskSet::WithServiceArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the service the task set exists in.

Definition at line 173 of file TaskSet.h.

◆ WithServiceRegistries() [1/2]

TaskSet& Aws::ECS::Model::TaskSet::WithServiceRegistries ( const Aws::Vector< ServiceRegistry > &  value)
inline

The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.

Definition at line 949 of file TaskSet.h.

◆ WithServiceRegistries() [2/2]

TaskSet& Aws::ECS::Model::TaskSet::WithServiceRegistries ( Aws::Vector< ServiceRegistry > &&  value)
inline

The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.

Definition at line 957 of file TaskSet.h.

◆ WithStabilityStatus() [1/2]

TaskSet& Aws::ECS::Model::TaskSet::WithStabilityStatus ( const StabilityStatus value)
inline

The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:

  • The task runningCount is equal to the computedDesiredCount.

  • The pendingCount is 0.

  • There are no tasks running on container instances in the DRAINING status.

  • All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

If any of those conditions are not met, the stability status returns STABILIZING.

Definition at line 1081 of file TaskSet.h.

◆ WithStabilityStatus() [2/2]

TaskSet& Aws::ECS::Model::TaskSet::WithStabilityStatus ( StabilityStatus &&  value)
inline

The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:

  • The task runningCount is equal to the computedDesiredCount.

  • The pendingCount is 0.

  • There are no tasks running on container instances in the DRAINING status.

  • All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

If any of those conditions are not met, the stability status returns STABILIZING.

Definition at line 1095 of file TaskSet.h.

◆ WithStabilityStatusAt() [1/2]

TaskSet& Aws::ECS::Model::TaskSet::WithStabilityStatusAt ( const Aws::Utils::DateTime value)
inline

The Unix timestamp for when the task set stability status was retrieved.

Definition at line 1121 of file TaskSet.h.

◆ WithStabilityStatusAt() [2/2]

TaskSet& Aws::ECS::Model::TaskSet::WithStabilityStatusAt ( Aws::Utils::DateTime &&  value)
inline

The Unix timestamp for when the task set stability status was retrieved.

Definition at line 1126 of file TaskSet.h.

◆ WithStartedBy() [1/3]

TaskSet& Aws::ECS::Model::TaskSet::WithStartedBy ( const Aws::String value)
inline

The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY. For a task set created for an external deployment, the startedBy field isn't used.

Definition at line 271 of file TaskSet.h.

◆ WithStartedBy() [2/3]

TaskSet& Aws::ECS::Model::TaskSet::WithStartedBy ( Aws::String &&  value)
inline

The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY. For a task set created for an external deployment, the startedBy field isn't used.

Definition at line 279 of file TaskSet.h.

◆ WithStartedBy() [3/3]

TaskSet& Aws::ECS::Model::TaskSet::WithStartedBy ( const char *  value)
inline

The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY. For a task set created for an external deployment, the startedBy field isn't used.

Definition at line 287 of file TaskSet.h.

◆ WithStatus() [1/3]

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

The status of the task set. The following describes each state:

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set is not serving production traffic.

DRAINING

The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

Definition at line 429 of file TaskSet.h.

◆ WithStatus() [2/3]

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

The status of the task set. The following describes each state:

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set is not serving production traffic.

DRAINING

The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

Definition at line 439 of file TaskSet.h.

◆ WithStatus() [3/3]

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

The status of the task set. The following describes each state:

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set is not serving production traffic.

DRAINING

The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

Definition at line 449 of file TaskSet.h.

◆ WithTags() [1/2]

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

The metadata that you apply to the task set 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 1227 of file TaskSet.h.

◆ WithTags() [2/2]

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

The metadata that you apply to the task set 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 1247 of file TaskSet.h.

◆ WithTaskDefinition() [1/3]

TaskSet& Aws::ECS::Model::TaskSet::WithTaskDefinition ( const Aws::String value)
inline

The task definition the task set is using.

Definition at line 480 of file TaskSet.h.

◆ WithTaskDefinition() [2/3]

TaskSet& Aws::ECS::Model::TaskSet::WithTaskDefinition ( Aws::String &&  value)
inline

The task definition the task set is using.

Definition at line 485 of file TaskSet.h.

◆ WithTaskDefinition() [3/3]

TaskSet& Aws::ECS::Model::TaskSet::WithTaskDefinition ( const char *  value)
inline

The task definition the task set is using.

Definition at line 490 of file TaskSet.h.

◆ WithTaskSetArn() [1/3]

TaskSet& Aws::ECS::Model::TaskSet::WithTaskSetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the task set.

Definition at line 122 of file TaskSet.h.

◆ WithTaskSetArn() [2/3]

TaskSet& Aws::ECS::Model::TaskSet::WithTaskSetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the task set.

Definition at line 127 of file TaskSet.h.

◆ WithTaskSetArn() [3/3]

TaskSet& Aws::ECS::Model::TaskSet::WithTaskSetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the task set.

Definition at line 132 of file TaskSet.h.

◆ WithUpdatedAt() [1/2]

TaskSet& Aws::ECS::Model::TaskSet::WithUpdatedAt ( const Aws::Utils::DateTime value)
inline

The Unix timestamp for when the task set was last updated.

Definition at line 646 of file TaskSet.h.

◆ WithUpdatedAt() [2/2]

TaskSet& Aws::ECS::Model::TaskSet::WithUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The Unix timestamp for when the task set was last updated.

Definition at line 651 of file TaskSet.h.


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