software.aws.awsprototypingsdk.pdknag.PDKNag Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pdk-nag Show documentation
@aws-prototyping-sdk/pdk-nag
There is a newer version: 0.19.68
package software.aws.awsprototypingsdk.pdknag;

/**
 * Helper for create a Nag Enabled App.
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.82.0 (build 2d2ddd7)", date = "2023-08-09T23:54:33.271Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Jsii(module = software.aws.awsprototypingsdk.pdknag.$Module.class, fqn = "@aws-prototyping-sdk/pdk-nag.PDKNag")
public class PDKNag extends software.amazon.jsii.JsiiObject {

    protected PDKNag(final software.amazon.jsii.JsiiObjectRef objRef) {
        super(objRef);
    }

    protected PDKNag(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
        super(initializationMode);
    }

    /**
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public PDKNag() {
        super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this);
    }

    /**
     * Wrapper around NagSuppressions which does not throw.
     * 
     * @param stack stack instance. This parameter is required.
     * @param path resource path. This parameter is required.
     * @param suppressions list of suppressions to apply. This parameter is required.
     * @param applyToChildren whether to apply to children.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public static void addResourceSuppressionsByPathNoThrow(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.Stack stack, final @org.jetbrains.annotations.NotNull java.lang.String path, final @org.jetbrains.annotations.NotNull java.util.List suppressions, final @org.jetbrains.annotations.Nullable java.lang.Boolean applyToChildren) {
        software.amazon.jsii.JsiiObject.jsiiStaticCall(software.aws.awsprototypingsdk.pdknag.PDKNag.class, "addResourceSuppressionsByPathNoThrow", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(stack, "stack is required"), java.util.Objects.requireNonNull(path, "path is required"), java.util.Objects.requireNonNull(suppressions, "suppressions is required"), applyToChildren });
    }

    /**
     * Wrapper around NagSuppressions which does not throw.
     * 

     * @param stack stack instance. This parameter is required.
     * @param path resource path. This parameter is required.
     * @param suppressions list of suppressions to apply. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public static void addResourceSuppressionsByPathNoThrow(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.Stack stack, final @org.jetbrains.annotations.NotNull java.lang.String path, final @org.jetbrains.annotations.NotNull java.util.List suppressions) {
        software.amazon.jsii.JsiiObject.jsiiStaticCall(software.aws.awsprototypingsdk.pdknag.PDKNag.class, "addResourceSuppressionsByPathNoThrow", software.amazon.jsii.NativeType.VOID, new Object[] { java.util.Objects.requireNonNull(stack, "stack is required"), java.util.Objects.requireNonNull(path, "path is required"), java.util.Objects.requireNonNull(suppressions, "suppressions is required") });
    }

    /**
     * Returns an instance of an App with Nag enabled.
     * 

     * @param props props to initialize the app with.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public static @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.pdknag.PDKNagApp app(final @org.jetbrains.annotations.Nullable software.aws.awsprototypingsdk.pdknag.PDKNagAppProps props) {
        return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.aws.awsprototypingsdk.pdknag.PDKNag.class, "app", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.pdknag.PDKNagApp.class), new Object[] { props });
    }

    /**
     * Returns an instance of an App with Nag enabled.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public static @org.jetbrains.annotations.NotNull software.aws.awsprototypingsdk.pdknag.PDKNagApp app() {
        return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.aws.awsprototypingsdk.pdknag.PDKNag.class, "app", software.amazon.jsii.NativeType.forClass(software.aws.awsprototypingsdk.pdknag.PDKNagApp.class));
    }

    /**
     * Returns a stack account regex.
     * 

     * @param stack stack instance. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public static @org.jetbrains.annotations.NotNull java.lang.String getStackAccountRegex(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.Stack stack) {
        return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.aws.awsprototypingsdk.pdknag.PDKNag.class, "getStackAccountRegex", software.amazon.jsii.NativeType.forClass(java.lang.String.class), new Object[] { java.util.Objects.requireNonNull(stack, "stack is required") });
    }

    /**
     * Returns a stack partition regex.
     * 

     * @param stack stack instance. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public static @org.jetbrains.annotations.NotNull java.lang.String getStackPartitionRegex(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.Stack stack) {
        return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.aws.awsprototypingsdk.pdknag.PDKNag.class, "getStackPartitionRegex", software.amazon.jsii.NativeType.forClass(java.lang.String.class), new Object[] { java.util.Objects.requireNonNull(stack, "stack is required") });
    }

    /**
     * Returns a prefix comprising of a delimited set of Stack Ids.
     * 

     * For example: StackA/NestedStackB/
     * 

     * @param stack stack instance. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public static @org.jetbrains.annotations.NotNull java.lang.String getStackPrefix(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.Stack stack) {
        return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.aws.awsprototypingsdk.pdknag.PDKNag.class, "getStackPrefix", software.amazon.jsii.NativeType.forClass(java.lang.String.class), new Object[] { java.util.Objects.requireNonNull(stack, "stack is required") });
    }

    /**
     * Returns a stack region regex.
     * 
     * @param stack stack instance. This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
    public static @org.jetbrains.annotations.NotNull java.lang.String getStackRegionRegex(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.Stack stack) {
        return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.aws.awsprototypingsdk.pdknag.PDKNag.class, "getStackRegionRegex", software.amazon.jsii.NativeType.forClass(java.lang.String.class), new Object[] { java.util.Objects.requireNonNull(stack, "stack is required") });
    }
}