AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS Service Catalog Resource Types Reference » AWS::ServiceCatalog::CloudFormationProvisionedProduct

Filter View: All JSON YAML

AWS::ServiceCatalog::CloudFormationProvisionedProduct

Provisions the specified product for AWS Service Catalog. For more information, see ProvisionProduct in the AWS Service Catalog Developer Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ServiceCatalog::CloudFormationProvisionedProduct",
  "Properties" : {
    "PathId" : String,
    "ProvisioningParameters" : [ ProvisioningParameter, ... ],
    "ProductName" : String,
    "ProvisioningArtifactName" : String,
    "NotificationArns" : [ String, ... ],
    "AcceptLanguage" : String,
    "ProductId" : String,
    "Tags" : [ Tag, ... ],
    "ProvisionedProductName" : String,
    "ProvisioningArtifactId" : String
  }
}

YAML

Type: "AWS::ServiceCatalog::CloudFormationProvisionedProduct"
Properties:
  PathId: String
  ProvisioningParameters: 
    - ProvisioningParameter
  ProductName: String
  ProvisioningArtifactName: String
  NotificationArns: 
    - String
  AcceptLanguage: String
  ProductId: String
  Tags: 
    - Tag
  ProvisionedProductName: String
  ProvisioningArtifactId: String

Properties

AcceptLanguage

The language code.

Required: No

Type: String

Update requires: No interruption

NotificationArns

The SNS topic ARNs for stack-related events.

Required: No

Type: List of String values

Update requires: Replacement

PathId

The path identifier of the product.

Required: No

Type: String

Update requires: No interruption

ProductId

The product identifier. You must specify either the ID or the name of the product, but not both.

Required: No

Type: String

Update requires: No interruption

ProductName

The product name. This name must be unique for the user. You must specify either the name or the ID of the product, but not both.

Each time a stack is created or updated, if ProductName is provided it will successfully resolve to ProductId as long as only one product exists in the account/region with that ProductName.

Required: No

Type: String

Update requires: No interruption

ProvisionedProductName

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

Required: No

Type: String

Update requires: Replacement

ProvisioningArtifactId

The identifier of the provisioning artifact (also known as a version) for the product. You must specify either the ID or the name of the provisioning artifact, but not both.

Required: No

Type: String

Update requires: No interruption

ProvisioningArtifactName

The name of the provisioning artifact (also known as a version) for the product. This name must be unique for the product. You must specify either the name or the ID of the provisioning artifact, but not both.

Required: No

Type: String

Update requires: No interruption

ProvisioningParameters

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

Required: No

Type: List of ProvisioningParameter property types

Update requires: No interruption

Tags

One or more tags.

Required: No

Type: List of Resource Tag property types

Update requires: Replacement

Return Values

Ref

When you pass the logical ID of an AWS::ServiceCatalog::CloudFormationProvisionedProduct resource to the intrinsic Ref function, the function returns the provisioned product ID, such as pp-hfyszaotincww.

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

CloudformationStackArn

The Amazon Resource Name (ARN) of the CloudFormation stack, such as arn:aws:cloudformation:eu-west-1:123456789012:stack/SC-499278721343-pp-hfyszaotincww/8f3df460-346a-11e8-9444-503abe701c29.

RecordId

The ID of the record, such as rec-rjeatvy434trk.

For more information about using Fn::GetAtt, see Fn::GetAtt.