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

#include <Deployment.h>

Public Member Functions

 Deployment ()
 
 Deployment (Aws::Utils::Json::JsonView jsonValue)
 
Deploymentoperator= (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)
 
DeploymentWithId (const Aws::String &value)
 
DeploymentWithId (Aws::String &&value)
 
DeploymentWithId (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)
 
DeploymentWithStatus (const Aws::String &value)
 
DeploymentWithStatus (Aws::String &&value)
 
DeploymentWithStatus (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)
 
DeploymentWithTaskDefinition (const Aws::String &value)
 
DeploymentWithTaskDefinition (Aws::String &&value)
 
DeploymentWithTaskDefinition (const char *value)
 
int GetDesiredCount () const
 
bool DesiredCountHasBeenSet () const
 
void SetDesiredCount (int value)
 
DeploymentWithDesiredCount (int value)
 
int GetPendingCount () const
 
bool PendingCountHasBeenSet () const
 
void SetPendingCount (int value)
 
DeploymentWithPendingCount (int value)
 
int GetRunningCount () const
 
bool RunningCountHasBeenSet () const
 
void SetRunningCount (int value)
 
DeploymentWithRunningCount (int value)
 
int GetFailedTasks () const
 
bool FailedTasksHasBeenSet () const
 
void SetFailedTasks (int value)
 
DeploymentWithFailedTasks (int value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
DeploymentWithCreatedAt (const Aws::Utils::DateTime &value)
 
DeploymentWithCreatedAt (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)
 
DeploymentWithUpdatedAt (const Aws::Utils::DateTime &value)
 
DeploymentWithUpdatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Vector< CapacityProviderStrategyItem > & GetCapacityProviderStrategy () const
 
bool CapacityProviderStrategyHasBeenSet () const
 
void SetCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)
 
void SetCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)
 
DeploymentWithCapacityProviderStrategy (const Aws::Vector< CapacityProviderStrategyItem > &value)
 
DeploymentWithCapacityProviderStrategy (Aws::Vector< CapacityProviderStrategyItem > &&value)
 
DeploymentAddCapacityProviderStrategy (const CapacityProviderStrategyItem &value)
 
DeploymentAddCapacityProviderStrategy (CapacityProviderStrategyItem &&value)
 
const LaunchTypeGetLaunchType () const
 
bool LaunchTypeHasBeenSet () const
 
void SetLaunchType (const LaunchType &value)
 
void SetLaunchType (LaunchType &&value)
 
DeploymentWithLaunchType (const LaunchType &value)
 
DeploymentWithLaunchType (LaunchType &&value)
 
const Aws::StringGetPlatformVersion () const
 
bool PlatformVersionHasBeenSet () const
 
void SetPlatformVersion (const Aws::String &value)
 
void SetPlatformVersion (Aws::String &&value)
 
void SetPlatformVersion (const char *value)
 
DeploymentWithPlatformVersion (const Aws::String &value)
 
DeploymentWithPlatformVersion (Aws::String &&value)
 
DeploymentWithPlatformVersion (const char *value)
 
const NetworkConfigurationGetNetworkConfiguration () const
 
bool NetworkConfigurationHasBeenSet () const
 
void SetNetworkConfiguration (const NetworkConfiguration &value)
 
void SetNetworkConfiguration (NetworkConfiguration &&value)
 
DeploymentWithNetworkConfiguration (const NetworkConfiguration &value)
 
DeploymentWithNetworkConfiguration (NetworkConfiguration &&value)
 
const DeploymentRolloutStateGetRolloutState () const
 
bool RolloutStateHasBeenSet () const
 
void SetRolloutState (const DeploymentRolloutState &value)
 
void SetRolloutState (DeploymentRolloutState &&value)
 
DeploymentWithRolloutState (const DeploymentRolloutState &value)
 
DeploymentWithRolloutState (DeploymentRolloutState &&value)
 
const Aws::StringGetRolloutStateReason () const
 
bool RolloutStateReasonHasBeenSet () const
 
