AppProps¶
-
class
aws_cdk.core.
AppProps
(*, analytics_reporting=None, auto_synth=None, context=None, outdir=None, runtime_info=None, stack_traces=None, tree_metadata=None)¶ Bases:
object
Initialization props for apps.
- Parameters
analytics_reporting (
Optional
[bool
]) – Include runtime versioning information in the Stacks of this app. Default: Value of ‘aws:cdk:version-reporting’ context keyauto_synth (
Optional
[bool
]) – Automatically callsynth()
before the program exits. If you set this, you don’t have to callsynth()
explicitly. Note that this feature is only available for certain programming languages, and callingsynth()
is still recommended. Default: true if running via CDK CLI (CDK_OUTDIR
is set),false
otherwisecontext (
Optional
[Mapping
[str
,Any
]]) – Additional context values for the application. Context set by the CLI or thecontext
key incdk.json
has precedence. Context can be read from any construct usingnode.getContext(key)
. Default: - no additional contextoutdir (
Optional
[str
]) – The output directory into which to emit synthesized artifacts. You should never need to set this value. By default, the value you pass to the CLI’s--output
flag will be used, and if you change it to a different directory the CLI will fail to pick up the generated Cloud Assembly. This property is intended for internal and testing use. Default: - If this value is not set, considers the environment variableCDK_OUTDIR
. IfCDK_OUTDIR
is not defined, uses a temp directory.runtime_info (
Optional
[bool
]) – (deprecated) Include runtime versioning information in the Stacks of this app. Default: Value of ‘aws:cdk:version-reporting’ context keystack_traces (
Optional
[bool
]) – Include construct creation stack trace in theaws:cdk:trace
metadata key of all constructs. Default: true stack traces are included unlessaws:cdk:disable-stack-trace
is set in the context.tree_metadata (
Optional
[bool
]) – Include construct tree metadata as part of the Cloud Assembly. Default: true
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.core as cdk # context: Any app_props = cdk.AppProps( analytics_reporting=False, auto_synth=False, context={ "context_key": context }, outdir="outdir", runtime_info=False, stack_traces=False, tree_metadata=False )
Attributes
-
analytics_reporting
¶ Include runtime versioning information in the Stacks of this app.
- Default
Value of ‘aws:cdk:version-reporting’ context key
- Return type
Optional
[bool
]
-
auto_synth
¶ 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 callingsynth()
is still recommended.- Default
true if running via CDK CLI (
CDK_OUTDIR
is set),false
otherwise- Return type
Optional
[bool
]
-
context
¶ Additional context values for the application.
Context set by the CLI or the
context
key incdk.json
has precedence.Context can be read from any construct using
node.getContext(key)
.- Default
no additional context
- Return type
Optional
[Mapping
[str
,Any
]]
-
outdir
¶ The output directory into which to emit synthesized artifacts.
You should never need to set this value. By default, the value you pass to the CLI’s
--output
flag will be used, and if you change it to a different directory the CLI will fail to pick up the generated Cloud Assembly.This property is intended for internal and testing use.
- Default
If this value is not set, considers the environment variable
CDK_OUTDIR
.
If
CDK_OUTDIR
is not defined, uses a temp directory.- Return type
Optional
[str
]
-
runtime_info
¶ (deprecated) Include runtime versioning information in the Stacks of this app.
- Default
Value of ‘aws:cdk:version-reporting’ context key
- Deprecated
use
versionReporting
instead- Stability
deprecated
- Return type
Optional
[bool
]
-
stack_traces
¶ Include construct creation stack trace in the
aws:cdk:trace
metadata key of all constructs.- Default
true stack traces are included unless
aws:cdk:disable-stack-trace
is set in the context.- Return type
Optional
[bool
]
-
tree_metadata
¶ Include construct tree metadata as part of the Cloud Assembly.
- Default
true
- Return type
Optional
[bool
]