software.amazon.awscdk.core

Class CfnResource

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

All Implemented Interfaces:

IDependable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

Direct Known Subclasses:

CfnCustomResource, CfnHookDefaultVersion, CfnHookTypeConfig, CfnHookVersion, CfnMacro, CfnModuleDefaultVersion, CfnModuleVersion, CfnPublicTypeVersion, CfnPublisher, CfnResourceDefaultVersion, CfnResourceVersion, CfnStack, CfnStackSet, CfnTypeActivation, CfnWaitCondition, CfnWaitConditionHandle

@Generated(value="jsii-pacmak/1.54.0 (build b1b977a)",
           date="2022-03-01T02:28:55.691Z")
 @Stability(value=Stable)
public class CfnResource
extends CfnRefElement

Represents a CloudFormation resource.

Example:

 import software.amazon.awscdk.core.*;
 public class MyConstruct extends Resource implements ITaggable {
     public final Object tags;
     public MyConstruct(Construct scope, String id) {
         super(scope, id);
         CfnResource.Builder.create(this, "Resource")
                 .type("Whatever::The::Type")
                 .properties(Map.of(
                         // ...
                         "Tags", this.tags.getRenderedTags()))
                 .build();
     }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnResource.Builder A fluent builder for CfnResource.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnResource(software.constructs.Construct scope, String id, CfnResourceProps props) Creates a resource construct.
protected	CfnResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnResource(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addDeletionOverride(String path) Syntactic sugar for `addOverride(path, undefined)`.
void	addDependsOn(CfnResource target) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
void	addMetadata(String key, Object value) Add a value to the CloudFormation Resource Metadata.
void	addOverride(String path, Object value) Adds an override to the synthesized CloudFormation resource.
void	addPropertyDeletionOverride(String propertyPath) Adds an override that deletes the value of a property from the resource definition.
void	addPropertyOverride(String propertyPath, Object value) Adds an override to a resource property.
void	applyRemovalPolicy() Sets the deletion policy of the resource based on the removal policy specified.
void	applyRemovalPolicy(RemovalPolicy policy) Sets the deletion policy of the resource based on the removal policy specified.
void	applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options) Sets the deletion policy of the resource based on the removal policy specified.
Reference	getAtt(String attributeName) Returns a token for an runtime attribute of this resource.
ICfnResourceOptions	getCfnOptions() Options for this resource, such as condition, update policy etc.
protected Map<String,Object>	getCfnProperties()
String	getCfnResourceType() AWS resource type.
Object	getMetadata(String key) Retrieve a value value from the CloudFormation Resource Metadata.
protected Map<String,Object>	getUpdatedProperites() Return properties modified after initiation.
static Boolean	isCfnResource(software.constructs.IConstruct construct) Check whether the given construct is a CfnResource.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
protected Boolean	shouldSynthesize() Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
String	toString() Returns a string representation of this construct.
protected void	validateProperties(Object _properties)

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CfnResource

protected CfnResource(software.amazon.jsii.JsiiObjectRef objRef)

CfnResource

protected CfnResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnResource

@Stability(value=Stable)
public CfnResource(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnResourceProps props)

Creates a resource construct.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

isCfnResource

@Stability(value=Stable)
 @NotNull
public static Boolean isCfnResource(@NotNull
                                                                       software.constructs.IConstruct construct)

Check whether the given construct is a CfnResource.

Parameters:

construct - This parameter is required.

addDeletionOverride

@Stability(value=Stable)
public void addDeletionOverride(@NotNull
                                                         String path)

Syntactic sugar for `addOverride(path, undefined)`.

Parameters:

path - The path of the value to delete. This parameter is required.

addDependsOn

@Stability(value=Stable)
public void addDependsOn(@NotNull
                                                  CfnResource target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target - This parameter is required.

addMetadata

@Stability(value=Stable)
public void addMetadata(@NotNull
                                                 String key,
                                                 @NotNull
                                                 Object value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key - This parameter is required.

value - This parameter is required.

See Also:

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

addOverride

@Stability(value=Stable)
public void addOverride(@NotNull
                                                 String path,
                                                 @NotNull
                                                 Object value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

 cfnResource.addOverride("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", List.of("myattribute"));
 cfnResource.addOverride("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE");
 

would add the overrides

 "Properties": {
    "GlobalSecondaryIndexes": [
      {
        "Projection": {
          "NonKeyAttributes": [ "myattribute" ]
          ...
        }
        ...
      },
      {
        "ProjectionType": "INCLUDE"
        ...
      },
    ]
    ...
 }
 

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path - - The path of the property, you can use dot notation to override values in complex types. This parameter is required.

value - - The value. This parameter is required.

addPropertyDeletionOverride

@Stability(value=Stable)
public void addPropertyDeletionOverride(@NotNull
                                                                 String propertyPath)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

propertyPath - The path to the property. This parameter is required.

addPropertyOverride

@Stability(value=Stable)
public void addPropertyOverride(@NotNull
                                                         String propertyPath,
                                                         @NotNull
                                                         Object value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

propertyPath - The path of the property. This parameter is required.

value - The value. This parameter is required.

applyRemovalPolicy

@Stability(value=Stable)
public void applyRemovalPolicy(@Nullable
                                                        RemovalPolicy policy,
                                                        @Nullable
                                                        RemovalPolicyOptions options)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy -

options -

applyRemovalPolicy

@Stability(value=Stable)
public void applyRemovalPolicy(@Nullable
                                                        RemovalPolicy policy)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy -

applyRemovalPolicy

@Stability(value=Stable)
public void applyRemovalPolicy()

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt

@Stability(value=Stable)
 @NotNull
public Reference getAtt(@NotNull
                                                           String attributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attributeName - The name of the attribute. This parameter is required.

getMetadata

@Stability(value=Stable)
 @NotNull
public Object getMetadata(@NotNull
                                                             String key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key - This parameter is required.

See Also:

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Parameters:

props - This parameter is required.

shouldSynthesize

@Stability(value=Stable)
 @NotNull
protected Boolean shouldSynthesize()

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

`true` if the resource should be included or `false` is the resource should be omitted.

toString

@Stability(value=Stable)
 @NotNull
public String toString()

Returns a string representation of this construct.

Overrides:

toString in class software.constructs.Construct

Returns:

a string representation of this resource

validateProperties

@Stability(value=Stable)
protected void validateProperties(@NotNull
                                                           Object _properties)

Parameters:

_properties - This parameter is required.

getCfnOptions

@Stability(value=Stable)
 @NotNull
public ICfnResourceOptions getCfnOptions()

Options for this resource, such as condition, update policy etc.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

getCfnResourceType

@Stability(value=Stable)
 @NotNull
public String getCfnResourceType()

AWS resource type.

getUpdatedProperites

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getUpdatedProperites()

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.