Class: AWSCDK::CloudAssemblySchema::DeployOptions

Inherits:
DefaultCDKOptions
  • Object
show all
Defined in:
cloud_assembly_schema/deploy_options.rb

Overview

Options to use with cdk deploy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(all: nil, app: nil, asset_metadata: nil, ca_bundle_path: nil, color: nil, context: nil, debug: nil, ec2_creds: nil, ignore_errors: nil, json: nil, lookups: nil, notices: nil, output: nil, path_metadata: nil, profile: nil, proxy: nil, role_arn: nil, stacks: nil, staging: nil, strict: nil, trace: nil, verbose: nil, version_reporting: nil, change_set_name: nil, ci: nil, concurrency: nil, exclusively: nil, execute: nil, force: nil, notification_arns: nil, outputs_file: nil, parameters: nil, require_approval: nil, reuse_assets: nil, rollback: nil, toolkit_stack_name: nil, use_previous_parameters: nil) ⇒ DeployOptions

Returns a new instance of DeployOptions.

Parameters:

  • all (Boolean, nil) (defaults to: nil) —

    Deploy all stacks.

  • app (String, nil) (defaults to: nil) —

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

  • asset_metadata (Boolean, nil) (defaults to: nil) —

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

  • ca_bundle_path (String, nil) (defaults to: nil) —

    Path to CA certificate to use when validating HTTPS requests.

  • color (Boolean, nil) (defaults to: nil) —

    Show colors and other style from console output.

  • context (Hash{String => String}, nil) (defaults to: nil) —

    Additional context.

  • debug (Boolean, nil) (defaults to: nil) —

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

  • ec2_creds (Boolean, nil) (defaults to: nil) —

    Force trying to fetch EC2 instance credentials.

  • ignore_errors (Boolean, nil) (defaults to: nil) —

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

  • json (Boolean, nil) (defaults to: nil) —

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

  • lookups (Boolean, nil) (defaults to: nil) —

    Perform context lookups.

  • notices (Boolean, nil) (defaults to: nil) —

    Show relevant notices.

  • output (String, nil) (defaults to: nil) —

    Emits the synthesized cloud assembly into a directory.

  • path_metadata (Boolean, nil) (defaults to: nil) —

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

  • profile (String, nil) (defaults to: nil) —

    Use the indicated AWS profile as the default environment.

  • proxy (String, nil) (defaults to: nil) —

    Use the indicated proxy.

  • role_arn (String, nil) (defaults to: nil) —

    Role to pass to CloudFormation for deployment.

  • stacks (Array<String>, nil) (defaults to: nil) —

    List of stacks to deploy.

  • staging (Boolean, nil) (defaults to: nil) —

    Copy assets to the output directory.

  • strict (Boolean, nil) (defaults to: nil) —

    Do not construct stacks with warnings.

  • trace (Boolean, nil) (defaults to: nil) —

    Print trace for stack warnings.

  • verbose (Boolean, nil) (defaults to: nil) —

    show debug logs.

  • version_reporting (Boolean, nil) (defaults to: nil) —

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

  • change_set_name (String, nil) (defaults to: nil) —

    Optional name to use for the CloudFormation change set.

  • ci (Boolean, nil) (defaults to: nil) —

    Whether we are on a CI system.

  • concurrency (Numeric, nil) (defaults to: nil) —

    Deploy multiple stacks in parallel.

  • exclusively (Boolean, nil) (defaults to: nil) —

    Only perform action on the given stack.

  • execute (Boolean, nil) (defaults to: nil) —

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

  • force (Boolean, nil) (defaults to: nil) —

    Always deploy, even if templates are identical.

  • notification_arns (Array<String>, nil) (defaults to: nil) —

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

  • outputs_file (String, nil) (defaults to: nil) —

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

  • parameters (Hash{String => String}, nil) (defaults to: nil) —

    Additional parameters for CloudFormation at deploy time.

  • require_approval (AWSCDK::CloudAssemblySchema::RequireApproval, nil) (defaults to: nil) —

    What kind of security changes require approval.

  • reuse_assets (Array<String>, nil) (defaults to: nil) —

    Reuse the assets with the given asset IDs.

  • rollback (Boolean, nil) (defaults to: nil) —

    Rollback failed deployments.

  • toolkit_stack_name (String, nil) (defaults to: nil) —

    Name of the toolkit stack to use/deploy.

  • use_previous_parameters (Boolean, nil) (defaults to: nil) —

    Use previous values for unspecified parameters.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'cloud_assembly_schema/deploy_options.rb', line 44

