Class: AWSCDK::StackProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
stack_props.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(analytics_reporting: nil, cross_region_references: nil, description: nil, env: nil, notification_arns: nil, permissions_boundary: nil, property_injectors: nil, stack_name: nil, suppress_template_indentation: nil, synthesizer: nil, tags: nil, termination_protection: nil) ⇒ StackProps

Returns a new instance of StackProps.

Parameters:

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

    Include runtime versioning information in this Stack.

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

    Enable this flag to allow native cross region stack references.

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

    A description of the stack.

  • env (AWSCDK::Environment, nil) (defaults to: nil) —

    The AWS environment (account/region) where this stack will be deployed.

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

    SNS Topic ARNs that will receive stack events.

  • permissions_boundary (AWSCDK::PermissionsBoundary, nil) (defaults to: nil) —

    Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.

  • property_injectors (Array<AWSCDK::IPropertyInjector>, nil) (defaults to: nil) —

    A list of IPropertyInjector attached to this Stack.

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

    Name to deploy the stack with.

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

    Enable this flag to suppress indentation in generated CloudFormation templates.

  • synthesizer (AWSCDK::IStackSynthesizer, nil) (defaults to: nil) —

    Synthesis method to use while deploying this stack.

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

    Tags that will be applied to the Stack.

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

    Whether to enable termination protection for this stack.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'stack_props.rb', line 18

