software.amazon.awscdk.core

Interface ICfnResourceOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ICfnResourceOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/0.20.4 (build 96d89e1)",
           date="2019-11-12T11:54:39.759Z")
 @Stability(value=Stable)
public interface ICfnResourceOptions
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ICfnResourceOptions.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
default CfnCondition	getCondition() A condition to associate with this resource.
default CfnCreationPolicy	getCreationPolicy() 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.
default CfnDeletionPolicy	getDeletionPolicy() With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted.
default Map<String,Object>	getMetadata() Metadata associated with the CloudFormation resource.
default CfnUpdatePolicy	getUpdatePolicy() Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource.
default CfnDeletionPolicy	getUpdateReplacePolicy() 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.
default void	setCondition(CfnCondition value) A condition to associate with this resource.
default void	setCreationPolicy(CfnCreationPolicy value) 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.
default void	setDeletionPolicy(CfnDeletionPolicy value) With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted.
default void	setMetadata(Map<String,Object> value) Metadata associated with the CloudFormation resource.
default void	setUpdatePolicy(CfnUpdatePolicy value) Use the UpdatePolicy attribute to specify how AWS CloudFormation handles updates to the AWS::AutoScaling::AutoScalingGroup resource.
default void	setUpdateReplacePolicy(CfnDeletionPolicy value) 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCondition

@Stability(value=Stable)
default CfnCondition getCondition()

A condition to associate with this resource. 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 noramlly there is no need to use it in CDK projects.

setCondition

@Optional
default void setCondition(CfnCondition value)

A condition to associate with this resource. 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 noramlly there is no need to use it in CDK projects.

getCreationPolicy

@Stability(value=Stable)
default CfnCreationPolicy getCreationPolicy()

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.

setCreationPolicy

@Optional
default void setCreationPolicy(CfnCreationPolicy value)

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.

getDeletionPolicy

@Stability(value=Stable)
default CfnDeletionPolicy getDeletionPolicy()

With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. 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.

setDeletionPolicy

@Optional
default void setDeletionPolicy(CfnDeletionPolicy value)

With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted. 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.

getMetadata

@Stability(value=Stable)
default Map<String,Object> getMetadata()

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.

setMetadata

@Optional
default void setMetadata(Map<String,Object> value)

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.

getUpdatePolicy

@Stability(value=Stable)
default CfnUpdatePolicy getUpdatePolicy()

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.

setUpdatePolicy

@Optional
default void setUpdatePolicy(CfnUpdatePolicy value)

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.

getUpdateReplacePolicy

@Stability(value=Stable)
default CfnDeletionPolicy getUpdateReplacePolicy()

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.

setUpdateReplacePolicy

@Optional
default void setUpdateReplacePolicy(CfnDeletionPolicy value)

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.