Class: AWSCDK::CloudFormation::CfnWaitConditionProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_formation/cfn_wait_condition_props.rb

Overview

Properties for defining a CfnWaitCondition.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(count: nil, handle: nil, timeout: nil) ⇒ CfnWaitConditionProps

Returns a new instance of CfnWaitConditionProps.

Parameters:

  • count (Numeric, nil) (defaults to: nil) —

    The number of success signals that CloudFormation must receive before it continues the stack creation process.

  • handle (String, nil) (defaults to: nil) —

    A reference to the wait condition handle used to signal this wait condition.

  • timeout (String, nil) (defaults to: nil) —

    The length of time (in seconds) to wait for the number of signals that the Count property specifies.



12
13
14
15
16
17
18
19
 
# File 'cloud_formation/cfn_wait_condition_props.rb', line 12

def initialize(count: nil, handle: nil, timeout: nil)
  @count = count
  Jsii::Type.check_type(@count, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "count") unless @count.nil?
  @handle = handle
  Jsii::Type.check_type(@handle, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "handle") unless @handle.nil?
  @timeout = timeout
  Jsii::Type.check_type(@timeout, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeout") unless @timeout.nil?
end

Instance Attribute Details

#count ⇒ Numeric? (readonly)

The number of success signals that CloudFormation must receive before it continues the stack creation process.

When the wait condition receives the requisite number of success signals, CloudFormation resumes the creation of the stack. If the wait condition doesn't receive the specified number of success signals before the Timeout period expires, CloudFormation assumes that the wait condition has failed and rolls the stack back.

Updates aren't supported.

Returns:

  • (Numeric, nil)

See Also:



29
30
31
 
# File 'cloud_formation/cfn_wait_condition_props.rb', line 29

def count
  @count
end

#handle ⇒ String? (readonly)

A reference to the wait condition handle used to signal this wait condition.

Use the Ref intrinsic function to specify an AWS::CloudFormation::WaitConditionHandle resource.

Anytime you add a WaitCondition resource during a stack update, you must associate the wait condition with a new WaitConditionHandle resource. Don't reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command.

Updates aren't supported.

Returns:

  • (String, nil)

See Also:



40
41
42
 
# File 'cloud_formation/cfn_wait_condition_props.rb', line 40

def handle
  @handle
end

#timeout ⇒ String? (readonly)

The length of time (in seconds) to wait for the number of signals that the Count property specifies.

Timeout is a minimum-bound property, meaning the timeout occurs no sooner than the time you specify, but can occur shortly thereafter. The maximum time that can be specified for this property is 12 hours (43200 seconds).

Updates aren't supported.

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'cloud_formation/cfn_wait_condition_props.rb', line 49

def timeout
  @timeout
end

Class Method Details

.jsii_properties ⇒ Object 



51
52
53
54
55
56
57
 
# File 'cloud_formation/cfn_wait_condition_props.rb', line 51

def self.jsii_properties
  {
    :count => "count",
    :handle => "handle",
    :timeout => "timeout",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'cloud_formation/cfn_wait_condition_props.rb', line 59

def to_jsii
  result = {}
  result.merge!({
    "count" => @count,
    "handle" => @handle,
    "timeout" => @timeout,
  })
  result.compact
end