class CfnCloudFormationProvisionedProduct (construct)

Language	Type name
.NET	Amazon.CDK.AWS.Servicecatalog.CfnCloudFormationProvisionedProduct
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsservicecatalog#CfnCloudFormationProvisionedProduct
Java	software.amazon.awscdk.services.servicecatalog.CfnCloudFormationProvisionedProduct
Python	aws_cdk.aws_servicecatalog.CfnCloudFormationProvisionedProduct
TypeScript	aws-cdk-lib » aws_servicecatalog » CfnCloudFormationProvisionedProduct

Implements IConstruct, IDependable, IInspectable, ITaggable

Provisions the specified product.

A provisioned product is a resourced instance of a product. For example, provisioning a product based on a AWS CloudFormation template launches a AWS CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord .

If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[ N ]: Value ".

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_servicecatalog as servicecatalog } from 'aws-cdk-lib';
const cfnCloudFormationProvisionedProduct = new servicecatalog.CfnCloudFormationProvisionedProduct(this, 'MyCfnCloudFormationProvisionedProduct', /* all optional props */ {
  acceptLanguage: 'acceptLanguage',
  notificationArns: ['notificationArns'],
  pathId: 'pathId',
  pathName: 'pathName',
  productId: 'productId',
  productName: 'productName',
  provisionedProductName: 'provisionedProductName',
  provisioningArtifactId: 'provisioningArtifactId',
  provisioningArtifactName: 'provisioningArtifactName',
  provisioningParameters: [{
    key: 'key',
    value: 'value',
  }],
  provisioningPreferences: {
    stackSetAccounts: ['stackSetAccounts'],
    stackSetFailureToleranceCount: 123,
    stackSetFailureTolerancePercentage: 123,
    stackSetMaxConcurrencyCount: 123,
    stackSetMaxConcurrencyPercentage: 123,
    stackSetOperationType: 'stackSetOperationType',
    stackSetRegions: ['stackSetRegions'],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnCloudFormationProvisionedProduct(scope: Construct, id: string, props?: CfnCloudFormationProvisionedProductProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnCloudFormationProvisionedProductProps — Resource properties.

Construct Props

Name	Type	Description
acceptLanguage?	string	The language code.
notificationArns?	string[]	Passed to AWS CloudFormation .
pathId?	string	The path identifier of the product.
pathName?	string	The name of the path.
productId?	string	The product identifier.
productName?	string	The name of the Service Catalog product.
provisionedProductName?	string	A user-friendly name for the provisioned product.
provisioningArtifactId?	string	The identifier of the provisioning artifact (also known as a version).
provisioningArtifactName?	string	The name of the provisioning artifact (also known as a version) for the product.
provisioningParameters?	IResolvable | IResolvable | ProvisioningParameterProperty[]	Parameters specified by the administrator that are required for provisioning the product.
provisioningPreferences?	IResolvable | ProvisioningPreferencesProperty	StackSet preferences that are required for provisioning the product or updating a provisioned product.
tags?	CfnTag[]	One or more tags.

---

acceptLanguage?

Type: string (optional)

The language code.

• jp - Japanese
• zh - Chinese

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-acceptlanguage

---

notificationArns?

Type: string[] (optional)

Passed to AWS CloudFormation .

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-notificationarns

---

pathId?

Type: string (optional)

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 .

You must provide the name or ID, but not both.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-pathid

---

pathName?

Type: string (optional)

The name of the path.

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 .

You must provide the name or ID, but not both.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-pathname

---

productId?

Type: string (optional)

The product identifier.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-productid

---

productName?

Type: string (optional)

The name of the Service Catalog product.

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 or Region with that ProductName .

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-productname

---

provisionedProductName?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisionedproductname

---

provisioningArtifactId?

Type: string (optional)

The identifier of the provisioning artifact (also known as a version).

You must specify either the ID or the name of the provisioning artifact, but not both.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningartifactid

---

provisioningArtifactName?

Type: string (optional)

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. You must also specify either the name or the ID of the product, but not both.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningartifactname

---

provisioningParameters?

Type: IResolvable | IResolvable | ProvisioningParameterProperty[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningparameters

---

provisioningPreferences?

Type: IResolvable | ProvisioningPreferencesProperty (optional)

StackSet preferences that are required for provisioning the product or updating a provisioned product.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-provisioningpreferences

---

tags?

Type: CfnTag[] (optional)

One or more tags.

Requires the provisioned product to have an ResourceUpdateConstraint resource with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates. If RESOURCE_UPDATE constraint is not present, tags updates are ignored.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationprovisionedproduct.html#cfn-servicecatalog-cloudformationprovisionedproduct-tags

Properties

Name	Type	Description
attrCloudformationStackArn	string
attrOutputs	IResolvable	List of key-value pair outputs.
attrProvisionedProductId	string	The ID of the provisioned product.
attrRecordId	string	The ID of the record, such as rec-rjeatvy434trk .
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
logicalId	string	The logical ID for this CloudFormation stack element.
node	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
tags	TagManager	Tag Manager which manages the tags for this resource.
acceptLanguage?	string	The language code.
notificationArns?	string[]	Passed to AWS CloudFormation .
pathId?	string	The path identifier of the product.
pathName?	string	The name of the path.
productId?	string	The product identifier.
productName?	string	The name of the Service Catalog product.
provisionedProductName?	string	A user-friendly name for the provisioned product.
provisioningArtifactId?	string	The identifier of the provisioning artifact (also known as a version).
provisioningArtifactName?	string	The name of the provisioning artifact (also known as a version) for the product.
provisioningParameters?	IResolvable | IResolvable | ProvisioningParameterProperty[]	Parameters specified by the administrator that are required for provisioning the product.
provisioningPreferences?	IResolvable | ProvisioningPreferencesProperty	StackSet preferences that are required for provisioning the product or updating a provisioned product.
tagsRaw?	CfnTag[]	One or more tags.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrCloudformationStackArn

Type: string

---

attrOutputs

Type: IResolvable

List of key-value pair outputs.

---

attrProvisionedProductId

Type: string

The ID of the provisioned product.

---

attrRecordId

Type: string

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

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

node

Type: Node

The tree node.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

tags

Type: TagManager

Tag Manager which manages the tags for this resource.

---

acceptLanguage?

Type: string (optional)

The language code.

---

notificationArns?

Type: string[] (optional)

Passed to AWS CloudFormation .

---

pathId?

Type: string (optional)

The path identifier of the product.

---

pathName?

Type: string (optional)

The name of the path.

---

productId?

Type: string (optional)

The product identifier.

---

productName?

Type: string (optional)

The name of the Service Catalog product.

---

provisionedProductName?

Type: string (optional)

A user-friendly name for the provisioned product.

---

provisioningArtifactId?

Type: string (optional)

The identifier of the provisioning artifact (also known as a version).

---

provisioningArtifactName?

Type: string (optional)

The name of the provisioning artifact (also known as a version) for the product.

---

provisioningParameters?

Type: IResolvable | IResolvable | ProvisioningParameterProperty[] (optional)

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

---

provisioningPreferences?

Type: IResolvable | ProvisioningPreferencesProperty (optional)

StackSet preferences that are required for provisioning the product or updating a provisioned product.

---

tagsRaw?

Type: CfnTag[] (optional)

One or more tags.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }