Package org.cdk8s

Class AppProps.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<AppProps>
    Enclosing interface:
    AppProps
    @Stability(Stable)
public static final class AppProps.Builder
extends Object
implements software.amazon.jsii.Builder<AppProps>
    A builder for AppProps

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • outdir

        @Stability(Stable)
public AppProps.Builder outdir​(String outdir)
        Sets the value of AppProps.getOutdir()
        Parameters:
        outdir - The directory to output Kubernetes manifests. If you synthesize your application using cdk8s synth, you must also pass this value to the CLI using the --output option or the output property in the cdk8s.yaml configuration file. Otherwise, the CLI will not know about the output directory, and synthesis will fail.

        This property is intended for internal and testing use.

        Returns:
        this

      • recordConstructMetadata

        @Stability(Stable)
public AppProps.Builder recordConstructMetadata​(Boolean recordConstructMetadata)
        Sets the value of AppProps.getRecordConstructMetadata()
        Parameters:
        recordConstructMetadata - When set to true, the output directory will contain a `construct-metadata.json` file that holds construct related metadata on every resource in the app.
        Returns:
        this

      • build

        @Stability(Stable)
public AppProps build()
        Builds the configured instance.
        Specified by:
        build in interface software.amazon.jsii.Builder<AppProps>
        Returns:
        a new instance of AppProps
        Throws:
        NullPointerException - if any required attribute was not provided