software.amazon.awscdk.services.servicecatalog

Class CloudFormationTemplate

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.servicecatalog.CloudFormationTemplate

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:03.925Z")
public abstract class CloudFormationTemplate
extends software.amazon.jsii.JsiiObject

Represents the Product Provisioning Artifact Template.

Example:

 import path.*;
 CloudFormationProduct product = CloudFormationProduct.Builder.create(this, "Product")
         .productName("My Product")
         .owner("Product Owner")
         .productVersions(List.of(CloudFormationProductVersion.builder()
                 .productVersionName("v1")
                 .cloudFormationTemplate(CloudFormationTemplate.fromUrl("https://raw.githubusercontent.com/awslabs/aws-cloudformation-templates/master/aws/services/ServiceCatalog/Product.yaml"))
                 .build(), CloudFormationProductVersion.builder()
                 .productVersionName("v2")
                 .cloudFormationTemplate(CloudFormationTemplate.fromAsset(join(__dirname, "development-environment.template.json")))
                 .build()))
         .build();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CloudFormationTemplate()
protected	CloudFormationTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CloudFormationTemplate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
abstract CloudFormationTemplateConfig	bind(Construct scope) Called when the product is initialized to allow this object to bind to the stack, add resources and have fun.
static CloudFormationTemplate	fromAsset(java.lang.String path) Loads the provisioning artifacts template from a local disk path.
static CloudFormationTemplate	fromAsset(java.lang.String path, AssetOptions options) Loads the provisioning artifacts template from a local disk path.
static CloudFormationTemplate	fromProductStack(ProductStack productStack) Creates a product with the resources defined in the given product stack.
static CloudFormationTemplate	fromUrl(java.lang.String url) Template from URL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CloudFormationTemplate

protected CloudFormationTemplate(software.amazon.jsii.JsiiObjectRef objRef)

CloudFormationTemplate

protected CloudFormationTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CloudFormationTemplate

protected CloudFormationTemplate()

Method Detail

fromAsset

public static CloudFormationTemplate fromAsset(java.lang.String path,
                                               AssetOptions options)

Loads the provisioning artifacts template from a local disk path.

Parameters:

path - A file containing the provisioning artifacts. This parameter is required.

options -

fromAsset

public static CloudFormationTemplate fromAsset(java.lang.String path)

Loads the provisioning artifacts template from a local disk path.

Parameters:

path - A file containing the provisioning artifacts. This parameter is required.

fromProductStack

public static CloudFormationTemplate fromProductStack(ProductStack productStack)

Creates a product with the resources defined in the given product stack.

Parameters:

productStack - This parameter is required.

fromUrl

public static CloudFormationTemplate fromUrl(java.lang.String url)

Template from URL.

Parameters:

url - The url that points to the provisioning artifacts template. This parameter is required.

bind

public abstract CloudFormationTemplateConfig bind(Construct scope)

Called when the product is initialized to allow this object to bind to the stack, add resources and have fun.

Parameters:

scope - The binding scope. This parameter is required.