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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#capacity_provider_strategy ⇒ Array<Types::CapacityProviderStrategyItem>

The capacity provider strategy the service uses.
#cluster_arn ⇒ String

The Amazon Resource Name (ARN) of the cluster that hosts the service.
#created_at ⇒ Time

The Unix timestamp for the time when the service was created.
#created_by ⇒ String

The principal that created the service.
#deployment_configuration ⇒ Types::DeploymentConfiguration

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
#deployment_controller ⇒ Types::DeploymentController

The deployment controller type the service is using.
#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.
#enable_ecs_managed_tags ⇒ Boolean

Determines whether to use Amazon ECS managed tags for the tasks in the service.
#enable_execute_command ⇒ Boolean

Determines whether the execute command functionality is turned on for 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 the service is using.
#load_balancers ⇒ Array<Types::LoadBalancer>

A list of Elastic Load Balancing load balancer objects.
#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_family ⇒ String

The operating system that your tasks in the service run on.
#platform_version ⇒ String

The platform version to run your service on.
#propagate_tags ⇒ String

Determines whether to propagate the tags from the task definition or the service to the task.
#role_arn ⇒ String

The ARN of the IAM role that’s associated with the service.
#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>

The details for the service discovery registries to assign to this service.
#status ⇒ String

The status of the service.
#tags ⇒ Array<Types::Tag>

The metadata that you apply to the service to help you categorize and organize them.
#task_definition ⇒ String

The task definition to use for tasks in the service.
#task_sets ⇒ Array<Types::TaskSet>

Information about a set of Amazon ECS tasks in either an CodeDeploy or an ‘EXTERNAL` deployment.

Instance Attribute Details

#capacity_provider_strategy ⇒ `Array<Types::CapacityProviderStrategyItem>`

The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.

Returns:

(Array<Types::CapacityProviderStrategyItem>)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ `Time`

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

Returns:

(Time)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#created_by ⇒ `String`

The principal that created the service.

Returns:

(String)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  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 9039

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_controller ⇒ `Types::DeploymentController`

The deployment controller type the service is using.

Returns:

(Types::DeploymentController)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  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 9039

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  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].

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html [2]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html

Returns:

(Integer)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#enable_ecs_managed_tags ⇒ `Boolean`

Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see [Tagging Your Amazon ECS Resources] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html

Returns:

(Boolean)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#enable_execute_command ⇒ `Boolean`

Determines whether the execute command functionality is turned on for the service. If ‘true`, the execute command functionality is turned on for all containers in tasks as part of the service.

Returns:

(Boolean)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  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 9039

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  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 9039

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#launch_type ⇒ `String`

The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.

Returns:

(String)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

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

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

Returns:

(Array<Types::LoadBalancer>)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  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.

Returns:

(Types::NetworkConfiguration)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  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 9039

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  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 9039

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  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 9039

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#platform_family ⇒ `String`

The operating system that your tasks in the service run 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)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#platform_version ⇒ `String`

The platform version to run your service on. A platform version is only specified for tasks that are hosted on Fargate. 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)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#propagate_tags ⇒ `String`

Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren’t propagated.

Returns:

(String)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ `String`

The ARN of the IAM role that’s associated with the service. It 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 9039

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  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 9039

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  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 active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don’t meet the placement constraints.

<note markdown=“1”> Fargate tasks don’t support the ‘DAEMON` scheduling strategy.
```
</note>
```

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

Returns:

(String)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#service_arn ⇒ `String`

The ARN that identifies the service. For more information about the ARN format, see [Amazon Resource Name (ARN)] in the *Amazon ECS Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids

Returns:

(String)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#service_name ⇒ `String`

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, 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 9039

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

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

The details for the service discovery registries to assign to this service. For more information, see [Service Discovery].

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html

Returns:

(Array<Types::ServiceRegistry>)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  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 9039

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.

The following basic restrictions apply to tags:

Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use ‘aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Returns:

(Array<Types::Tag>)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  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].

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html [2]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html

Returns:

(String)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#task_sets ⇒ `Array<Types::TaskSet>`

Information about a set of Amazon ECS tasks in either an CodeDeploy or an ‘EXTERNAL` deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

Returns:

(Array<Types::TaskSet>)

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

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :service_registries,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :launch_type,
  :capacity_provider_strategy,
  :platform_version,
  :platform_family,
  :task_definition,
  :deployment_configuration,
  :task_sets,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy,
  :network_configuration,
  :health_check_grace_period_seconds,
  :scheduling_strategy,
  :deployment_controller,
  :tags,
  :created_by,
  :enable_ecs_managed_tags,
  :propagate_tags,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_provider_strategy ⇒ Array<Types::CapacityProviderStrategyItem>

#cluster_arn ⇒ String

#created_at ⇒ Time

#created_by ⇒ String

#deployment_configuration ⇒ Types::DeploymentConfiguration

#deployment_controller ⇒ Types::DeploymentController

#deployments ⇒ Array<Types::Deployment>

#desired_count ⇒ Integer

#enable_ecs_managed_tags ⇒ Boolean

#enable_execute_command ⇒ Boolean

#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_family ⇒ String

#platform_version ⇒ String

#propagate_tags ⇒ String

#role_arn ⇒ String

#running_count ⇒ Integer

#scheduling_strategy ⇒ String

#service_arn ⇒ String

#service_name ⇒ String

#service_registries ⇒ Array<Types::ServiceRegistry>

#status ⇒ String

#tags ⇒ Array<Types::Tag>

#task_definition ⇒ String

#task_sets ⇒ Array<Types::TaskSet>

#capacity_provider_strategy ⇒ `Array<Types::CapacityProviderStrategyItem>`

#cluster_arn ⇒ `String`

#created_at ⇒ `Time`

#created_by ⇒ `String`

#deployment_configuration ⇒ `Types::DeploymentConfiguration`

#deployment_controller ⇒ `Types::DeploymentController`

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

#desired_count ⇒ `Integer`

#enable_ecs_managed_tags ⇒ `Boolean`

#enable_execute_command ⇒ `Boolean`

#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_family ⇒ `String`

#platform_version ⇒ `String`

#propagate_tags ⇒ `String`

#role_arn ⇒ `String`

#running_count ⇒ `Integer`

#scheduling_strategy ⇒ `String`

#service_arn ⇒ `String`

#service_name ⇒ `String`

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

#status ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#task_definition ⇒ `String`

#task_sets ⇒ `Array<Types::TaskSet>`