Class CfnElement

An element of a CloudFormation stack.

Inheritance
System.Object
Construct
CfnElement
CfnCondition
CfnHook
CfnInclude
CfnOutput
CfnParameter
CfnRefElement
CfnInclude
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK
Assembly: Amazon.CDK.dll
Syntax (csharp)
public abstract class CfnElement : Construct, IConstruct, IConstruct, IDependable
Syntax (vb)
Public MustInherit Class CfnElement
    Inherits Construct
    Implements IConstruct, IConstruct, IDependable

Synopsis

Constructors

CfnElement(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnElement(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnElement(Construct, String)

Creates an entity and binds it to a tree.

Properties

CreationStack
LogicalId

The logical ID for this CloudFormation stack element.
Stack

The stack in which this element is defined.

Methods

IsCfnElement(Object)

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

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

Constructors

CfnElement(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnElement(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnElement(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnElement(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnElement(Construct, String)

Creates an entity and binds it to a tree.

protected CfnElement(Construct scope, string id)
Parameters
scope Constructs.Construct

The parent construct.

id System.String

The parent construct.

Remarks

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

Properties

CreationStack

public virtual string[] CreationStack { get; }
Property Value

System.String[]

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.

LogicalId

The logical ID for this CloudFormation stack element.

public virtual string LogicalId { get; }
Property Value

System.String

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

Remarks

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

Stack

The stack in which this element is defined.

public virtual Stack Stack { get; }
Property Value

Stack

Remarks

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

Methods

IsCfnElement(Object)

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

public static bool IsCfnElement(object x)
Parameters
x System.Object
Returns

System.Boolean

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

Remarks

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

OverrideLogicalId(String)

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

public virtual void OverrideLogicalId(string newLogicalId)
Parameters
newLogicalId System.String

The new logical ID to use for this stack element.

Implements

Constructs.IConstruct