software.amazon.awscdk.core

Class CfnRefElement

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

All Implemented Interfaces:

IConstruct, IDependable

Direct Known Subclasses:

CfnMapping, CfnResource, CfnRule

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:52.955Z")
public abstract class CfnRefElement
extends CfnElement

Base class for referenceable CloudFormation constructs which are not Resources.

These constructs are things like Conditions and Parameters, can be referenced by taking the .ref attribute.

Resource constructs do not inherit from CfnRefElement because they have their own, more specific types returned from the .ref attribute. Also, some resources aren't referenceable at all (such as BucketPolicies or GatewayAttachments).

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	CfnRefElement(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRefElement(software.amazon.jsii.JsiiObjectRef objRef)
protected	CfnRefElement(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.lang.String	getRef() Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

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 java.lang.Object

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

Constructor Detail

CfnRefElement

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

CfnRefElement

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

CfnRefElement

protected CfnRefElement(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

getRef

public java.lang.String getRef()

Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).