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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb

Overview

Details on a service within a cluster

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_provider_strategyArray<Types::CapacityProviderStrategyItem>

The capacity provider strategy associated with the service.



8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#cluster_arnString

The Amazon Resource Name (ARN) of the cluster that hosts the service.

Returns:

  • (String)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#created_atTime

The Unix timestamp for when the service was created.

Returns:

  • (Time)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#created_byString

The principal that created the service.

Returns:

  • (String)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#deployment_configurationTypes::DeploymentConfiguration

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.



8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#deployment_controllerTypes::DeploymentController

The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the ECS deployment controller type.



8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#deploymentsArray<Types::Deployment>

The current state of deployments for the service.

Returns:



8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#desired_countInteger

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)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#enable_ecs_managed_tagsBoolean

Specifies whether to enable 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.

Returns:

  • (Boolean)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#eventsArray<Types::ServiceEvent>

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

Returns:



8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#health_check_grace_period_secondsInteger

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)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#launch_typeString

The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Returns:

  • (String)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#load_balancersArray<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:



8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#network_configurationTypes::NetworkConfiguration

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.



8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#pending_countInteger

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

Returns:

  • (Integer)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#placement_constraintsArray<Types::PlacementConstraint>

The placement constraints for the tasks in the service.

Returns:



8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#placement_strategyArray<Types::PlacementStrategy>

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

Returns:



8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#platform_versionString

The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Returns:

  • (String)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#propagate_tagsString

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

Returns:

  • (String)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#role_arnString

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)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#running_countInteger

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

Returns:

  • (Integer)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#scheduling_strategyString

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 that 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 and will stop tasks that do not meet the placement constraints.

    Fargate tasks do not support the DAEMON scheduling strategy.

Returns:

  • (String)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#service_arnString

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)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#service_nameString

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens 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)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#service_registriesArray<Types::ServiceRegistry>

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

Returns:



8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#statusString

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

Returns:

  • (String)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#tagsArray<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, both of which you define.

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 AWS 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:



8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#task_definitionString

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)


8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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

#task_setsArray<Types::TaskSet>

Information about a set of Amazon ECS tasks in either an AWS 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:



8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 8572

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