This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.
AWS::ServiceCatalog::CloudFormationProduct
Specifies a product.
Syntax
To declare this entity in your Amazon 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:StringDescription:StringDistributor:StringName:StringOwner:StringProductType:StringProvisioningArtifactParameters:- ProvisioningArtifactPropertiesReplaceProvisioningArtifacts:BooleanSourceConnection:SourceConnectionSupportDescription:StringSupportEmail:StringSupportUrl:StringTags:- Tag
Properties
AcceptLanguage-
The language code.
-
jp- Japanese -
zh- Chinese
Required: No
Type: String
Maximum:
100Update requires: No interruption
-
Description-
The description of the product.
Required: No
Type: String
Maximum:
8191Update requires: No interruption
Distributor-
The distributor of the product.
Required: No
Type: String
Maximum:
8191Update requires: No interruption
Name-
The name of the product.
Required: Yes
Type: String
Maximum:
8191Update requires: No interruption
Owner-
The owner of the product.
Required: Yes
Type: String
Maximum:
8191Update requires: No interruption
ProductType-
The type of product.
Required: No
Type: String
Allowed values:
CLOUD_FORMATION_TEMPLATE | MARKETPLACE_AMI | MARKETPLACE_CAR | TERRAFORM_OPEN_SOURCE | TERRAFORM_CLOUD | EXTERNALUpdate requires: No interruption
ProvisioningArtifactParameters-
The configuration of the provisioning artifact (also known as a version).
Required if you don't specify
SourceConnection. If you specifySourceConnectionwhen you create the product, don't specify this property. The product's versions come from the connected repository, and the create fails if you specify both.If you add
SourceConnectionin an update, keep this property in that update, or the update fails. You can remove this property in a later update. Removing it doesn't delete the product's existing provisioning artifacts. Until you remove it, creating a product from that template fails.Required: Conditional
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 combination 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.
The following describes the product when an update fails, before any rollback of the stack. If an update fails partway, the product keeps the changes that the update already made to its provisioning artifacts, so it can contain a mix of old and new provisioning artifacts. An old provisioning artifact that the update couldn't delete can remain in the product. The exact state depends on where the update fails.
The update also fails if a provisioning artifact in the product has the
FAILEDstatus afterward, such as one that already had that status before the update. If turned on, the update doesn't delete versions that are synced from a Git repository.Required: No
Type: Boolean
Update requires: No interruption
SourceConnection-
A top level
ProductViewDetailresponse containing details about the product’s connection. Amazon Service Catalog returns this field for theCreateProduct,UpdateProduct,DescribeProductAsAdmin, andSearchProductAsAdminAPIs. This response contains the same fields as theConnectionParametersrequest, with the addition of theLastSyncresponse.Required if you don't specify
ProvisioningArtifactParameters.Required: Conditional
Type: SourceConnection
Update requires: No interruption
SupportDescription-
The support information about the product.
Required: No
Type: String
Maximum:
8191Update requires: No interruption
SupportEmail-
The contact email for product support.
Required: No
Type: String
Maximum:
254Update requires: No interruption
SupportUrl-
The contact URL for product support.
^https?:\/\/// is the pattern used to validate SupportUrl.Required: No
Type: String
Maximum:
2083Update requires: No interruption
-
One or more tags.
Required: No
Type: Array of Tag
Maximum:
20Update 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.
Examples
Example - Create a product from a template in Amazon S3
The following example creates a product with one version (provisioning artifact) whose Amazon CloudFormation template is stored in Amazon S3.
JSON
{ "MyProduct": { "Type": "AWS::ServiceCatalog::CloudFormationProduct", "Properties": { "Name": "Sample product", "Owner": "Platform team", "ProductType": "CLOUD_FORMATION_TEMPLATE", "ProvisioningArtifactParameters": [ { "Name": "v1", "Description": "Initial version", "Type": "CLOUD_FORMATION_TEMPLATE", "Info": { "LoadTemplateFromURL": "https://s3.amazonaws.com/amzn-s3-demo-bucket/sample-template.json" } } ] } } }
YAML
MyProduct: Type: AWS::ServiceCatalog::CloudFormationProduct Properties: Name: Sample product Owner: Platform team ProductType: CLOUD_FORMATION_TEMPLATE ProvisioningArtifactParameters: - Name: v1 Description: Initial version Type: CLOUD_FORMATION_TEMPLATE Info: LoadTemplateFromURL: https://s3.amazonaws.com/amzn-s3-demo-bucket/sample-template.json
Example - Create a product that syncs versions from a Git repository
The following example creates a product that is synced with a template file in a Git repository through
a connection. Because the example specifies SourceConnection, it omits
ProvisioningArtifactParameters.
JSON
{ "MySyncedProduct": { "Type": "AWS::ServiceCatalog::CloudFormationProduct", "Properties": { "Name": "Sample synced product", "Owner": "Platform team", "ProductType": "CLOUD_FORMATION_TEMPLATE", "SourceConnection": { "Type": "CODESTAR", "ConnectionParameters": { "CodeStar": { "ConnectionArn": "arn:aws:codeconnections:us-east-1:111122223333:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Repository": "my-org/my-templates", "Branch": "main", "ArtifactPath": "templates/sample-template.json" } } } } } }
YAML
MySyncedProduct: Type: AWS::ServiceCatalog::CloudFormationProduct Properties: Name: Sample synced product Owner: Platform team ProductType: CLOUD_FORMATION_TEMPLATE SourceConnection: Type: CODESTAR ConnectionParameters: CodeStar: ConnectionArn: arn:aws:codeconnections:us-east-1:111122223333:connection/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 Repository: my-org/my-templates Branch: main ArtifactPath: templates/sample-template.json
See also
-
CreateProduct in the Amazon Service Catalog API Reference