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

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 DeploymentCircuitBreaker data as a hash:

{
  enable: false, # required
  rollback: false, # required
}

<note markdown=“1”> The deployment circuit breaker can only be used for services using the rolling update (`ECS`) deployment type that aren't behind a Classic Load Balancer.

</note>

The **deployment circuit breaker** determines whether a service deployment will fail if the service can't reach a steady state. If enabled, a service deployment will transition to a failed state and stop launching new tasks. You can also enable 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*.

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enableBoolean

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

Returns:

  • (Boolean)

3841
3842
3843
3844
3845
3846
# File 'lib/aws-sdk-ecs/types.rb', line 3841

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

#rollbackBoolean

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

Returns:

  • (Boolean)

3841
3842
3843
3844
3845
3846
# File 'lib/aws-sdk-ecs/types.rb', line 3841

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