Class: AWSCDK::ServiceCatalog::CfnCloudFormationProductProps

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

Overview

Properties for defining a CfnCloudFormationProduct.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, owner:, accept_language: nil, description: nil, distributor: nil, product_type: nil, provisioning_artifact_parameters: nil, replace_provisioning_artifacts: nil, source_connection: nil, support_description: nil, support_email: nil, support_url: nil, tags: nil) ⇒ CfnCloudFormationProductProps

Returns a new instance of CfnCloudFormationProductProps.

Parameters:

  • name (String) —

    The name of the product.

  • owner (String) —

    The owner of the product.

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

    The language code.

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

    The description of the product.

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

    The distributor of the product.

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

    The type of product.

  • provisioning_artifact_parameters (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::ServiceCatalog::CfnCloudFormationProduct::ProvisioningArtifactPropertiesProperty>, nil) (defaults to: nil) —

    The configuration of the provisioning artifact (also known as a version).

  • replace_provisioning_artifacts (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    This property is turned off by default.

  • source_connection (AWSCDK::IResolvable, AWSCDK::ServiceCatalog::CfnCloudFormationProduct::SourceConnectionProperty, nil) (defaults to: nil) —

    A top level ProductViewDetail response containing details about the product’s connection.

  • 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.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    One or more tags.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 22

def initialize(name:, owner:, accept_language: nil, description: nil, distributor: nil, product_type: nil, provisioning_artifact_parameters: nil, replace_provisioning_artifacts: nil, source_connection: nil, support_description: nil, support_email: nil, support_url: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @owner = owner
  Jsii::Type.check_type(@owner, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "owner")
  @accept_language = accept_language
  Jsii::Type.check_type(@accept_language, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "acceptLanguage") unless @accept_language.nil?
  @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?
  @product_type = product_type
  Jsii::Type.check_type(@product_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "productType") unless @product_type.nil?
  @provisioning_artifact_parameters = provisioning_artifact_parameters
  Jsii::Type.check_type(@provisioning_artifact_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWNhdGFsb2cuQ2ZuQ2xvdWRGb3JtYXRpb25Qcm9kdWN0LlByb3Zpc2lvbmluZ0FydGlmYWN0UHJvcGVydGllc1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "provisioningArtifactParameters") unless @provisioning_artifact_parameters.nil?
  @replace_provisioning_artifacts = replace_provisioning_artifacts
  Jsii::Type.check_type(@replace_provisioning_artifacts, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "replaceProvisioningArtifacts") unless @replace_provisioning_artifacts.nil?
  @source_connection = source_connection.is_a?(Hash) ? ::AWSCDK::ServiceCatalog::CfnCloudFormationProduct::SourceConnectionProperty.new(**source_connection.transform_keys(&:to_sym)) : source_connection
  Jsii::Type.check_type(@source_connection, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXJ2aWNlY2F0YWxvZy5DZm5DbG91ZEZvcm1hdGlvblByb2R1Y3QuU291cmNlQ29ubmVjdGlvblByb3BlcnR5In1dfX0=")), "sourceConnection") unless @source_connection.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?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#accept_language ⇒ String? (readonly)

The language code.

  • jp - Japanese
  • zh - Chinese

Returns:

  • (String, nil)

See Also:



68
69
70
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 68

def accept_language
  @accept_language
end

#description ⇒ String? (readonly)

The description of the product.

Returns:

  • (String, nil)

See Also:



73
74
75
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 73

def description
  @description
end

#distributor ⇒ String? (readonly)

The distributor of the product.

Returns:

  • (String, nil)

See Also:



78
79
80
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 78

def distributor
  @distributor
end

#name ⇒ String (readonly)

The name of the product.

Returns:

  • (String)

See Also:



55
56
57
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 55

def name
  @name
end

#owner ⇒ String (readonly)

The owner of the product.

Returns:

  • (String)

See Also:



60
61
62
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 60

def owner
  @owner
end

#product_type ⇒ String? (readonly)

The type of product.

Returns:

  • (String, nil)

See Also:



83
84
85
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 83

def product_type
  @product_type
end

#provisioning_artifact_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration of the provisioning artifact (also known as a version).

Returns:

See Also:



88
89
90
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 88

def provisioning_artifact_parameters
  @provisioning_artifact_parameters
end

#replace_provisioning_artifacts ⇒ Boolean, ... (readonly)

This property is turned off by default.

If turned off, you can update provisioning artifacts or product attributes (such as description, distributor, name, owner, and more) and the associated provisioning artifacts will retain the same unique identifier. Provisioning artifacts are matched within the CloudFormationProduct resource, and only those that have been updated will be changed. Provisioning artifacts are matched by a combinaton of provisioning artifact template URL and name.

If turned on, provisioning artifacts will be given a new unique identifier when you update the product or provisioning artifacts.

Returns:

See Also:



97
98
99
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 97

def replace_provisioning_artifacts
  @replace_provisioning_artifacts
end

#source_connection ⇒ AWSCDK::IResolvable, ... (readonly)

A top level ProductViewDetail response containing details about the product’s connection.

AWS Service Catalog returns this field for the CreateProduct , UpdateProduct , DescribeProductAsAdmin , and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

Returns:

See Also:



104
105
106
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 104

def source_connection
  @source_connection
end

#support_description ⇒ String? (readonly)

The support information about the product.

Returns:

  • (String, nil)

See Also:



109
110
111
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 109

def support_description
  @support_description
end

#support_email ⇒ String? (readonly)

The contact email for product support.

Returns:

  • (String, nil)

See Also:



114
115
116
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 114

def support_email
  @support_email
end

#support_url ⇒ String? (readonly)

The contact URL for product support.

^https?:\/\// / is the pattern used to validate SupportUrl.

Returns:

  • (String, nil)

See Also:



121
122
123
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 121

def support_url
  @support_url
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

One or more tags.

Returns:

See Also:



126
127
128
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 126

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 128

def self.jsii_properties
  {
    :name => "name",
    :owner => "owner",
    :accept_language => "acceptLanguage",
    :description => "description",
    :distributor => "distributor",
    :product_type => "productType",
    :provisioning_artifact_parameters => "provisioningArtifactParameters",
    :replace_provisioning_artifacts => "replaceProvisioningArtifacts",
    :source_connection => "sourceConnection",
    :support_description => "supportDescription",
    :support_email => "supportEmail",
    :support_url => "supportUrl",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'service_catalog/cfn_cloud_formation_product_props.rb', line 146

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "owner" => @owner,
    "acceptLanguage" => @accept_language,
    "description" => @description,
    "distributor" => @distributor,
    "productType" => @product_type,
    "provisioningArtifactParameters" => @provisioning_artifact_parameters,
    "replaceProvisioningArtifacts" => @replace_provisioning_artifacts,
    "sourceConnection" => @source_connection,
    "supportDescription" => @support_description,
    "supportEmail" => @support_email,
    "supportUrl" => @support_url,
    "tags" => @tags,
  })
  result.compact
end