cloud_formation_provisioned_products

Creates, updates, deletes or gets a cloud_formation_provisioned_product resource or lists cloud_formation_provisioned_products in a region

Overview

Name	cloud_formation_provisioned_products
Type	Resource
Description	Resource Schema for AWS::ServiceCatalog::CloudFormationProvisionedProduct
Id	awscc.servicecatalog.cloud_formation_provisioned_products

Fields

Name	Datatype	Description
accept_language	string
notification_arns	array
path_id	string
path_name	string
product_id	string
product_name	string
provisioned_product_name	string
provisioning_artifact_id	string
provisioning_artifact_name	string
▶provisioning_parameters	array
▶provisioning_preferences	object
▶tags	array
provisioned_product_id	string
record_id	string
cloudformation_stack_arn	string
outputs	object	List of key-value pair outputs.
region	string	AWS region.

For more information, see AWS::ServiceCatalog::CloudFormationProvisionedProduct.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual cloud_formation_provisioned_product.

SELECT
  region,
  accept_language,
  notification_arns,
  path_id,
  path_name,
  product_id,
  product_name,
  provisioned_product_name,
  provisioning_artifact_id,
  provisioning_artifact_name,
  provisioning_parameters,
  provisioning_preferences,
  tags,
  provisioned_product_id,
  record_id,
  cloudformation_stack_arn,
  outputs
FROM awscc.servicecatalog.cloud_formation_provisioned_products
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ provisioned_product_id }}';

INSERT example

Use the following StackQL query and manifest file to create a new cloud_formation_provisioned_product resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.servicecatalog.cloud_formation_provisioned_products (
  AcceptLanguage,
  NotificationArns,
  PathId,
  PathName,
  ProductId,
  ProductName,
  ProvisionedProductName,
  ProvisioningArtifactId,
  ProvisioningArtifactName,
  ProvisioningParameters,
  ProvisioningPreferences,
  Tags,
  region
)
SELECT
  '{{ accept_language }}',
  '{{ notification_arns }}',
  '{{ path_id }}',
  '{{ path_name }}',
  '{{ product_id }}',
  '{{ product_name }}',
  '{{ provisioned_product_name }}',
  '{{ provisioning_artifact_id }}',
  '{{ provisioning_artifact_name }}',
  '{{ provisioning_parameters }}',
  '{{ provisioning_preferences }}',
  '{{ tags }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.servicecatalog.cloud_formation_provisioned_products (
  AcceptLanguage,
  NotificationArns,
  PathId,
  PathName,
  ProductId,
  ProductName,
  ProvisionedProductName,
  ProvisioningArtifactId,
  ProvisioningArtifactName,
  ProvisioningParameters,
  ProvisioningPreferences,
  Tags,
  region
)
SELECT
  '{{ accept_language }}',
  '{{ notification_arns }}',
  '{{ path_id }}',
  '{{ path_name }}',
  '{{ product_id }}',
  '{{ product_name }}',
  '{{ provisioned_product_name }}',
  '{{ provisioning_artifact_id }}',
  '{{ provisioning_artifact_name }}',
  '{{ provisioning_parameters }}',
  '{{ provisioning_preferences }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: cloud_formation_provisioned_product
    props:
      - name: accept_language
        value: '{{ accept_language }}'
      - name: notification_arns
        value:
          - '{{ notification_arns[0] }}'
      - name: path_id
        value: '{{ path_id }}'
      - name: path_name
        value: '{{ path_name }}'
      - name: product_id
        value: '{{ product_id }}'
      - name: product_name
        value: '{{ product_name }}'
      - name: provisioned_product_name
        value: '{{ provisioned_product_name }}'
      - name: provisioning_artifact_id
        value: '{{ provisioning_artifact_id }}'
      - name: provisioning_artifact_name
        value: '{{ provisioning_artifact_name }}'
      - name: provisioning_parameters
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: provisioning_preferences
        value:
          stack_set_accounts:
            - '{{ stack_set_accounts[0] }}'
          stack_set_failure_tolerance_count: '{{ stack_set_failure_tolerance_count }}'
          stack_set_failure_tolerance_percentage: '{{ stack_set_failure_tolerance_percentage }}'
          stack_set_max_concurrency_count: '{{ stack_set_max_concurrency_count }}'
          stack_set_max_concurrency_percentage: '{{ stack_set_max_concurrency_percentage }}'
          stack_set_operation_type: '{{ stack_set_operation_type }}'
          stack_set_regions:
            - '{{ stack_set_regions[0] }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a cloud_formation_provisioned_product resource, using stack-deploy.

/*+ update */
UPDATE awscc.servicecatalog.cloud_formation_provisioned_products
SET PatchDocument = string('{{ {
    "AcceptLanguage": accept_language,
    "PathId": path_id,
    "PathName": path_name,
    "ProductId": product_id,
    "ProductName": product_name,
    "ProvisioningArtifactId": provisioning_artifact_id,
    "ProvisioningArtifactName": provisioning_artifact_name,
    "ProvisioningParameters": provisioning_parameters,
    "ProvisioningPreferences": provisioning_preferences,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ provisioned_product_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.servicecatalog.cloud_formation_provisioned_products
WHERE
  Identifier = '{{ provisioned_product_id }}' AND
  region = 'us-east-1';

Permissions

To operate on the cloud_formation_provisioned_products resource, the following permissions are required:

Create

servicecatalog:provisionProduct,
cloudformation:CreateStack

Read

servicecatalog:describeProvisionedProduct,
cloudformation:ListStacks

Update

servicecatalog:updateProvisionedProduct,
cloudformation:UpdateStack

Delete

servicecatalog:terminateProvisionedProduct,
servicecatalog:describeRecord,
cloudformation:DeleteStack