Class: Aws::ECS::Types::Deployment
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::Deployment
- 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
-
#capacity_provider_strategy ⇒ Array<Types::CapacityProviderStrategyItem>
The capacity provider strategy that the deployment is using.
-
#created_at ⇒ Time
The Unix timestamp for the time when the service deployment was created.
-
#desired_count ⇒ Integer
The most recent desired count of tasks that was specified for the service to deploy or maintain.
-
#failed_tasks ⇒ Integer
The number of consecutively failed tasks in the deployment.
-
#fargate_ephemeral_storage ⇒ Types::DeploymentEphemeralStorage
The Fargate ephemeral storage settings for the deployment.
-
#id ⇒ String
The ID of the deployment.
-
#launch_type ⇒ String
The launch type the tasks in the service are using.
-
#network_configuration ⇒ Types::NetworkConfiguration
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the ‘awsvpc` networking mode.
-
#pending_count ⇒ Integer
The number of tasks in the deployment that are in the ‘PENDING` status.
-
#platform_family ⇒ String
The operating system that your tasks in the service, or tasks are running on.
-
#platform_version ⇒ String
The platform version that your tasks in the service run on.
-
#rollout_state ⇒ String
<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.
-
#rollout_state_reason ⇒ String
A description of the rollout state of a deployment.
-
#running_count ⇒ Integer
The number of tasks in the deployment that are in the ‘RUNNING` status.
-
#service_connect_configuration ⇒ Types::ServiceConnectConfiguration
The details of the Service Connect configuration that’s used by this deployment.
-
#service_connect_resources ⇒ Array<Types::ServiceConnectServiceResource>
The list of Service Connect resources that are associated with this deployment.
-
#status ⇒ String
The status of the deployment.
-
#task_definition ⇒ String
The most recent task definition that was specified for the tasks in the service to use.
-
#updated_at ⇒ Time
The Unix timestamp for the time when the service deployment was last updated.
-
#volume_configurations ⇒ Array<Types::ServiceVolumeConfiguration>
The details of the volume that was ‘configuredAtLaunch`.
-
#vpc_lattice_configurations ⇒ Array<Types::VpcLatticeConfiguration>
The VPC Lattice configuration for the service deployment.
Instance Attribute Details
#capacity_provider_strategy ⇒ Array<Types::CapacityProviderStrategyItem>
The capacity provider strategy that the deployment is using.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#created_at ⇒ Time
The Unix timestamp for the time when the service deployment was created.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#desired_count ⇒ Integer
The most recent desired count of tasks that was specified for the service to deploy or maintain.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#failed_tasks ⇒ Integer
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>
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#fargate_ephemeral_storage ⇒ Types::DeploymentEphemeralStorage
The Fargate ephemeral storage settings for the deployment.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
The ID of the deployment.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#launch_type ⇒ String
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
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#network_configuration ⇒ Types::NetworkConfiguration
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the ‘awsvpc` networking mode.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#pending_count ⇒ Integer
The number of tasks in the deployment that are in the ‘PENDING` status.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#platform_family ⇒ String
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.`.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#platform_version ⇒ String
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
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#rollout_state ⇒ String
<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 turned on, the deployment transitions to a `FAILED` state. A deployment in `FAILED` state doesn’t launch any new tasks. For more information, see [DeploymentCircuitBreaker].
[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeploymentCircuitBreaker.html
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#rollout_state_reason ⇒ String
A description of the rollout state of a deployment.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#running_count ⇒ Integer
The number of tasks in the deployment that are in the ‘RUNNING` status.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#service_connect_configuration ⇒ Types::ServiceConnectConfiguration
The details of the Service Connect configuration that’s used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.
The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect] in the *Amazon Elastic Container Service Developer Guide*.
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#service_connect_resources ⇒ Array<Types::ServiceConnectServiceResource>
The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
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.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#task_definition ⇒ String
The most recent task definition that was specified for the tasks in the service to use.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#updated_at ⇒ Time
The Unix timestamp for the time when the service deployment was last updated.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#volume_configurations ⇒ Array<Types::ServiceVolumeConfiguration>
The details of the volume that was ‘configuredAtLaunch`. You can configure different settings like the size, throughput, volumeType, and ecryption in [ServiceManagedEBSVolumeConfiguration]. The `name` of the volume must match the `name` from the task definition.
[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |
#vpc_lattice_configurations ⇒ Array<Types::VpcLatticeConfiguration>
The VPC Lattice configuration for the service deployment.
3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 |
# File 'lib/aws-sdk-ecs/types.rb', line 3702 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, :service_connect_configuration, :service_connect_resources, :volume_configurations, :fargate_ephemeral_storage, :vpc_lattice_configurations) SENSITIVE = [] include Aws::Structure end |