Class: Aws::ECS::Types::Deployment

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_provider_strategyArray<Types::CapacityProviderStrategyItem>

The capacity provider strategy that the deployment is using.


3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

The Unix timestamp for the time when the service deployment was created.

Returns:

  • (Time)

3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#desired_countInteger

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

Returns:

  • (Integer)

3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#failed_tasksInteger

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.

<note markdown=“1”> Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

</note>

Returns:

  • (Integer)

3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The ID of the deployment.

Returns:

  • (String)

3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#launch_typeString

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

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html

Returns:

  • (String)

3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#network_configurationTypes::NetworkConfiguration

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


3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#pending_countInteger

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

Returns:

  • (Integer)

3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#platform_familyString

The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same `platformFamily` value as the service, for example, ` LINUX.`.

Returns:

  • (String)

3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#platform_versionString

The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the `LATEST` platform version is used. For more information, see [Fargate Platform Versions] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html

Returns:

  • (String)

3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#rollout_stateString

<note markdown=“1”> The `rolloutState` of a service is only returned for services that use the rolling update (`ECS`) deployment type that aren't behind a Classic Load Balancer.

</note>

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 transitions to a `COMPLETED` state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment transitions to a `FAILED` state. A deployment in `FAILED` state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

Returns:

  • (String)

3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#rollout_state_reasonString

A description of the rollout state of a deployment.

Returns:

  • (String)

3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#running_countInteger

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

Returns:

  • (Integer)

3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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.

Returns:

  • (String)

3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#task_definitionString

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

Returns:

  • (String)

3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#updated_atTime

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

Returns:

  • (Time)

3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
# File 'lib/aws-sdk-ecs/types.rb', line 3780

class Deployment < Struct.new(
  :id,
  :status,
  :task_definition,
  :desired_count,
  :pending_count,
  :running_count,
  :failed_tasks,
  :created_at,
  :updated_at,
  :capacity_provider_strategy,
  :launch_type,
  :platform_version,
  :platform_family,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end