Skip to content

Commit

Permalink
docs/r/servicecat_prov_prod: New resource
Browse files Browse the repository at this point in the history
  • Loading branch information
YakDriver committed May 24, 2021
1 parent f2be7f5 commit 69f13d1
Showing 1 changed file with 84 additions and 0 deletions.
84 changes: 84 additions & 0 deletions website/docs/r/servicecatalog_provisioned_product.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
subcategory: "Service Catalog"
layout: "aws"
page_title: "AWS: aws_servicecatalog_product"
description: |-
Manages a Service Catalog Product
---

# Resource: aws_servicecatalog_product

Manages a Service Catalog Product.

~> **NOTE:** The user or role that uses this resources must have the `cloudformation:GetTemplate` IAM policy permission. This policy permission is required when using the `template_physical_id` argument.

-> A "provisioning artifact" is also referred to as a "version." A "distributor" is also referred to as a "vendor."

## Example Usage

### Basic Usage

```terraform
resource "aws_servicecatalog_product" "example" {
name = "example"
owner = [aws_security_group.example.id]
type = aws_subnet.main.id
provisioning_artifact_parameters {
template_url = "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/temp1.json"
}
tags = {
foo = "bar"
}
}
```

## Argument Reference

The following arguments are required:

* `name` - (Required) Name of the product.
* `owner` - (Required) Owner of the product.
* `provisioning_artifact_parameters` - (Required) Configuration block for provisioning artifact (i.e., version) parameters. Detailed below.
* `type` - (Required) Type of product. Valid values are `CLOUD_FORMATION_TEMPLATE`, `MARKETPLACE`.

The following arguments are optional:

* `accept_language` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`.
* `description` - (Optional) Description of the product.
* `distributor` - (Optional) Distributor (i.e., vendor) of the product.
* `support_description` - (Optional) Support information about the product.
* `support_email` - (Optional) Contact email for product support.
* `support_url` - (Optional) Contact URL for product support.
* `tags` - (Optional) Tags to apply to the product. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.

### provisioning_artifact_parameters

The following arguments are supported:

* `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.
* `name` - (Optional) Name of the provisioning artifact (for example, `v1`, `v2beta`). No spaces are allowed.
* `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.
* `type` - (Optional) Type of provisioning artifact. Valid values: `CLOUD_FORMATION_TEMPLATE`, `MARKETPLACE_AMI`, `MARKETPLACE_CAR` (Marketplace Clusters and AWS Resources).

## Attributes Reference

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

* `arn` - ARN of the product.
* `created_time` - Time when the product was created.
* `has_default_path` - Whether the product has a default path. If the product does not have a default path, call `ListLaunchPaths` to disambiguate between paths. Otherwise, `ListLaunchPaths` is not required, and the output of ProductViewSummary can be used directly with `DescribeProvisioningParameters`.
* `id` - Product ID.
* `status` - Status of the product.
* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block).

## Import

`aws_servicecatalog_product` can be imported using the product ID, e.g.

```
$ terraform import aws_servicecatalog_product.example arn:aws:catalog:us-east-1:123456789012:product/prod-dnigbtea24ste
```

0 comments on commit 69f13d1

Please sign in to comment.