Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ServiceCatalog.CreateProvisionedProductPlan

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Synopsis

Creating a Request

data CreateProvisionedProductPlan Source #

See: newCreateProvisionedProductPlan smart constructor.

Constructors

CreateProvisionedProductPlan'

Fields

notificationArns :: Maybe [Text]
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
acceptLanguage :: Maybe Text
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
pathId :: Maybe Text
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.
provisioningParameters :: Maybe [UpdateProvisioningParameter]
Parameters specified by the administrator that are required for provisioning the product.
tags :: Maybe [Tag]
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.
planName :: Text
The name of the plan.
planType :: ProvisionedProductPlanType
The plan type.
productId :: Text
The product identifier.
provisionedProductName :: Text
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 :: Text
The identifier of the provisioning artifact.
idempotencyToken :: Text
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.

Instances

Instances details

Eq CreateProvisionedProductPlan Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Methods (==) :: CreateProvisionedProductPlan -> CreateProvisionedProductPlan -> Bool # (/=) :: CreateProvisionedProductPlan -> CreateProvisionedProductPlan -> Bool #
Read CreateProvisionedProductPlan Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Methods readsPrec :: Int -> ReadS CreateProvisionedProductPlan # readList :: ReadS [CreateProvisionedProductPlan] # readPrec :: ReadPrec CreateProvisionedProductPlan # readListPrec :: ReadPrec [CreateProvisionedProductPlan] #
Show CreateProvisionedProductPlan Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Methods showsPrec :: Int -> CreateProvisionedProductPlan -> ShowS # show :: CreateProvisionedProductPlan -> String # showList :: [CreateProvisionedProductPlan] -> ShowS #
Generic CreateProvisionedProductPlan Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Associated Types type Rep CreateProvisionedProductPlan :: Type -> Type # Methods from :: CreateProvisionedProductPlan -> Rep CreateProvisionedProductPlan x # to :: Rep CreateProvisionedProductPlan x -> CreateProvisionedProductPlan #
NFData CreateProvisionedProductPlan Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Methods rnf :: CreateProvisionedProductPlan -> () #
Hashable CreateProvisionedProductPlan Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Methods hashWithSalt :: Int -> CreateProvisionedProductPlan -> Int # hash :: CreateProvisionedProductPlan -> Int #
ToJSON CreateProvisionedProductPlan Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Methods toJSON :: CreateProvisionedProductPlan -> Value # toEncoding :: CreateProvisionedProductPlan -> Encoding # toJSONList :: [CreateProvisionedProductPlan] -> Value # toEncodingList :: [CreateProvisionedProductPlan] -> Encoding #
AWSRequest CreateProvisionedProductPlan Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Associated Types type AWSResponse CreateProvisionedProductPlan # Methods request :: CreateProvisionedProductPlan -> Request CreateProvisionedProductPlan # response :: MonadResource m => Logger -> Service -> Proxy CreateProvisionedProductPlan -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateProvisionedProductPlan))) #
ToHeaders CreateProvisionedProductPlan Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Methods toHeaders :: CreateProvisionedProductPlan -> [Header] #
ToPath CreateProvisionedProductPlan Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Methods toPath :: CreateProvisionedProductPlan -> ByteString #
ToQuery CreateProvisionedProductPlan Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Methods toQuery :: CreateProvisionedProductPlan -> QueryString #
type Rep CreateProvisionedProductPlan Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan type Rep CreateProvisionedProductPlan = D1 ('MetaData "CreateProvisionedProductPlan" "Amazonka.ServiceCatalog.CreateProvisionedProductPlan" "libZSservicesZSamazonka-servicecatalogZSamazonka-servicecatalog" 'False) (C1 ('MetaCons "CreateProvisionedProductPlan'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "notificationArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "acceptLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "pathId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "provisioningParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UpdateProvisioningParameter])) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))))) :: ((S1 ('MetaSel ('Just "planName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "planType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProvisionedProductPlanType) :: S1 ('MetaSel ('Just "productId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "provisionedProductName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "provisioningArtifactId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateProvisionedProductPlan Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan type AWSResponse CreateProvisionedProductPlan = CreateProvisionedProductPlanResponse

newCreateProvisionedProductPlan Source #

Arguments

:: Text	`$sel:planName:CreateProvisionedProductPlan'`
-> ProvisionedProductPlanType	`$sel:planType:CreateProvisionedProductPlan'`
-> Text	`$sel:productId:CreateProvisionedProductPlan'`
-> Text	`$sel:provisionedProductName:CreateProvisionedProductPlan'`
-> Text	`$sel:provisioningArtifactId:CreateProvisionedProductPlan'`
-> Text	`$sel:idempotencyToken:CreateProvisionedProductPlan'`
-> CreateProvisionedProductPlan

Create a value of CreateProvisionedProductPlan with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:notificationArns:CreateProvisionedProductPlan', createProvisionedProductPlan_notificationArns - Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

$sel:acceptLanguage:CreateProvisionedProductPlan', createProvisionedProductPlan_acceptLanguage - The language code.

en - English (default)
jp - Japanese
zh - Chinese

$sel:pathId:CreateProvisionedProductPlan', createProvisionedProductPlan_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 ListLaunchPaths.

$sel:provisioningParameters:CreateProvisionedProductPlan', createProvisionedProductPlan_provisioningParameters - Parameters specified by the administrator that are required for provisioning the product.

$sel:tags:CreateProvisionedProductPlan', createProvisionedProductPlan_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.

$sel:planName:CreateProvisionedProductPlan', createProvisionedProductPlan_planName - The name of the plan.

$sel:planType:CreateProvisionedProductPlan', createProvisionedProductPlan_planType - The plan type.

$sel:productId:CreateProvisionedProductPlan', createProvisionedProductPlan_productId - The product identifier.

$sel:provisionedProductName:CreateProvisionedProductPlan', createProvisionedProductPlan_provisionedProductName - 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.

$sel:provisioningArtifactId:CreateProvisionedProductPlan', createProvisionedProductPlan_provisioningArtifactId - The identifier of the provisioning artifact.

$sel:idempotencyToken:CreateProvisionedProductPlan', createProvisionedProductPlan_idempotencyToken - 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.

Request Lenses

createProvisionedProductPlan_notificationArns :: Lens' CreateProvisionedProductPlan (Maybe [Text]) Source #

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

createProvisionedProductPlan_acceptLanguage :: Lens' CreateProvisionedProductPlan (Maybe Text) Source #

The language code.

en - English (default)
jp - Japanese
zh - Chinese

createProvisionedProductPlan_pathId :: Lens' CreateProvisionedProductPlan (Maybe Text) Source #

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.

createProvisionedProductPlan_provisioningParameters :: Lens' CreateProvisionedProductPlan (Maybe [UpdateProvisioningParameter]) Source #

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

createProvisionedProductPlan_tags :: Lens' CreateProvisionedProductPlan (Maybe [Tag]) Source #

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.

createProvisionedProductPlan_planName :: Lens' CreateProvisionedProductPlan Text Source #

The name of the plan.

createProvisionedProductPlan_planType :: Lens' CreateProvisionedProductPlan ProvisionedProductPlanType Source #

The plan type.

createProvisionedProductPlan_productId :: Lens' CreateProvisionedProductPlan Text Source #

The product identifier.

createProvisionedProductPlan_provisionedProductName :: Lens' CreateProvisionedProductPlan Text Source #

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.

createProvisionedProductPlan_provisioningArtifactId :: Lens' CreateProvisionedProductPlan Text Source #

The identifier of the provisioning artifact.

createProvisionedProductPlan_idempotencyToken :: Lens' CreateProvisionedProductPlan Text Source #

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.

Destructuring the Response

data CreateProvisionedProductPlanResponse Source #

See: newCreateProvisionedProductPlanResponse smart constructor.

Constructors

CreateProvisionedProductPlanResponse'
Fields provisionedProductName :: Maybe Text The user-friendly name of the provisioned product. provisionProductId :: Maybe Text The product identifier. provisioningArtifactId :: Maybe Text The identifier of the provisioning artifact. planId :: Maybe Text The plan identifier. planName :: Maybe Text The name of the plan. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateProvisionedProductPlanResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Methods (==) :: CreateProvisionedProductPlanResponse -> CreateProvisionedProductPlanResponse -> Bool # (/=) :: CreateProvisionedProductPlanResponse -> CreateProvisionedProductPlanResponse -> Bool #
Read CreateProvisionedProductPlanResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Methods readsPrec :: Int -> ReadS CreateProvisionedProductPlanResponse # readList :: ReadS [CreateProvisionedProductPlanResponse] # readPrec :: ReadPrec CreateProvisionedProductPlanResponse # readListPrec :: ReadPrec [CreateProvisionedProductPlanResponse] #
Show CreateProvisionedProductPlanResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Methods showsPrec :: Int -> CreateProvisionedProductPlanResponse -> ShowS # show :: CreateProvisionedProductPlanResponse -> String # showList :: [CreateProvisionedProductPlanResponse] -> ShowS #
Generic CreateProvisionedProductPlanResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Associated Types type Rep CreateProvisionedProductPlanResponse :: Type -> Type # Methods from :: CreateProvisionedProductPlanResponse -> Rep CreateProvisionedProductPlanResponse x # to :: Rep CreateProvisionedProductPlanResponse x -> CreateProvisionedProductPlanResponse #
NFData CreateProvisionedProductPlanResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan Methods rnf :: CreateProvisionedProductPlanResponse -> () #
type Rep CreateProvisionedProductPlanResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.CreateProvisionedProductPlan type Rep CreateProvisionedProductPlanResponse = D1 ('MetaData "CreateProvisionedProductPlanResponse" "Amazonka.ServiceCatalog.CreateProvisionedProductPlan" "libZSservicesZSamazonka-servicecatalogZSamazonka-servicecatalog" 'False) (C1 ('MetaCons "CreateProvisionedProductPlanResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "provisionedProductName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "provisionProductId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "provisioningArtifactId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "planId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "planName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))