void SetRolloutStateReason (const Aws::String &value)
 
void SetRolloutStateReason (Aws::String &&value)
 
void SetRolloutStateReason (const char *value)
 
DeploymentWithRolloutStateReason (const Aws::String &value)
 
DeploymentWithRolloutStateReason (Aws::String &&value)
 
DeploymentWithRolloutStateReason (const char *value)
 

Detailed Description

The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.

See Also:

AWS API Reference

Definition at line 39 of file Deployment.h.

Constructor & Destructor Documentation

◆ Deployment() [1/2]

Aws::ECS::Model::Deployment::Deployment ( )

◆ Deployment() [2/2]

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

Member Function Documentation

◆ AddCapacityProviderStrategy() [1/2]

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

The capacity provider strategy that the deployment is using.

Definition at line 430 of file Deployment.h.

◆ AddCapacityProviderStrategy() [2/2]

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

The capacity provider strategy that the deployment is using.

Definition at line 435 of file Deployment.h.

◆ CapacityProviderStrategyHasBeenSet()

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

The capacity provider strategy that the deployment is using.

Definition at line 405 of file Deployment.h.

◆ CreatedAtHasBeenSet()

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

The Unix timestamp for when the service deployment was created.

Definition at line 343 of file Deployment.h.

◆ DesiredCountHasBeenSet()

bool Aws::ECS::Model::Deployment::DesiredCountHasBeenSet ( ) const
inline

The most recent desired count of tasks that was specified for the service to deploy or maintain.

Definition at line 229 of file Deployment.h.

◆ FailedTasksHasBeenSet()

bool Aws::ECS::Model::Deployment::FailedTasksHasBeenSet ( ) const
inline

The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

Definition at line 312 of file Deployment.h.

◆ GetCapacityProviderStrategy()

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

The capacity provider strategy that the deployment is using.

Definition at line 400 of file Deployment.h.

◆ GetCreatedAt()

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

The Unix timestamp for when the service deployment was created.

Definition at line 338 of file Deployment.h.

◆ GetDesiredCount()

int Aws::ECS::Model::Deployment::GetDesiredCount ( ) const
inline

The most recent desired count of tasks that was specified for the service to deploy or maintain.

Definition at line 223 of file Deployment.h.

◆ GetFailedTasks()

int Aws::ECS::Model::Deployment::GetFailedTasks ( ) const
inline

The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

Definition at line 302 of file Deployment.h.

◆ GetId()

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

The ID of the deployment.

Definition at line 51 of file Deployment.h.

◆ GetLaunchType()

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

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

Definition at line 445 of file Deployment.h.

◆ GetNetworkConfiguration()

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

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

Definition at line 587 of file Deployment.h.

◆ GetPendingCount()

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

The number of tasks in the deployment that are in the PENDING status.

Definition at line 248 of file Deployment.h.

◆ GetPlatformVersion()

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

The platform version on which your tasks in the service 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 502 of file Deployment.h.

◆ GetRolloutState()

const DeploymentRolloutState& Aws::ECS::Model::Deployment::GetRolloutState ( ) const
inline

The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that are not behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment will transition to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment will transition to a FAILED state. A deployment in FAILED state will launch no new tasks. For more information, see DeploymentCircuitBreaker.

Definition at line 637 of file Deployment.h.

◆ GetRolloutStateReason()

const Aws::String& Aws::ECS::Model::Deployment::GetRolloutStateReason ( ) const
inline

A description of the rollout state of a deployment.

Definition at line 713 of file Deployment.h.

◆ GetRunningCount()

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

The number of tasks in the deployment that are in the RUNNING status.

Definition at line 273 of file Deployment.h.

◆ GetStatus()

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

The status of the deployment. The following describes each state:

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

Definition at line 97 of file Deployment.h.

◆ GetTaskDefinition()

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

The most recent task definition that was specified for the tasks in the service to use.

Definition at line 174 of file Deployment.h.

◆ GetUpdatedAt()

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

The Unix timestamp for when the service deployment was last updated.

