software.amazon.awscdk.core

Interface ICfnResourceOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ICfnResourceOptions.Jsii$Default

All Known Implementing Classes:

ICfnResourceOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:31.992Z")
 @Stability(value=Stable)
public interface ICfnResourceOptions
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ICfnResourceOptions.Jsii$Default Internal default implementation for ICfnResourceOptions.
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 String	getDescription() The description of this resource.
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 String	getVersion() The version of this resource.
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	setDescription(String value) The description of this resource.
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.
default void	setVersion(String value) The version of this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCondition

@Stability(value=Stable)
 @Nullable
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(@Nullable
                                    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)
 @Nullable
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(@Nullable
                                         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)
 @Nullable
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(@Nullable
                                         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.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

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).

setDescription

@Optional
default void setDescription(@Nullable
                                      String value)

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).

getMetadata

@Stability(value=Stable)
 @Nullable
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(@Nullable
                                   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)
 @Nullable
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(@Nullable
                                       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)
 @Nullable
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(@Nullable
                                              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.

getVersion

@Stability(value=Stable)
 @Nullable
default String getVersion()

The version of this resource.

Used only for custom CloudFormation resources.

See Also:

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

setVersion

@Optional
default void setVersion(@Nullable
                                  String value)

The version of this resource.

Used only for custom CloudFormation resources.

See Also:

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