Skip to content

Resource: awsServicecatalogProvisioningArtifact

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 templatePhysicalId argument.

Example Usage

Basic Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.servicecatalogProvisioningArtifact.ServicecatalogProvisioningArtifact(
  this,
  "example",
  {
    name: "example",
    productId: "${aws_servicecatalog_product.example.id}",
    templateUrl:
      "https://${aws_s3_bucket.example.bucket_regional_domain_name}/${aws_s3_object.example.key}",
    type: "CLOUD_FORMATION_TEMPLATE",
  }
);

Argument Reference

The following arguments are required:

  • productId - (Required) Identifier of the product.
  • templatePhysicalId - (Required if templateUrl 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]:[accountId]:stack/[stackName]/[resourceId].
  • templateUrl - (Required if templatePhysicalId is not provided) Template source as URL of the CloudFormation template in Amazon S3.

The following arguments are optional:

  • acceptLanguage - (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.
  • disableTemplateValidation - (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. See AWS Docs for valid list of values.

Attributes Reference

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

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

Timeouts

Configuration options:

  • create - (Default 3M)
  • read - (Default 10M)
  • update - (Default 3M)
  • delete - (Default 3M)

Import

awsServicecatalogProvisioningArtifact can be imported using the provisioning artifact ID and product ID separated by a colon, e.g.,

$ terraform import aws_servicecatalog_provisioning_artifact.example pa-ij2b6lusy6dec:prod-el3an0rma3