software.amazon.awscdk.CfnOutput 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;

@javax.annotation.Generated(value = "jsii-pacmak/0.10.5 (build 46bc9b0)", date = "2019-05-06T20:49:40.937Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.$Module.class, fqn = "@aws-cdk/cdk.CfnOutput")
public class CfnOutput extends software.amazon.awscdk.CfnElement {
    protected CfnOutput(final software.amazon.jsii.JsiiObject.InitializationMode mode) {
        super(mode);
    }
    /**
     * Creates an CfnOutput value for this stack.
     * 
     * @param scope The parent construct.
     * @param props CfnOutput properties.
     */
    public CfnOutput(final software.amazon.awscdk.Construct scope, final java.lang.String id, final software.amazon.awscdk.CfnOutputProps props) {
        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"), java.util.Objects.requireNonNull(props, "props is required") });
    }

    /**
     * Returns an FnImportValue bound to this export name.
     */
    @javax.annotation.Nullable
    public java.lang.Object makeImportValue() {
        return this.jsiiCall("makeImportValue", java.lang.Object.class);
    }

    /**
     * Allocate an export name for this `CfnOutput` if not already done.
     */
    public java.lang.String obtainExportName() {
        return this.jsiiCall("obtainExportName", java.lang.String.class);
    }

    public java.lang.String getRef() {
        return this.jsiiGet("ref", java.lang.String.class);
    }

    /**
     * The value of the property returned by the aws cloudformation describe-stacks command. The value of an output can include literals, parameter references, pseudo-parameters, a mapping value, or intrinsic functions.
     */
    @javax.annotation.Nullable
    public java.lang.Object getValue() {
        return this.jsiiGet("value", java.lang.Object.class);
    }

    /**
     * A condition from the "Conditions" section to associate with this output value.
     * 
     * If the condition evaluates to `false`, this output value will not
     * be included in the stack.
     */
    @javax.annotation.Nullable
    public software.amazon.awscdk.CfnCondition getCondition() {
        return this.jsiiGet("condition", software.amazon.awscdk.CfnCondition.class);
    }

    /**
     * A String type that describes the output value. The description can be a maximum of 4 K in length.
     */
    @javax.annotation.Nullable
    public java.lang.String getDescription() {
        return this.jsiiGet("description", java.lang.String.class);
    }

    /**
     * The name of the resource output to be exported for a cross-stack reference. By default, the logical ID of the CfnOutput element is used as it's export name.
     * 
     * May be undefined if the CfnOutput hasn't been exported yet.
     */
    @javax.annotation.Nullable
    public java.lang.String getExport() {
        return this.jsiiGet("export", java.lang.String.class);
    }

    /**
     * The name of the resource output to be exported for a cross-stack reference. By default, the logical ID of the CfnOutput element is used as it's export name.
     * 
     * May be undefined if the CfnOutput hasn't been exported yet.
     */
    public void setExport(@javax.annotation.Nullable final java.lang.String value) {
        this.jsiiSet("export", value);
    }
}