Class DeployOptions.Jsii$Proxy
- java.lang.Object
-
- software.amazon.jsii.JsiiObject
-
- software.amazon.awscdk.cloudassembly.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 forDeployOptions
-
-
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.cloudassembly.schema.DeployOptions
DeployOptions.Builder, DeployOptions.Jsii$Proxy
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedJsii$Proxy(DeployOptions.Builder builder)Constructor that initializes the object based on literal property values passed by theDeployOptions.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)Constructor that initializes the object based on values retrieved from the JsiiObject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.fasterxml.jackson.databind.JsonNode$jsii$toJson()booleanequals(Object o)BooleangetAll()Deploy all stacks.StringgetApp()command-line for executing your app or a cloud assembly directory e.g.BooleangetAssetMetadata()Include "aws:asset:*" CloudFormation metadata for resources that use assets.StringgetCaBundlePath()Path to CA certificate to use when validating HTTPS requests.StringgetChangeSetName()Optional name to use for the CloudFormation change set.BooleangetCi()Whether we are on a CI system.BooleangetColor()Show colors and other style from console output.NumbergetConcurrency()Deploy multiple stacks in parallel.Map<String,String>getContext()Additional context.BooleangetDebug()enable emission of additional debugging information, such as creation stack traces of tokens.BooleangetEc2Creds()Force trying to fetch EC2 instance credentials.BooleangetExclusively()Only perform action on the given stack.BooleangetExecute()Whether to execute the ChangeSet Not providingexecuteparameter will result in execution of ChangeSet.BooleangetForce()Always deploy, even if templates are identical.BooleangetIgnoreErrors()Ignores synthesis errors, which will likely produce an invalid output.BooleangetJson()Use JSON output instead of YAML when templates are printed to STDOUT.BooleangetLookups()Perform context lookups.BooleangetNotices()Show relevant notices.List<String>getNotificationArns()ARNs of SNS topics that CloudFormation will notify with stack related events.StringgetOutput()Emits the synthesized cloud assembly into a directory.StringgetOutputsFile()Path to file where stack outputs will be written after a successful deploy as JSON.Map<String,String>getParameters()Additional parameters for CloudFormation at deploy time.BooleangetPathMetadata()Include "aws:cdk:path" CloudFormation metadata for each resource.StringgetProfile()Use the indicated AWS profile as the default environment.StringgetProxy()Use the indicated proxy.RequireApprovalgetRequireApproval()What kind of security changes require approval.List<String>getReuseAssets()Reuse the assets with the given asset IDs.StringgetRoleArn()Role to pass to CloudFormation for deployment.BooleangetRollback()Rollback failed deployments.List<String>getStacks()List of stacks to deploy.BooleangetStaging()Copy assets to the output directory.BooleangetStrict()Do not construct stacks with warnings.StringgetToolkitStackName()Name of the toolkit stack to use/deploy.BooleangetTrace()Print trace for stack warnings.BooleangetUsePreviousParameters()Use previous values for unspecified parameters.BooleangetVerbose()show debug logs.BooleangetVersionReporting()Include "AWS::CDK::Metadata" resource in synthesized templates.inthashCode()
-
-
-
Constructor Detail
-
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 theDeployOptions.Builder.
-
-
Method Detail
-
getChangeSetName
public final String getChangeSetName()
Description copied from interface:DeployOptionsOptional name to use for the CloudFormation change set.If not provided, a name will be generated automatically.
Default: - auto generate a name
- Specified by:
getChangeSetNamein interfaceDeployOptions
-
getCi
public final Boolean getCi()
Description copied from interface:DeployOptionsWhether we are on a CI system.Default: false
- Specified by:
getCiin interfaceDeployOptions
-
getConcurrency
public final Number getConcurrency()
Description copied from interface:DeployOptionsDeploy multiple stacks in parallel.Default: 1
- Specified by:
getConcurrencyin interfaceDeployOptions
-
getExclusively
public final Boolean getExclusively()
Description copied from interface:DeployOptionsOnly perform action on the given stack.Default: false
- Specified by:
getExclusivelyin interfaceDeployOptions
-
getExecute
public final Boolean getExecute()
Description copied from interface:DeployOptionsWhether to execute the ChangeSet Not providingexecuteparameter will result in execution of ChangeSet.Default: true
- Specified by:
getExecutein interfaceDeployOptions
-
getForce
public final Boolean getForce()
Description copied from interface:DeployOptionsAlways deploy, even if templates are identical.Default: false
- Specified by:
getForcein interfaceDeployOptions
-
getNotificationArns
public final List<String> getNotificationArns()
Description copied from interface:DeployOptionsARNs of SNS topics that CloudFormation will notify with stack related events.Default: - no notifications
- Specified by:
getNotificationArnsin interfaceDeployOptions
-
getOutputsFile
public final String getOutputsFile()
Description copied from interface:DeployOptionsPath to file where stack outputs will be written after a successful deploy as JSON.Default: - Outputs are not written to any file
- Specified by:
getOutputsFilein interfaceDeployOptions
-
getParameters
public final Map<String,String> getParameters()
Description copied from interface:DeployOptionsAdditional parameters for CloudFormation at deploy time.Default: {}
- Specified by:
getParametersin interfaceDeployOptions
-
getRequireApproval
public final RequireApproval getRequireApproval()
Description copied from interface:DeployOptionsWhat kind of security changes require approval.Default: RequireApproval.NEVER
- Specified by:
getRequireApprovalin interfaceDeployOptions
-
getReuseAssets
public final List<String> getReuseAssets()
Description copied from interface:DeployOptionsReuse the assets with the given asset IDs.Default: - do not reuse assets
- Specified by:
getReuseAssetsin interfaceDeployOptions
-
getRollback
public final Boolean getRollback()
Description copied from interface:DeployOptionsRollback failed deployments.Default: true
- Specified by:
getRollbackin interfaceDeployOptions
-
getToolkitStackName
public final String getToolkitStackName()
Description copied from interface:DeployOptionsName of the toolkit stack to use/deploy.Default: CDKToolkit
- Specified by:
getToolkitStackNamein interfaceDeployOptions
-
getUsePreviousParameters
public final Boolean getUsePreviousParameters()
Description copied from interface:DeployOptionsUse previous values for unspecified parameters.If not set, all parameters must be specified for every deployment.
Default: true
- Specified by:
getUsePreviousParametersin interfaceDeployOptions
-
getAll
public final Boolean getAll()
Description copied from interface:DefaultCdkOptionsDeploy all stacks.Requried if
stacksis not setDefault: - false
- Specified by:
getAllin interfaceDefaultCdkOptions
-
getApp
public final String getApp()
Description copied from interface:DefaultCdkOptionscommand-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:
getAppin interfaceDefaultCdkOptions
-
getAssetMetadata
public final Boolean getAssetMetadata()
Description copied from interface:DefaultCdkOptionsInclude "aws:asset:*" CloudFormation metadata for resources that use assets.Default: true
- Specified by:
getAssetMetadatain interfaceDefaultCdkOptions
-
getCaBundlePath
public final String getCaBundlePath()
Description copied from interface:DefaultCdkOptionsPath to CA certificate to use when validating HTTPS requests.Default: - read from AWS_CA_BUNDLE environment variable
- Specified by:
getCaBundlePathin interfaceDefaultCdkOptions
-
getColor
public final Boolean getColor()
Description copied from interface:DefaultCdkOptionsShow colors and other style from console output.Default: true
- Specified by:
getColorin interfaceDefaultCdkOptions
-
getContext
public final Map<String,String> getContext()
Description copied from interface:DefaultCdkOptionsAdditional context.Default: - no additional context
- Specified by:
getContextin interfaceDefaultCdkOptions
-
getDebug
public final Boolean getDebug()
Description copied from interface:DefaultCdkOptionsenable emission of additional debugging information, such as creation stack traces of tokens.Default: false
- Specified by:
getDebugin interfaceDefaultCdkOptions
-
getEc2Creds
public final Boolean getEc2Creds()
Description copied from interface:DefaultCdkOptionsForce trying to fetch EC2 instance credentials.Default: - guess EC2 instance status
- Specified by:
getEc2Credsin interfaceDefaultCdkOptions
-
getIgnoreErrors
public final Boolean getIgnoreErrors()
Description copied from interface:DefaultCdkOptionsIgnores synthesis errors, which will likely produce an invalid output.Default: false
- Specified by:
getIgnoreErrorsin interfaceDefaultCdkOptions
-
getJson
public final Boolean getJson()
Description copied from interface:DefaultCdkOptionsUse JSON output instead of YAML when templates are printed to STDOUT.Default: false
- Specified by:
getJsonin interfaceDefaultCdkOptions
-
getLookups
public final Boolean getLookups()
Description copied from interface:DefaultCdkOptionsPerform context lookups.Synthesis fails if this is disabled and context lookups need to be performed
Default: true
- Specified by:
getLookupsin interfaceDefaultCdkOptions
-
getNotices
public final Boolean getNotices()
Description copied from interface:DefaultCdkOptionsShow relevant notices.Default: true
- Specified by:
getNoticesin interfaceDefaultCdkOptions
-
getOutput
public final String getOutput()
Description copied from interface:DefaultCdkOptionsEmits the synthesized cloud assembly into a directory.Default: cdk.out
- Specified by:
getOutputin interfaceDefaultCdkOptions
-
getPathMetadata
public final Boolean getPathMetadata()
Description copied from interface:DefaultCdkOptionsInclude "aws:cdk:path" CloudFormation metadata for each resource.Default: true
- Specified by:
getPathMetadatain interfaceDefaultCdkOptions
-
getProfile
public final String getProfile()
Description copied from interface:DefaultCdkOptionsUse the indicated AWS profile as the default environment.Default: - no profile is used
- Specified by:
getProfilein interfaceDefaultCdkOptions
-
getProxy
public final String getProxy()
Description copied from interface:DefaultCdkOptionsUse the indicated proxy.Will read from HTTPS_PROXY environment if specified
Default: - no proxy
- Specified by:
getProxyin interfaceDefaultCdkOptions
-
getRoleArn
public final String getRoleArn()
Description copied from interface:DefaultCdkOptionsRole to pass to CloudFormation for deployment.Default: - use the bootstrap cfn-exec role
- Specified by:
getRoleArnin interfaceDefaultCdkOptions
-
getStacks
public final List<String> getStacks()
Description copied from interface:DefaultCdkOptionsList of stacks to deploy.Requried if
allis not setDefault: - []
- Specified by:
getStacksin interfaceDefaultCdkOptions
-
getStaging
public final Boolean getStaging()
Description copied from interface:DefaultCdkOptionsCopy assets to the output directory.Needed for local debugging the source files with SAM CLI
Default: false
- Specified by:
getStagingin interfaceDefaultCdkOptions
-
getStrict
public final Boolean getStrict()
Description copied from interface:DefaultCdkOptionsDo not construct stacks with warnings.Default: false
- Specified by:
getStrictin interfaceDefaultCdkOptions
-
getTrace
public final Boolean getTrace()
Description copied from interface:DefaultCdkOptionsPrint trace for stack warnings.Default: false
- Specified by:
getTracein interfaceDefaultCdkOptions
-
getVerbose
public final Boolean getVerbose()
Description copied from interface:DefaultCdkOptionsshow debug logs.Default: false
- Specified by:
getVerbosein interfaceDefaultCdkOptions
-
getVersionReporting
public final Boolean getVersionReporting()
Description copied from interface:DefaultCdkOptionsInclude "AWS::CDK::Metadata" resource in synthesized templates.Default: true
- Specified by:
getVersionReportingin interfaceDefaultCdkOptions
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
-