Definition at line 369 of file Deployment.h.

◆ IdHasBeenSet()

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

The ID of the deployment.

Definition at line 56 of file Deployment.h.

◆ Jsonize()

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

◆ LaunchTypeHasBeenSet()

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

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

Definition at line 454 of file Deployment.h.

◆ NetworkConfigurationHasBeenSet()

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

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

Definition at line 594 of file Deployment.h.

◆ operator=()

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

◆ PendingCountHasBeenSet()

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

The number of tasks in the deployment that are in the PENDING status.

Definition at line 254 of file Deployment.h.

◆ PlatformVersionHasBeenSet()

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

The platform version on which your tasks in the service 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 513 of file Deployment.h.

◆ RolloutStateHasBeenSet()

bool Aws::ECS::Model::Deployment::RolloutStateHasBeenSet ( ) const
inline

The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that are not behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment will transition to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment will transition to a FAILED state. A deployment in FAILED state will launch no new tasks. For more information, see DeploymentCircuitBreaker.

Definition at line 651 of file Deployment.h.

◆ RolloutStateReasonHasBeenSet()

bool Aws::ECS::Model::Deployment::RolloutStateReasonHasBeenSet ( ) const
inline

A description of the rollout state of a deployment.

Definition at line 718 of file Deployment.h.

◆ RunningCountHasBeenSet()

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

The number of tasks in the deployment that are in the RUNNING status.

Definition at line 279 of file Deployment.h.

◆ SetCapacityProviderStrategy() [1/2]

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

The capacity provider strategy that the deployment is using.

Definition at line 410 of file Deployment.h.

◆ SetCapacityProviderStrategy() [2/2]

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

The capacity provider strategy that the deployment is using.

Definition at line 415 of file Deployment.h.

◆ SetCreatedAt() [1/2]

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

The Unix timestamp for when the service deployment was created.

Definition at line 348 of file Deployment.h.

◆ SetCreatedAt() [2/2]

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

The Unix timestamp for when the service deployment was created.

Definition at line 353 of file Deployment.h.

◆ SetDesiredCount()

void Aws::ECS::Model::Deployment::SetDesiredCount ( int  value)
inline

The most recent desired count of tasks that was specified for the service to deploy or maintain.

Definition at line 235 of file Deployment.h.

◆ SetFailedTasks()

void Aws::ECS::Model::Deployment::SetFailedTasks ( int  value)
inline

The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

Definition at line 322 of file Deployment.h.

◆ SetId() [1/3]

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

The ID of the deployment.

Definition at line 61 of file Deployment.h.

◆ SetId() [2/3]

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

The ID of the deployment.

Definition at line 66 of file Deployment.h.

◆ SetId() [3/3]

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

The ID of the deployment.

Definition at line 71 of file Deployment.h.

◆ SetLaunchType() [1/2]

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

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

Definition at line 463 of file Deployment.h.

◆ SetLaunchType() [2/2]

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

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

Definition at line 472 of file Deployment.h.

◆ SetNetworkConfiguration() [1/2]

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

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

Definition at line 601 of file Deployment.h.

◆ SetNetworkConfiguration() [2/2]

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

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

Definition at line 608 of file Deployment.h.

◆ SetPendingCount()

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

The number of tasks in the deployment that are in the PENDING status.

Definition at line 260 of file Deployment.h.

◆ SetPlatformVersion() [1/3]

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

The platform version on which your tasks in the service 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 524 of file Deployment.h.

◆ SetPlatformVersion() [2/3]

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

The platform version on which your tasks in the service 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 535 of file Deployment.h.

◆ SetPlatformVersion() [3/3]

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

The platform version on which your tasks in the service 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 546 of file Deployment.h.

◆ SetRolloutState() [1/2]

void Aws::ECS::Model::Deployment::SetRolloutState ( const DeploymentRolloutState value)
inline

The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that are not behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment will transition to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment will transition to a FAILED state. A deployment in FAILED state will launch no new tasks. For more information, see DeploymentCircuitBreaker.

