Class SharedOptions
(experimental) AWS CDK CLI options that apply to all commands.
Inheritance
Implements
Namespace: Amazon.CDK.Cli.Lib.Alpha
Assembly: Amazon.CDK.Cli.Lib.Alpha.dll
Syntax (csharp)
public class SharedOptions : Object, ISharedOptions
Syntax (vb)
Public Class SharedOptions
Inherits Object
Implements ISharedOptions
Remarks
Stability: Experimental
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.Cli.Lib.Alpha;
var sharedOptions = new SharedOptions {
AssetMetadata = false,
CaBundlePath = "caBundlePath",
Color = false,
Context = new Dictionary<string, string> {
{ "contextKey", "context" }
},
Debug = false,
Ec2Creds = false,
IgnoreErrors = false,
Json = false,
Lookups = false,
Notices = false,
PathMetadata = false,
Profile = "profile",
Proxy = "proxy",
RoleArn = "roleArn",
Stacks = new [] { "stacks" },
Staging = false,
Strict = false,
Trace = false,
Verbose = false,
VersionReporting = false
};
Synopsis
Constructors
SharedOptions() |
Properties
AssetMetadata | (experimental) Include "aws:asset:*" CloudFormation metadata for resources that use assets. |
CaBundlePath | (experimental) Path to CA certificate to use when validating HTTPS requests. |
Color | (experimental) Show colors and other style from console output. |
Context | (experimental) Additional context. |
Debug | (experimental) enable emission of additional debugging information, such as creation stack traces of tokens. |
Ec2Creds | (experimental) Force trying to fetch EC2 instance credentials. |
IgnoreErrors | (experimental) Ignores synthesis errors, which will likely produce an invalid output. |
Json | (experimental) Use JSON output instead of YAML when templates are printed to STDOUT. |
Lookups | (experimental) Perform context lookups. |
Notices | (experimental) Show relevant notices. |
PathMetadata | (experimental) Include "aws:cdk:path" CloudFormation metadata for each resource. |
Profile | (experimental) Use the indicated AWS profile as the default environment. |
Proxy | (experimental) Use the indicated proxy. |
RoleArn | (experimental) Role to pass to CloudFormation for deployment. |
Stacks | (experimental) List of stacks to deploy. |
Staging | (experimental) Copy assets to the output directory. |
Strict | (experimental) Do not construct stacks with warnings. |
Trace | (experimental) Print trace for stack warnings. |
Verbose | (experimental) show debug logs. |
VersionReporting | (experimental) Include "AWS::CDK::Metadata" resource in synthesized templates. |
Constructors
SharedOptions()
public SharedOptions()
Properties
AssetMetadata
(experimental) Include "aws:asset:*" CloudFormation metadata for resources that use assets.
public Nullable<bool> AssetMetadata { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Stability: Experimental
CaBundlePath
(experimental) Path to CA certificate to use when validating HTTPS requests.
public string CaBundlePath { get; set; }
Property Value
System.String
Remarks
Default: - read from AWS_CA_BUNDLE environment variable
Stability: Experimental
Color
(experimental) Show colors and other style from console output.
public Nullable<bool> Color { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - true
unless the environment variable NO_COLOR
is set
Stability: Experimental
Context
(experimental) Additional context.
public IDictionary<string, string> Context { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - no additional context
Stability: Experimental
Debug
(experimental) enable emission of additional debugging information, such as creation stack traces of tokens.
public Nullable<bool> Debug { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
Ec2Creds
(experimental) Force trying to fetch EC2 instance credentials.
public Nullable<bool> Ec2Creds { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - guess EC2 instance status
Stability: Experimental
IgnoreErrors
(experimental) Ignores synthesis errors, which will likely produce an invalid output.
public Nullable<bool> IgnoreErrors { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
Json
(experimental) Use JSON output instead of YAML when templates are printed to STDOUT.
public Nullable<bool> Json { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
Lookups
(experimental) Perform context lookups.
public Nullable<bool> Lookups { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Synthesis fails if this is disabled and context lookups need to be performed
Default: true
Stability: Experimental
Notices
(experimental) Show relevant notices.
public Nullable<bool> Notices { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Stability: Experimental
PathMetadata
(experimental) Include "aws:cdk:path" CloudFormation metadata for each resource.
public Nullable<bool> PathMetadata { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Stability: Experimental
Profile
(experimental) Use the indicated AWS profile as the default environment.
public string Profile { get; set; }
Property Value
System.String
Remarks
Default: - no profile is used
Stability: Experimental
Proxy
(experimental) Use the indicated proxy.
public string Proxy { get; set; }
Property Value
System.String
Remarks
Will read from HTTPS_PROXY environment if specified
Default: - no proxy
Stability: Experimental
RoleArn
(experimental) Role to pass to CloudFormation for deployment.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
Default: - use the bootstrap cfn-exec role
Stability: Experimental
Stacks
(experimental) List of stacks to deploy.
public string[] Stacks { get; set; }
Property Value
System.String[]
Remarks
Default: - all stacks
Stability: Experimental
Staging
(experimental) Copy assets to the output directory.
public Nullable<bool> Staging { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Needed for local debugging the source files with SAM CLI
Default: false
Stability: Experimental
Strict
(experimental) Do not construct stacks with warnings.
public Nullable<bool> Strict { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
Trace
(experimental) Print trace for stack warnings.
public Nullable<bool> Trace { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
Verbose
(experimental) show debug logs.
public Nullable<bool> Verbose { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
VersionReporting
(experimental) Include "AWS::CDK::Metadata" resource in synthesized templates.
public Nullable<bool> VersionReporting { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Stability: Experimental