software.amazon.awscdk.services.servicecatalog

Class CloudFormationTemplate

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.servicecatalog.CloudFormationTemplate

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.101Z")
 @Stability(value=Stable)
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();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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(software.constructs.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(String path) Loads the provisioning artifacts template from a local disk path.
static CloudFormationTemplate	fromAsset(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(String url) Template from URL.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CloudFormationTemplate

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

CloudFormationTemplate

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

CloudFormationTemplate

@Stability(value=Stable)
protected CloudFormationTemplate()

Method Detail

fromAsset

@Stability(value=Stable)
 @NotNull
public static CloudFormationTemplate fromAsset(@NotNull
                                                                                  String path,
                                                                                  @Nullable
                                                                                  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

@Stability(value=Stable)
 @NotNull
public static CloudFormationTemplate fromAsset(@NotNull
                                                                                  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

@Stability(value=Stable)
 @NotNull
public static CloudFormationTemplate fromProductStack(@NotNull
                                                                                         ProductStack productStack)

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

Parameters:

productStack - This parameter is required.

fromUrl

@Stability(value=Stable)
 @NotNull
public static CloudFormationTemplate fromUrl(@NotNull
                                                                                String url)

Template from URL.

Parameters:

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

bind

@Stability(value=Stable)
 @NotNull
public abstract CloudFormationTemplateConfig bind(@NotNull
                                                                                     software.constructs.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.