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
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnIncludeProps
static final class
An implementation forCfnIncludeProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnIncludeProps.Builder
builder()
default Boolean
Specifies whether to allow cyclical references, effectively disregarding safeguards meant to avoid undeployable templates.Specifies a list of LogicalIDs for resources that will be included in the CDK Stack, but will not be parsed and converted to CDK types.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.
-
getAllowCyclicalReferences
Specifies whether to allow cyclical references, effectively disregarding safeguards meant to avoid undeployable templates.This should only be set to true in the case of templates utilizing cloud transforms (e.g. SAM) that after processing the transform will no longer contain any circular references.
Default: - will throw an error on detecting any cyclical references
-
getDehydratedResources
Specifies a list of LogicalIDs for resources that will be included in the CDK Stack, but will not be parsed and converted to CDK types.This allows you to use CFN templates that rely on Intrinsic placement that
cfn-include
would otherwise reject, such as non-primitive values in resource update policies.Default: - All resources are hydrated
-
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
CfnInclude.getNestedStack
method (but will still be accessible from theCfnInclude.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
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
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
CfnInclude.getResource
and related methods always uses the original logical ID of the resource/element, as specified in the template file.Default: true
-
builder
- Returns:
- a
CfnIncludeProps.Builder
ofCfnIncludeProps
-