Class AppProps
Initialization props for apps.
Inheritance
Implements
Namespace: Amazon.CDK
Assembly: Amazon.CDK.dll
Syntax (csharp)
public class AppProps : Object, IAppProps
Syntax (vb)
Public Class AppProps
Inherits Object
Implements IAppProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
var context;
var appProps = new AppProps {
AnalyticsReporting = false,
AutoSynth = false,
Context = new Dictionary<string, object> {
{ "contextKey", context }
},
Outdir = "outdir",
RuntimeInfo = false,
StackTraces = false,
TreeMetadata = false
};
Synopsis
Constructors
AppProps() |
Properties
AnalyticsReporting | Include runtime versioning information in the Stacks of this app. |
AutoSynth | Automatically call |
Context | Additional context values for the application. |
Outdir | The output directory into which to emit synthesized artifacts. |
RuntimeInfo | (deprecated) Include runtime versioning information in the Stacks of this app. |
StackTraces | Include construct creation stack trace in the |
TreeMetadata | Include construct tree metadata as part of the Cloud Assembly. |
Constructors
AppProps()
public AppProps()
Properties
AnalyticsReporting
Include runtime versioning information in the Stacks of this app.
public Nullable<bool> AnalyticsReporting { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: Value of 'aws:cdk:version-reporting' context key
AutoSynth
Automatically call synth()
before the program exits.
public Nullable<bool> AutoSynth { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
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
Context
Additional context values for the application.
public IDictionary<string, object> Context { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
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)
.
Default: - no additional context
Outdir
The output directory into which to emit synthesized artifacts.
public string Outdir { get; set; }
Property Value
System.String
Remarks
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.
RuntimeInfo
(deprecated) Include runtime versioning information in the Stacks of this app.
public Nullable<bool> RuntimeInfo { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: Value of 'aws:cdk:version-reporting' context key
Stability: Deprecated
StackTraces
Include construct creation stack trace in the aws:cdk:trace
metadata key of all constructs.
public Nullable<bool> StackTraces { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true stack traces are included unless aws:cdk:disable-stack-trace
is set in the context.
TreeMetadata
Include construct tree metadata as part of the Cloud Assembly.
public Nullable<bool> TreeMetadata { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true