provisioning_artifacts

Creates, updates, deletes, gets or lists a provisioning_artifacts resource.

Overview

Name	provisioning_artifacts
Type	Resource
Id	aws.servicecatalog.provisioning_artifacts

Fields

The following fields are returned by SELECT queries:

list_provisioning_artifacts

Name	Datatype	Description
next_page_token	string	The page token to use to retrieve the next set of results. If there are no additional results, this value is null. (pattern: <code>[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*</code>)
provisioning_artifact_details	array	Information about the provisioning artifacts.

describe_provisioning_artifact

Name	Datatype	Description
info	object	The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.
provisioning_artifact_detail	object	Information about the provisioning artifact.
provisioning_artifact_parameters	array	Information about the parameters used to provision the product.
status	string	The status of the current request. (AVAILABLE, CREATING, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_provisioning_artifacts	select	region		Lists all provisioning artifacts (also known as versions) for the specified product.
describe_provisioning_artifact	select	region		Gets information about the specified provisioning artifact (also known as a version) for the specified product.
create_provisioning_artifact	insert	region, ProductId, Parameters, IdempotencyToken		Creates a provisioning artifact (also known as a version) for the specified product. You cannot create a provisioning artifact for a product that was shared with you. The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.
associate_service_action_with_provisioning_artifact	update	region, ProductId, ProvisioningArtifactId, ServiceActionId		Associates a self-service action with a provisioning artifact.
update_provisioning_artifact	update	region, ProductId, ProvisioningArtifactId		Updates the specified provisioning artifact (also known as a version) for the specified product. You cannot update a provisioning artifact for a product that was shared with you.
delete_provisioning_artifact	delete	region		Deletes the specified provisioning artifact (also known as a version) for the specified product. You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.
disassociate_service_action_from_provisioning_artifact	exec	region, ProductId, ProvisioningArtifactId, ServiceActionId		Disassociates the specified self-service action association from the specified provisioning artifact.
import_as_provisioned_product	exec	region, ProductId, ProvisioningArtifactId, ProvisionedProductName, PhysicalId, IdempotencyToken		Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product. Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks, are not supported. The CloudFormation stack must have one of the following statuses to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, and IMPORT_ROLLBACK_COMPLETE. Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact. When you import an existing CloudFormation stack into a portfolio, Service Catalog does not apply the product's associated constraints during the import process. Service Catalog applies the constraints after you call UpdateProvisionedProduct for the provisioned product. The user or role that performs this operation must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions. You can only import one provisioned product at a time. The product's CloudFormation stack must have the IMPORT_COMPLETE status before you import another.

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

list_provisioning_artifacts

Lists all provisioning artifacts (also known as versions) for the specified product.

SELECT
next_page_token,
provisioning_artifact_details
FROM aws.servicecatalog.provisioning_artifacts
WHERE region = '{{ region }}' -- required
;

describe_provisioning_artifact

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

SELECT
info,
provisioning_artifact_detail,
provisioning_artifact_parameters,
status
FROM aws.servicecatalog.provisioning_artifacts
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_provisioning_artifact

Creates a provisioning artifact (also known as a version) for the specified product. You cannot create a provisioning artifact for a product that was shared with you. The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.

INSERT INTO aws.servicecatalog.provisioning_artifacts (
AcceptLanguage,
ProductId,
Parameters,
IdempotencyToken,
region
)
SELECT 
'{{ AcceptLanguage }}',
'{{ ProductId }}' /* required */,
'{{ Parameters }}' /* required */,
'{{ IdempotencyToken }}' /* required */,
'{{ region }}'
RETURNING
info,
provisioning_artifact_detail,
status
;

Manifest

# Description fields are for documentation purposes
- name: provisioning_artifacts
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the provisioning_artifacts resource.
  - name: AcceptLanguage
    value: "{{ AcceptLanguage }}"
    description: |
      The language code. jp - Japanese zh - Chinese
  - name: ProductId
    value: "{{ ProductId }}"
    description: |
      The product identifier.
  - name: Parameters
    description: |
      The configuration for the provisioning artifact.
    value:
      Name: "{{ Name }}"
      Description: "{{ Description }}"
      Info: "{{ Info }}"
      Type: "{{ Type }}"
      DisableTemplateValidation: {{ DisableTemplateValidation }}
  - name: IdempotencyToken
    value: "{{ IdempotencyToken }}"
    description: |
      A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

UPDATE examples

associate_service_action_with_provisioning_artifact

Associates a self-service action with a provisioning artifact.

UPDATE aws.servicecatalog.provisioning_artifacts
SET 
ProductId = '{{ ProductId }}',
ProvisioningArtifactId = '{{ ProvisioningArtifactId }}',
ServiceActionId = '{{ ServiceActionId }}',
AcceptLanguage = '{{ AcceptLanguage }}',
IdempotencyToken = '{{ IdempotencyToken }}'
WHERE 
region = '{{ region }}' --required
AND ProductId = '{{ ProductId }}' --required
AND ProvisioningArtifactId = '{{ ProvisioningArtifactId }}' --required
AND ServiceActionId = '{{ ServiceActionId }}' --required;

update_provisioning_artifact

Updates the specified provisioning artifact (also known as a version) for the specified product. You cannot update a provisioning artifact for a product that was shared with you.

UPDATE aws.servicecatalog.provisioning_artifacts
SET 
AcceptLanguage = '{{ AcceptLanguage }}',
ProductId = '{{ ProductId }}',
ProvisioningArtifactId = '{{ ProvisioningArtifactId }}',
Name = '{{ Name }}',
Description = '{{ Description }}',
Active = {{ Active }},
Guidance = '{{ Guidance }}'
WHERE 
region = '{{ region }}' --required
AND ProductId = '{{ ProductId }}' --required
AND ProvisioningArtifactId = '{{ ProvisioningArtifactId }}' --required
RETURNING
info,
provisioning_artifact_detail,
status;

DELETE examples

delete_provisioning_artifact

Deletes the specified provisioning artifact (also known as a version) for the specified product. You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.

DELETE FROM aws.servicecatalog.provisioning_artifacts
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

disassociate_service_action_from_provisioning_artifact

Disassociates the specified self-service action association from the specified provisioning artifact.

EXEC aws.servicecatalog.provisioning_artifacts.disassociate_service_action_from_provisioning_artifact 
@region='{{ region }}' --required 
@@json=
'{
"ProductId": "{{ ProductId }}", 
"ProvisioningArtifactId": "{{ ProvisioningArtifactId }}", 
"ServiceActionId": "{{ ServiceActionId }}", 
"AcceptLanguage": "{{ AcceptLanguage }}", 
"IdempotencyToken": "{{ IdempotencyToken }}"
}'
;

import_as_provisioned_product

Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product. Resource import only supports CloudFormation stack ARNs. CloudFormation StackSets, and non-root nested stacks, are not supported. The CloudFormation stack must have one of the following statuses to be imported: CREATE_COMPLETE, UPDATE_COMPLETE, UPDATE_ROLLBACK_COMPLETE, IMPORT_COMPLETE, and IMPORT_ROLLBACK_COMPLETE. Import of the resource requires that the CloudFormation stack template matches the associated Service Catalog product provisioning artifact. When you import an existing CloudFormation stack into a portfolio, Service Catalog does not apply the product's associated constraints during the import process. Service Catalog applies the constraints after you call UpdateProvisionedProduct for the provisioned product. The user or role that performs this operation must have the cloudformation:GetTemplate and cloudformation:DescribeStacks IAM policy permissions. You can only import one provisioned product at a time. The product's CloudFormation stack must have the IMPORT_COMPLETE status before you import another.

EXEC aws.servicecatalog.provisioning_artifacts.import_as_provisioned_product 
@region='{{ region }}' --required 
@@json=
'{
"AcceptLanguage": "{{ AcceptLanguage }}", 
"ProductId": "{{ ProductId }}", 
"ProvisioningArtifactId": "{{ ProvisioningArtifactId }}", 
"ProvisionedProductName": "{{ ProvisionedProductName }}", 
"PhysicalId": "{{ PhysicalId }}", 
"IdempotencyToken": "{{ IdempotencyToken }}"
}'
;