aws-cdk-lib.ICfnResourceOptions

ICfnResourceOptions Interface

Source

core/lib/cfn-resource.ts

Properties

condition?may be undefinedCfnConditioncondition?may be undefinedCfnConditioncondition?may be undefinedCfnConditionCondition?may be undefinedCfnConditionCondition?may be undefinedCfnCondition#

A condition to associate with this resource.

notes

This means that only if the condition evaluates to 'true' when the stack is deployed, the resource will be included. This is provided to allow CDK projects to produce legacy templates, but normally there is no need to use it in CDK projects.

creationPolicy?may be undefinedCfnCreationPolicycreation_policy?may be undefinedCfnCreationPolicycreationPolicy?may be undefinedCfnCreationPolicyCreationPolicy?may be undefinedCfnCreationPolicyCreationPolicy?may be undefinedCfnCreationPolicy#

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.

deletionPolicy?may be undefinedCfnDeletionPolicydeletion_policy?may be undefinedCfnDeletionPolicydeletionPolicy?may be undefinedCfnDeletionPolicyDeletionPolicy?may be undefinedCfnDeletionPolicyDeletionPolicy?may be undefinedCfnDeletionPolicy#

With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted.

notes

You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. Note that this capability also applies to update operations that lead to resources being removed.

description?may be undefinedstringdescription?may be undefinedstrdescription?may be undefinedStringDescription?may be undefinedstringDescription?may be undefined*string#

The description of this resource.

Used for informational purposes only, is not processed in any way (and stays with the CloudFormation template, is not passed to the underlying resource, even if it does have a 'description' property).

metadata?may be undefined{ [key: string]: any }metadata?may be undefinedtyping.Mapping[str, Any]metadata?may be undefinedMap<String, Object>Metadata?may be undefinedIDictionary<string, object>Metadata?may be undefined*map[string]interface{}#

Metadata associated with the CloudFormation resource.

This is not the same as the construct metadata which can be added using construct.addMetadata(), but would not appear in the CloudFormation template automatically.

updatePolicy?may be undefinedCfnUpdatePolicyupdate_policy?may be undefinedCfnUpdatePolicyupdatePolicy?may be undefinedCfnUpdatePolicyUpdatePolicy?may be undefinedCfnUpdatePolicyUpdatePolicy?may be undefinedCfnUpdatePolicy#

Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource.

AWS CloudFormation invokes one of three update policies depending on the type of change you make or whether a scheduled action is associated with the Auto Scaling group.

updateReplacePolicy?may be undefinedCfnDeletionPolicyupdate_replace_policy?may be undefinedCfnDeletionPolicyupdateReplacePolicy?may be undefinedCfnDeletionPolicyUpdateReplacePolicy?may be undefinedCfnDeletionPolicyUpdateReplacePolicy?may be undefinedCfnDeletionPolicy#

Use the UpdateReplacePolicy attribute to retain or (in some cases) backup the existing physical instance of a resource when it is replaced during a stack update operation.

version?may be undefinedstringversion?may be undefinedstrversion?may be undefinedStringVersion?may be undefinedstringVersion?may be undefined*string#

The version of this resource.

Used only for custom CloudFormation resources.