You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_arnString

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

Returns:

  • (String)


3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#created_atTime

The Unix timestamp for when the service was created.

Returns:

  • (Time)


3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  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.



3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#deploymentsArray<Types::Deployment>

The current state of deployments for the service.

Returns:



3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  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)


3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#eventsArray<Types::ServiceEvent>

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

Returns:



3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  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:



3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#pending_countInteger

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

Returns:

  • (Integer)


3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#placement_constraintsArray<Types::PlacementConstraint>

The placement constraints for the tasks in the service.

Returns:



3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#placement_strategyArray<Types::PlacementStrategy>

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

Returns:



3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (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)


3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#running_countInteger

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

Returns:

  • (Integer)


3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#service_arnString

The Amazon Resource Name (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)


3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#service_nameString

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)


3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  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)


3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 3361

class Service < Struct.new(
  :service_arn,
  :service_name,
  :cluster_arn,
  :load_balancers,
  :status,
  :desired_count,
  :running_count,
  :pending_count,
  :task_definition,
  :deployment_configuration,
  :deployments,
  :role_arn,
  :events,
  :created_at,
  :placement_constraints,
  :placement_strategy)
  include Aws::Structure
end