def initialize(analytics_reporting: nil, cross_region_references: nil, description: nil, env: nil, notification_arns: nil, permissions_boundary: nil, property_injectors: nil, stack_name: nil, suppress_template_indentation: nil, synthesizer: nil, tags: nil, termination_protection: nil)
  @analytics_reporting = analytics_reporting
  Jsii::Type.check_type(@analytics_reporting, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "analyticsReporting") unless @analytics_reporting.nil?
  @cross_region_references = cross_region_references
  Jsii::Type.check_type(@cross_region_references, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "crossRegionReferences") unless @cross_region_references.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @env = env.is_a?(Hash) ? ::AWSCDK::Environment.new(**env.transform_keys(&:to_sym)) : env
  Jsii::Type.check_type(@env, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5FbnZpcm9ubWVudCJ9")), "env") unless @env.nil?
  @notification_arns = notification_arns
  Jsii::Type.check_type(@notification_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "notificationArns") unless @notification_arns.nil?
  @permissions_boundary = permissions_boundary
  Jsii::Type.check_type(@permissions_boundary, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5QZXJtaXNzaW9uc0JvdW5kYXJ5In0=")), "permissionsBoundary") unless @permissions_boundary.nil?
  @property_injectors = property_injectors
  Jsii::Type.check_type(@property_injectors, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLklQcm9wZXJ0eUluamVjdG9yIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "propertyInjectors") unless @property_injectors.nil?
  @stack_name = stack_name
  Jsii::Type.check_type(@stack_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stackName") unless @stack_name.nil?
  @suppress_template_indentation = suppress_template_indentation
  Jsii::Type.check_type(@suppress_template_indentation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "suppressTemplateIndentation") unless @suppress_template_indentation.nil?
  @synthesizer = synthesizer
  Jsii::Type.check_type(@synthesizer, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5JU3RhY2tTeW50aGVzaXplciJ9")), "synthesizer") unless @synthesizer.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
  @termination_protection = termination_protection
  Jsii::Type.check_type(@termination_protection, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "terminationProtection") unless @termination_protection.nil?
end

Instance Attribute Details

#analytics_reporting ⇒ Boolean? (readonly)

Note:

Default: analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

Include runtime versioning information in this Stack.

Returns:

  • (Boolean, nil) 


49
50
51
 
# File 'stack_props.rb', line 49

def analytics_reporting
  @analytics_reporting
end

#cross_region_references ⇒ Boolean? (readonly)

Note:

Default: false

Enable this flag to allow native cross region stack references.

Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

This feature is currently experimental

Returns:

  • (Boolean, nil) 


59
60
61
 
# File 'stack_props.rb', line 59

def cross_region_references
  @cross_region_references
end

#description ⇒ String? (readonly)

Note:

Default: - No description.

A description of the stack.

Returns:

  • (String, nil) 


64
65
66
 
# File 'stack_props.rb', line 64

def description
  @description
end

#env ⇒ AWSCDK::Environment? (readonly)

Note:

Default: - The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.

The AWS environment (account/region) where this stack will be deployed.

Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).

If the Stack is instantiated inside a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there.

If either region or account are not set nor inherited from Stage, the Stack will be considered "environment-agnostic"". Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

Examples:

# Use a concrete account and region to deploy this stack to:
# `.account` and `.region` will simply return these values.
AWSCDK::Stack.new(app, "Stack1", {
    env: {
        account: "123456789012",
        region: "us-east-1",
    },
})

# Use the CLI's current credentials to determine the target environment:
# `.account` and `.region` will reflect the account+region the CLI
# is configured to use (based on the user CLI credentials)
AWSCDK::Stack.new(app, "Stack2", {
    env: {
        account: Process::Env::CDK_DEFAULT_ACCOUNT,
        region: Process::Env::CDK_DEFAULT_REGION,
    },
})

# Define multiple stacks stage associated with an environment
my_stage = AWSCDK::Stage.new(app, "MyStage", {
    env: {
        account: "123456789012",
        region: "us-east-1",
    },
})

# both of these stacks will use the stage's account/region:
# `.account` and `.region` will resolve to the concrete values as above
MyStack.new(my_stage, "Stack1")
YourStack.new(my_stage, "Stack2")

# Define an environment-agnostic stack:
# `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
# which will only resolve to actual values by CloudFormation during deployment.
MyStack.new(app, "Stack1")

Returns:



125
126
127
 
# File 'stack_props.rb', line 125

def env
  @env
end

#notification_arns ⇒ Array<String>? (readonly)

Note:

Default: - no notification arns.

SNS Topic ARNs that will receive stack events.

Returns:

  • (Array<String>, nil) 


130
131
132
 
# File 'stack_props.rb', line 130

def notification_arns
  @notification_arns
end

#permissions_boundary ⇒ AWSCDK::PermissionsBoundary? (readonly)

Note:

Default: - no permissions boundary is applied

Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.

Returns:



135
136
137
 
# File 'stack_props.rb', line 135

def permissions_boundary
  @permissions_boundary
end

#property_injectors ⇒ Array<AWSCDK::IPropertyInjector>? (readonly)

Note:

Default: - no PropertyInjectors

A list of IPropertyInjector attached to this Stack.

Returns:



140
141
142
 
# File 'stack_props.rb', line 140

def property_injectors
  @property_injectors
end

#stack_name ⇒ String? (readonly)

Note:

Default: - Derived from construct path.

Name to deploy the stack with.

Returns:

  • (String, nil) 


145
146
147
 
# File 'stack_props.rb', line 145

def stack_name
  @stack_name
end

#suppress_template_indentation ⇒ Boolean? (readonly)

Note:

Default: - the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.

Enable this flag to suppress indentation in generated CloudFormation templates.

If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

Returns:

  • (Boolean, nil) 


154
155
156
 
# File 'stack_props.rb', line 154

def suppress_template_indentation
  @suppress_template_indentation
end

#synthesizer ⇒ AWSCDK::IStackSynthesizer? (readonly)

Note:

Default: - The synthesizer specified on App, or DefaultStackSynthesizer otherwise.

Synthesis method to use while deploying this stack.

The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

If not specified, the default_stack_synthesizer from App will be used. If that is not specified, DefaultStackSynthesizer is used if @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

Returns:



169
170
171
 
# File 'stack_props.rb', line 169

def synthesizer
  @synthesizer
end

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

Note:

Default: {}

Tags that will be applied to the Stack.

These tags are applied to the CloudFormation Stack itself. They will not appear in the CloudFormation template.

However, at deployment time, CloudFormation will apply these tags to all resources in the stack that support tagging. You will not be able to exempt resources from tagging (using the exclude_resource_types property of Tags.of(...).add()) for tags applied in this way.

Returns:

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


182
183
184
 
# File 'stack_props.rb', line 182

def tags
  @tags
end

#termination_protection ⇒ Boolean? (readonly)

Note:

Default: false

Whether to enable termination protection for this stack.

Returns:

  • (Boolean, nil) 


187
188
189
 
# File 'stack_props.rb', line 187

def termination_protection
  @termination_protection
end

Class Method Details

.jsii_properties ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'stack_props.rb', line 189

def self.jsii_properties
  {
    :analytics_reporting => "analyticsReporting",
    :cross_region_references => "crossRegionReferences",
    :description => "description",
    :env => "env",
    :notification_arns => "notificationArns",
    :permissions_boundary => "permissionsBoundary",
    :property_injectors => "propertyInjectors",
    :stack_name => "stackName",
    :suppress_template_indentation => "suppressTemplateIndentation",
    :synthesizer => "synthesizer",
    :tags => "tags",
    :termination_protection => "terminationProtection",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'stack_props.rb', line 206

def to_jsii
  result = {}
  result.merge!({
    "analyticsReporting" => @analytics_reporting,
    "crossRegionReferences" => @cross_region_references,
    "description" => @description,
    "env" => @env,
    "notificationArns" => @notification_arns,
    "permissionsBoundary" => @permissions_boundary,
    "propertyInjectors" => @property_injectors,
    "stackName" => @stack_name,
    "suppressTemplateIndentation" => @suppress_template_indentation,
    "synthesizer" => @synthesizer,
    "tags" => @tags,
    "terminationProtection" => @termination_protection,
  })
  result.compact
end