Package software.amazon.awscdk

Interface CfnResourceSignal

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnResourceSignal.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:23:55.715Z") @Stability(Stable) public interface CfnResourceSignal extends software.amazon.jsii.JsiiSerializable
When AWS CloudFormation creates the associated resource, configures the number of required success signals and the length of time that AWS CloudFormation waits for those signals.

Example: 

 CfnResource resource;
 resource.getCfnOptions().getCreationPolicy() = CfnCreationPolicy.builder()
         .resourceSignal(CfnResourceSignal.builder()
                 .count(3)
                 .timeout("PR15M")
                 .build())
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    CfnResourceSignal.Builder
    A builder for CfnResourceSignal
    static final class 
    CfnResourceSignal.Jsii$Proxy
    An implementation for CfnResourceSignal

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnResourceSignal.Builder
    builder()
     
    default Number
    getCount()
    The number of success signals AWS CloudFormation must receive before it sets the resource status as CREATE_COMPLETE.
    default String
    getTimeout()
    The length of time that AWS CloudFormation waits for the number of signals that was specified in the Count property.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getCount

      @Stability(Stable) @Nullable default Number getCount()
      The number of success signals AWS CloudFormation must receive before it sets the resource status as CREATE_COMPLETE.

      If the resource receives a failure signal or doesn't receive the specified number of signals before the timeout period expires, the resource creation fails and AWS CloudFormation rolls the stack back.

    • getTimeout

      @Stability(Stable) @Nullable default String getTimeout()
      The length of time that AWS CloudFormation waits for the number of signals that was specified in the Count property.

      The timeout period starts after AWS CloudFormation starts creating the resource, and the timeout expires no sooner than the time you specify but can occur shortly thereafter. The maximum time that you can specify is 12 hours.

    • builder

      @Stability(Stable) static CfnResourceSignal.Builder builder()
      Returns:
      a CfnResourceSignal.Builder of CfnResourceSignal