[ aws . servicecatalog ]

create-provisioned-product-plan

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 DescribeProvisionedProductPlan . To create or modify the provisioned product, use ExecuteProvisionedProductPlan .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-provisioned-product-plan
[--accept-language <value>]
--plan-name <value>
--plan-type <value>
[--notification-arns <value>]
[--path-id <value>]
--product-id <value>
--provisioned-product-name <value>
--provisioning-artifact-id <value>
[--provisioning-parameters <value>]
[--idempotency-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--accept-language (string)

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

--plan-name (string)

The name of the plan.

--plan-type (string)

The plan type.

Possible values:

• CLOUDFORMATION

--notification-arns (list)

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

(string)

Syntax:

"string" "string" ...

--path-id (string)

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 .

--product-id (string)

The product identifier.

--provisioned-product-name (string)

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.

--provisioning-artifact-id (string)

The identifier of the provisioning artifact.

--provisioning-parameters (list)

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

(structure)

The parameter key-value pair used to update a provisioned product.

Key -> (string)

The parameter key.

Value -> (string)

The parameter value.

UsePreviousValue -> (boolean)

If set to true, Value is ignored and the previous parameter value is kept.

Shorthand Syntax:

Key=string,Value=string,UsePreviousValue=boolean ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string",
    "UsePreviousValue": true|false
  }
  ...
]

--idempotency-token (string)

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 (list)

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.

(structure)

Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.

Key -> (string)

The tag key.

Value -> (string)

The value for this key.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

PlanName -> (string)

The name of the plan.

PlanId -> (string)

The plan identifier.

ProvisionProductId -> (string)

The product identifier.

ProvisionedProductName -> (string)

The user-friendly name of the provisioned product.

ProvisioningArtifactId -> (string)

The identifier of the provisioning artifact.