AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecs/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.



3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

The Unix timestamp for when the service deployment was created.

Returns:

  • (Time)


3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :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)


3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :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.

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

Returns:

  • (Integer)


3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The ID of the deployment.

Returns:

  • (String)


3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :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.

Returns:

  • (String)


3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :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.



3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :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)


3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#platform_versionString

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.

Returns:

  • (String)


3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#rollout_stateString

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.

Returns:

  • (String)


3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :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)


3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :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)


3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :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)


3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :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)


3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end

#updated_atTime

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

Returns:

  • (Time)


3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3646

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,
  :network_configuration,
  :rollout_state,
  :rollout_state_reason)
  SENSITIVE = []
  include Aws::Structure
end