Package com.hashicorp.cdktf

Interface AppConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AppConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-02-05T09:47:53.739Z")
@Stability(Experimental)
public interface AppConfig
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AppConfig.Builder	builder()
default Map<String,Object>	getContext()	(experimental) Additional context values for the application.
default Boolean	getHclOutput()
default String	getOutdir()	(experimental) The directory to output Terraform resources.
default Boolean	getSkipBackendValidation()	(experimental) Whether to skip backend validation during synthesis of the app.
default Boolean	getSkipValidation()	(experimental) Whether to skip all validations during synthesis of the app.
default Boolean	getStackTraces()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContext

@Stability(Experimental)
@Nullable
default Map<String,Object> getContext()

(experimental) Additional context values for the application.

Context set by the CLI or the context key in cdktf.json has precedence.

Context can be read from any construct using node.getContext(key).

Default: - no additional context

getHclOutput

@Stability(Experimental)
@Nullable
default Boolean getHclOutput()

getOutdir

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

(experimental) The directory to output Terraform resources.

If you are using the CDKTF CLI, this value is automatically set from one of the following three sources:

• The -o / --output CLI option
• The CDKTF_OUTDIR environment variable
• The outdir key in cdktf.json

If you are using the CDKTF CLI and want to set a different value here, you will also need to set the same value via one of the three ways specified above.

The most common case to set this value is when you are using the CDKTF library directly (e.g. when writing unit tests).

Default: - CDKTF_OUTDIR if defined, otherwise "cdktf.out"

getSkipBackendValidation

@Stability(Experimental)
@Nullable
default Boolean getSkipBackendValidation()

(experimental) Whether to skip backend validation during synthesis of the app.

Default: - false

getSkipValidation

@Stability(Experimental)
@Nullable
default Boolean getSkipValidation()

(experimental) Whether to skip all validations during synthesis of the app.

Default: - false

getStackTraces

@Stability(Experimental)
@Nullable
default Boolean getStackTraces()

builder

@Stability(Experimental)
static AppConfig.Builder builder()

Returns:

a AppConfig.Builder of AppConfig