Package software.amazon.awscdk.services.servicecatalog

Class CfnCloudFormationProvisionedProduct

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.724Z") @Stability(Stable) 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();

  • 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 Construct scope, @NotNull String id, @Nullable 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

      @Stability(Stable) public CfnCloudFormationProvisionedProduct(@NotNull Construct scope, @NotNull 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 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()
      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

      @Stability(Stable) @NotNull public IResolvable getAttrOutputs()
      The output of the product you are provisioning.

      For example, the DNS of an EC2 instance.

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

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

      • jp - Japanese
      • zh - Chinese

    • setAcceptLanguage

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

      • jp - Japanese
      • zh - Chinese

    • getNotificationArns

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

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

    • setNotificationArns

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

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

    • getPathId

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setPathId(@Nullable 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

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setPathName(@Nullable 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

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

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

    • setProductId

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

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

    • getProductName

      @Stability(Stable) @Nullable public String getProductName()
      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.

    • setProductName

      @Stability(Stable) public void setProductName(@Nullable String value)
      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.

    • getProvisionedProductName

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setProvisionedProductName(@Nullable 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

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setProvisioningArtifactId(@Nullable 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

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setProvisioningArtifactName(@Nullable 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

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