software.amazon.awscdk.services.servicecatalog

Interface CfnCloudFormationProductProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCloudFormationProductProps.Jsii$Proxy

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

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

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

The name of the product.

getOwner

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

The owner of the product.

getProvisioningArtifactParameters

@Stability(value=Stable)
 @NotNull
Object getProvisioningArtifactParameters()

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

getAcceptLanguage

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

The language code.

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

getDescription

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

The description of the product.

getDistributor

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

The distributor of the product.

getReplaceProvisioningArtifacts

@Stability(value=Stable)
 @Nullable
default 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

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

The support information about the product.

getSupportEmail

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

The contact email for product support.

getSupportUrl

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

The contact URL for product support.

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

One or more tags.

builder

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

Returns:

a CfnCloudFormationProductProps.Builder of CfnCloudFormationProductProps