provisioned_product_plans

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

Overview

Name	provisioned_product_plans
Type	Resource
Id	aws.servicecatalog.provisioned_product_plans

Fields

The following fields are returned by SELECT queries:

describe_provisioned_product_plan

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>)
provisioned_product_plan_details	object	Information about the plan.
resource_changes	array	Information about the resource changes that will occur when the plan is executed.

list_provisioned_product_plans

Name	Datatype	Description
plan_id	string	The plan identifier. (pattern: <code>^[a-zA-Z0-9_-]*</code>)
plan_name	string	The name of the plan.
plan_type	string	The plan type. (CLOUDFORMATION)
provision_product_id	string	The product identifier. (pattern: <code>^[a-zA-Z0-9_-]*</code>)
provision_product_name	string	The user-friendly name of the provisioned product. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9._-]*</code>)
provisioning_artifact_id	string	The identifier of the provisioning artifact. (pattern: <code>^[a-zA-Z0-9_-]*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_provisioned_product_plan	select	region		Gets information about the resource changes for the specified plan.
list_provisioned_product_plans	select	region		Lists the plans for the specified provisioned product or all plans to which the user has access.
create_provisioned_product_plan	insert	region, PlanName, PlanType, ProductId, ProvisionedProductName, ProvisioningArtifactId, IdempotencyToken		Creates a plan. A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed. You can create one plan for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED. To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.
delete_provisioned_product_plan	delete	region		Deletes the specified plan.

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_provisioned_product_plan

Gets information about the resource changes for the specified plan.

SELECT
next_page_token,
provisioned_product_plan_details,
resource_changes
FROM aws.servicecatalog.provisioned_product_plans
WHERE region = '{{ region }}' -- required
;

list_provisioned_product_plans

Lists the plans for the specified provisioned product or all plans to which the user has access.

SELECT
plan_id,
plan_name,
plan_type,
provision_product_id,
provision_product_name,
provisioning_artifact_id
FROM aws.servicecatalog.provisioned_product_plans
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_provisioned_product_plan

Creates a plan. A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed. You can create one plan for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED. To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

INSERT INTO aws.servicecatalog.provisioned_product_plans (
AcceptLanguage,
PlanName,
PlanType,
NotificationArns,
PathId,
ProductId,
ProvisionedProductName,
ProvisioningArtifactId,
ProvisioningParameters,
IdempotencyToken,
Tags,
region
)
SELECT 
'{{ AcceptLanguage }}',
'{{ PlanName }}' /* required */,
'{{ PlanType }}' /* required */,
'{{ NotificationArns }}',
'{{ PathId }}',
'{{ ProductId }}' /* required */,
'{{ ProvisionedProductName }}' /* required */,
'{{ ProvisioningArtifactId }}' /* required */,
'{{ ProvisioningParameters }}',
'{{ IdempotencyToken }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
plan_id,
plan_name,
provision_product_id,
provisioned_product_name,
provisioning_artifact_id
;

Manifest

# Description fields are for documentation purposes
- name: provisioned_product_plans
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the provisioned_product_plans resource.
  - name: AcceptLanguage
    value: "{{ AcceptLanguage }}"
    description: |
      The language code. jp - Japanese zh - Chinese
  - name: PlanName
    value: "{{ PlanName }}"
    description: |
      The name of the plan.
  - name: PlanType
    value: "{{ PlanType }}"
    description: |
      The plan type.
    valid_values: ['CLOUDFORMATION']
  - name: NotificationArns
    value:
      - "{{ NotificationArns }}"
    description: |
      Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
  - name: PathId
    value: "{{ PathId }}"
    description: |
      The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.
  - name: ProductId
    value: "{{ ProductId }}"
    description: |
      The product identifier.
  - name: ProvisionedProductName
    value: "{{ ProvisionedProductName }}"
    description: |
      A user-friendly name for the provisioned product. This value must be unique for the Amazon Web Services account and cannot be updated after the product is provisioned.
  - name: ProvisioningArtifactId
    value: "{{ ProvisioningArtifactId }}"
    description: |
      The identifier of the provisioning artifact.
  - name: ProvisioningParameters
    description: |
      Parameters specified by the administrator that are required for provisioning the product.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
        UsePreviousValue: {{ UsePreviousValue }}
  - 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.
  - name: Tags
    description: |
      One or more tags. If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_provisioned_product_plan

Deletes the specified plan.

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