software.amazon.awscdk.core

Class CfnResource

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

All Implemented Interfaces:

IConstruct, IDependable, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.20.4 (build 96d89e1)",
           date="2019-11-12T11:54:39.741Z")
 @Stability(value=Stable)
public class CfnResource
extends CfnRefElement

Represents a CloudFormation resource.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnResource(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 resource) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
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.
protected Map<String,Object>	getUpdatedProperites() Return properties modified after initiation.
static Boolean	isCfnResource(IConstruct construct) Check whether the given construct is a CfnResource.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
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, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, 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(Construct scope,
                                            String id,
                                            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)
public static Boolean isCfnResource(IConstruct construct)

Check whether the given construct is a CfnResource.

Parameters:

construct - This parameter is required.

addDeletionOverride

@Stability(value=Stable)
public void addDeletionOverride(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(CfnResource resource)

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

Parameters:

resource - This parameter is required.

addOverride

@Stability(value=Stable)
public void addOverride(String path,
                                                 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. For example, ```typescript addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']) addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE') ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ```

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(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(String propertyPath,
                                                         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(RemovalPolicy policy,
                                                        RemovalPolicyOptions options)

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

Parameters:

policy -

options -

applyRemovalPolicy

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

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

Parameters:

policy -

applyRemovalPolicy

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

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

getAtt

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

renderProperties

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

Parameters:

props - This parameter is required.

toString

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

Returns a string representation of this construct.

Overrides:

toString in class Construct

Returns:

a string representation of this resource

validateProperties

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

Parameters:

_properties - This parameter is required.

getCfnOptions

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

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

getCfnProperties

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

getCfnResourceType

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

AWS resource type.

getUpdatedProperites

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