Class: AWSCDK::ServiceCatalog::CloudFormationProductVersion

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
service_catalog/cloud_formation_product_version.rb

Overview

Properties of product version (also known as a provisioning artifact).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cloud_formation_template:, description: nil, product_version_name: nil, validate_template: nil) ⇒ CloudFormationProductVersion

Returns a new instance of CloudFormationProductVersion.

Parameters:

  • cloud_formation_template (AWSCDK::ServiceCatalog::CloudFormationTemplate) —

    The S3 template that points to the provisioning version template.

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

    The description of the product version.

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

    The name of the product version.

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

    Whether the specified product template will be validated by CloudFormation.



11
12
13
14
15
16
17
18
19
20
 
# File 'service_catalog/cloud_formation_product_version.rb', line 11

def initialize(cloud_formation_template:, description: nil, product_version_name: nil, validate_template: nil)
  @cloud_formation_template = cloud_formation_template
  Jsii::Type.check_type(@cloud_formation_template, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWNhdGFsb2cuQ2xvdWRGb3JtYXRpb25UZW1wbGF0ZSJ9")), "cloudFormationTemplate")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @product_version_name = product_version_name
  Jsii::Type.check_type(@product_version_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "productVersionName") unless @product_version_name.nil?
  @validate_template = validate_template
  Jsii::Type.check_type(@validate_template, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "validateTemplate") unless @validate_template.nil?
end

Instance Attribute Details

#cloud_formation_template ⇒ AWSCDK::ServiceCatalog::CloudFormationTemplate (readonly)

The S3 template that points to the provisioning version template.

Returns:



25
26
27
 
# File 'service_catalog/cloud_formation_product_version.rb', line 25

def cloud_formation_template
  @cloud_formation_template
end

#description ⇒ String? (readonly)

Note:

Default: - No description provided

The description of the product version.

Returns:

  • (String, nil) 


30
31
32
 
# File 'service_catalog/cloud_formation_product_version.rb', line 30

def description
  @description
end

#product_version_name ⇒ String? (readonly)

Note:

Default: - No product version name provided

The name of the product version.

Returns:

  • (String, nil) 


35
36
37
 
# File 'service_catalog/cloud_formation_product_version.rb', line 35

def product_version_name
  @product_version_name
end

#validate_template ⇒ Boolean? (readonly)

Note:

Default: true

Whether the specified product template will be validated by CloudFormation.

If turned off, an invalid template configuration can be stored.

Returns:

  • (Boolean, nil) 


42
43
44
 
# File 'service_catalog/cloud_formation_product_version.rb', line 42

def validate_template
  @validate_template
end

Class Method Details

.jsii_properties ⇒ Object 



44
45
46
47
48
49
50
51
 
# File 'service_catalog/cloud_formation_product_version.rb', line 44

def self.jsii_properties
  {
    :cloud_formation_template => "cloudFormationTemplate",
    :description => "description",
    :product_version_name => "productVersionName",
    :validate_template => "validateTemplate",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



53
54
55
56
57
58
59
60
61
62
 
# File 'service_catalog/cloud_formation_product_version.rb', line 53

def to_jsii
  result = {}
  result.merge!({
    "cloudFormationTemplate" => @cloud_formation_template,
    "description" => @description,
    "productVersionName" => @product_version_name,
    "validateTemplate" => @validate_template,
  })
  result.compact
end