software.amazon.awscdk.core

Class CfnRefElement

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

All Implemented Interfaces:

IConstruct, IDependable, software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

CfnMapping, CfnResource, CfnRule

@Generated(value="jsii-pacmak/0.14.3 (build 1b1062d)",
           date="2019-08-14T08:10:20.272Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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, prepare

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

getNode, isConstruct, synthesize, toString, 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

CfnRefElement

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

CfnRefElement

@Stability(value=Stable)
public CfnRefElement(Construct scope,
                                              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.

Method Detail

getRef

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