software.amazon.awscdk.services.servicecatalog

Interface CloudFormationProductProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CloudFormationProductProps.Jsii$Proxy

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

Properties for a Cloudformation Product.

Example:

 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.*;
 public class S3BucketProduct extends ProductStack {
     public S3BucketProduct(Construct scope, String id) {
         super(scope, id);
         new Bucket(this, "BucketProduct");
     }
 }
 CloudFormationProduct product = CloudFormationProduct.Builder.create(this, "Product")
         .productName("My Product")
         .owner("Product Owner")
         .productVersions(List.of(CloudFormationProductVersion.builder()
                 .productVersionName("v1")
                 .cloudFormationTemplate(CloudFormationTemplate.fromProductStack(new S3BucketProduct(this, "S3BucketProduct")))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CloudFormationProductProps.Builder A builder for CloudFormationProductProps
static class	CloudFormationProductProps.Jsii$Proxy An implementation for CloudFormationProductProps

Method Summary

Modifier and Type	Method and Description
static CloudFormationProductProps.Builder	builder()
default String	getDescription() The description of the product.
default String	getDistributor() The distributor of the product.
default MessageLanguage	getMessageLanguage() The language code.
String	getOwner() The owner of the product.
String	getProductName() The name of the product.
List<CloudFormationProductVersion>	getProductVersions() The configuration of the product version.
default Boolean	getReplaceProductVersionIds() Whether to give provisioning artifacts a new unique identifier when the product attributes or provisioning artifacts is updated.
default String	getSupportDescription() The support information about the product.
default String	getSupportEmail() The contact email for product support.
default String	getSupportUrl() The contact URL for product support.
default TagOptions	getTagOptions() TagOptions associated directly to a product.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getOwner

@Stability(value=Stable)
 @NotNull
String getOwner()

The owner of the product.

getProductName

@Stability(value=Stable)
 @NotNull
String getProductName()

The name of the product.

getProductVersions

@Stability(value=Stable)
 @NotNull
List<CloudFormationProductVersion> getProductVersions()

The configuration of the product version.

getDescription

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

The description of the product.

Default: - No description provided

getDistributor

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

The distributor of the product.

Default: - No distributor provided

getMessageLanguage

@Stability(value=Stable)
 @Nullable
default MessageLanguage getMessageLanguage()

The language code.

Controls language for logging and errors.

Default: - English

getReplaceProductVersionIds

@Stability(value=Stable)
 @Nullable
default Boolean getReplaceProductVersionIds()

Whether to give provisioning artifacts a new unique identifier when the product attributes or provisioning artifacts is updated.

Default: false

getSupportDescription

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

The support information about the product.

Default: - No support description provided

getSupportEmail

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

The contact email for product support.

Default: - No support email provided

getSupportUrl

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

The contact URL for product support.

Default: - No support URL provided

getTagOptions

@Stability(value=Stable)
 @Nullable
default TagOptions getTagOptions()

TagOptions associated directly to a product.

Default: - No tagOptions provided

builder

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

Returns:

a CloudFormationProductProps.Builder of CloudFormationProductProps