Package org.cdk8s

Class AppProps.Builder

java.lang.Object

org.cdk8s.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 Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AppProps	build()	Builds the configured instance.
AppProps.Builder	outdir(String outdir)	Sets the value of AppProps.getOutdir()
AppProps.Builder	outputFileExtension(String outputFileExtension)	Sets the value of AppProps.getOutputFileExtension()
AppProps.Builder	recordConstructMetadata(Boolean recordConstructMetadata)	Sets the value of AppProps.getRecordConstructMetadata()
AppProps.Builder	yamlOutputType(YamlOutputType yamlOutputType)	Sets the value of AppProps.getYamlOutputType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.

Returns:

this

outputFileExtension

@Stability(Stable)
public AppProps.Builder outputFileExtension(String outputFileExtension)

Sets the value of AppProps.getOutputFileExtension()

Parameters:

outputFileExtension - The file extension to use for rendered YAML files.

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

yamlOutputType

@Stability(Stable)
public AppProps.Builder yamlOutputType(YamlOutputType yamlOutputType)

Sets the value of AppProps.getYamlOutputType()

Parameters:

yamlOutputType - How to divide the YAML output into files.

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