software.amazon.awscdk.services.servicecatalog

Class CfnCloudFormationProvisionedProduct.Builder

java.lang.Object

software.amazon.awscdk.services.servicecatalog.CfnCloudFormationProvisionedProduct.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCloudFormationProvisionedProduct>

Enclosing class:

CfnCloudFormationProvisionedProduct

@Stability(value=Stable)
public static final class CfnCloudFormationProvisionedProduct.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCloudFormationProvisionedProduct>

A fluent builder for CfnCloudFormationProvisionedProduct.

Method Summary

Modifier and Type	Method and Description
CfnCloudFormationProvisionedProduct.Builder	acceptLanguage(String acceptLanguage) The language code.
CfnCloudFormationProvisionedProduct	build()
static CfnCloudFormationProvisionedProduct.Builder	create(software.constructs.Construct scope, String id)
CfnCloudFormationProvisionedProduct.Builder	notificationArns(List<String> notificationArns) Passed to AWS CloudFormation .
CfnCloudFormationProvisionedProduct.Builder	pathId(String pathId) The path identifier of the product.
CfnCloudFormationProvisionedProduct.Builder	pathName(String pathName) The name of the path.
CfnCloudFormationProvisionedProduct.Builder	productId(String productId) The product identifier.
CfnCloudFormationProvisionedProduct.Builder	productName(String productName) A user-friendly name for the provisioned product.
CfnCloudFormationProvisionedProduct.Builder	provisionedProductName(String provisionedProductName) A user-friendly name for the provisioned product.
CfnCloudFormationProvisionedProduct.Builder	provisioningArtifactId(String provisioningArtifactId) The identifier of the provisioning artifact (also known as a version).
CfnCloudFormationProvisionedProduct.Builder	provisioningArtifactName(String provisioningArtifactName) The name of the provisioning artifact (also known as a version) for the product.
CfnCloudFormationProvisionedProduct.Builder	provisioningParameters(IResolvable provisioningParameters) Parameters specified by the administrator that are required for provisioning the product.
CfnCloudFormationProvisionedProduct.Builder	provisioningParameters(List<? extends Object> provisioningParameters) Parameters specified by the administrator that are required for provisioning the product.
CfnCloudFormationProvisionedProduct.Builder	provisioningPreferences(CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty provisioningPreferences) StackSet preferences that are required for provisioning the product or updating a provisioned product.
CfnCloudFormationProvisionedProduct.Builder	provisioningPreferences(IResolvable provisioningPreferences) StackSet preferences that are required for provisioning the product or updating a provisioned product.
CfnCloudFormationProvisionedProduct.Builder	tags(List<? extends CfnTag> tags) One or more tags.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnCloudFormationProvisionedProduct.Builder create(software.constructs.Construct scope,
                                                                                          String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnCloudFormationProvisionedProduct.ProvisioningParameterProperty.Builder.

acceptLanguage

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct.Builder acceptLanguage(String acceptLanguage)

The language code.

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

Parameters:

acceptLanguage - The language code. This parameter is required.

Returns:

this

notificationArns

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct.Builder notificationArns(List<String> notificationArns)

Passed to AWS CloudFormation .

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

Parameters:

notificationArns - Passed to AWS CloudFormation . This parameter is required.

Returns:

this

pathId

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct.Builder pathId(String pathId)

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.

Parameters:

pathId - The path identifier of the product. This parameter is required.

Returns:

this

pathName

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct.Builder pathName(String pathName)

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.

Parameters:

pathName - The name of the path. This parameter is required.

Returns:

this

productId

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct.Builder productId(String productId)

The product identifier.

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

Parameters:

productId - The product identifier. This parameter is required.

Returns:

this

productName

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct.Builder productName(String productName)

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.

Parameters:

productName - A user-friendly name for the provisioned product. This parameter is required.

Returns:

this

provisionedProductName

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct.Builder provisionedProductName(String provisionedProductName)

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.

Parameters:

provisionedProductName - A user-friendly name for the provisioned product. This parameter is required.

Returns:

this

provisioningArtifactId

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct.Builder provisioningArtifactId(String provisioningArtifactId)

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.

Parameters:

provisioningArtifactId - The identifier of the provisioning artifact (also known as a version). This parameter is required.

Returns:

this

provisioningArtifactName

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct.Builder provisioningArtifactName(String provisioningArtifactName)

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.

Parameters:

provisioningArtifactName - The name of the provisioning artifact (also known as a version) for the product. This parameter is required.

Returns:

this

provisioningParameters

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct.Builder provisioningParameters(IResolvable provisioningParameters)

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

Parameters:

provisioningParameters - Parameters specified by the administrator that are required for provisioning the product. This parameter is required.

Returns:

this

provisioningParameters

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct.Builder provisioningParameters(List<? extends Object> provisioningParameters)

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

Parameters:

provisioningParameters - Parameters specified by the administrator that are required for provisioning the product. This parameter is required.

Returns:

this

provisioningPreferences

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct.Builder provisioningPreferences(CfnCloudFormationProvisionedProduct.ProvisioningPreferencesProperty provisioningPreferences)

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

Parameters:

provisioningPreferences - StackSet preferences that are required for provisioning the product or updating a provisioned product. This parameter is required.

Returns:

this

provisioningPreferences

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct.Builder provisioningPreferences(IResolvable provisioningPreferences)

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

Parameters:

provisioningPreferences - StackSet preferences that are required for provisioning the product or updating a provisioned product. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct.Builder tags(List<? extends CfnTag> tags)

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.

Parameters:

tags - One or more tags. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnCloudFormationProvisionedProduct build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCloudFormationProvisionedProduct>