software.amazon.awscdk.services.servicecatalog

Interface CfnCloudFormationProvisionedProductProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCloudFormationProvisionedProductProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.072Z")
 @Stability(value=Stable)
public interface CfnCloudFormationProvisionedProductProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnCloudFormationProvisionedProduct`.

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.*;
 CfnCloudFormationProvisionedProductProps cfnCloudFormationProvisionedProductProps = CfnCloudFormationProvisionedProductProps.builder()
         .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	Interface and Description
static class	CfnCloudFormationProvisionedProductProps.Builder A builder for CfnCloudFormationProvisionedProductProps
static class	CfnCloudFormationProvisionedProductProps.Jsii$Proxy An implementation for CfnCloudFormationProvisionedProductProps

Method Summary

Modifier and Type	Method and Description
static CfnCloudFormationProvisionedProductProps.Builder	builder()
default String	getAcceptLanguage() The language code.
default List<String>	getNotificationArns() Passed to AWS CloudFormation .
default String	getPathId() The path identifier of the product.
default String	getPathName() The name of the path.
default String	getProductId() The product identifier.
default String	getProductName() A user-friendly name for the provisioned product.
default String	getProvisionedProductName() A user-friendly name for the provisioned product.
default String	getProvisioningArtifactId() The identifier of the provisioning artifact (also known as a version).
default String	getProvisioningArtifactName() The name of the provisioning artifact (also known as a version) for the product.
default Object	getProvisioningParameters() Parameters specified by the administrator that are required for provisioning the product.
default Object	getProvisioningPreferences() StackSet preferences that are required for provisioning the product or updating a provisioned product.
default List<CfnTag>	getTags() One or more tags.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAcceptLanguage

@Stability(value=Stable)
 @Nullable
default String getAcceptLanguage()

The language code.

• en - English (default)
• jp - Japanese
• zh - Chinese

getNotificationArns

@Stability(value=Stable)
 @Nullable
default List<String> getNotificationArns()

Passed to AWS CloudFormation .

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

getPathId

@Stability(value=Stable)
 @Nullable
default 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.

getPathName

@Stability(value=Stable)
 @Nullable
default 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.

getProductId

@Stability(value=Stable)
 @Nullable
default String getProductId()

The product identifier.

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

getProductName

@Stability(value=Stable)
 @Nullable
default 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.

getProvisionedProductName

@Stability(value=Stable)
 @Nullable
default 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.

getProvisioningArtifactId

@Stability(value=Stable)
 @Nullable
default 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.

getProvisioningArtifactName

@Stability(value=Stable)
 @Nullable
default 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.

getProvisioningParameters

@Stability(value=Stable)
 @Nullable
default Object getProvisioningParameters()

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

getProvisioningPreferences

@Stability(value=Stable)
 @Nullable
default Object getProvisioningPreferences()

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> 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.

builder

@Stability(value=Stable)
static CfnCloudFormationProvisionedProductProps.Builder builder()

Returns:

a CfnCloudFormationProvisionedProductProps.Builder of CfnCloudFormationProvisionedProductProps