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 ProvisioningArtifactProperties
Information about a provisioning artifact (also known as a version) for a product.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Description" :String, "DisableTemplateValidation" :Boolean, "Info" :Info, "Name" :String, "Type" :String}
YAML
Description:StringDisableTemplateValidation:BooleanInfo:InfoName:StringType:String
Properties
Description-
The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
Required: No
Type: String
Maximum:
8192Update requires: No interruption
DisableTemplateValidation-
If set to true, Amazon Service Catalog stops validating the specified provisioning artifact even if it is invalid.
Required: No
Type: Boolean
Update requires: No interruption
Info-
The template source of the provisioning artifact.
Infois an object that has one of the following keys, but not both. Each value is a string.-
LoadTemplateFromURL- The URL of the Amazon CloudFormation template in Amazon S3, for examplehttps://s3.amazonaws.com/amzn-s3-demo-bucket/sample-template.json. -
ImportFromPhysicalId- The Amazon Resource Name (ARN) of the Amazon CloudFormation stack that contains the template, for examplearn:aws:cloudformation:us-east-1:111122223333:stack/MyStack/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. Amazon Service Catalog supports only Amazon CloudFormation stack ARNs.
Required: Yes
Type: Info
Update requires: No interruption
-
Name-
The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
When
ReplaceProvisioningArtifactsisfalse(the default), Amazon CloudFormation matches the provisioning artifacts in your template to the product's existing provisioning artifacts by name and template URL. If you change the name or the template URL of a provisioning artifact, Amazon CloudFormation creates a provisioning artifact with a new ID and deletes the old one. The product itself isn't replaced. If the update fails partway, the product can have the old provisioning artifact, the new one, or both. For details, see theReplaceProvisioningArtifactsproperty of theAWS::ServiceCatalog::CloudFormationProductresource.Required: No
Type: String
Maximum:
8192Update requires: No interruption
Type-
The type of provisioning artifact.
-
CLOUD_FORMATION_TEMPLATE- Amazon CloudFormation template -
TERRAFORM_OPEN_SOURCE- Terraform Open Source configuration file -
TERRAFORM_CLOUD- Terraform Cloud configuration file -
EXTERNAL- External configuration file
Required: No
Type: String
Allowed values:
CLOUD_FORMATION_TEMPLATE | MARKETPLACE_AMI | MARKETPLACE_CAR | TERRAFORM_OPEN_SOURCE | TERRAFORM_CLOUD | EXTERNALUpdate requires: No interruption
-
Examples
Example - Specify the template of a provisioning artifact
Info is an object, not a string. The following example specifies a provisioning artifact
whose template is loaded from Amazon S3.
JSON
{ "Name": "v2", "Description": "Adds an output for the bucket name", "Type": "CLOUD_FORMATION_TEMPLATE", "Info": { "LoadTemplateFromURL": "https://s3.amazonaws.com/amzn-s3-demo-bucket/sample-template-v2.json" } }
YAML
Name: v2 Description: Adds an output for the bucket name Type: CLOUD_FORMATION_TEMPLATE Info: LoadTemplateFromURL: https://s3.amazonaws.com/amzn-s3-demo-bucket/sample-template-v2.json
See also
-
ProvisioningArtifactProperties in the Amazon Service Catalog API Reference