Class: AWSCDK::ServiceCatalog::CloudFormationProductProps

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

Overview

Properties for a Cloudformation Product.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(owner:, product_name:, product_versions:, description: nil, distributor: nil, message_language: nil, replace_product_version_ids: nil, support_description: nil, support_email: nil, support_url: nil, tag_options: nil) ⇒ CloudFormationProductProps

Returns a new instance of CloudFormationProductProps.

Parameters:

  • owner (String) —

    The owner of the product.

  • product_name (String) —

    The name of the product.

  • product_versions (Array<AWSCDK::ServiceCatalog::CloudFormationProductVersion>) —

    The configuration of the product version.

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

    The description of the product.

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

    The distributor of the product.

  • message_language (AWSCDK::ServiceCatalog::MessageLanguage, nil) (defaults to: nil) —

    The language code.

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

    Whether to give provisioning artifacts a new unique identifier when the product attributes or provisioning artifacts is updated.

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

    The support information about the product.

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

    The contact email for product support.

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

    The contact URL for product support.

  • tag_options (AWSCDK::ServiceCatalog::TagOptions, nil) (defaults to: nil) —

    TagOptions associated directly to a product.



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

def initialize(owner:, product_name:, product_versions:, description: nil, distributor: nil, message_language: nil, replace_product_version_ids: nil, support_description: nil, support_email: nil, support_url: nil, tag_options: nil)
  @owner = owner
  Jsii::Type.check_type(@owner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "owner")
  @product_name = product_name
  Jsii::Type.check_type(@product_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "productName")
  @product_versions = product_versions.is_a?(Array) ? product_versions.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::ServiceCatalog::CloudFormationProductVersion.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : product_versions
  Jsii::Type.check_type(@product_versions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXJ2aWNlY2F0YWxvZy5DbG91ZEZvcm1hdGlvblByb2R1Y3RWZXJzaW9uIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "productVersions")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @distributor = distributor
  Jsii::Type.check_type(@distributor, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "distributor") unless @distributor.nil?
  @message_language = message_language
  Jsii::Type.check_type(@message_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWNhdGFsb2cuTWVzc2FnZUxhbmd1YWdlIn0=")), "messageLanguage") unless @message_language.nil?
  @replace_product_version_ids = replace_product_version_ids
  Jsii::Type.check_type(@replace_product_version_ids, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "replaceProductVersionIds") unless @replace_product_version_ids.nil?
  @support_description = support_description
  Jsii::Type.check_type(@support_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "supportDescription") unless @support_description.nil?
  @support_email = support_email
  Jsii::Type.check_type(@support_email, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "supportEmail") unless @support_email.nil?
  @support_url = support_url
  Jsii::Type.check_type(@support_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "supportUrl") unless @support_url.nil?
  @tag_options = tag_options
  Jsii::Type.check_type(@tag_options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWNhdGFsb2cuVGFnT3B0aW9ucyJ9")), "tagOptions") unless @tag_options.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

Note:

Default: - No description provided

The description of the product.

Returns:

  • (String, nil) 


59
60
61
 
# File 'service_catalog/cloud_formation_product_props.rb', line 59

def description
  @description
end

#distributor ⇒ String? (readonly)

Note:

Default: - No distributor provided

The distributor of the product.

Returns:

  • (String, nil) 


64
65
66
 
# File 'service_catalog/cloud_formation_product_props.rb', line 64

def distributor
  @distributor
end

#message_language ⇒ AWSCDK::ServiceCatalog::MessageLanguage? (readonly)

Note:

Default: - English

The language code.

Controls language for logging and errors.

Returns:



71
72
73
 
# File 'service_catalog/cloud_formation_product_props.rb', line 71

def message_language
  @message_language
end

#owner ⇒ String (readonly)

The owner of the product.

Returns:

  • (String) 


46
47
48
 
# File 'service_catalog/cloud_formation_product_props.rb', line 46

def owner
  @owner
end

#product_name ⇒ String (readonly)

The name of the product.

Returns:

  • (String) 


50
51
52
 
# File 'service_catalog/cloud_formation_product_props.rb', line 50

def product_name
  @product_name
end

#product_versions ⇒ Array<AWSCDK::ServiceCatalog::CloudFormationProductVersion> (readonly)

The configuration of the product version.

Returns:



54
55
56
 
# File 'service_catalog/cloud_formation_product_props.rb', line 54

def product_versions
  @product_versions
end

#replace_product_version_ids ⇒ Boolean? (readonly)

Note:

Default: false

Whether to give provisioning artifacts a new unique identifier when the product attributes or provisioning artifacts is updated.

Returns:

  • (Boolean, nil) 


76
77
78
 
# File 'service_catalog/cloud_formation_product_props.rb', line 76

def replace_product_version_ids
  @replace_product_version_ids
end

#support_description ⇒ String? (readonly)

Note:

Default: - No support description provided

The support information about the product.

Returns:

  • (String, nil) 


81
82
83
 
# File 'service_catalog/cloud_formation_product_props.rb', line 81

def support_description
  @support_description
end

#support_email ⇒ String? (readonly)

Note:

Default: - No support email provided

The contact email for product support.

Returns:

  • (String, nil) 


86
87
88
 
# File 'service_catalog/cloud_formation_product_props.rb', line 86

def support_email
  @support_email
end

#support_url ⇒ String? (readonly)

Note:

Default: - No support URL provided

The contact URL for product support.

Returns:

  • (String, nil) 


91
92
93
 
# File 'service_catalog/cloud_formation_product_props.rb', line 91

def support_url
  @support_url
end

#tag_options ⇒ AWSCDK::ServiceCatalog::TagOptions? (readonly)

Note:

Default: - No tagOptions provided

TagOptions associated directly to a product.

Returns:



96
97
98
 
# File 'service_catalog/cloud_formation_product_props.rb', line 96

def tag_options
  @tag_options
end

Class Method Details

.jsii_properties ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'service_catalog/cloud_formation_product_props.rb', line 98

def self.jsii_properties
  {
    :owner => "owner",
    :product_name => "productName",
    :product_versions => "productVersions",
    :description => "description",
    :distributor => "distributor",
    :message_language => "messageLanguage",
    :replace_product_version_ids => "replaceProductVersionIds",
    :support_description => "supportDescription",
    :support_email => "supportEmail",
    :support_url => "supportUrl",
    :tag_options => "tagOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'service_catalog/cloud_formation_product_props.rb', line 114

def to_jsii
  result = {}
  result.merge!({
    "owner" => @owner,
    "productName" => @product_name,
    "productVersions" => @product_versions,
    "description" => @description,
    "distributor" => @distributor,
    "messageLanguage" => @message_language,
    "replaceProductVersionIds" => @replace_product_version_ids,
    "supportDescription" => @support_description,
    "supportEmail" => @support_email,
    "supportUrl" => @support_url,
    "tagOptions" => @tag_options,
  })
  result.compact
end