software.amazon.awscdk.core

Class CfnElement

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

All Implemented Interfaces:

IConstruct, IDependable

Direct Known Subclasses:

CfnCondition, CfnHook, CfnInclude, CfnInclude, CfnOutput, CfnParameter, CfnRefElement

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:28:55.940Z")
public abstract class CfnElement
extends Construct

An element of a CloudFormation stack.

Nested Class Summary

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

IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CfnElement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnElement(software.amazon.jsii.JsiiObjectRef objRef)
protected	CfnElement(software.constructs.Construct scope, java.lang.String id) Creates an entity and binds it to a tree.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getCreationStack()
java.lang.String	getLogicalId() The logical ID for this CloudFormation stack element.
Stack	getStack() The stack in which this element is defined.
static java.lang.Boolean	isCfnElement(java.lang.Object x) Returns `true` if a construct is a stack element (i.e.
void	overrideLogicalId(java.lang.String newLogicalId) Overrides the auto-generated logical ID with a specific ID.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CfnElement

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

CfnElement

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

CfnElement

protected CfnElement(software.constructs.Construct scope,
                     java.lang.String id)

Creates an entity and binds it to a tree.

Note that the root of the tree must be a Stack object (not just any Root).

Parameters:

scope - The parent construct. This parameter is required.

id - This parameter is required.

Method Detail

isCfnElement

public static java.lang.Boolean isCfnElement(java.lang.Object x)

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x - This parameter is required.

Returns:

The construct as a stack element or undefined if it is not a stack element.

overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

newLogicalId - The new logical ID to use for this stack element. This parameter is required.

getCreationStack

public java.util.List<java.lang.String> getCreationStack()

Returns:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

getLogicalId

public java.lang.String getLogicalId()

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

getStack

public Stack getStack()

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).