Package org.cdk8s

Class App

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

org.cdk8s.App

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)",
           date="2024-02-14T12:33:52.022Z")
@Stability(Stable)
public class App
extends software.constructs.Construct

Represents a cdk8s application.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	App.Builder	A fluent builder for App.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	App()	Defines an app.
	App(AppProps props)	Defines an app.
protected	App(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	App(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
List<Chart>	getCharts()	Returns all the charts in this app, sorted topologically.
String	getOutdir()	The output directory into which manifests will be synthesized.
String	getOutputFileExtension()	The file extension to use for rendered YAML files.
List<IResolver>	getResolvers()	Resolvers used by this app.
YamlOutputType	getYamlOutputType()	How to divide the YAML output into files.
static App	of(software.constructs.IConstruct c)
void	synth()	Synthesizes all manifests to the output directory.
String	synthYaml()	Synthesizes the app into a YAML string.

Methods inherited from class software.constructs.Construct

onPrepare, onSynthesize, onValidate, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

App

protected App(software.amazon.jsii.JsiiObjectRef objRef)

App

protected App(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

App

@Stability(Stable)
public App(@Nullable
           AppProps props)

Defines an app.

Parameters:

props - configuration options.

App

@Stability(Stable)
public App()

Defines an app.

Method Detail

of

@Stability(Stable)
@NotNull
public static App of(@NotNull
                     software.constructs.IConstruct c)

Parameters:

c - This parameter is required.

synth

@Stability(Stable)
public void synth()

Synthesizes all manifests to the output directory.

synthYaml

@Stability(Stable)
@NotNull
public String synthYaml()

Synthesizes the app into a YAML string.

Returns:

A string with all YAML objects across all charts in this app.

getCharts

@Stability(Stable)
@NotNull
public List<Chart> getCharts()

Returns all the charts in this app, sorted topologically.

getOutdir

@Stability(Stable)
@NotNull
public String getOutdir()

The output directory into which manifests will be synthesized.

getOutputFileExtension

@Stability(Stable)
@NotNull
public String getOutputFileExtension()

The file extension to use for rendered YAML files.

Default: .k8s.yaml

getResolvers

@Stability(Stable)
@NotNull
public List<IResolver> getResolvers()

Resolvers used by this app.

This includes both custom resolvers passed by the resolvers property, as well as built-in resolvers.

getYamlOutputType

@Stability(Stable)
@NotNull
public YamlOutputType getYamlOutputType()

How to divide the YAML output into files.

Default: YamlOutputType.FILE_PER_CHART