Class: Aws::ECS::Types::Service

Inherits:

Struct

Object
Struct
Aws::ECS::Types::Service

show all

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

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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)
  include Aws::Structure
end

#created_at ⇒ `Time`

The Unix time stamp for when the service was created.

Returns:

(Time)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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

Returns:

(Types::DeploymentConfiguration)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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)
  include Aws::Structure
end

#deployments ⇒ `Array<Types::Deployment>`

The current state of deployments for the service.

Returns:

(Array<Types::Deployment>)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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

Returns:

(Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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)
  include Aws::Structure
end

#events ⇒ `Array<Types::ServiceEvent>`

The event stream for your service. A maximum of 100 of the latest events are displayed.

Returns:

(Array<Types::ServiceEvent>)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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

Returns:

(Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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)
  include Aws::Structure
end

#launch_type ⇒ `String`

The launch type on which your service is running.

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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

Returns:

(Array<Types::LoadBalancer>)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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

Returns:

(Types::NetworkConfiguration)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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)
  include Aws::Structure
end

#pending_count ⇒ `Integer`

The number of tasks in the cluster that are in the ‘PENDING` state.

Returns:

(Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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)
  include Aws::Structure
end

#placement_constraints ⇒ `Array<Types::PlacementConstraint>`

The placement constraints for the tasks in the service.

Returns:

(Array<Types::PlacementConstraint>)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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)
  include Aws::Structure
end

#placement_strategy ⇒ `Array<Types::PlacementStrategy>`

The placement strategy that determines how tasks for the service are placed.

Returns:

(Array<Types::PlacementStrategy>)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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)
  include Aws::Structure
end

#running_count ⇒ `Integer`

The number of tasks in the cluster that are in the ‘RUNNING` state.

Returns:

(Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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)
  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 `.

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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)
  include Aws::Structure
end

#service_registries ⇒ `Array<Types::ServiceRegistry>`

Returns:

(Array<Types::ServiceRegistry>)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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)
  include Aws::Structure
end

#status ⇒ `String`

The status of the service. The valid values are ‘ACTIVE`, `DRAINING`, or `INACTIVE`.

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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

Returns:

(String)

# File 'lib/aws-sdk-ecs/types.rb', line 4391

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)
  include Aws::Structure
end

Class: Aws::ECS::Types::Service

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_arn ⇒ String

#created_at ⇒ Time

#deployment_configuration ⇒ Types::DeploymentConfiguration

#deployments ⇒ Array<Types::Deployment>

#desired_count ⇒ Integer

#events ⇒ Array<Types::ServiceEvent>

#health_check_grace_period_seconds ⇒ Integer

#launch_type ⇒ String

#load_balancers ⇒ Array<Types::LoadBalancer>

#network_configuration ⇒ Types::NetworkConfiguration

#pending_count ⇒ Integer

#placement_constraints ⇒ Array<Types::PlacementConstraint>

#placement_strategy ⇒ Array<Types::PlacementStrategy>

#platform_version ⇒ String

#role_arn ⇒ String

#running_count ⇒ Integer

#service_arn ⇒ String

#service_name ⇒ String

#service_registries ⇒ Array<Types::ServiceRegistry>

#status ⇒ String

#task_definition ⇒ String

#cluster_arn ⇒ `String`

#created_at ⇒ `Time`

#deployment_configuration ⇒ `Types::DeploymentConfiguration`

#deployments ⇒ `Array<Types::Deployment>`

#desired_count ⇒ `Integer`

#events ⇒ `Array<Types::ServiceEvent>`

#health_check_grace_period_seconds ⇒ `Integer`

#launch_type ⇒ `String`

#load_balancers ⇒ `Array<Types::LoadBalancer>`

#network_configuration ⇒ `Types::NetworkConfiguration`

#pending_count ⇒ `Integer`

#placement_constraints ⇒ `Array<Types::PlacementConstraint>`

#placement_strategy ⇒ `Array<Types::PlacementStrategy>`

#platform_version ⇒ `String`

#role_arn ⇒ `String`

#running_count ⇒ `Integer`

#service_arn ⇒ `String`

#service_name ⇒ `String`

#service_registries ⇒ `Array<Types::ServiceRegistry>`

#status ⇒ `String`

#task_definition ⇒ `String`