Class: AWSCDK::ServiceCatalog::CfnCloudFormationProvisionedProductProps

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

Overview

Properties for defining a CfnCloudFormationProvisionedProduct.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(accept_language: nil, notification_arns: nil, path_id: nil, path_name: nil, product_id: nil, product_name: nil, provisioned_product_name: nil, provisioning_artifact_id: nil, provisioning_artifact_name: nil, provisioning_parameters: nil, provisioning_preferences: nil, tags: nil) ⇒ CfnCloudFormationProvisionedProductProps

Returns a new instance of CfnCloudFormationProvisionedProductProps.

Parameters:

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

    The language code.

  • notification_arns (Array<String>, nil) (defaults to: nil) —

    Passed to AWS CloudFormation .

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

    The path identifier of the product.

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

    The name of the path.

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

    The product identifier.

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

    The name of the Service Catalog product.

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

    A user-friendly name for the provisioned product.

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

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

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

    The name of the provisioning artifact (also known as a version) for the product.

  • provisioning_parameters (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::ServiceCatalog::CfnCloudFormationProvisionedProduct::ProvisioningParameterProperty>, nil) (defaults to: nil) —

    Parameters specified by the administrator that are required for provisioning the product.

  • provisioning_preferences (AWSCDK::IResolvable, AWSCDK::ServiceCatalog::CfnCloudFormationProvisionedProduct::ProvisioningPreferencesProperty, nil) (defaults to: nil) —

    StackSet preferences that are required for provisioning the product or updating a provisioned product.

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

    One or more tags.



21
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
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product_props.rb', line 21

