Package org.cdk8s

Class App

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
    @Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-21T00:09:32.100Z")
@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

      All Methods Instance Methods Concrete Methods 
      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.
      YamlOutputType getYamlOutputType()
      How to divide the YAML output into files.
      void synth()
      Synthesizes all manifests to the output directory.
      Object 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 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

      • synth

        @Stability(Stable)
public void synth()
        Synthesizes all manifests to the output directory.

      • synthYaml

        @Stability(Stable)
@NotNull
public Object 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

      • getYamlOutputType

        @Stability(Stable)
@NotNull
public YamlOutputType getYamlOutputType()
        How to divide the YAML output into files.

        Default: YamlOutputType.FILE_PER_CHART