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

Class: Aws::ECS::Types::UpdateServiceRequest

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

Overview

Note:

When making an API call, you may pass UpdateServiceRequest data as a hash:

{
  cluster: "String",
  service: "String", # required
  desired_count: 1,
  task_definition: "String",
  deployment_configuration: {
    maximum_percent: 1,
    minimum_healthy_percent: 1,
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#clusterString

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

Returns:

  • (String)


4228
4229
4230
4231
4232
4233
4234
4235
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4228

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :deployment_configuration)
  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.



4228
4229
4230
4231
4232
4233
4234
4235
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4228

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :deployment_configuration)
  include Aws::Structure
end

#desired_countInteger

The number of instantiations of the task to place and keep running in your service.

Returns:

  • (Integer)


4228
4229
4230
4231
4232
4233
4234
4235
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4228

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :deployment_configuration)
  include Aws::Structure
end

#serviceString

The name of the service to update.

Returns:

  • (String)


4228
4229
4230
4231
4232
4233
4234
4235
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4228

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :deployment_configuration)
  include Aws::Structure
end

#task_definitionString

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

Returns:

  • (String)


4228
4229
4230
4231
4232
4233
4234
4235
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4228

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :deployment_configuration)
  include Aws::Structure
end