software.amazon.awscdk.cloudformation.include

Interface CfnIncludeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIncludeProps.Jsii$Proxy

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

Construction properties of CfnInclude.

Example:

 CfnInclude parentTemplate = CfnInclude.Builder.create(this, "ParentStack")
         .templateFile("path/to/my-parent-template.json")
         .loadNestedStacks(Map.of(
                 "ChildStack", CfnIncludeProps.builder()
                         .templateFile("path/to/my-nested-template.json")
                         .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnIncludeProps.Builder	builder()
default Map<String,CfnIncludeProps>	getLoadNestedStacks() Specifies the template files that define nested stacks that should be included.
default Map<String,Object>	getParameters() Specifies parameters to be replaced by the values in this mapping.
default Boolean	getPreserveLogicalIds() Whether the resources should have the same logical IDs in the resulting CDK template as they did in the original CloudFormation template file.
String	getTemplateFile() Path to the template file.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTemplateFile

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

Path to the template file.

Both JSON and YAML template formats are supported.

getLoadNestedStacks

@Stability(value=Stable)
 @Nullable
default Map<String,CfnIncludeProps> getLoadNestedStacks()

Specifies the template files that define nested stacks that should be included.

If your template specifies a stack that isn't included here, it won't be created as a NestedStack resource, and it won't be accessible from the {@link CfnInclude.getNestedStack} method (but will still be accessible from the {@link CfnInclude.getResource} method).

If you include a stack here with an ID that isn't in the template, or is in the template but is not a nested stack, template creation will fail and an error will be thrown.

Default: - no nested stacks will be included

getParameters

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

Specifies parameters to be replaced by the values in this mapping.

Any parameters in the template that aren't specified here will be left unmodified. If you include a parameter here with an ID that isn't in the template, template creation will fail and an error will be thrown.

If you are importing a parameter from a live stack, we cannot know the value of that parameter. You will need to supply a value for your parameters, else the default value will be used.

Default: - parameters will retain their original definitions

getPreserveLogicalIds

@Stability(value=Stable)
 @Nullable
default Boolean getPreserveLogicalIds()

Whether the resources should have the same logical IDs in the resulting CDK template as they did in the original CloudFormation template file.

If you're vending a Construct using an existing CloudFormation template, make sure to pass this as false.

Note: regardless of whether this option is true or false, the {@link CfnInclude.getResource} and related methods always uses the original logical ID of the resource/element, as specified in the template file.

Default: true

builder

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

Returns:

a CfnIncludeProps.Builder of CfnIncludeProps