Class: Aws::ECS::Types::Service
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::Service
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-ecs/types.rb
Overview
Details on a service within a cluster
Instance Attribute Summary collapse
-
#cluster_arn ⇒ String
The Amazon Resource Name (ARN) of the cluster that hosts the service.
-
#created_at ⇒ Time
The Unix time stamp for when the service was created.
-
#deployment_configuration ⇒ Types::DeploymentConfiguration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
-
#deployments ⇒ Array<Types::Deployment>
The current state of deployments for the service.
-
#desired_count ⇒ Integer
The desired number of instantiations of the task definition to keep running on the service.
-
#events ⇒ Array<Types::ServiceEvent>
The event stream for your service.
-
#health_check_grace_period_seconds ⇒ Integer
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
-
#launch_type ⇒ String
The launch type on which your service is running.
-
#load_balancers ⇒ Array<Types::LoadBalancer>
A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
-
#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 cluster that are in the ‘PENDING` state.
-
#placement_constraints ⇒ Array<Types::PlacementConstraint>
The placement constraints for the tasks in the service.
-
#placement_strategy ⇒ Array<Types::PlacementStrategy>
The placement strategy that determines how tasks for the service are placed.
-
#platform_version ⇒ String
The platform version on which your task is running.
-
#role_arn ⇒ String
The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
-
#running_count ⇒ Integer
The number of tasks in the cluster that are in the ‘RUNNING` state.
-
#scheduling_strategy ⇒ String
The scheduling strategy to use for the service.
-
#service_arn ⇒ String
The ARN that identifies the service.
-
#service_name ⇒ String
The name of your service.
- #service_registries ⇒ Array<Types::ServiceRegistry>
-
#status ⇒ String
The status of the service.
-
#task_definition ⇒ String
The task definition to use for tasks in the service.
Instance Attribute Details
#cluster_arn ⇒ String
The Amazon Resource Name (ARN) of the cluster that hosts the service.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#created_at ⇒ Time
The Unix time stamp for when the service was created.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#deployment_configuration ⇒ Types::DeploymentConfiguration
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#deployments ⇒ Array<Types::Deployment>
The current state of deployments for the service.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#desired_count ⇒ Integer
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#events ⇒ Array<Types::ServiceEvent>
The event stream for your service. A maximum of 100 of the latest events are displayed.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#health_check_grace_period_seconds ⇒ Integer
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#launch_type ⇒ String
The launch type on which your service is running.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#load_balancers ⇒ Array<Types::LoadBalancer>
A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
Services with tasks that use the ‘awsvpc` network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose `ip` as the target type, not `instance`, because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) 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.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#pending_count ⇒ Integer
The number of tasks in the cluster that are in the ‘PENDING` state.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#placement_constraints ⇒ Array<Types::PlacementConstraint>
The placement constraints for the tasks in the service.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#placement_strategy ⇒ Array<Types::PlacementStrategy>
The placement strategy that determines how tasks for the service are placed.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#platform_version ⇒ String
The platform version on which your task is running. For more information, see [AWS Fargate Platform Versions] in the *Amazon Elastic Container Service Developer Guide*.
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#role_arn ⇒ String
The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#running_count ⇒ Integer
The number of tasks in the cluster that are in the ‘RUNNING` state.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#scheduling_strategy ⇒ String
The scheduling strategy to use for the service. For more information, see [Services].
There are two service scheduler strategies available:
-
‘REPLICA`-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
-
‘DAEMON`-The daemon scheduling strategy deploys exactly one task on each container instance in your cluster. When using this strategy, do not specify a desired number of tasks or any task placement strategies.
<note markdown=“1”> Fargate tasks do not support the ‘DAEMON` scheduling strategy.
</note>
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguideecs_services.html
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#service_arn ⇒ String
The ARN that identifies the service. The ARN contains the ‘arn:aws:ecs` namespace, followed by the region of the service, the AWS account ID of the service owner, the `service` namespace, and then the service name. For example, `arn:aws:ecs:region:012345678910:service/my-service `.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#service_name ⇒ String
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#service_registries ⇒ Array<Types::ServiceRegistry>
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#status ⇒ String
The status of the service. The valid values are ‘ACTIVE`, `DRAINING`, or `INACTIVE`.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |
#task_definition ⇒ String
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 |
# File 'lib/aws-sdk-ecs/types.rb', line 4517 class Service < Struct.new( :service_arn, :service_name, :cluster_arn, :load_balancers, :service_registries, :status, :desired_count, :running_count, :pending_count, :launch_type, :platform_version, :task_definition, :deployment_configuration, :deployments, :role_arn, :events, :created_at, :placement_constraints, :placement_strategy, :network_configuration, :health_check_grace_period_seconds, :scheduling_strategy) include Aws::Structure end |