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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_provider_strategy ⇒ Array<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.

Returns:



12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#cluster ⇒ String

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) 


12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  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:



12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#desired_count ⇒ Integer

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

Returns:

  • (Integer) 


12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#enable_ecs_managed_tags ⇒ Boolean

Determines whether to turn on 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*.

Only tasks launched after the update will reflect the update. To update the tags on all tasks, set ‘forceNewDeployment` to `true`, so that Amazon ECS starts new tasks with the updated tags.

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

Returns:

  • (Boolean) 


12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#enable_execute_command ⇒ Boolean

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) 


12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#force_new_deployment ⇒ Boolean

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) 


12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  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. 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) 


12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  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.

When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.

For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can update from a single target group to multiple target groups and from multiple target groups to a single target group.

For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using ‘ CreateDeployment ` through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more information see [Register multiple target groups with a service] in the *Amazon Elastic Container Service Developer Guide*.

For services that use the external deployment controller, you can add, update, or remove load balancers by using [CreateTaskSet]. Note that multiple target groups are not supported for external deployments. For more information see [Register multiple target groups with a service] in the *Amazon Elastic Container Service Developer Guide*.

You can remove existing ‘loadBalancers` by passing an empty list.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html [2]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html

Returns:



12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#network_configuration ⇒ Types::NetworkConfiguration

An object representing the network configuration for the service.

Returns:



12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#placement_constraints ⇒ Array<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:



12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#placement_strategy ⇒ Array<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:



12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#platform_version ⇒ String

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) 


12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  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.

Only tasks launched after the update will reflect the update. To update the tags on all tasks, set ‘forceNewDeployment` to `true`, so that Amazon ECS starts new tasks with the updated tags.

Returns:

  • (String) 


12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#service ⇒ String

The name of the service to update.

Returns:

  • (String) 


12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#service_connect_configuration ⇒ Types::ServiceConnectConfiguration

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect] in the *Amazon Elastic Container Service Developer Guide*.

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

Returns:



12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  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].

When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the updated service registries configuration, and then stops the old tasks when the new tasks are running.

You can remove existing ‘serviceRegistries` by passing an empty list.

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

Returns:



12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#task_definition ⇒ String

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) 


12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end

#volume_configurations ⇒ Array<Types::ServiceVolumeConfiguration>

The details of the volume that was ‘configuredAtLaunch`. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in [ServiceManagedEBSVolumeConfiguration]. The `name` of the volume must match the `name` from the task definition. If set to null, no new deployment is triggered. Otherwise, if this configuration differs from the existing one, it triggers a new deployment.

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ServiceManagedEBSVolumeConfiguration.html

Returns:



12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
 
# File 'lib/aws-sdk-ecs/types.rb', line 12427

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,
  :enable_ecs_managed_tags,
  :load_balancers,
  :propagate_tags,
  :service_registries,
  :service_connect_configuration,
  :volume_configurations)
  SENSITIVE = []
  include Aws::Structure
end