Interface ICfnResourceOptions

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnResourceOptions

Syntax (vb)

Public Interface ICfnResourceOptions

Synopsis

Properties

Condition	A condition to associate with this resource.
CreationPolicy	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.
DeletionPolicy	With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted.
Description	The description of this resource.
Metadata	Metadata associated with the CloudFormation resource.
UpdatePolicy	Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource.
UpdateReplacePolicy	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	The version of this resource.

Properties

Condition

A condition to associate with this resource.

virtual CfnCondition Condition { get; set; }

Property Value

CfnCondition

Remarks

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

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.

virtual ICfnCreationPolicy CreationPolicy { get; set; }

Property Value

ICfnCreationPolicy

Remarks

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

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

virtual Nullable<CfnDeletionPolicy> DeletionPolicy { get; set; }

Property Value

System.Nullable<CfnDeletionPolicy>

Remarks

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

The description of this resource.

virtual string Description { get; set; }

Property Value

System.String

Remarks

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

Metadata associated with the CloudFormation resource.

virtual IDictionary<string, object> Metadata { get; set; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Remarks

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

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

virtual ICfnUpdatePolicy UpdatePolicy { get; set; }

Property Value

ICfnUpdatePolicy

Remarks

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

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.

virtual Nullable<CfnDeletionPolicy> UpdateReplacePolicy { get; set; }

Property Value

System.Nullable<CfnDeletionPolicy>

Version

The version of this resource.

virtual string Version { get; set; }

Property Value

System.String

Remarks

Used only for custom CloudFormation resources.

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html