CfnCloudFormationProvisionedProduct

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.servicecatalog.CfnCloudFormationProvisionedProduct

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:53.666Z")
public class CfnCloudFormationProvisionedProduct
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ServiceCatalog::CloudFormationProvisionedProduct`.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.servicecatalog.*;
 CfnCloudFormationProvisionedProduct cfnCloudFormationProvisionedProduct = CfnCloudFormationProvisionedProduct.Builder.create(this, "MyCfnCloudFormationProvisionedProduct")
         .acceptLanguage("acceptLanguage")
         .notificationArns(List.of("notificationArns"))
         .pathId("pathId")
         .pathName("pathName")
         .productId("productId")
         .productName("productName")
         .provisionedProductName("provisionedProductName")
         .provisioningArtifactId("provisioningArtifactId")
         .provisioningArtifactName("provisioningArtifactName")
         .provisioningParameters(List.of(ProvisioningParameterProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .provisioningPreferences(ProvisioningPreferencesProperty.builder()
                 .stackSetAccounts(List.of("stackSetAccounts"))
                 .stackSetFailureToleranceCount(123)
                 .stackSetFailureTolerancePercentage(123)
                 .stackSetMaxConcurrencyCount(123)
                 .stackSetMaxConcurrencyPercentage(123)
                 .stackSetOperationType("stackSetOperationType")
                 .stackSetRegions(List.of("stackSetRegions"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnCloudFormationProvisionedProduct.Builder` A fluent builder for `CfnCloudFormationProvisionedProduct`.
