Interface CfnIncludeProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnIncludeProps.Jsii$Proxy
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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnIncludeProps
static final class
An implementation forCfnIncludeProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnIncludeProps.Builder
builder()
default Map<String,
CfnIncludeProps> Specifies the template files that define nested stacks that should be included.Specifies parameters to be replaced by the values in this mapping.default Boolean
Whether the resources should have the same logical IDs in the resulting CDK template as they did in the original CloudFormation template file.Path to the template file.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getTemplateFile
Path to the template file.Both JSON and YAML template formats are supported.
-
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
invalid @link
CfnInclude.getNestedStack
invalid @link
CfnInclude.getResource
Default: - no nested stacks will be included
-
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.
Default: - no parameters will be replaced
-
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
invalid @link
CfnInclude.getResource
Default: true
-
builder
- Returns:
- a
CfnIncludeProps.Builder
ofCfnIncludeProps
-