def initialize(accept_language: nil, notification_arns: nil, path_id: nil, path_name: nil, product_id: nil, product_name: nil, provisioned_product_name: nil, provisioning_artifact_id: nil, provisioning_artifact_name: nil, provisioning_parameters: nil, provisioning_preferences: nil, tags: nil)
  @accept_language = accept_language
  Jsii::Type.check_type(@accept_language, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "acceptLanguage") unless @accept_language.nil?
  @notification_arns = notification_arns
  Jsii::Type.check_type(@notification_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "notificationArns") unless @notification_arns.nil?
  @path_id = path_id
  Jsii::Type.check_type(@path_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pathId") unless @path_id.nil?
  @path_name = path_name
  Jsii::Type.check_type(@path_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pathName") unless @path_name.nil?
  @product_id = product_id
  Jsii::Type.check_type(@product_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "productId") unless @product_id.nil?
  @product_name = product_name
  Jsii::Type.check_type(@product_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "productName") unless @product_name.nil?
  @provisioned_product_name = provisioned_product_name
  Jsii::Type.check_type(@provisioned_product_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "provisionedProductName") unless @provisioned_product_name.nil?
  @provisioning_artifact_id = provisioning_artifact_id
  Jsii::Type.check_type(@provisioning_artifact_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "provisioningArtifactId") unless @provisioning_artifact_id.nil?
  @provisioning_artifact_name = provisioning_artifact_name
  Jsii::Type.check_type(@provisioning_artifact_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "provisioningArtifactName") unless @provisioning_artifact_name.nil?
  @provisioning_parameters = provisioning_parameters
  Jsii::Type.check_type(@provisioning_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWNhdGFsb2cuQ2ZuQ2xvdWRGb3JtYXRpb25Qcm92aXNpb25lZFByb2R1Y3QuUHJvdmlzaW9uaW5nUGFyYW1ldGVyUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "provisioningParameters") unless @provisioning_parameters.nil?
  @provisioning_preferences = provisioning_preferences.is_a?(Hash) ? ::AWSCDK::ServiceCatalog::CfnCloudFormationProvisionedProduct::ProvisioningPreferencesProperty.new(**provisioning_preferences.transform_keys(&:to_sym)) : provisioning_preferences
  Jsii::Type.check_type(@provisioning_preferences, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXJ2aWNlY2F0YWxvZy5DZm5DbG91ZEZvcm1hdGlvblByb3Zpc2lvbmVkUHJvZHVjdC5Qcm92aXNpb25pbmdQcmVmZXJlbmNlc1Byb3BlcnR5In1dfX0=")), "provisioningPreferences") unless @provisioning_preferences.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:



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

def accept_language
  @accept_language
end

#notification_arns ⇒ Array<String>? (readonly)

Passed to AWS CloudFormation .

The SNS topic ARNs to which to publish stack-related events.

Returns:

  • (Array<String>, nil)

See Also:



62
63
64
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product_props.rb', line 62

def notification_arns
  @notification_arns
end

#path_id ⇒ String? (readonly)

The path identifier of the product.

This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

You must provide the name or ID, but not both.

Returns:

  • (String, nil)

See Also:



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

def path_id
  @path_id
end

#path_name ⇒ String? (readonly)

The name of the path.

This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths .

You must provide the name or ID, but not both.

Returns:

  • (String, nil)

See Also:



80
81
82
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product_props.rb', line 80

def path_name
  @path_name
end

#product_id ⇒ String? (readonly)

The product identifier.

You must specify either the ID or the name of the product, but not both.

Returns:

  • (String, nil)

See Also:



87
88
89
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product_props.rb', line 87

def product_id
  @product_id
end

#product_name ⇒ String? (readonly)

The name of the Service Catalog product.

Each time a stack is created or updated, if ProductName is provided it will successfully resolve to ProductId as long as only one product exists in the account or Region with that ProductName .

You must specify either the name or the ID of the product, but not both.

Returns:

  • (String, nil)

See Also:



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

def product_name
  @product_name
end

#provisioned_product_name ⇒ String? (readonly)

A user-friendly name for the provisioned product.

This value must be unique for the AWS account and cannot be updated after the product is provisioned.

Returns:

  • (String, nil)

See Also:



103
104
105
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product_props.rb', line 103

def provisioned_product_name
  @provisioned_product_name
end

#provisioning_artifact_id ⇒ String? (readonly)

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

You must specify either the ID or the name of the provisioning artifact, but not both.

Returns:

  • (String, nil)

See Also:



110
111
112
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product_props.rb', line 110

def provisioning_artifact_id
  @provisioning_artifact_id
end

#provisioning_artifact_name ⇒ String? (readonly)

The name of the provisioning artifact (also known as a version) for the product.

This name must be unique for the product.

You must specify either the name or the ID of the provisioning artifact, but not both. You must also specify either the name or the ID of the product, but not both.

Returns:

  • (String, nil)

See Also:



119
120
121
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product_props.rb', line 119

def provisioning_artifact_name
  @provisioning_artifact_name
end

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

Parameters specified by the administrator that are required for provisioning the product.

Returns:

See Also:



124
125
126
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product_props.rb', line 124

def provisioning_parameters
  @provisioning_parameters
end

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

StackSet preferences that are required for provisioning the product or updating a provisioned product.

Returns:

See Also:



129
130
131
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product_props.rb', line 129

def provisioning_preferences
  @provisioning_preferences
end

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

One or more tags.

Requires the provisioned product to have an ResourceUpdateConstraint resource with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. If RESOURCE_UPDATE constraint is not present, tags updates are ignored.

Returns:

See Also:



136
137
138
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product_props.rb', line 136

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product_props.rb', line 138

def self.jsii_properties
  {
    :accept_language => "acceptLanguage",
    :notification_arns => "notificationArns",
    :path_id => "pathId",
    :path_name => "pathName",
    :product_id => "productId",
    :product_name => "productName",
    :provisioned_product_name => "provisionedProductName",
    :provisioning_artifact_id => "provisioningArtifactId",
    :provisioning_artifact_name => "provisioningArtifactName",
    :provisioning_parameters => "provisioningParameters",
    :provisioning_preferences => "provisioningPreferences",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'service_catalog/cfn_cloud_formation_provisioned_product_props.rb', line 155

def to_jsii
  result = {}
  result.merge!({
    "acceptLanguage" => @accept_language,
    "notificationArns" => @notification_arns,
    "pathId" => @path_id,
    "pathName" => @path_name,
    "productId" => @product_id,
    "productName" => @product_name,
    "provisionedProductName" => @provisioned_product_name,
    "provisioningArtifactId" => @provisioning_artifact_id,
    "provisioningArtifactName" => @provisioning_artifact_name,
    "provisioningParameters" => @provisioning_parameters,
    "provisioningPreferences" => @provisioning_preferences,
    "tags" => @tags,
  })
  result.compact
end