Class: Aws::ECS::Types::DeploymentCircuitBreaker

Inherits:

Struct

Object
Struct
Aws::ECS::Types::DeploymentCircuitBreaker

show all

Includes:: Structure

Defined in:: lib/aws-sdk-ecs/types.rb

Overview

<note markdown=“1”> The deployment circuit breaker can only be used for services using the rolling update (‘ECS`) deployment type.

</note>

The **deployment circuit breaker** determines whether a service deployment will fail if the service can’t reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see [Rolling update] in the *Amazon Elastic Container Service Developer Guide*.

For more information about API failure reasons, see [API failure reasons] in the *Amazon Elastic Container Service Developer Guide*.

[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html [2]: docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#enable ⇒ Boolean

Determines whether to use the deployment circuit breaker logic for the service.
#rollback ⇒ Boolean

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.

Instance Attribute Details

#enable ⇒ `Boolean`

Determines whether to use the deployment circuit breaker logic for the service.

Returns:

(Boolean)

# File 'lib/aws-sdk-ecs/types.rb', line 3786

class DeploymentCircuitBreaker < Struct.new(
  :enable,
  :rollback)
  SENSITIVE = []
  include Aws::Structure
end

#rollback ⇒ `Boolean`

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.