software.amazon.awscdk.services.servicecatalog

Interface CloudFormationProductProps

All Known Implementing Classes:

CloudFormationProductProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:03.922Z")
public interface CloudFormationProductProps

Properties for a Cloudformation Product.

Example:

 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.core.*;
 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 java.lang.String	getDescription() The description of the product.
default java.lang.String	getDistributor() The distributor of the product.
default MessageLanguage	getMessageLanguage() The language code.
java.lang.String	getOwner() The owner of the product.
java.lang.String	getProductName() The name of the product.
java.util.List<CloudFormationProductVersion>	getProductVersions() The configuration of the product version.
default java.lang.Boolean	getReplaceProductVersionIds() Whether to give provisioning artifacts a new unique identifier when the product attributes or provisioning artifacts is updated.
default java.lang.String	getSupportDescription() The support information about the product.
default java.lang.String	getSupportEmail() The contact email for product support.
default java.lang.String	getSupportUrl() The contact URL for product support.
default TagOptions	getTagOptions() TagOptions associated directly to a product.

Method Detail

getOwner

java.lang.String getOwner()

The owner of the product.

getProductName

java.lang.String getProductName()

The name of the product.

getProductVersions

java.util.List<CloudFormationProductVersion> getProductVersions()

The configuration of the product version.

getDescription

default java.lang.String getDescription()

The description of the product.

Default: - No description provided

getDistributor

default java.lang.String getDistributor()

The distributor of the product.

Default: - No distributor provided

getMessageLanguage

default MessageLanguage getMessageLanguage()

The language code.

Controls language for logging and errors.

Default: - English

getReplaceProductVersionIds

default java.lang.Boolean getReplaceProductVersionIds()

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

Default: false

getSupportDescription

default java.lang.String getSupportDescription()

The support information about the product.

Default: - No support description provided

getSupportEmail

default java.lang.String getSupportEmail()

The contact email for product support.

Default: - No support email provided

getSupportUrl

default java.lang.String getSupportUrl()

The contact URL for product support.

Default: - No support URL provided

getTagOptions

default TagOptions getTagOptions()

TagOptions associated directly to a product.

Default: - No tagOptions provided

builder

static CloudFormationProductProps.Builder builder()

Returns:

a CloudFormationProductProps.Builder of CloudFormationProductProps