Class: AWSCDK::ECS::CfnService::DeploymentCircuitBreakerProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ECS::CfnService::DeploymentCircuitBreakerProperty

Defined in:

ecs/cfn_service.rb

Overview

The deployment circuit breaker can only be used for services using the rolling update ( ECS ) deployment type.

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html

Instance Attribute Summary

• #enable ⇒ Boolean, AWSCDK::IResolvable readonly

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

• #rollback ⇒ Boolean, AWSCDK::IResolvable readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(enable:, rollback:) ⇒ DeploymentCircuitBreakerProperty constructor

  A new instance of DeploymentCircuitBreakerProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(enable:, rollback:) ⇒ DeploymentCircuitBreakerProperty

Returns a new instance of DeploymentCircuitBreakerProperty.

Parameters:

• enable (Boolean, AWSCDK::IResolvable) —

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

• rollback (Boolean, AWSCDK::IResolvable) —

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

# File 'ecs/cfn_service.rb', line 1251

def initialize(enable:, rollback:)
  @enable = enable
  Jsii::Type.check_type(@enable, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enable")
  @rollback = rollback
  Jsii::Type.check_type(@rollback, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "rollback")
end

Instance Attribute Details

#enable ⇒ Boolean, AWSCDK::IResolvable (readonly)

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

Returns:

• (Boolean, AWSCDK::IResolvable)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html#cfn-ecs-service-deploymentcircuitbreaker-enable

# File 'ecs/cfn_service.rb', line 1262

def enable
  @enable
end

#rollback ⇒ Boolean, AWSCDK::IResolvable (readonly)

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.

Returns:

• (Boolean, AWSCDK::IResolvable)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentcircuitbreaker.html#cfn-ecs-service-deploymentcircuitbreaker-rollback

# File 'ecs/cfn_service.rb', line 1269

def rollback
  @rollback
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ecs/cfn_service.rb', line 1271

def self.jsii_properties
  {
    :enable => "enable",
    :rollback => "rollback",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'ecs/cfn_service.rb', line 1278

def to_jsii
  result = {}
  result.merge!({
    "enable" => @enable,
    "rollback" => @rollback,
  })
  result.compact
end