Module: AWSCDK::ITemplateOptions

Defined in:
i_template_options.rb

Overview

CloudFormation template options for a stack.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



57
58
59
60
61
62
63
64
 
# File 'i_template_options.rb', line 57

def self.jsii_overridable_methods
  {
    :description => { kind: :property, name: "description", is_optional: true },
    :metadata => { kind: :property, name: "metadata", is_optional: true },
    :template_format_version => { kind: :property, name: "templateFormatVersion", is_optional: true },
    :transforms => { kind: :property, name: "transforms", is_optional: true },
  }
end

Instance Method Details

#description ⇒ String?

Gets or sets the description of this stack.

If provided, it will be included in the CloudFormation template's "Description" attribute.

Returns:

  • (String, nil) 


12
13
14
 
# File 'i_template_options.rb', line 12

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



16
17
18
19
 
# File 'i_template_options.rb', line 16

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#metadata ⇒ Hash{String => Object}?

Metadata associated with the CloudFormation template.

Returns:

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


24
25
26
 
# File 'i_template_options.rb', line 24

def metadata()
  jsii_get_property("metadata")
end

#metadata=(value) ⇒ Object 



28
29
30
31
 
# File 'i_template_options.rb', line 28

def metadata=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "metadata") unless value.nil?
  jsii_set_property("metadata", value)
end

#template_format_version ⇒ String?

Gets or sets the AWSTemplateFormatVersion field of the CloudFormation template.

Returns:

  • (String, nil) 


36
37
38
 
# File 'i_template_options.rb', line 36

def template_format_version()
  jsii_get_property("templateFormatVersion")
end

#template_format_version=(value) ⇒ Object 



40
41
42
43
 
# File 'i_template_options.rb', line 40

def template_format_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "templateFormatVersion") unless value.nil?
  jsii_set_property("templateFormatVersion", value)
end

#transforms ⇒ Array<String>?

Gets or sets the top-level template transform(s) for this stack (e.g. ["AWS::Serverless-2016-10-31"]).

Returns:

  • (Array<String>, nil) 


48
49
50
 
# File 'i_template_options.rb', line 48

def transforms()
  jsii_get_property("transforms")
end

#transforms=(value) ⇒ Object 



52
53
54
55
 
# File 'i_template_options.rb', line 52

def transforms=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "transforms") unless value.nil?
  jsii_set_property("transforms", value)
end