software.amazon.awscdk

Class CfnRefElement

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

All Implemented Interfaces:

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

Direct Known Subclasses:

CfnMapping, CfnResource, CfnRule

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:42.431Z")
 @Stability(value=Experimental)
public abstract class CfnRefElement
extends CfnElement

(experimental) 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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getRef() (experimental) Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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

CfnRefElement

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

CfnRefElement

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

CfnRefElement

@Stability(value=Experimental)
protected CfnRefElement(@NotNull
                                                       software.constructs.Construct scope,
                                                       @NotNull
                                                       String id)

(experimental) 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

@Stability(value=Experimental)
 @NotNull
public String getRef()

(experimental) 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 }).