Class: AWSCDK::CfnAutoScalingReplacingUpdate

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cfn_auto_scaling_replacing_update.rb

Overview

Specifies whether an Auto Scaling group and the instances it contains are replaced during an update.

During replacement, AWS CloudFormation retains the old group until it finishes creating the new one. If the update fails, AWS CloudFormation can roll back to the old Auto Scaling group and delete the new Auto Scaling group.

While AWS CloudFormation creates the new group, it doesn't detach or attach any instances. After successfully creating the new Auto Scaling group, AWS CloudFormation deletes the old Auto Scaling group during the cleanup process.

When you set the WillReplace parameter, remember to specify a matching CreationPolicy. If the minimum number of instances (specified by the MinSuccessfulInstancesPercent property) don't signal success within the Timeout period (specified in the CreationPolicy policy), the replacement update fails and AWS CloudFormation rolls back to the old Auto Scaling group.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(will_replace: nil) ⇒ CfnAutoScalingReplacingUpdate

Returns a new instance of CfnAutoScalingReplacingUpdate.

Parameters:

  • will_replace (Boolean, nil) (defaults to: nil) 


20
21
22
23
 
# File 'cfn_auto_scaling_replacing_update.rb', line 20

def initialize(will_replace: nil)
  @will_replace = will_replace
  Jsii::Type.check_type(@will_replace, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "willReplace") unless @will_replace.nil?
end

Instance Attribute Details

#will_replace ⇒ Boolean? (readonly)

Returns:

  • (Boolean, nil) 


26
27
28
 
# File 'cfn_auto_scaling_replacing_update.rb', line 26

def will_replace
  @will_replace
end

Class Method Details

.jsii_properties ⇒ Object 



28
29
30
31
32
 
# File 'cfn_auto_scaling_replacing_update.rb', line 28

def self.jsii_properties
  {
    :will_replace => "willReplace",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



34
35
36
37
38
39
40
 
# File 'cfn_auto_scaling_replacing_update.rb', line 34

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