provisioning_parameters
Creates, updates, deletes, gets or lists a provisioning_parameters resource.
Overview
| Name | provisioning_parameters |
| Type | Resource |
| Id | aws.servicecatalog.provisioning_parameters |
Fields
The following fields are returned by SELECT queries:
- describe_provisioning_parameters
| Name | Datatype | Description |
|---|---|---|
constraint_summaries | array | Information about the constraints used to provision the product. |
provisioning_artifact_output_keys | array | A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact. |
provisioning_artifact_outputs | array | The output of the provisioning artifact. |
provisioning_artifact_parameters | array | Information about the parameters used to provision the product. |
provisioning_artifact_preferences | object | An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact. |
tag_options | array | Information about the TagOptions associated with the resource. |
usage_instructions | array | Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_provisioning_parameters | select | region | Gets information about the configuration required to provision the specified product using the specified provisioning artifact. If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_provisioning_parameters
Gets information about the configuration required to provision the specified product using the specified provisioning artifact. If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.
SELECT
constraint_summaries,
provisioning_artifact_output_keys,
provisioning_artifact_outputs,
provisioning_artifact_parameters,
provisioning_artifact_preferences,
tag_options,
usage_instructions
FROM aws.servicecatalog.provisioning_parameters
WHERE region = '{{ region }}' -- required
;