Definition at line 665 of file Deployment.h.

◆ SetRolloutState() [2/2]

void Aws::ECS::Model::Deployment::SetRolloutState ( DeploymentRolloutState &&  value)
inline

The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that are not behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment will transition to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment will transition to a FAILED state. A deployment in FAILED state will launch no new tasks. For more information, see DeploymentCircuitBreaker.

Definition at line 679 of file Deployment.h.

◆ SetRolloutStateReason() [1/3]

void Aws::ECS::Model::Deployment::SetRolloutStateReason ( const Aws::String value)
inline

A description of the rollout state of a deployment.

Definition at line 723 of file Deployment.h.

◆ SetRolloutStateReason() [2/3]

void Aws::ECS::Model::Deployment::SetRolloutStateReason ( Aws::String &&  value)
inline

A description of the rollout state of a deployment.

Definition at line 728 of file Deployment.h.

◆ SetRolloutStateReason() [3/3]

void Aws::ECS::Model::Deployment::SetRolloutStateReason ( const char *  value)
inline

A description of the rollout state of a deployment.

Definition at line 733 of file Deployment.h.

◆ SetRunningCount()

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

The number of tasks in the deployment that are in the RUNNING status.

Definition at line 285 of file Deployment.h.

◆ SetStatus() [1/3]

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

The status of the deployment. The following describes each state:

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

Definition at line 117 of file Deployment.h.

◆ SetStatus() [2/3]

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

The status of the deployment. The following describes each state:

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

Definition at line 127 of file Deployment.h.

◆ SetStatus() [3/3]

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

The status of the deployment. The following describes each state:

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

Definition at line 137 of file Deployment.h.

◆ SetTaskDefinition() [1/3]

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

The most recent task definition that was specified for the tasks in the service to use.

Definition at line 186 of file Deployment.h.

◆ SetTaskDefinition() [2/3]

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

The most recent task definition that was specified for the tasks in the service to use.

Definition at line 192 of file Deployment.h.

◆ SetTaskDefinition() [3/3]

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

The most recent task definition that was specified for the tasks in the service to use.

Definition at line 198 of file Deployment.h.

◆ SetUpdatedAt() [1/2]

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

The Unix timestamp for when the service deployment was last updated.

Definition at line 379 of file Deployment.h.

◆ SetUpdatedAt() [2/2]

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

The Unix timestamp for when the service deployment was last updated.

Definition at line 384 of file Deployment.h.

◆ StatusHasBeenSet()

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

The status of the deployment. The following describes each state:

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

Definition at line 107 of file Deployment.h.

◆ TaskDefinitionHasBeenSet()

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

The most recent task definition that was specified for the tasks in the service to use.

Definition at line 180 of file Deployment.h.

◆ UpdatedAtHasBeenSet()

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

The Unix timestamp for when the service deployment was last updated.

Definition at line 374 of file Deployment.h.

◆ WithCapacityProviderStrategy() [1/2]

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

The capacity provider strategy that the deployment is using.

Definition at line 420 of file Deployment.h.

◆ WithCapacityProviderStrategy() [2/2]

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

The capacity provider strategy that the deployment is using.

Definition at line 425 of file Deployment.h.

◆ WithCreatedAt() [1/2]

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

The Unix timestamp for when the service deployment was created.

Definition at line 358 of file Deployment.h.

◆ WithCreatedAt() [2/2]

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

The Unix timestamp for when the service deployment was created.

Definition at line 363 of file Deployment.h.

◆ WithDesiredCount()

Deployment& Aws::ECS::Model::Deployment::WithDesiredCount ( int  value)
inline

The most recent desired count of tasks that was specified for the service to deploy or maintain.

Definition at line 241 of file Deployment.h.

◆ WithFailedTasks()

Deployment& Aws::ECS::Model::Deployment::WithFailedTasks ( int  value)
inline

The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

Definition at line 332 of file Deployment.h.

◆ WithId() [1/3]

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

The ID of the deployment.

