servicecatalog_create_provisioned_product_plan: Creates a plan

Description Usage Arguments Value Request syntax

View source: R/servicecatalog_operations.R

Description

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 per provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILBLE or TAINTED.

To view the resource changes in the change set, use describe_provisioned_product_plan. To create or modify the provisioned product, use execute_provisioned_product_plan.

Usage

1
2
3
servicecatalog_create_provisioned_product_plan(AcceptLanguage, PlanName,
  PlanType, NotificationArns, PathId, ProductId, ProvisionedProductName,
  ProvisioningArtifactId, ProvisioningParameters, IdempotencyToken, Tags)

Arguments

AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

PlanName

[required] The name of the plan.

PlanType

[required] The plan type.

NotificationArns

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

PathId

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 list_launch_paths.

ProductId

[required] The product identifier.

ProvisionedProductName

[required] A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.

ProvisioningArtifactId

[required] The identifier of the provisioning artifact.

ProvisioningParameters

Parameters specified by the administrator that are required for provisioning the product.

IdempotencyToken

[required] 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.

Tags

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

A list with the following syntax:

1
2
3
4
5
6
7
list(
  PlanName = "string",
  PlanId = "string",
  ProvisionProductId = "string",
  ProvisionedProductName = "string",
  ProvisioningArtifactId = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
svc$create_provisioned_product_plan(
  AcceptLanguage = "string",
  PlanName = "string",
  PlanType = "CLOUDFORMATION",
  NotificationArns = list(
    "string"
  ),
  PathId = "string",
  ProductId = "string",
  ProvisionedProductName = "string",
  ProvisioningArtifactId = "string",
  ProvisioningParameters = list(
    list(
      Key = "string",
      Value = "string",
      UsePreviousValue = TRUE|FALSE
    )
  ),
  IdempotencyToken = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.