Package software.amazon.awscdk.services.servicecatalog

Interface CloudFormationProductVersion

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CloudFormationProductVersion.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:24.826Z")
@Stability(Stable)
public interface CloudFormationProductVersion
extends software.amazon.jsii.JsiiSerializable

Properties of product version (also known as a provisioning artifact).

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.*;
 CloudFormationTemplate cloudFormationTemplate;
 CloudFormationProductVersion cloudFormationProductVersion = CloudFormationProductVersion.builder()
         .cloudFormationTemplate(cloudFormationTemplate)
         // the properties below are optional
         .description("description")
         .productVersionName("productVersionName")
         .validateTemplate(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CloudFormationProductVersion.Builder	builder()
CloudFormationTemplate	getCloudFormationTemplate()	The S3 template that points to the provisioning version template.
default String	getDescription()	The description of the product version.
default String	getProductVersionName()	The name of the product version.
default Boolean	getValidateTemplate()	Whether the specified product template will be validated by CloudFormation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCloudFormationTemplate

@Stability(Stable)
@NotNull
CloudFormationTemplate getCloudFormationTemplate()

The S3 template that points to the provisioning version template.

getDescription

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

The description of the product version.

Default: - No description provided

getProductVersionName

@Stability(Stable)
@Nullable
default String getProductVersionName()

The name of the product version.

Default: - No product version name provided

getValidateTemplate

@Stability(Stable)
@Nullable
default Boolean getValidateTemplate()

Whether the specified product template will be validated by CloudFormation.

If turned off, an invalid template configuration can be stored.

Default: true

builder

@Stability(Stable)
static CloudFormationProductVersion.Builder builder()

Returns:

a CloudFormationProductVersion.Builder of CloudFormationProductVersion