def initialize(all: nil, app: nil, asset_metadata: nil, ca_bundle_path: nil, color: nil, context: nil, debug: nil, ec2_creds: nil, ignore_errors: nil, json: nil, lookups: nil, notices: nil, output: nil, path_metadata: nil, profile: nil, proxy: nil, role_arn: nil, stacks: nil, staging: nil, strict: nil, trace: nil, verbose: nil, version_reporting: nil, change_set_name: nil, ci: nil, concurrency: nil, exclusively: nil, execute: nil, force: nil, notification_arns: nil, outputs_file: nil, parameters: nil, require_approval: nil, reuse_assets: nil, rollback: nil, toolkit_stack_name: nil, use_previous_parameters: nil)
  @all = all
  Jsii::Type.check_type(@all, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "all") unless @all.nil?
  @app = app
  Jsii::Type.check_type(@app, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "app") unless @app.nil?
  @asset_metadata = asset_metadata
  Jsii::Type.check_type(@asset_metadata, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "assetMetadata") unless @asset_metadata.nil?
  @ca_bundle_path = ca_bundle_path
  Jsii::Type.check_type(@ca_bundle_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "caBundlePath") unless @ca_bundle_path.nil?
  @color = color
  Jsii::Type.check_type(@color, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "color") unless @color.nil?
  @context = context
  Jsii::Type.check_type(@context, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "context") unless @context.nil?
  @debug = debug
  Jsii::Type.check_type(@debug, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "debug") unless @debug.nil?
  @ec2_creds = ec2_creds
  Jsii::Type.check_type(@ec2_creds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "ec2Creds") unless @ec2_creds.nil?
  @ignore_errors = ignore_errors
  Jsii::Type.check_type(@ignore_errors, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "ignoreErrors") unless @ignore_errors.nil?
  @json = json
  Jsii::Type.check_type(@json, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "json") unless @json.nil?
  @lookups = lookups
  Jsii::Type.check_type(@lookups, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "lookups") unless @lookups.nil?
  @notices = notices
  Jsii::Type.check_type(@notices, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "notices") unless @notices.nil?
  @output = output
  Jsii::Type.check_type(@output, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "output") unless @output.nil?
  @path_metadata = path_metadata
  Jsii::Type.check_type(@path_metadata, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "pathMetadata") unless @path_metadata.nil?
  @profile = profile
  Jsii::Type.check_type(@profile, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "profile") unless @profile.nil?
  @proxy = proxy
  Jsii::Type.check_type(@proxy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "proxy") unless @proxy.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
  @stacks = stacks
  Jsii::Type.check_type(@stacks, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "stacks") unless @stacks.nil?
  @staging = staging
  Jsii::Type.check_type(@staging, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "staging") unless @staging.nil?
  @strict = strict
  Jsii::Type.check_type(@strict, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "strict") unless @strict.nil?
  @trace = trace
  Jsii::Type.check_type(@trace, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "trace") unless @trace.nil?
  @verbose = verbose
  Jsii::Type.check_type(@verbose, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "verbose") unless @verbose.nil?
  @version_reporting = version_reporting
  Jsii::Type.check_type(@version_reporting, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "versionReporting") unless @version_reporting.nil?
  @change_set_name = change_set_name
  Jsii::Type.check_type(@change_set_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "changeSetName") unless @change_set_name.nil?
  @ci = ci
  Jsii::Type.check_type(@ci, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "ci") unless @ci.nil?
  @concurrency = concurrency
  Jsii::Type.check_type(@concurrency, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "concurrency") unless @concurrency.nil?
  @exclusively = exclusively
  Jsii::Type.check_type(@exclusively, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "exclusively") unless @exclusively.nil?
  @execute = execute
  Jsii::Type.check_type(@execute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "execute") unless @execute.nil?
  @force = force
  Jsii::Type.check_type(@force, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "force") unless @force.nil?
  @notification_arns = notification_arns
  Jsii::Type.check_type(@notification_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "notificationArns") unless @notification_arns.nil?
  @outputs_file = outputs_file
  Jsii::Type.check_type(@outputs_file, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "outputsFile") unless @outputs_file.nil?
  @parameters = parameters
  Jsii::Type.check_type(@parameters, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "parameters") unless @parameters.nil?
  @require_approval = require_approval
  Jsii::Type.check_type(@require_approval, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5jbG91ZF9hc3NlbWJseV9zY2hlbWEuUmVxdWlyZUFwcHJvdmFsIn0=")), "requireApproval") unless @require_approval.nil?
  @reuse_assets = reuse_assets
  Jsii::Type.check_type(@reuse_assets, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "reuseAssets") unless @reuse_assets.nil?
  @rollback = rollback
  Jsii::Type.check_type(@rollback, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "rollback") unless @rollback.nil?
  @toolkit_stack_name = toolkit_stack_name
  Jsii::Type.check_type(@toolkit_stack_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "toolkitStackName") unless @toolkit_stack_name.nil?
  @use_previous_parameters = use_previous_parameters
  Jsii::Type.check_type(@use_previous_parameters, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "usePreviousParameters") unless @use_previous_parameters.nil?
end

Instance Attribute Details

#all ⇒ Boolean? (readonly)

Note:

Default: - false

Deploy all stacks.

Requried if stacks is not set

Returns:

  • (Boolean, nil) 


127
128
129
 
# File 'cloud_assembly_schema/deploy_options.rb', line 127

def all
  @all
end

#app ⇒ String? (readonly)

Note:

Default: - read from cdk.json

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

Returns:

  • (String, nil) 


132
133
134
 
# File 'cloud_assembly_schema/deploy_options.rb', line 132

def app
  @app
end

#asset_metadata ⇒ Boolean? (readonly)

Note:

Default: true

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

Returns:

  • (Boolean, nil) 


137
138
139
 
# File 'cloud_assembly_schema/deploy_options.rb', line 137

def asset_metadata
  @asset_metadata
end

#ca_bundle_path ⇒ String? (readonly)

Note:

Default: - read from AWS_CA_BUNDLE environment variable

Path to CA certificate to use when validating HTTPS requests.

Returns:

  • (String, nil) 


142
143
144
 
# File 'cloud_assembly_schema/deploy_options.rb', line 142

def ca_bundle_path
  @ca_bundle_path
end

#change_set_name ⇒ String? (readonly)

Note:

Default: - auto generate a name

Optional name to use for the CloudFormation change set.

If not provided, a name will be generated automatically.

Returns:

  • (String, nil) 


254
255
256
 
# File 'cloud_assembly_schema/deploy_options.rb', line 254

def change_set_name
  @change_set_name
end

#ci ⇒ Boolean? (readonly)

Note:

Default: false

Whether we are on a CI system.

Returns:

  • (Boolean, nil) 


259
260
261
 
# File 'cloud_assembly_schema/deploy_options.rb', line 259

def ci
  @ci
end

#color ⇒ Boolean? (readonly)

Note:

Default: true

Show colors and other style from console output.

Returns:

  • (Boolean, nil) 


147
148
149
 
# File 'cloud_assembly_schema/deploy_options.rb', line 147

def color
  @color
end

#concurrency ⇒ Numeric? (readonly)

Note:

Default: 1

Deploy multiple stacks in parallel.

Returns:

  • (Numeric, nil) 


264
265
266
 
# File 'cloud_assembly_schema/deploy_options.rb', line 264

def concurrency
  @concurrency
end

#context ⇒ Hash{String => String}? (readonly)

Note:

Default: - no additional context

Additional context.

Returns:

  • (Hash{String => String}, nil) 


152
153
154
 
# File 'cloud_assembly_schema/deploy_options.rb', line 152

def context
  @context
end

#debug ⇒ Boolean? (readonly)

Note:

Default: false

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

Returns:

  • (Boolean, nil) 


157
158
159
 
# File 'cloud_assembly_schema/deploy_options.rb', line 157

def debug
  @debug
end

#ec2_creds ⇒ Boolean? (readonly)

Note:

Default: - guess EC2 instance status

Force trying to fetch EC2 instance credentials.

Returns:

  • (Boolean, nil) 


162
163
164
 
# File 'cloud_assembly_schema/deploy_options.rb', line 162

def ec2_creds
  @ec2_creds
end

#exclusively ⇒ Boolean? (readonly)

Note:

Default: false

Only perform action on the given stack.

Returns:

  • (Boolean, nil) 


269
270
271
 
# File 'cloud_assembly_schema/deploy_options.rb', line 269

def exclusively
  @exclusively
end

#execute ⇒ Boolean? (readonly)

Note:

Default: true

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

Returns:

  • (Boolean, nil) 


274
275
276
 
# File 'cloud_assembly_schema/deploy_options.rb', line 274

def execute
  @execute
end

#force ⇒ Boolean? (readonly)

Note:

Default: false

Always deploy, even if templates are identical.

Returns:

  • (Boolean, nil) 


279
280
281
 
# File 'cloud_assembly_schema/deploy_options.rb', line 279

def force
  @force
end

#ignore_errors ⇒ Boolean? (readonly)

Note:

Default: false

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

Returns:

  • (Boolean, nil) 


167
168
169
 
# File 'cloud_assembly_schema/deploy_options.rb', line 167

def ignore_errors
  @ignore_errors
end

#json ⇒ Boolean? (readonly)

Note:

Default: false

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

Returns:

  • (Boolean, nil) 


172
173
174
 
# File 'cloud_assembly_schema/deploy_options.rb', line 172

def json
  @json
end

#lookups ⇒ Boolean? (readonly)

Note:

Default: true

Perform context lookups.

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

Returns:

  • (Boolean, nil) 


180
181
182
 
# File 'cloud_assembly_schema/deploy_options.rb', line 180

def lookups
  @lookups
end

#notices ⇒ Boolean? (readonly)

Note:

Default: true

Show relevant notices.

Returns:

  • (Boolean, nil) 


185
186
187
 
# File 'cloud_assembly_schema/deploy_options.rb', line 185

def notices
  @notices
end

#notification_arns ⇒ Array<String>? (readonly)

Note:

Default: - no notifications

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

Returns:

  • (Array<String>, nil) 


284
285
286
 
# File 'cloud_assembly_schema/deploy_options.rb', line 284

def notification_arns
  @notification_arns
end

#output ⇒ String? (readonly)

Note:

Default: cdk.out

Emits the synthesized cloud assembly into a directory.

Returns:

  • (String, nil) 


190
191
192
 
# File 'cloud_assembly_schema/deploy_options.rb', line 190

def output
  @output
end

#outputs_file ⇒ String? (readonly)

Note:

Default: - Outputs are not written to any file

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

Returns:

  • (String, nil) 


289
290
291
 
# File 'cloud_assembly_schema/deploy_options.rb', line 289

def outputs_file
  @outputs_file
end

#parameters ⇒ Hash{String => String}? (readonly)

Note:

Default: {}

Additional parameters for CloudFormation at deploy time.

Returns:

  • (Hash{String => String}, nil) 


294
295
296
 
# File 'cloud_assembly_schema/deploy_options.rb', line 294

def parameters
  @parameters
end

#path_metadata ⇒ Boolean? (readonly)

Note:

Default: true

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

Returns:

  • (Boolean, nil) 


195
196
197
 
# File 'cloud_assembly_schema/deploy_options.rb', line 195

def path_metadata
  @path_metadata
end

#profile ⇒ String? (readonly)

Note:

Default: - no profile is used

Use the indicated AWS profile as the default environment.

Returns:

  • (String, nil) 


200
201
202
 
# File 'cloud_assembly_schema/deploy_options.rb', line 200

def profile
  @profile
end

#proxy ⇒ String? (readonly)

Note:

Default: - no proxy

Use the indicated proxy.

Will read from HTTPS_PROXY environment if specified

Returns:

  • (String, nil) 


208
209
210
 
# File 'cloud_assembly_schema/deploy_options.rb', line 208

def proxy
  @proxy
end

#require_approval ⇒ AWSCDK::CloudAssemblySchema::RequireApproval? (readonly)

Note:

Default: RequireApproval.NEVER

What kind of security changes require approval.

Returns:



299
300
301
 
# File 'cloud_assembly_schema/deploy_options.rb', line 299

def require_approval
  @require_approval
end

#reuse_assets ⇒ Array<String>? (readonly)

Note:

Default: - do not reuse assets

Reuse the assets with the given asset IDs.

Returns:

  • (Array<String>, nil) 


304
305
306
 
# File 'cloud_assembly_schema/deploy_options.rb', line 304

def reuse_assets
  @reuse_assets
end

#role_arn ⇒ String? (readonly)

Note:

Default: - use the bootstrap cfn-exec role

Role to pass to CloudFormation for deployment.

Returns:

  • (String, nil) 


213
214
215
 
# File 'cloud_assembly_schema/deploy_options.rb', line 213

def role_arn
  @role_arn
end

#rollback ⇒ Boolean? (readonly)

Note:

Default: true

Rollback failed deployments.

Returns:

  • (Boolean, nil) 


309
310
311
 
# File 'cloud_assembly_schema/deploy_options.rb', line 309

def rollback
  @rollback
end

#stacks ⇒ Array<String>? (readonly)

Note:

Default: - []

List of stacks to deploy.

Requried if all is not set

Returns:

  • (Array<String>, nil) 


220
221
222
 
# File 'cloud_assembly_schema/deploy_options.rb', line 220

def stacks
  @stacks
end

#staging ⇒ Boolean? (readonly)

Note:

Default: false

Copy assets to the output directory.

Needed for local debugging the source files with SAM CLI

Returns:

  • (Boolean, nil) 


227
228
229
 
# File 'cloud_assembly_schema/deploy_options.rb', line 227

def staging
  @staging
end

#strict ⇒ Boolean? (readonly)

Note:

Default: false

Do not construct stacks with warnings.

Returns:

  • (Boolean, nil) 


232
233
234
 
# File 'cloud_assembly_schema/deploy_options.rb', line 232

def strict
  @strict
end

#toolkit_stack_name ⇒ String? (readonly)

Note:

Default: CDKToolkit

Name of the toolkit stack to use/deploy.

Returns:

  • (String, nil) 


314
315
316
 
# File 'cloud_assembly_schema/deploy_options.rb', line 314

def toolkit_stack_name
  @toolkit_stack_name
end

#trace ⇒ Boolean? (readonly)

Note:

Default: false

Print trace for stack warnings.

Returns:

  • (Boolean, nil) 


237
238
239
 
# File 'cloud_assembly_schema/deploy_options.rb', line 237

def trace
  @trace
end

#use_previous_parameters ⇒ Boolean? (readonly)

Note:

Default: true

Use previous values for unspecified parameters.

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

Returns:

  • (Boolean, nil) 


321
322
323
 
# File 'cloud_assembly_schema/deploy_options.rb', line 321

def use_previous_parameters
  @use_previous_parameters
end

#verbose ⇒ Boolean? (readonly)

Note:

Default: false

show debug logs.

Returns:

  • (Boolean, nil) 


242
243
244
 
# File 'cloud_assembly_schema/deploy_options.rb', line 242

def verbose
  @verbose
end

#version_reporting ⇒ Boolean? (readonly)

Note:

Default: true

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

Returns:

  • (Boolean, nil) 


247
248
249
 
# File 'cloud_assembly_schema/deploy_options.rb', line 247

def version_reporting
  @version_reporting
end

Class Method Details

.jsii_properties ⇒ Object 



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'cloud_assembly_schema/deploy_options.rb', line 323

def self.jsii_properties
  {
    :all => "all",
    :app => "app",
    :asset_metadata => "assetMetadata",
    :ca_bundle_path => "caBundlePath",
    :color => "color",
    :context => "context",
    :debug => "debug",
    :ec2_creds => "ec2Creds",
    :ignore_errors => "ignoreErrors",
    :json => "json",
    :lookups => "lookups",
    :notices => "notices",
    :output => "output",
    :path_metadata => "pathMetadata",
    :profile => "profile",
    :proxy => "proxy",
    :role_arn => "roleArn",
    :stacks => "stacks",
    :staging => "staging",
    :strict => "strict",
    :trace => "trace",
    :verbose => "verbose",
    :version_reporting => "versionReporting",
    :change_set_name => "changeSetName",
    :ci => "ci",
    :concurrency => "concurrency",
    :exclusively => "exclusively",
    :execute => "execute",
    :force => "force",
    :notification_arns => "notificationArns",
    :outputs_file => "outputsFile",
    :parameters => "parameters",
    :require_approval => "requireApproval",
    :reuse_assets => "reuseAssets",
    :rollback => "rollback",
    :toolkit_stack_name => "toolkitStackName",
    :use_previous_parameters => "usePreviousParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'cloud_assembly_schema/deploy_options.rb', line 365

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "all" => @all,
    "app" => @app,
    "assetMetadata" => @asset_metadata,
    "caBundlePath" => @ca_bundle_path,
    "color" => @color,
    "context" => @context,
    "debug" => @debug,
    "ec2Creds" => @ec2_creds,
    "ignoreErrors" => @ignore_errors,
    "json" => @json,
    "lookups" => @lookups,
    "notices" => @notices,
    "output" => @output,
    "pathMetadata" => @path_metadata,
    "profile" => @profile,
    "proxy" => @proxy,
    "roleArn" => @role_arn,
    "stacks" => @stacks,
    "staging" => @staging,
    "strict" => @strict,
    "trace" => @trace,
    "verbose" => @verbose,
    "versionReporting" => @version_reporting,
    "changeSetName" => @change_set_name,
    "ci" => @ci,
    "concurrency" => @concurrency,
    "exclusively" => @exclusively,
    "execute" => @execute,
    "force" => @force,
    "notificationArns" => @notification_arns,
    "outputsFile" => @outputs_file,
    "parameters" => @parameters,
    "requireApproval" => @require_approval,
    "reuseAssets" => @reuse_assets,
    "rollback" => @rollback,
    "toolkitStackName" => @toolkit_stack_name,
    "usePreviousParameters" => @use_previous_parameters,
  })
  result.compact
end