Definition at line 76 of file Deployment.h.

◆ WithId() [2/3]

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

The ID of the deployment.

Definition at line 81 of file Deployment.h.

◆ WithId() [3/3]

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

The ID of the deployment.

Definition at line 86 of file Deployment.h.

◆ WithLaunchType() [1/2]

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

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

Definition at line 481 of file Deployment.h.

◆ WithLaunchType() [2/2]

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

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

Definition at line 490 of file Deployment.h.

◆ WithNetworkConfiguration() [1/2]

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

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

Definition at line 615 of file Deployment.h.

◆ WithNetworkConfiguration() [2/2]

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

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

Definition at line 622 of file Deployment.h.

◆ WithPendingCount()

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

The number of tasks in the deployment that are in the PENDING status.

Definition at line 266 of file Deployment.h.

◆ WithPlatformVersion() [1/3]

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

The platform version on which your tasks in the service 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 557 of file Deployment.h.

◆ WithPlatformVersion() [2/3]

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

The platform version on which your tasks in the service 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 568 of file Deployment.h.

◆ WithPlatformVersion() [3/3]

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

The platform version on which your tasks in the service 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 579 of file Deployment.h.

◆ WithRolloutState() [1/2]

Deployment& Aws::ECS::Model::Deployment::WithRolloutState ( const DeploymentRolloutState value)
inline

The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that are not behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment will transition to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment will transition to a FAILED state. A deployment in FAILED state will launch no new tasks. For more information, see DeploymentCircuitBreaker.

Definition at line 693 of file Deployment.h.

◆ WithRolloutState() [2/2]

Deployment& Aws::ECS::Model::Deployment::WithRolloutState ( DeploymentRolloutState &&  value)
inline

The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that are not behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment will transition to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment will transition to a FAILED state. A deployment in FAILED state will launch no new tasks. For more information, see DeploymentCircuitBreaker.

Definition at line 707 of file Deployment.h.

◆ WithRolloutStateReason() [1/3]

Deployment& Aws::ECS::Model::Deployment::WithRolloutStateReason ( const Aws::String value)
inline

A description of the rollout state of a deployment.

Definition at line 738 of file Deployment.h.

◆ WithRolloutStateReason() [2/3]

Deployment& Aws::ECS::Model::Deployment::WithRolloutStateReason ( Aws::String &&  value)
inline

A description of the rollout state of a deployment.

Definition at line 743 of file Deployment.h.

◆ WithRolloutStateReason() [3/3]

Deployment& Aws::ECS::Model::Deployment::WithRolloutStateReason ( const char *  value)
inline

A description of the rollout state of a deployment.

Definition at line 748 of file Deployment.h.

◆ WithRunningCount()

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

The number of tasks in the deployment that are in the RUNNING status.

Definition at line 291 of file Deployment.h.

◆ WithStatus() [1/3]

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

The status of the deployment. The following describes each state:

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

Definition at line 147 of file Deployment.h.

◆ WithStatus() [2/3]

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

The status of the deployment. The following describes each state:

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

Definition at line 157 of file Deployment.h.

◆ WithStatus() [3/3]

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

The status of the deployment. The following describes each state:

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

Definition at line 167 of file Deployment.h.

◆ WithTaskDefinition() [1/3]

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

The most recent task definition that was specified for the tasks in the service to use.

Definition at line 204 of file Deployment.h.

◆ WithTaskDefinition() [2/3]

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

The most recent task definition that was specified for the tasks in the service to use.

Definition at line 210 of file Deployment.h.

◆ WithTaskDefinition() [3/3]

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

The most recent task definition that was specified for the tasks in the service to use.

Definition at line 216 of file Deployment.h.

◆ WithUpdatedAt() [1/2]

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

The Unix timestamp for when the service deployment was last updated.

Definition at line 389 of file Deployment.h.

◆ WithUpdatedAt() [2/2]

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

The Unix timestamp for when the service deployment was last updated.

Definition at line 394 of file Deployment.h.


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