Package software.amazon.awscdk.cloud_assembly_schema

Class DeployOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cloud_assembly_schema.DeployOptions.Jsii$Proxy

All Implemented Interfaces:

DefaultCdkOptions, DeployOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

DeployOptions

@Stability(Stable)
@Internal
public static final class DeployOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements DeployOptions

An implementation for DeployOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cloud_assembly_schema.DeployOptions

DeployOptions.Builder, DeployOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(DeployOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the DeployOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Boolean	getAll()	Deploy all stacks.
final String	getApp()	command-line for executing your app or a cloud assembly directory e.g.
final Boolean	getAssetMetadata()	Include "aws:asset:*" CloudFormation metadata for resources that use assets.
final String	getCaBundlePath()	Path to CA certificate to use when validating HTTPS requests.
final String	getChangeSetName()	Optional name to use for the CloudFormation change set.
final Boolean	getCi()	Whether we are on a CI system.
final Boolean	getColor()	Show colors and other style from console output.
final Number	getConcurrency()	Deploy multiple stacks in parallel.
final Map<String,String>	getContext()	Additional context.
final Boolean	getDebug()	enable emission of additional debugging information, such as creation stack traces of tokens.
final Boolean	getEc2Creds()	Force trying to fetch EC2 instance credentials.
final Boolean	getExclusively()	Only perform action on the given stack.
final Boolean	getExecute()	Whether to execute the ChangeSet Not providing execute parameter will result in execution of ChangeSet.
final Boolean	getForce()	Always deploy, even if templates are identical.
final Boolean	getIgnoreErrors()	Ignores synthesis errors, which will likely produce an invalid output.
final Boolean	getJson()	Use JSON output instead of YAML when templates are printed to STDOUT.
final Boolean	getLookups()	Perform context lookups.
final Boolean	getNotices()	Show relevant notices.
final List<String>	getNotificationArns()	ARNs of SNS topics that CloudFormation will notify with stack related events.
final String	getOutput()	Emits the synthesized cloud assembly into a directory.
final String	getOutputsFile()	Path to file where stack outputs will be written after a successful deploy as JSON.
final Map<String,String>	getParameters()	Additional parameters for CloudFormation at deploy time.
final Boolean	getPathMetadata()	Include "aws:cdk:path" CloudFormation metadata for each resource.
final String	getProfile()	Use the indicated AWS profile as the default environment.
final String	getProxy()	Use the indicated proxy.
final RequireApproval	getRequireApproval()	What kind of security changes require approval.
final List<String>	getReuseAssets()	Reuse the assets with the given asset IDs.
final String	getRoleArn()	Role to pass to CloudFormation for deployment.
final Boolean	getRollback()	Rollback failed deployments.
final List<String>	getStacks()	List of stacks to deploy.
final Boolean	getStaging()	Copy assets to the output directory.
final Boolean	getStrict()	Do not construct stacks with warnings.
final String	getToolkitStackName()	Name of the toolkit stack to use/deploy.
final Boolean	getTrace()	Print trace for stack warnings.
final Boolean	getUsePreviousParameters()	Use previous values for unspecified parameters.
final Boolean	getVerbose()	show debug logs.
final Boolean	getVersionReporting()	Include "AWS::CDK::Metadata" resource in synthesized templates.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(DeployOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the DeployOptions.Builder.

Method Details

getChangeSetName

public final String getChangeSetName()

Description copied from interface: DeployOptions

Optional name to use for the CloudFormation change set.

If not provided, a name will be generated automatically.

Default: - auto generate a name

Specified by:

getChangeSetName in interface DeployOptions

getCi

public final Boolean getCi()

Description copied from interface: DeployOptions

Whether we are on a CI system.

Default: false

Specified by:

getCi in interface DeployOptions

getConcurrency

public final Number getConcurrency()

Description copied from interface: DeployOptions

Deploy multiple stacks in parallel.

Default: 1

Specified by:

getConcurrency in interface DeployOptions

getExclusively

public final Boolean getExclusively()

Description copied from interface: DeployOptions

Only perform action on the given stack.

Default: false

Specified by:

getExclusively in interface DeployOptions

getExecute

public final Boolean getExecute()

Description copied from interface: DeployOptions

Whether to execute the ChangeSet Not providing execute parameter will result in execution of ChangeSet.

Default: true

Specified by:

getExecute in interface DeployOptions

getForce

public final Boolean getForce()

Description copied from interface: DeployOptions

Always deploy, even if templates are identical.

Default: false

Specified by:

getForce in interface DeployOptions

getNotificationArns

public final List<String> getNotificationArns()

Description copied from interface: DeployOptions

ARNs of SNS topics that CloudFormation will notify with stack related events.

Default: - no notifications

Specified by:

getNotificationArns in interface DeployOptions

getOutputsFile

public final String getOutputsFile()

Description copied from interface: DeployOptions

Path to file where stack outputs will be written after a successful deploy as JSON.

Default: - Outputs are not written to any file

Specified by:

getOutputsFile in interface DeployOptions

getParameters

public final Map<String,String> getParameters()

Description copied from interface: DeployOptions

Additional parameters for CloudFormation at deploy time.

Default: {}

Specified by:

getParameters in interface DeployOptions

getRequireApproval

public final RequireApproval getRequireApproval()

Description copied from interface: DeployOptions

What kind of security changes require approval.

Default: RequireApproval.NEVER

Specified by:

getRequireApproval in interface DeployOptions

getReuseAssets

public final List<String> getReuseAssets()

Description copied from interface: DeployOptions

Reuse the assets with the given asset IDs.

Default: - do not reuse assets

Specified by:

getReuseAssets in interface DeployOptions

getRollback

public final Boolean getRollback()

Description copied from interface: DeployOptions

Rollback failed deployments.

Default: true

Specified by:

getRollback in interface DeployOptions

getToolkitStackName

public final String getToolkitStackName()

Description copied from interface: DeployOptions

Name of the toolkit stack to use/deploy.

Default: CDKToolkit

Specified by:

getToolkitStackName in interface DeployOptions

getUsePreviousParameters

public final Boolean getUsePreviousParameters()

Description copied from interface: DeployOptions

Use previous values for unspecified parameters.

If not set, all parameters must be specified for every deployment.

Default: true

Specified by:

getUsePreviousParameters in interface DeployOptions

getAll

public final Boolean getAll()

Description copied from interface: DefaultCdkOptions

Deploy all stacks.

Requried if stacks is not set

Default: - false

Specified by:

getAll in interface DefaultCdkOptions

getApp

public final String getApp()

Description copied from interface: DefaultCdkOptions

command-line for executing your app or a cloud assembly directory e.g. "node bin/my-app.js" or "cdk.out".

Default: - read from cdk.json

Specified by:

getApp in interface DefaultCdkOptions

getAssetMetadata

public final Boolean getAssetMetadata()

Description copied from interface: DefaultCdkOptions

Include "aws:asset:*" CloudFormation metadata for resources that use assets.

Default: true

Specified by:

getAssetMetadata in interface DefaultCdkOptions

getCaBundlePath

public final String getCaBundlePath()

Description copied from interface: DefaultCdkOptions

Path to CA certificate to use when validating HTTPS requests.

Default: - read from AWS_CA_BUNDLE environment variable

Specified by:

getCaBundlePath in interface DefaultCdkOptions

getColor

public final Boolean getColor()

Description copied from interface: DefaultCdkOptions

Show colors and other style from console output.

Default: true

Specified by:

getColor in interface DefaultCdkOptions

getContext

public final Map<String,String> getContext()

Description copied from interface: DefaultCdkOptions

Additional context.

Default: - no additional context

Specified by:

getContext in interface DefaultCdkOptions

getDebug

public final Boolean getDebug()

Description copied from interface: DefaultCdkOptions

enable emission of additional debugging information, such as creation stack traces of tokens.

Default: false

Specified by:

getDebug in interface DefaultCdkOptions

getEc2Creds

public final Boolean getEc2Creds()

Description copied from interface: DefaultCdkOptions

Force trying to fetch EC2 instance credentials.

Default: - guess EC2 instance status

Specified by:

getEc2Creds in interface DefaultCdkOptions

getIgnoreErrors

public final Boolean getIgnoreErrors()

Description copied from interface: DefaultCdkOptions

Ignores synthesis errors, which will likely produce an invalid output.

Default: false

Specified by:

getIgnoreErrors in interface DefaultCdkOptions

getJson

public final Boolean getJson()

Description copied from interface: DefaultCdkOptions

Use JSON output instead of YAML when templates are printed to STDOUT.

Default: false

Specified by:

getJson in interface DefaultCdkOptions

getLookups

public final Boolean getLookups()

Description copied from interface: DefaultCdkOptions

Perform context lookups.

Synthesis fails if this is disabled and context lookups need to be performed

Default: true

Specified by:

getLookups in interface DefaultCdkOptions

getNotices

public final Boolean getNotices()

Description copied from interface: DefaultCdkOptions

Show relevant notices.

Default: true

Specified by:

getNotices in interface DefaultCdkOptions

getOutput

public final String getOutput()

Description copied from interface: DefaultCdkOptions

Emits the synthesized cloud assembly into a directory.

Default: cdk.out

Specified by:

getOutput in interface DefaultCdkOptions

getPathMetadata

public final Boolean getPathMetadata()

Description copied from interface: DefaultCdkOptions

Include "aws:cdk:path" CloudFormation metadata for each resource.

Default: true

Specified by:

getPathMetadata in interface DefaultCdkOptions

getProfile

public final String getProfile()

Description copied from interface: DefaultCdkOptions

Use the indicated AWS profile as the default environment.

Default: - no profile is used

Specified by:

getProfile in interface DefaultCdkOptions

getProxy

public final String getProxy()

Description copied from interface: DefaultCdkOptions

Use the indicated proxy.

Will read from HTTPS_PROXY environment if specified

Default: - no proxy

Specified by:

getProxy in interface DefaultCdkOptions

getRoleArn

public final String getRoleArn()

Description copied from interface: DefaultCdkOptions

Role to pass to CloudFormation for deployment.

Default: - use the bootstrap cfn-exec role

Specified by:

getRoleArn in interface DefaultCdkOptions

getStacks

public final List<String> getStacks()

Description copied from interface: DefaultCdkOptions

List of stacks to deploy.

Requried if all is not set

Default: - []

Specified by:

getStacks in interface DefaultCdkOptions

getStaging

public final Boolean getStaging()

Description copied from interface: DefaultCdkOptions

Copy assets to the output directory.

Needed for local debugging the source files with SAM CLI

Default: false

Specified by:

getStaging in interface DefaultCdkOptions

getStrict

public final Boolean getStrict()

Description copied from interface: DefaultCdkOptions

Do not construct stacks with warnings.

Default: false

Specified by:

getStrict in interface DefaultCdkOptions

getTrace

public final Boolean getTrace()

Description copied from interface: DefaultCdkOptions

Print trace for stack warnings.

Default: false

Specified by:

getTrace in interface DefaultCdkOptions

getVerbose

public final Boolean getVerbose()

Description copied from interface: DefaultCdkOptions

show debug logs.

Default: false

Specified by:

getVerbose in interface DefaultCdkOptions

getVersionReporting

public final Boolean getVersionReporting()

Description copied from interface: DefaultCdkOptions

Include "AWS::CDK::Metadata" resource in synthesized templates.

Default: true

Specified by:

getVersionReporting in interface DefaultCdkOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object