software.amazon.awscdk

Class ICfnResourceOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.ICfnResourceOptions.Jsii$Proxy

All Implemented Interfaces:

ICfnResourceOptions, ICfnResourceOptions.Jsii$Default, software.amazon.jsii.JsiiSerializable

Enclosing interface:

ICfnResourceOptions

@Internal
public static final class ICfnResourceOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ICfnResourceOptions.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

ICfnResourceOptions.Jsii$Default, ICfnResourceOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getCondition

@Stability(value=Experimental)
 @Nullable
public final 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

Specified by:

getCondition in interface ICfnResourceOptions.Jsii$Default

setCondition

@Stability(value=Experimental)
public final 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

Specified by:

setCondition in interface ICfnResourceOptions.Jsii$Default

getCreationPolicy

@Stability(value=Experimental)
 @Nullable
public final 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

Specified by:

getCreationPolicy in interface ICfnResourceOptions.Jsii$Default

setCreationPolicy

@Stability(value=Experimental)
public final 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

Specified by:

setCreationPolicy in interface ICfnResourceOptions.Jsii$Default

getDeletionPolicy

@Stability(value=Experimental)
 @Nullable
public final 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

Specified by:

getDeletionPolicy in interface ICfnResourceOptions.Jsii$Default

setDeletionPolicy

@Stability(value=Experimental)
public final 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

Specified by:

setDeletionPolicy in interface ICfnResourceOptions.Jsii$Default

getDescription

@Stability(value=Experimental)
 @Nullable
public final 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

Specified by:

getDescription in interface ICfnResourceOptions.Jsii$Default

setDescription

@Stability(value=Experimental)
public final 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

Specified by:

setDescription in interface ICfnResourceOptions.Jsii$Default

getMetadata

@Stability(value=Experimental)
 @Nullable
public final 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

Specified by:

getMetadata in interface ICfnResourceOptions.Jsii$Default

setMetadata

@Stability(value=Experimental)
public final 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

Specified by:

setMetadata in interface ICfnResourceOptions.Jsii$Default

getUpdatePolicy

@Stability(value=Experimental)
 @Nullable
public final 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

Specified by:

getUpdatePolicy in interface ICfnResourceOptions.Jsii$Default

setUpdatePolicy

@Stability(value=Experimental)
public final 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

Specified by:

setUpdatePolicy in interface ICfnResourceOptions.Jsii$Default

getUpdateReplacePolicy

@Stability(value=Experimental)
 @Nullable
public final 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

Specified by:

getUpdateReplacePolicy in interface ICfnResourceOptions.Jsii$Default

setUpdateReplacePolicy

@Stability(value=Experimental)
public final 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

Specified by:

setUpdateReplacePolicy in interface ICfnResourceOptions.Jsii$Default

getVersion

@Stability(value=Experimental)
 @Nullable
public final String getVersion()

(experimental) The version of this resource.

Used only for custom CloudFormation resources.

Specified by:

getVersion in interface ICfnResourceOptions

Specified by:

getVersion in interface ICfnResourceOptions.Jsii$Default

See Also:

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

setVersion

@Stability(value=Experimental)
public final void setVersion(@Nullable
                                                            String value)

(experimental) The version of this resource.

Used only for custom CloudFormation resources.

Specified by:

setVersion in interface ICfnResourceOptions

Specified by:

setVersion in interface ICfnResourceOptions.Jsii$Default

See Also:

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