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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
  capacity_provider_strategy: [
    {
      capacity_provider: "String", # required
      weight: 1,
      base: 1,
    },
  ],
  deployment_configuration: {
    deployment_circuit_breaker: {
      enable: false, # required
      rollback: false, # required
    },
    maximum_percent: 1,
    minimum_healthy_percent: 1,
  },
  network_configuration: {
    awsvpc_configuration: {
      subnets: ["String"], # required
      security_groups: ["String"],
      assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
  placement_constraints: [
    {
      type: "distinctInstance", # accepts distinctInstance, memberOf
      expression: "String",
    },
  ],
  placement_strategy: [
    {
      type: "random", # accepts random, spread, binpack
      field: "String",
    },
  ],
  platform_version: "String",
  force_new_deployment: false,
  health_check_grace_period_seconds: 1,
  enable_execute_command: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_provider_strategyArray<Types::CapacityProviderStrategyItem>

The capacity provider strategy to update the service to use.

if the service uses the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that's not the default capacity provider strategy, the service can't be updated to use the cluster's default capacity provider strategy.

A capacity provider strategy consists of one or more capacity providers along with the `base` and `weight` to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an `ACTIVE` or `UPDATING` status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a Fargate capacity provider, specify either the `FARGATE` or `FARGATE_SPOT` capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.


11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
# File 'lib/aws-sdk-ecs/types.rb', line 11974

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :capacity_provider_strategy,
  :deployment_configuration,
  :network_configuration,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :force_new_deployment,
  :health_check_grace_period_seconds,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#clusterString

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

Returns:

  • (String)

11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
# File 'lib/aws-sdk-ecs/types.rb', line 11974

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :capacity_provider_strategy,
  :deployment_configuration,
  :network_configuration,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :force_new_deployment,
  :health_check_grace_period_seconds,
  :enable_execute_command)
  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.


11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
# File 'lib/aws-sdk-ecs/types.rb', line 11974

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :capacity_provider_strategy,
  :deployment_configuration,
  :network_configuration,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :force_new_deployment,
  :health_check_grace_period_seconds,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#desired_countInteger

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

Returns:

  • (Integer)

11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
# File 'lib/aws-sdk-ecs/types.rb', line 11974

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :capacity_provider_strategy,
  :deployment_configuration,
  :network_configuration,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :force_new_deployment,
  :health_check_grace_period_seconds,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#enable_execute_commandBoolean

If `true`, this enables execute command functionality on all task containers.

If you do not want to override the value that was set when the service was created, you can set this to `null` when performing this action.

Returns:

  • (Boolean)

11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
# File 'lib/aws-sdk-ecs/types.rb', line 11974

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :capacity_provider_strategy,
  :deployment_configuration,
  :network_configuration,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :force_new_deployment,
  :health_check_grace_period_seconds,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#force_new_deploymentBoolean

Determines whether to force a new deployment of the service. By default, deployments aren't forced. You can use this option to start a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (`my_image:latest`) or to roll Fargate tasks onto a newer platform version.

Returns:

  • (Boolean)

11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
# File 'lib/aws-sdk-ecs/types.rb', line 11974

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :capacity_provider_strategy,
  :deployment_configuration,
  :network_configuration,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :force_new_deployment,
  :health_check_grace_period_seconds,
  :enable_execute_command)
  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. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

Returns:

  • (Integer)

11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
# File 'lib/aws-sdk-ecs/types.rb', line 11974

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :capacity_provider_strategy,
  :deployment_configuration,
  :network_configuration,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :force_new_deployment,
  :health_check_grace_period_seconds,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#network_configurationTypes::NetworkConfiguration

An object representing the network configuration for the service.


11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
# File 'lib/aws-sdk-ecs/types.rb', line 11974

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :capacity_provider_strategy,
  :deployment_configuration,
  :network_configuration,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :force_new_deployment,
  :health_check_grace_period_seconds,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#placement_constraintsArray<Types::PlacementConstraint>

An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.

You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

Returns:


11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
# File 'lib/aws-sdk-ecs/types.rb', line 11974

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :capacity_provider_strategy,
  :deployment_configuration,
  :network_configuration,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :force_new_deployment,
  :health_check_grace_period_seconds,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#placement_strategyArray<Types::PlacementStrategy>

The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.

You can specify a maximum of five strategy rules for each service.

Returns:


11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
# File 'lib/aws-sdk-ecs/types.rb', line 11974

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :capacity_provider_strategy,
  :deployment_configuration,
  :network_configuration,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :force_new_deployment,
  :health_check_grace_period_seconds,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#platform_versionString

The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not 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)

11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
# File 'lib/aws-sdk-ecs/types.rb', line 11974

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :capacity_provider_strategy,
  :deployment_configuration,
  :network_configuration,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :force_new_deployment,
  :health_check_grace_period_seconds,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#serviceString

The name of the service to update.

Returns:

  • (String)

11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
# File 'lib/aws-sdk-ecs/types.rb', line 11974

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :capacity_provider_strategy,
  :deployment_configuration,
  :network_configuration,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :force_new_deployment,
  :health_check_grace_period_seconds,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end

#task_definitionString

The `family` and `revision` (`family:revision`) or full 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)

11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
# File 'lib/aws-sdk-ecs/types.rb', line 11974

class UpdateServiceRequest < Struct.new(
  :cluster,
  :service,
  :desired_count,
  :task_definition,
  :capacity_provider_strategy,
  :deployment_configuration,
  :network_configuration,
  :placement_constraints,
  :placement_strategy,
  :platform_version,
  :force_new_deployment,
  :health_check_grace_period_seconds,
  :enable_execute_command)
  SENSITIVE = []
  include Aws::Structure
end