Module: AWSCDK::IReusableStackSynthesizer

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

Overview

Interface for Stack Synthesizers that can be used for more than one stack.

Regular IStackSynthesizer instances can only be bound to a Stack once. IReusableStackSynthesizer instances.

For backwards compatibility reasons, this class inherits from IStackSynthesizer, but if an object implements IReusableStackSynthesizer, no other methods than reusable_bind() will be called.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'i_reusable_stack_synthesizer.rb', line 94

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 },
    :reusable_bind => { kind: :method, name: "reusableBind", 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:



45
46
47
48
49
 
# File 'i_reusable_stack_synthesizer.rb', line 45

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:



57
58
59
60
61
 
# File 'i_reusable_stack_synthesizer.rb', line 57

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:



69
70
71
72
 
# File 'i_reusable_stack_synthesizer.rb', line 69

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) 


19
20
21
 
# File 'i_reusable_stack_synthesizer.rb', line 19

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) 


27
28
29
 
# File 'i_reusable_stack_synthesizer.rb', line 27

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) 


35
36
37
 
# File 'i_reusable_stack_synthesizer.rb', line 35

def lookup_role()
  jsii_get_property("lookupRole")
end

#reusable_bind(stack) ⇒ AWSCDK::IBoundStackSynthesizer

Produce a bound Stack Synthesizer for the given stack.

This method may be called more than once on the same object.

Parameters:

Returns:



89
90
91
92
 
# File 'i_reusable_stack_synthesizer.rb', line 89

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

#synthesize(session) ⇒ void

This method returns an undefined value.

Synthesize the associated stack to the session.

Parameters:



78
79
80
81
 
# File 'i_reusable_stack_synthesizer.rb', line 78

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