Package software.amazon.awscdk.services.servicecatalog

Class CfnCloudFormationProduct.Builder

java.lang.Object

software.amazon.awscdk.services.servicecatalog.CfnCloudFormationProduct.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCloudFormationProduct>

Enclosing class:

CfnCloudFormationProduct

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

A fluent builder for CfnCloudFormationProduct.

Method Summary

Modifier and Type	Method	Description
CfnCloudFormationProduct.Builder	acceptLanguage(String acceptLanguage)	The language code.
CfnCloudFormationProduct	build()
static CfnCloudFormationProduct.Builder	create(software.constructs.Construct scope, String id)
CfnCloudFormationProduct.Builder	description(String description)	The description of the product.
CfnCloudFormationProduct.Builder	distributor(String distributor)	The distributor of the product.
CfnCloudFormationProduct.Builder	name(String name)	The name of the product.
CfnCloudFormationProduct.Builder	owner(String owner)	The owner of the product.
CfnCloudFormationProduct.Builder	productType(String productType)	The type of product.
CfnCloudFormationProduct.Builder	provisioningArtifactParameters(List<? extends Object> provisioningArtifactParameters)	The configuration of the provisioning artifact (also known as a version).
CfnCloudFormationProduct.Builder	provisioningArtifactParameters(IResolvable provisioningArtifactParameters)	The configuration of the provisioning artifact (also known as a version).
CfnCloudFormationProduct.Builder	replaceProvisioningArtifacts(Boolean replaceProvisioningArtifacts)	This property is turned off by default.
CfnCloudFormationProduct.Builder	replaceProvisioningArtifacts(IResolvable replaceProvisioningArtifacts)	This property is turned off by default.
CfnCloudFormationProduct.Builder	sourceConnection(IResolvable sourceConnection)	A top level ProductViewDetail response containing details about the product’s connection.
CfnCloudFormationProduct.Builder	sourceConnection(CfnCloudFormationProduct.SourceConnectionProperty sourceConnection)	A top level ProductViewDetail response containing details about the product’s connection.
CfnCloudFormationProduct.Builder	supportDescription(String supportDescription)	The support information about the product.
CfnCloudFormationProduct.Builder	supportEmail(String supportEmail)	The contact email for product support.
CfnCloudFormationProduct.Builder	supportUrl(String supportUrl)	The contact URL for product support.
CfnCloudFormationProduct.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 Details

create

@Stability(Stable)
public static CfnCloudFormationProduct.Builder create(software.constructs.Construct scope,
 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.

Returns:

a new instance of CfnCloudFormationProduct.Builder.

name

@Stability(Stable)
public CfnCloudFormationProduct.Builder name(String name)

The name of the product.

Parameters:

name - The name of the product. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-name

owner

@Stability(Stable)
public CfnCloudFormationProduct.Builder owner(String owner)

The owner of the product.

Parameters:

owner - The owner of the product. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-owner

acceptLanguage

@Stability(Stable)
public CfnCloudFormationProduct.Builder acceptLanguage(String acceptLanguage)

The language code.

• jp - Japanese
• zh - Chinese

Parameters:

acceptLanguage - The language code. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-acceptlanguage

description

@Stability(Stable)
public CfnCloudFormationProduct.Builder description(String description)

The description of the product.

Parameters:

description - The description of the product. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-description

distributor

@Stability(Stable)
public CfnCloudFormationProduct.Builder distributor(String distributor)

The distributor of the product.

Parameters:

distributor - The distributor of the product. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-distributor

productType

@Stability(Stable)
public CfnCloudFormationProduct.Builder productType(String productType)

The type of product.

Parameters:

productType - The type of product. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-producttype

provisioningArtifactParameters

@Stability(Stable)
public CfnCloudFormationProduct.Builder provisioningArtifactParameters(IResolvable provisioningArtifactParameters)

The configuration of the provisioning artifact (also known as a version).

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactparameters

provisioningArtifactParameters

@Stability(Stable)
public CfnCloudFormationProduct.Builder provisioningArtifactParameters(List<? extends Object> provisioningArtifactParameters)

The configuration of the provisioning artifact (also known as a version).

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-provisioningartifactparameters

replaceProvisioningArtifacts

@Stability(Stable)
public CfnCloudFormationProduct.Builder replaceProvisioningArtifacts(Boolean replaceProvisioningArtifacts)

This property is turned off by default.

If turned off, you can update provisioning artifacts or product attributes (such as description, distributor, name, owner, and more) and the associated provisioning artifacts will retain the same unique identifier. Provisioning artifacts are matched within the CloudFormationProduct resource, and only those that have been updated will be changed. Provisioning artifacts are matched by a combinaton of provisioning artifact template URL and name.

If turned on, provisioning artifacts will be given a new unique identifier when you update the product or provisioning artifacts.

Parameters:

replaceProvisioningArtifacts - This property is turned off by default. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-replaceprovisioningartifacts

replaceProvisioningArtifacts

@Stability(Stable)
public CfnCloudFormationProduct.Builder replaceProvisioningArtifacts(IResolvable replaceProvisioningArtifacts)

This property is turned off by default.

If turned off, you can update provisioning artifacts or product attributes (such as description, distributor, name, owner, and more) and the associated provisioning artifacts will retain the same unique identifier. Provisioning artifacts are matched within the CloudFormationProduct resource, and only those that have been updated will be changed. Provisioning artifacts are matched by a combinaton of provisioning artifact template URL and name.

If turned on, provisioning artifacts will be given a new unique identifier when you update the product or provisioning artifacts.

Parameters:

replaceProvisioningArtifacts - This property is turned off by default. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-replaceprovisioningartifacts

sourceConnection

@Stability(Stable)
public CfnCloudFormationProduct.Builder sourceConnection(IResolvable sourceConnection)

A top level ProductViewDetail response containing details about the product’s connection.

AWS Service Catalog returns this field for the CreateProduct , UpdateProduct , DescribeProductAsAdmin , and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

Parameters:

sourceConnection - A top level ProductViewDetail response containing details about the product’s connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-sourceconnection

sourceConnection

@Stability(Stable)
public CfnCloudFormationProduct.Builder sourceConnection(CfnCloudFormationProduct.SourceConnectionProperty sourceConnection)

A top level ProductViewDetail response containing details about the product’s connection.

AWS Service Catalog returns this field for the CreateProduct , UpdateProduct , DescribeProductAsAdmin , and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.

Parameters:

sourceConnection - A top level ProductViewDetail response containing details about the product’s connection. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-sourceconnection

supportDescription

@Stability(Stable)
public CfnCloudFormationProduct.Builder supportDescription(String supportDescription)

The support information about the product.

Parameters:

supportDescription - The support information about the product. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-supportdescription

supportEmail

@Stability(Stable)
public CfnCloudFormationProduct.Builder supportEmail(String supportEmail)

The contact email for product support.

Parameters:

supportEmail - The contact email for product support. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-supportemail

supportUrl

@Stability(Stable)
public CfnCloudFormationProduct.Builder supportUrl(String supportUrl)

The contact URL for product support.

^https?:\/\// / is the pattern used to validate SupportUrl.

Parameters:

supportUrl - The contact URL for product support. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-supporturl

tags

@Stability(Stable)
public CfnCloudFormationProduct.Builder tags(List<? extends CfnTag> tags)

One or more tags.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicecatalog-cloudformationproduct.html#cfn-servicecatalog-cloudformationproduct-tags

build

@Stability(Stable)
public CfnCloudFormationProduct build()

Specified by:

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

Returns:

a newly built instance of CfnCloudFormationProduct.