Package software.amazon.awscdk

Interface CfnCreationPolicy

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCreationPolicy.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-06T14:43:12.818Z")
@Stability(Stable)
public interface CfnCreationPolicy
extends software.amazon.jsii.JsiiSerializable

Associate the CreationPolicy attribute with a resource to prevent its status from reaching create complete until AWS CloudFormation receives a specified number of success signals or the timeout period is exceeded.

To signal a resource, you can use the cfn-signal helper script or SignalResource API. AWS CloudFormation publishes valid signals to the stack events so that you track the number of signals sent.

The creation policy is invoked only when AWS CloudFormation creates the associated resource. Currently, the only AWS CloudFormation resources that support creation policies are AWS::AutoScaling::AutoScalingGroup, AWS::EC2::Instance, AWS::CloudFormation::WaitCondition and AWS::AppStream::Fleet.

Use the CreationPolicy attribute when you want to wait on resource configuration actions before stack creation proceeds. For example, if you install and configure software applications on an EC2 instance, you might want those applications to be running before proceeding. In such cases, you can add a CreationPolicy attribute to the instance, and then send a success signal to the instance after the applications are installed and configured. For a detailed example, see Deploying Applications on Amazon EC2 with AWS CloudFormation.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 CfnCreationPolicy cfnCreationPolicy = CfnCreationPolicy.builder()
         .autoScalingCreationPolicy(CfnResourceAutoScalingCreationPolicy.builder()
                 .minSuccessfulInstancesPercent(123)
                 .build())
         .resourceSignal(CfnResourceSignal.builder()
                 .count(123)
                 .timeout("timeout")
                 .build())
         .startFleet(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCreationPolicy.Builder	builder()
default CfnResourceAutoScalingCreationPolicy	getAutoScalingCreationPolicy()	For an Auto Scaling group replacement update, specifies how many instances must signal success for the update to succeed.
default CfnResourceSignal	getResourceSignal()	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.
default Boolean	getStartFleet()	For an AppStream Fleet creation, specifies that the fleet is started after creation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutoScalingCreationPolicy

@Stability(Stable)
@Nullable
default CfnResourceAutoScalingCreationPolicy getAutoScalingCreationPolicy()

For an Auto Scaling group replacement update, specifies how many instances must signal success for the update to succeed.

getResourceSignal

@Stability(Stable)
@Nullable
default CfnResourceSignal getResourceSignal()

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.

getStartFleet

@Stability(Stable)
@Nullable
default Boolean getStartFleet()

For an AppStream Fleet creation, specifies that the fleet is started after creation.

builder

@Stability(Stable)
static CfnCreationPolicy.Builder builder()

Returns:

a CfnCreationPolicy.Builder of CfnCreationPolicy