Module: AWSCDK::IBoundStackSynthesizer

Includes:
IStackSynthesizer
Included in:
CliCredentialsStackSynthesizer, DefaultStackSynthesizer, LegacyStackSynthesizer
Defined in:
i_bound_stack_synthesizer.rb

Overview

A Stack Synthesizer, obtained from IReusableStackSynthesizer..

Just a type alias with a very concrete contract.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
 
# File 'i_bound_stack_synthesizer.rb', line 78

def self.jsii_overridable_methods
  {
    :bootstrap_qualifier => { kind: :property, name: "bootstrapQualifier", is_optional: true },
    :cloud_formation_execution_role => { kind: :property, name: "cloudFormationExecutionRole", is_optional: true },
    :lookup_role => { kind: :property, name: "lookupRole", is_optional: true },
    :add_docker_image_asset => { kind: :method, name: "addDockerImageAsset", is_optional: false },
    :add_file_asset => { kind: :method, name: "addFileAsset", is_optional: false },
    :bind => { kind: :method, name: "bind", is_optional: false },
    :synthesize => { kind: :method, name: "synthesize", is_optional: false },
  }
end

Instance Method Details

#add_docker_image_asset(asset) ⇒ AWSCDK::DockerImageAssetLocation

Register a Docker Image Asset.

Returns the parameters that can be used to refer to the asset inside the template.

Parameters:

Returns:



40
41
42
43
44
 
# File 'i_bound_stack_synthesizer.rb', line 40

def add_docker_image_asset(asset)
  asset = asset.is_a?(Hash) ? ::AWSCDK::DockerImageAssetSource.new(**asset.transform_keys(&:to_sym)) : asset
  Jsii::Type.check_type(asset, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Eb2NrZXJJbWFnZUFzc2V0U291cmNlIn0=")), "asset")
  jsii_call_method("addDockerImageAsset", [asset])
end

#add_file_asset(asset) ⇒ AWSCDK::FileAssetLocation

Register a File Asset.

Returns the parameters that can be used to refer to the asset inside the template.

Parameters:

Returns:



52
53
54
55
56
 
# File 'i_bound_stack_synthesizer.rb', line 52

def add_file_asset(asset)
  asset = asset.is_a?(Hash) ? ::AWSCDK::FileAssetSource.new(**asset.transform_keys(&:to_sym)) : asset
  Jsii::Type.check_type(asset, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5GaWxlQXNzZXRTb3VyY2UifQ==")), "asset")
  jsii_call_method("addFileAsset", [asset])
end

#bind(stack) ⇒ void

This method returns an undefined value.

Bind to the stack this environment is going to be used on.

Must be called before any of the other methods are called, and can only be called once.

Parameters:



64
65
66
67
 
# File 'i_bound_stack_synthesizer.rb', line 64

def bind(stack)
  Jsii::Type.check_type(stack, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5TdGFjayJ9")), "stack")
  jsii_call_method("bind", [stack])
end

#bootstrap_qualifier ⇒ String?

Note:

Default: - no qualifier

The qualifier used to bootstrap this stack.

Returns:

  • (String, nil) 


14
15
16
 
# File 'i_bound_stack_synthesizer.rb', line 14

def bootstrap_qualifier()
  jsii_get_property("bootstrapQualifier")
end

#cloud_formation_execution_role ⇒ String?

Note:

Default: - no role

The role that is passed to CloudFormation to execute the change set.

Returns:

  • (String, nil) 


22
23
24
 
# File 'i_bound_stack_synthesizer.rb', line 22

def cloud_formation_execution_role()
  jsii_get_property("cloudFormationExecutionRole")
end

#lookup_role ⇒ String?

Note:

Default: - no role

The role used to lookup for this stack.

Returns:

  • (String, nil) 


30
31
32
 
# File 'i_bound_stack_synthesizer.rb', line 30

def lookup_role()
  jsii_get_property("lookupRole")
end

#synthesize(session) ⇒ void

This method returns an undefined value.

Synthesize the associated stack to the session.

Parameters:



73
74
75
76
 
# File 'i_bound_stack_synthesizer.rb', line 73

def synthesize(session)
  Jsii::Type.check_type(session, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5JU3ludGhlc2lzU2Vzc2lvbiJ9")), "session")
  jsii_call_method("synthesize", [session])
end