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

/**
 * Class that keeps track of the logical IDs that are assigned to resources.
 * 
 * Supports renaming the generated IDs.
 */
@javax.annotation.Generated(value = "jsii-pacmak/0.10.5 (build 46bc9b0)", date = "2019-05-06T20:49:40.955Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.$Module.class, fqn = "@aws-cdk/cdk.LogicalIDs")
public class LogicalIDs extends software.amazon.jsii.JsiiObject {
    protected LogicalIDs(final software.amazon.jsii.JsiiObject.InitializationMode mode) {
        super(mode);
    }
    public LogicalIDs(final software.amazon.awscdk.IAddressingScheme namingScheme) {
        super(software.amazon.jsii.JsiiObject.InitializationMode.Jsii);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(namingScheme, "namingScheme is required") });
    }

    /**
     * Throw an error if not all renames have been used.
     * 
     * This is to assure that users didn't make typoes when registering renames.
     */
    public void assertAllRenamesApplied() {
        this.jsiiCall("assertAllRenamesApplied", Void.class);
    }

    /**
     * Return the logical ID for the given stack element.
     */
    public java.lang.String getLogicalId(final software.amazon.awscdk.CfnElement cfnElement) {
        return this.jsiiCall("getLogicalId", java.lang.String.class, new Object[] { java.util.Objects.requireNonNull(cfnElement, "cfnElement is required") });
    }

    /**
     * Rename a logical ID from an old ID to a new ID.
     */
    public void renameLogical(final java.lang.String oldId, final java.lang.String newId) {
        this.jsiiCall("renameLogical", Void.class, new Object[] { java.util.Objects.requireNonNull(oldId, "oldId is required"), java.util.Objects.requireNonNull(newId, "newId is required") });
    }

    public software.amazon.awscdk.IAddressingScheme getNamingScheme() {
        return this.jsiiGet("namingScheme", software.amazon.awscdk.IAddressingScheme.class);
    }
}