Package software.amazon.awscdk.services.servicecatalog

Class CfnCloudFormationProvisionedProduct

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.servicecatalog.CfnCloudFormationProvisionedProduct
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-12-06T14:43:27.165Z") @Stability(Stable) public class CfnCloudFormationProvisionedProduct extends CfnResource implements 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 ".

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

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCloudFormationProvisionedProduct

      protected CfnCloudFormationProvisionedProduct(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCloudFormationProvisionedProduct

      protected CfnCloudFormationProvisionedProduct(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCloudFormationProvisionedProduct

      @Stability(Stable) public CfnCloudFormationProvisionedProduct(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnCloudFormationProvisionedProductProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnCloudFormationProvisionedProduct

      @Stability(Stable) public CfnCloudFormationProvisionedProduct(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCloudformationStackArn

      @Stability(Stable) @NotNull public String getAttrCloudformationStackArn()

    • getAttrOutputs

      @Stability(Stable) @NotNull public IResolvable getAttrOutputs()
      List of key-value pair outputs.

    • getAttrProvisionedProductId

      @Stability(Stable) @NotNull public String getAttrProvisionedProductId()
      The ID of the provisioned product.

    • getAttrRecordId

      @Stability(Stable) @NotNull public String getAttrRecordId()
      The ID of the record, such as rec-rjeatvy434trk .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAcceptLanguage

      @Stability(Stable) @Nullable public String getAcceptLanguage()
      The language code.

    • setAcceptLanguage

      @Stability(Stable) public void setAcceptLanguage(@Nullable String value)
      The language code.

    • getNotificationArns

      @Stability(Stable) @Nullable public List<String> getNotificationArns()
      Passed to AWS CloudFormation .

    • setNotificationArns

      @Stability(Stable) public void setNotificationArns(@Nullable List<String> value)
      Passed to AWS CloudFormation .

    • getPathId

      @Stability(Stable) @Nullable public String getPathId()
      The path identifier of the product.

    • setPathId

      @Stability(Stable) public void setPathId(@Nullable String value)
      The path identifier of the product.

    • getPathName

      @Stability(Stable) @Nullable public String getPathName()
      The name of the path.

    • setPathName

      @Stability(Stable) public void setPathName(@Nullable String value)
      The name of the path.

    • getProductId

      @Stability(Stable) @Nullable public String getProductId()
      The product identifier.

    • setProductId

      @Stability(Stable) public void setProductId(@Nullable String value)
      The product identifier.

    • getProductName

      @Stability(Stable) @Nullable public String getProductName()
      The name of the Service Catalog product.

    • setProductName

      @Stability(Stable) public void setProductName(@Nullable String value)
      The name of the Service Catalog product.

    • getProvisionedProductName

      @Stability(Stable) @Nullable public String getProvisionedProductName()
      A user-friendly name for the provisioned product.

    • setProvisionedProductName

      @Stability(Stable) public void setProvisionedProductName(@Nullable String value)
      A user-friendly name for the provisioned product.

    • getProvisioningArtifactId

      @Stability(Stable) @Nullable public String getProvisioningArtifactId()
      The identifier of the provisioning artifact (also known as a version).

    • setProvisioningArtifactId

      @Stability(Stable) public void setProvisioningArtifactId(@Nullable String value)
      The identifier of the provisioning artifact (also known as a version).

    • getProvisioningArtifactName

      @Stability(Stable) @Nullable public String getProvisioningArtifactName()
      The name of the provisioning artifact (also known as a version) for the product.

    • setProvisioningArtifactName

      @Stability(Stable) public void setProvisioningArtifactName(@Nullable String value)
      The name of the provisioning artifact (also known as a version) for the product.

    • getProvisioningParameters

      @Stability(Stable) @Nullable public Object getProvisioningParameters()
      Parameters specified by the administrator that are required for provisioning the product.

    • setProvisioningParameters

      @Stability(Stable) public void setProvisioningParameters(@Nullable IResolvable value)
      Parameters specified by the administrator that are required for provisioning the product.

    • setProvisioningParameters

      @Stability(Stable) public void setProvisioningParameters(@Nullable List<Object> value)
      Parameters specified by the administrator that are required for provisioning the product.

    • getProvisioningPreferences

      @Stability(Stable) @Nullable public Object getProvisioningPreferences()
      StackSet preferences that are required for provisioning the product or updating a provisioned product.

    • setProvisioningPreferences

      @Stability(Stable) public void setProvisioningPreferences(@Nullable IResolvable value)
      StackSet preferences that are required for provisioning the product or updating a provisioned product.

    • setProvisioningPreferences

      @Stability(Stable) public void setProvisioningPreferences(@Nullable CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty value)
      StackSet preferences that are required for provisioning the product or updating a provisioned product.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      One or more tags.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      One or more tags.