Skip to content

AppProps

Initialization props for apps.

Initializer 

import ros_cdk_core
ros_cdk_core.AppProps(
  auto_synth: bool = None,
  context: typing.Mapping[str] = None,
  outdir: str = None,
  runtime_info: bool = None,
  stack_traces: bool = None,
  tree_metadata: bool = None
)

Properties

Name Type Description
auto_synth bool Automatically call 'synth()' before the program exits.
context typing.Mapping[str] Additional context values for the application.
outdir str The output directory into which to emit synthesized artifacts.
runtime_info bool Include runtime versioning information.
stack_traces bool Include construct creation stack trace.
tree_metadata bool Include construct tree metadata as part of the Cloud Assembly.

auto_synthOptional 

auto_synth: bool
  • Type: bool

Automatically call 'synth()' before the program exits.

If you set this, you don't have to call 'synth()' explicitly. Note that this feature is only available for certain programming languages, and calling 'synth()' is still recommended.

Default true if running via CDK CLI ('CDK_OUTDIR' is set), 'false' otherwise

contextOptional 

context: typing.Mapping[str]
  • Type: typing.Mapping[str]
  • Default: no additional context

Additional context values for the application.

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

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

outdirOptional 

outdir: str
  • Type: str

The output directory into which to emit synthesized artifacts.

Default - If this value is not set, considers the environment variable 'CDK_OUTDIR'. If 'CDK_OUTDIR' is not defined, uses a temp directory.

runtime_infoOptional 

runtime_info: bool
  • Type: bool
  • Default: true runtime info is included unless related comtext is set.

Include runtime versioning information.

stack_tracesOptional 

stack_traces: bool
  • Type: bool
  • Default: true stack traces are included unless related context is set.

Include construct creation stack trace.

tree_metadataOptional 

tree_metadata: bool
  • Type: bool
  • Default: true

Include construct tree metadata as part of the Cloud Assembly.