software.amazon.awscdk

Interface ICfnResourceOptions.Jsii$Default

All Superinterfaces:

ICfnResourceOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ICfnResourceOptions.Jsii$Proxy

Enclosing interface:

ICfnResourceOptions

@Internal
public static interface ICfnResourceOptions.Jsii$Default
extends ICfnResourceOptions

Internal default implementation for ICfnResourceOptions.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.ICfnResourceOptions

ICfnResourceOptions.Jsii$Default, ICfnResourceOptions.Jsii$Proxy

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCondition

@Stability(value=Experimental)
 @Nullable
default CfnCondition getCondition()

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

Specified by:

getCondition in interface ICfnResourceOptions

setCondition

@Stability(value=Experimental)
default void setCondition(@Nullable
                                                         CfnCondition value)

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

Specified by:

setCondition in interface ICfnResourceOptions

getCreationPolicy

@Stability(value=Experimental)
 @Nullable
default CfnCreationPolicy getCreationPolicy()

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

Specified by:

getCreationPolicy in interface ICfnResourceOptions

setCreationPolicy

@Stability(value=Experimental)
default void setCreationPolicy(@Nullable
                                                              CfnCreationPolicy value)

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

Specified by:

setCreationPolicy in interface ICfnResourceOptions

getDeletionPolicy

@Stability(value=Experimental)
 @Nullable
default CfnDeletionPolicy getDeletionPolicy()

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

Specified by:

getDeletionPolicy in interface ICfnResourceOptions

setDeletionPolicy

@Stability(value=Experimental)
default void setDeletionPolicy(@Nullable
                                                              CfnDeletionPolicy value)

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

Specified by:

setDeletionPolicy in interface ICfnResourceOptions

getDescription

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

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

Specified by:

getDescription in interface ICfnResourceOptions

setDescription

@Stability(value=Experimental)
default void setDescription(@Nullable
                                                           String value)

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

Specified by:

setDescription in interface ICfnResourceOptions

getMetadata

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

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

Specified by:

getMetadata in interface ICfnResourceOptions

setMetadata

@Stability(value=Experimental)
default void setMetadata(@Nullable
                                                        Map<String,Object> value)

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

Specified by:

setMetadata in interface ICfnResourceOptions

getUpdatePolicy

@Stability(value=Experimental)
 @Nullable
default CfnUpdatePolicy getUpdatePolicy()

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

Specified by:

getUpdatePolicy in interface ICfnResourceOptions

setUpdatePolicy

@Stability(value=Experimental)
default void setUpdatePolicy(@Nullable
                                                            CfnUpdatePolicy value)

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

Specified by:

setUpdatePolicy in interface ICfnResourceOptions

getUpdateReplacePolicy

@Stability(value=Experimental)
 @Nullable
default CfnDeletionPolicy getUpdateReplacePolicy()

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

Specified by:

getUpdateReplacePolicy in interface ICfnResourceOptions

setUpdateReplacePolicy

@Stability(value=Experimental)
default void setUpdateReplacePolicy(@Nullable
                                                                   CfnDeletionPolicy value)

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

Specified by:

setUpdateReplacePolicy in interface ICfnResourceOptions

getVersion

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

(experimental) The version of this resource.

Used only for custom CloudFormation resources.

Specified by:

getVersion in interface ICfnResourceOptions

See Also:

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

setVersion

@Stability(value=Experimental)
default void setVersion(@Nullable
                                                       String value)

(experimental) The version of this resource.

Used only for custom CloudFormation resources.

Specified by:

setVersion in interface ICfnResourceOptions

See Also:

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