`static interface`	`CfnCloudFormationProvisionedProduct.ProvisioningParameterProperty` Information about a parameter used to provision a product.
`static interface`	`CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty` The user-defined preferences that will be applied when updating a provisioned product.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnCloudFormationProvisionedProduct(Construct scope, java.lang.String id)` Create a new `AWS::ServiceCatalog::CloudFormationProvisionedProduct`.
	`CfnCloudFormationProvisionedProduct(Construct scope, java.lang.String id, CfnCloudFormationProvisionedProductProps props)` Create a new `AWS::ServiceCatalog::CloudFormationProvisionedProduct`.
`protected`	`CfnCloudFormationProvisionedProduct(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnCloudFormationProvisionedProduct(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAcceptLanguage()` The language code.
`java.lang.String`	`getAttrCloudformationStackArn()` 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` .
`IResolvable`	`getAttrOutputs()` The output of the product you are provisioning.
`java.lang.String`	`getAttrProvisionedProductId()` The ID of the provisioned product.
`java.lang.String`	`getAttrRecordId()` The ID of the record, such as `rec-rjeatvy434trk` .
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.util.List<java.lang.String>`	`getNotificationArns()` Passed to AWS CloudFormation .
`java.lang.String`	`getPathId()` The path identifier of the product.
`java.lang.String`	`getPathName()` The name of the path.
`java.lang.String`	`getProductId()` The product identifier.
`java.lang.String`	`getProductName()` A user-friendly name for the provisioned product.
`java.lang.String`	`getProvisionedProductName()` A user-friendly name for the provisioned product.
`java.lang.String`	`getProvisioningArtifactId()` The identifier of the provisioning artifact (also known as a version).
`java.lang.String`	`getProvisioningArtifactName()` The name of the provisioning artifact (also known as a version) for the product.
`java.lang.Object`	`getProvisioningParameters()` Parameters specified by the administrator that are required for provisioning the product.
`java.lang.Object`	`getProvisioningPreferences()` StackSet preferences that are required for provisioning the product or updating a provisioned product.
`TagManager`	`getTags()` One or more tags.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAcceptLanguage(java.lang.String value)` The language code.
`void`	`setNotificationArns(java.util.List<java.lang.String> value)` Passed to AWS CloudFormation .
`void`	`setPathId(java.lang.String value)` The path identifier of the product.
`void`	`setPathName(java.lang.String value)` The name of the path.
`void`	`setProductId(java.lang.String value)` The product identifier.
`void`	`setProductName(java.lang.String value)` A user-friendly name for the provisioned product.
`void`	`setProvisionedProductName(java.lang.String value)` A user-friendly name for the provisioned product.
`void`	`setProvisioningArtifactId(java.lang.String value)` The identifier of the provisioning artifact (also known as a version).
`void`	`setProvisioningArtifactName(java.lang.String value)` The name of the provisioning artifact (also known as a version) for the product.
`void`	`setProvisioningParameters(IResolvable value)` Parameters specified by the administrator that are required for provisioning the product.
`void`	`setProvisioningParameters(java.util.List<java.lang.Object> value)` Parameters specified by the administrator that are required for provisioning the product.
`void`	`setProvisioningPreferences(CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty value)` StackSet preferences that are required for provisioning the product or updating a provisioned product.
`void`	`setProvisioningPreferences(IResolvable value)` StackSet preferences that are required for provisioning the product or updating a provisioned product.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnCloudFormationProvisionedProduct
```
protected CfnCloudFormationProvisionedProduct(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnCloudFormationProvisionedProduct
```
protected CfnCloudFormationProvisionedProduct(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnCloudFormationProvisionedProduct
```
public CfnCloudFormationProvisionedProduct(Construct scope,
                                           java.lang.String id,
                                           CfnCloudFormationProvisionedProductProps props)
```
    Create a new `AWS::ServiceCatalog::CloudFormationProvisionedProduct`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties.
  - CfnCloudFormationProvisionedProduct
```
public CfnCloudFormationProvisionedProduct(Construct scope,
                                           java.lang.String id)
```
    Create a new `AWS::ServiceCatalog::CloudFormationProvisionedProduct`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrCloudformationStackArn
```
public java.lang.String getAttrCloudformationStackArn()
```
    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` .
  - getAttrOutputs
```
public IResolvable getAttrOutputs()
```
    The output of the product you are provisioning.
    For example, the DNS of an EC2 instance.
  - getAttrProvisionedProductId
```
public java.lang.String getAttrProvisionedProductId()
```
    The ID of the provisioned product.
  - getAttrRecordId
```
public java.lang.String getAttrRecordId()
```
    The ID of the record, such as `rec-rjeatvy434trk` .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    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.
  - getAcceptLanguage
```
public java.lang.String getAcceptLanguage()
```
    The language code.
    - en - English (default)
    - jp - Japanese
    - zh - Chinese
  - setAcceptLanguage
```
public void setAcceptLanguage(java.lang.String value)
```
    The language code.
    - en - English (default)
    - jp - Japanese
    - zh - Chinese
  - getNotificationArns
```
public java.util.List<java.lang.String> getNotificationArns()
```
    Passed to AWS CloudFormation .
    The SNS topic ARNs to which to publish stack-related events.
  - setNotificationArns
```
public void setNotificationArns(java.util.List<java.lang.String> value)
```
    Passed to AWS CloudFormation .
    The SNS topic ARNs to which to publish stack-related events.
  - getPathId
```
public java.lang.String getPathId()
```
    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.
  - setPathId
```
public void setPathId(java.lang.String value)
```
    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.
  - getPathName
```
public java.lang.String getPathName()
```
    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.
  - setPathName
```
public void setPathName(java.lang.String value)
```
    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.
  - getProductId
```
public java.lang.String getProductId()
```
    The product identifier.
    
    You must specify either the ID or the name of the product, but not both.
  - setProductId
```
public void setProductId(java.lang.String value)
```
    The product identifier.
    
    You must specify either the ID or the name of the product, but not both.
  - getProductName
```
public java.lang.String getProductName()
```
    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.
    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.
  - setProductName
```
public void setProductName(java.lang.String value)
```
    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.
    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.
  - getProvisionedProductName
```
public java.lang.String getProvisionedProductName()
```
    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.
  - setProvisionedProductName
```
public void setProvisionedProductName(java.lang.String value)
```
    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.
  - getProvisioningArtifactId
```
public java.lang.String getProvisioningArtifactId()
```
    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.
  - setProvisioningArtifactId
```
public void setProvisioningArtifactId(java.lang.String value)
```
    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.
  - getProvisioningArtifactName
```
public java.lang.String getProvisioningArtifactName()
```
    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.
  - setProvisioningArtifactName
```
public void setProvisioningArtifactName(java.lang.String value)
```
    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.
  - getProvisioningParameters
```
public java.lang.Object getProvisioningParameters()
```
    Parameters specified by the administrator that are required for provisioning the product.
  - setProvisioningParameters
```
public void setProvisioningParameters(IResolvable value)
```
    Parameters specified by the administrator that are required for provisioning the product.
  - setProvisioningParameters
```
public void setProvisioningParameters(java.util.List<java.lang.Object> value)
```
    Parameters specified by the administrator that are required for provisioning the product.
  - getProvisioningPreferences
```
public java.lang.Object getProvisioningPreferences()
```
    StackSet preferences that are required for provisioning the product or updating a provisioned product.
  - setProvisioningPreferences
```
public void setProvisioningPreferences(IResolvable value)
```
    StackSet preferences that are required for provisioning the product or updating a provisioned product.
  - setProvisioningPreferences
```
public void setProvisioningPreferences(CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty value)
```
    StackSet preferences that are required for provisioning the product or updating a provisioned product.

Class CfnCloudFormationProvisionedProduct

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnCloudFormationProvisionedProduct

CfnCloudFormationProvisionedProduct

CfnCloudFormationProvisionedProduct

CfnCloudFormationProvisionedProduct

Method Detail

inspect

renderProperties

getAttrCloudformationStackArn

getAttrOutputs

getAttrProvisionedProductId

getAttrRecordId

getCfnProperties

getTags

getAcceptLanguage

setAcceptLanguage

getNotificationArns

setNotificationArns

getPathId

setPathId

getPathName

setPathName

getProductId

setProductId

getProductName

setProductName

getProvisionedProductName

setProvisionedProductName

getProvisioningArtifactId

setProvisioningArtifactId

getProvisioningArtifactName

setProvisioningArtifactName

getProvisioningParameters

setProvisioningParameters

setProvisioningParameters

getProvisioningPreferences

setProvisioningPreferences

setProvisioningPreferences