software.amazon.awscdk.CfnRefElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdk Show documentation
AWS Cloud Development Kit Core Library
There is a newer version: 0.36.1
package software.amazon.awscdk;

/**
 * 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).
 */
@javax.annotation.Generated(value = "jsii-pacmak/0.10.5 (build 46bc9b0)", date = "2019-05-06T20:49:40.940Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.$Module.class, fqn = "@aws-cdk/cdk.CfnRefElement")
public abstract class CfnRefElement extends software.amazon.awscdk.CfnElement {
    protected CfnRefElement(final software.amazon.jsii.JsiiObject.InitializationMode mode) {
        super(mode);
    }
    /**
     * 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).
     * 
     * @param scope The parent construct.
     */
    public CfnRefElement(final software.amazon.awscdk.Construct scope, final java.lang.String id) {
        super(software.amazon.jsii.JsiiObject.InitializationMode.Jsii);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required") });
    }

    /**
     * Returns a token to a CloudFormation { Ref } that references this entity based on it's logical ID.
     */
    public java.lang.String getRef() {
        return this.jsiiGet("ref", java.lang.String.class);
    }

    /**
     * Return a token that will CloudFormation { Ref } this stack element.
     */
    protected software.amazon.awscdk.Token getReferenceToken() {
        return this.jsiiGet("referenceToken", software.amazon.awscdk.Token.class);
    }

    /**
     * A proxy class which represents a concrete javascript instance of this type.
     */
    final static class Jsii$Proxy extends software.amazon.awscdk.CfnRefElement {
        protected Jsii$Proxy(final software.amazon.jsii.JsiiObject.InitializationMode mode) {
            super(mode);
        }

        /**
         * The construct node in the scope tree.
         */
        @Override
        public software.amazon.awscdk.ConstructNode getNode() {
            return this.jsiiGet("node", software.amazon.awscdk.ConstructNode.class);
        }

        /**
         * The set of constructs that form the root of this dependable.
         * 
         * All resources under all returned constructs are included in the ordering
         * dependency.
         */
        @Override
        public java.util.List getDependencyRoots() {
            return this.jsiiGet("dependencyRoots", java.util.List.class);
        }
    }
}