AWS::ServiceCatalog::CloudFormationProduct

Specifies a product.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ServiceCatalog::CloudFormationProduct",
  "Properties" : {
      "AcceptLanguage" : String,
      "Description" : String,
      "Distributor" : String,
      "Name" : String,
      "Owner" : String,
      "ProductType" : String,
      "ProvisioningArtifactParameters" : [ ProvisioningArtifactProperties, ... ],
      "ReplaceProvisioningArtifacts" : Boolean,
      "SourceConnection" : SourceConnection,
      "SupportDescription" : String,
      "SupportEmail" : String,
      "SupportUrl" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::ServiceCatalog::CloudFormationProduct
Properties:
  AcceptLanguage: String
  Description: String
  Distributor: String
  Name: String
  Owner: String
  ProductType: String
  ProvisioningArtifactParameters: 
    - ProvisioningArtifactProperties
  ReplaceProvisioningArtifacts: Boolean
  SourceConnection: 
    SourceConnection
  SupportDescription: String
  SupportEmail: String
  SupportUrl: String
  Tags: 
    - Tag

Properties

AcceptLanguage

The language code.

• jp - Japanese

• zh - Chinese

Required: No

Type: String

Maximum: 100

Update requires: No interruption

Description

The description of the product.

Required: No

Type: String

Maximum: 8191

Update requires: No interruption

Distributor

The distributor of the product.

Required: No

Type: String

Maximum: 8191

Update requires: No interruption

Name

The name of the product.

Required: Yes

Type: String

Maximum: 8191

Update requires: No interruption

Owner

The owner of the product.

Required: Yes

Type: String

Maximum: 8191

Update requires: No interruption

ProductType

The type of product.

Required: No

Type: String

Allowed values: CLOUD_FORMATION_TEMPLATE | MARKETPLACE | TERRAFORM_OPEN_SOURCE | TERRAFORM_CLOUD | EXTERNAL

Update requires: No interruption

ProvisioningArtifactParameters

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

Required: No

Type: Array of ProvisioningArtifactProperties

Update requires: No interruption

ReplaceProvisioningArtifacts

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.

Required: No

Type: Boolean

Update requires: No interruption

SourceConnection

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.

Required: No

Type: SourceConnection

Update requires: No interruption

SupportDescription

The support information about the product.

Required: No

Type: String

Maximum: 8191

Update requires: No interruption

SupportEmail

The contact email for product support.

Required: No

Type: String

Maximum: 254

Update requires: No interruption

SupportUrl

The contact URL for product support.

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

Required: No

Type: String

Maximum: 2083

Update requires: No interruption

Tags

One or more tags.

Required: No

Type: Array of Tag

Maximum: 20

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the provisioning artifact, such as pa-3mc34fbybfmgp.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ProductName

The name of the product.

ProvisioningArtifactIds

The IDs of the provisioning artifacts.

ProvisioningArtifactNames

The names of the provisioning artifacts.

See also

• CreateProduct in the AWS Service Catalog API Reference