@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-31T18:37:02.720Z")
public interface CfnIncludeProps
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnIncludeProps.Builder
A builder for
CfnIncludeProps |
static class |
CfnIncludeProps.Jsii$Proxy
An implementation for
CfnIncludeProps |
Modifier and Type | Method and Description |
---|---|
static CfnIncludeProps.Builder |
builder() |
default java.util.Map<java.lang.String,CfnIncludeProps> |
getLoadNestedStacks()
Specifies the template files that define nested stacks that should be included.
|
default java.util.Map<java.lang.String,java.lang.Object> |
getParameters()
Specifies parameters to be replaced by the values in this mapping.
|
default java.lang.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.
|
java.lang.String |
getTemplateFile()
Path to the template file.
|
java.lang.String getTemplateFile()
Both JSON and YAML template formats are supported.
default java.util.Map<java.lang.String,CfnIncludeProps> getLoadNestedStacks()
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
default java.util.Map<java.lang.String,java.lang.Object> getParameters()
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
default java.lang.Boolean getPreserveLogicalIds()
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
static CfnIncludeProps.Builder builder()
CfnIncludeProps.Builder
of CfnIncludeProps