Top / Amazon Web Service / AWS Service Catalog / Provisioning Artifact

AWS Service Catalog Provisioning Artifact

This page shows how to write Terraform and CloudFormation for AWS Service Catalog Provisioning Artifact and write them securely.

terraform-logo

Review your .tf file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

aws_servicecatalog_provisioning_artifact (Terraform)

The Provisioning Artifact in AWS Service Catalog can be configured in Terraform with the resource name aws_servicecatalog_provisioning_artifact. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

The following arguments are required:

  • product_id - (Required) Identifier of the product.
  • template_physical_id - (Required if template_url is not provided) Template source as the physical ID of the resource that contains the template. Currently only supports CloudFormation stack ARN. Specify the physical ID as arn:[partition]:cloudformation:[region]:[account ID]:stack/[stack name]/[resource ID].
  • template_url - (Required if template_physical_id is not provided) Template source as URL of the CloudFormation template in Amazon S3.

The following arguments are optional:

  • accept_language - (Optional) Language code. Valid values: en (English), jp (Japanese), zh (Chinese). The default value is en.
  • active - (Optional) Whether the product version is active. Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact. Default is true.
  • description - (Optional) Description of the provisioning artifact (i.e., version), including how it differs from the previous provisioning artifact.
  • disable_template_validation - (Optional) Whether AWS Service Catalog stops validating the specified provisioning artifact template even if it is invalid.
  • guidance - (Optional) Information set by the administrator to provide guidance to end users about which provisioning artifacts to use. Valid values are DEFAULT and DEPRECATED. The default is DEFAULT. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.
  • name - (Optional) Name of the provisioning artifact (for example, v1, v2beta). No spaces are allowed.
  • type - (Optional) Type of provisioning artifact. Valid values: CLOUD_FORMATION_TEMPLATE, MARKETPLACE_AMI, MARKETPLACE_CAR (Marketplace Clusters and AWS Resources).

In addition to all arguments above, the following attributes are exported:

  • created_time - Time when the provisioning artifact was created.
  • id - Provisioning Artifact identifier and product identifier separated by a colon.
  • status - Status of the provisioning artifact.

>> from Terraform Registry

Explanation in Terraform Registry

Manages a Service Catalog Provisioning Artifact for a specified product. -> A "provisioning artifact" is also referred to as a "version."

NOTE: You cannot create a provisioning artifact for a product that was shared with you. NOTE: The user or role that use this resource must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the template_physical_id argument.

>> from Terraform Registry

AWS::ServiceCatalog::CloudFormationProduct ProvisioningArtifactProperties (CloudFormation)

The CloudFormationProduct ProvisioningArtifactProperties in ServiceCatalog can be configured in CloudFormation with the resource name AWS::ServiceCatalog::CloudFormationProduct ProvisioningArtifactProperties. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

Description The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
Required: No
Type: String
Maximum: 8192
Update requires: No interruption

DisableTemplateValidation If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.
Required: No
Type: Boolean
Update requires: No interruption

Info Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]
The URL of the AWS CloudFormation template in Amazon S3, AWS CodeCommit, or GitHub in JSON format. Specify the URL in JSON format as follows:
"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."
ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports AWS CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]
Required: Yes
Type: Json
Update requires: No interruption

Name The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
Required: No
Type: String
Maximum: 8192
Update requires: No interruption

>> from AWS CloudFormation Documentation

Explanation in CloudFormation Registry

Information about a provisioning artifact (also known as a version) for a product.

>> from AWS CloudFormation Documentation

The Other Related AWS Service Catalog Resources

Frequently asked questions

What is AWS Service Catalog Provisioning Artifact?

AWS Service Catalog Provisioning Artifact is a resource for Service Catalog of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents