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,
  },
  network_configuration: {
    awsvpc_configuration: {
      subnets: ["String"], # required
      security_groups: ["String"],
      assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
  platform_version: "String",
  force_new_deployment: false,
  health_check_grace_period_seconds: 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)


5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5278

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



5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5278

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

#desired_countInteger

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

Returns:

  • (Integer)


5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5278

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

#force_new_deploymentBoolean

Whether or not to force a new deployment of the service.

Returns:

  • (Boolean)


5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5278

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

#health_check_grace_period_secondsInteger

The period of time, in seconds, that the Amazon ECS service scheduler should ignore 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 ELB health checks, you can specify a health check grace period of up to 1,800 seconds during which the ECS service scheduler will ignore ELB 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)


5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5278

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

#network_configurationTypes::NetworkConfiguration

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own Elastic Network Interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.



5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5278

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

#platform_versionString

The platform version you want to update your service to run.

Returns:

  • (String)


5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5278

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

#serviceString

The name of the service to update.

Returns:

  • (String)


5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5278

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


5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5278

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