software.amazon.awscdk.services.servicecatalog

Interface CfnCloudFormationProductProps

All Known Implementing Classes:

CfnCloudFormationProductProps.Jsii$Proxy

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

Properties for defining a `CfnCloudFormationProduct`.

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.*;
 Object info;
 CfnCloudFormationProductProps cfnCloudFormationProductProps = CfnCloudFormationProductProps.builder()
         .name("name")
         .owner("owner")
         .provisioningArtifactParameters(List.of(ProvisioningArtifactPropertiesProperty.builder()
                 .info(info)
                 // the properties below are optional
                 .description("description")
                 .disableTemplateValidation(false)
                 .name("name")
                 .build()))
         // the properties below are optional
         .acceptLanguage("acceptLanguage")
         .description("description")
         .distributor("distributor")
         .replaceProvisioningArtifacts(false)
         .supportDescription("supportDescription")
         .supportEmail("supportEmail")
         .supportUrl("supportUrl")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnCloudFormationProductProps.Builder	builder()
default java.lang.String	getAcceptLanguage() The language code.
default java.lang.String	getDescription() The description of the product.
default java.lang.String	getDistributor() The distributor of the product.
java.lang.String	getName() The name of the product.
java.lang.String	getOwner() The owner of the product.
java.lang.Object	getProvisioningArtifactParameters() The configuration of the provisioning artifact (also known as a version).
default java.lang.Object	getReplaceProvisioningArtifacts() This property is turned off by default.
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 java.util.List<CfnTag>	getTags() One or more tags.

Method Detail

getName

java.lang.String getName()

The name of the product.

getOwner

java.lang.String getOwner()

The owner of the product.

getProvisioningArtifactParameters

java.lang.Object getProvisioningArtifactParameters()

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

getAcceptLanguage

default java.lang.String getAcceptLanguage()

The language code.

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

getDescription

default java.lang.String getDescription()

The description of the product.

getDistributor

default java.lang.String getDistributor()

The distributor of the product.

getReplaceProvisioningArtifacts

default java.lang.Object getReplaceProvisioningArtifacts()

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.

getSupportDescription

default java.lang.String getSupportDescription()

The support information about the product.

getSupportEmail

default java.lang.String getSupportEmail()

The contact email for product support.

getSupportUrl

default java.lang.String getSupportUrl()

The contact URL for product support.

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

getTags

default java.util.List<CfnTag> getTags()

One or more tags.

builder

static CfnCloudFormationProductProps.Builder builder()

Returns:

a CfnCloudFormationProductProps.Builder of CfnCloudFormationProductProps