Package org.cdk8s

Interface AppProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AppProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2024-12-31T06:16:49.788Z")
@Stability(Stable)
public interface AppProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AppProps.Builder	A builder for AppProps
static class	AppProps.Jsii$Proxy	An implementation for AppProps

Method Summary

Modifier and Type	Method	Description
static AppProps.Builder	builder()
default String	getOutdir()	The directory to output Kubernetes manifests.
default String	getOutputFileExtension()	The file extension to use for rendered YAML files.
default Boolean	getRecordConstructMetadata()	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.
default List<IResolver>	getResolvers()	A list of resolvers that can be used to replace property values before they are written to the manifest file.
default YamlOutputType	getYamlOutputType()	How to divide the YAML output into files.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getOutdir

@Stability(Stable)
@Nullable
default String getOutdir()

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.

Default: - CDK8S_OUTDIR if defined, otherwise "dist"

getOutputFileExtension

@Stability(Stable)
@Nullable
default String getOutputFileExtension()

The file extension to use for rendered YAML files.

Default: .k8s.yaml

getRecordConstructMetadata

@Stability(Stable)
@Nullable
default Boolean getRecordConstructMetadata()

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.

Default: false

getResolvers

@Stability(Stable)
@Nullable
default List<IResolver> getResolvers()

A list of resolvers that can be used to replace property values before they are written to the manifest file.

When multiple resolvers are passed, they are invoked by order in the list, and only the first one that applies (e.g calls context.replaceValue) is invoked.

Default: - no resolvers.

See Also:

https://cdk8s.io/docs/latest/basics/app/#resolvers

getYamlOutputType

@Stability(Stable)
@Nullable
default YamlOutputType getYamlOutputType()

How to divide the YAML output into files.

Default: YamlOutputType.FILE_PER_CHART

builder

@Stability(Stable)
static AppProps.Builder builder()

Returns:

a AppProps.Builder of AppProps