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

/**
 * Use the optional Parameters section to customize your templates. Parameters enable you to input custom values to your template each time you create or update a stack.
 */
@javax.annotation.Generated(value = "jsii-pacmak/0.10.5 (build 46bc9b0)", date = "2019-05-06T20:49:40.938Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.$Module.class, fqn = "@aws-cdk/cdk.CfnParameter")
public class CfnParameter extends software.amazon.awscdk.CfnRefElement {
    protected CfnParameter(final software.amazon.jsii.JsiiObject.InitializationMode mode) {
        super(mode);
    }
    /**
     * Creates a parameter construct. Note that the name (logical ID) of the parameter will derive from it's `coname` and location within the stack. Therefore, it is recommended that parameters are defined at the stack level.
     * 
     * @param scope The parent construct.
     * @param props The parameter properties.
     */
    public CfnParameter(final software.amazon.awscdk.Construct scope, final java.lang.String id, final software.amazon.awscdk.CfnParameterProps 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") });
    }

    /**
     * Allows using parameters as tokens without the need to dereference them. This implicitly implements Token, until we make it an interface.
     */
    @javax.annotation.Nullable
    public java.lang.Object resolve() {
        return this.jsiiCall("resolve", java.lang.Object.class);
    }

    /**
     * Indicates if this parameter has "NoEcho" set.
     */
    public java.lang.Boolean getNoEcho() {
        return this.jsiiGet("noEcho", java.lang.Boolean.class);
    }

    /**
     * The parameter value token represented as a string array.
     */
    public java.util.List getStringListValue() {
        return this.jsiiGet("stringListValue", java.util.List.class);
    }

    /**
     * The parameter value token represented as a string array.
     */
    public void setStringListValue(final java.util.List value) {
        this.jsiiSet("stringListValue", java.util.Objects.requireNonNull(value, "stringListValue is required"));
    }

    /**
     * The parameter value token represented as a string.
     */
    public java.lang.String getStringValue() {
        return this.jsiiGet("stringValue", java.lang.String.class);
    }

    /**
     * The parameter value token represented as a string.
     */
    public void setStringValue(final java.lang.String value) {
        this.jsiiSet("stringValue", java.util.Objects.requireNonNull(value, "stringValue is required"));
    }

    /**
     * A token that represents the actual value of this parameter.
     */
    public software.amazon.awscdk.Token getValue() {
        return this.jsiiGet("value", software.amazon.awscdk.Token.class);
    }

    /**
     * A token that represents the actual value of this parameter.
     */
    public void setValue(final software.amazon.awscdk.Token value) {
        this.jsiiSet("value", java.util.Objects.requireNonNull(value, "value is required"));
    }
}