software.amazon.awscdk.core

Interface ITemplateOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ITemplateOptions.Jsii$Default

All Known Implementing Classes:

ITemplateOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-28T18:14:31.998Z")
 @Stability(value=Stable)
public interface ITemplateOptions
extends software.amazon.jsii.JsiiSerializable

CloudFormation template options for a stack.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ITemplateOptions.Jsii$Default Internal default implementation for ITemplateOptions.
static class	ITemplateOptions.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
default String	getDescription() Gets or sets the description of this stack.
default Map<String,Object>	getMetadata() Metadata associated with the CloudFormation template.
default String	getTemplateFormatVersion() Gets or sets the AWSTemplateFormatVersion field of the CloudFormation template.
default String	getTransform() Deprecated. use `transforms` instead.
default List<String>	getTransforms() Gets or sets the top-level template transform(s) for this stack (e.g.
default void	setDescription(String value) Gets or sets the description of this stack.
default void	setMetadata(Map<String,Object> value) Metadata associated with the CloudFormation template.
default void	setTemplateFormatVersion(String value) Gets or sets the AWSTemplateFormatVersion field of the CloudFormation template.
default void	setTransform(String value) Deprecated. use `transforms` instead.
default void	setTransforms(List<String> value) Gets or sets the top-level template transform(s) for this stack (e.g.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDescription

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

Gets or sets the description of this stack.

If provided, it will be included in the CloudFormation template's "Description" attribute.

setDescription

@Optional
default void setDescription(@Nullable
                                      String value)

Gets or sets the description of this stack.

If provided, it will be included in the CloudFormation template's "Description" attribute.

getMetadata

@Stability(value=Stable)
 @Nullable
default Map<String,Object> getMetadata()

Metadata associated with the CloudFormation template.

setMetadata

@Optional
default void setMetadata(@Nullable
                                   Map<String,Object> value)

Metadata associated with the CloudFormation template.

getTemplateFormatVersion

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

Gets or sets the AWSTemplateFormatVersion field of the CloudFormation template.

setTemplateFormatVersion

@Optional
default void setTemplateFormatVersion(@Nullable
                                                String value)

Gets or sets the AWSTemplateFormatVersion field of the CloudFormation template.

getTransform

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getTransform()

Deprecated. use `transforms` instead.

(deprecated) Gets or sets the top-level template transform for this stack (e.g. "AWS::Serverless-2016-10-31").

setTransform

@Optional
default void setTransform(@Nullable
                                    String value)

Deprecated. use `transforms` instead.

(deprecated) Gets or sets the top-level template transform for this stack (e.g. "AWS::Serverless-2016-10-31").

getTransforms

@Stability(value=Stable)
 @Nullable
default List<String> getTransforms()

Gets or sets the top-level template transform(s) for this stack (e.g. `["AWS::Serverless-2016-10-31"]`).

setTransforms

@Optional
default void setTransforms(@Nullable
                                     List<String> value)

Gets or sets the top-level template transform(s) for this stack (e.g. `["AWS::Serverless-2016-10-31"]`).