aws-cdk-lib.cloudformation_include.CfnIncludeProps

CfnIncludeProps Struct

Construction properties of CfnInclude.

CfnIncludeProps

used as props by

• CfnInclude

Source

cloudformation-include/lib/cfn-include.ts

Type last changed

v2.161.0 · 4 Oct 2024

Example

const parentTemplate = new cfn_inc.CfnInclude(this, 'ParentStack', {
  templateFile: 'path/to/my-parent-template.json',
  loadNestedStacks: {
    'ChildStack': {
      templateFile: 'path/to/my-nested-template.json',
    },
  },
});

Properties

allowCyclicalReferences?optionalbooleanallow_cyclical_references?optionalboolallowCyclicalReferences?optionalBooleanAllowCyclicalReferences?optionalboolAllowCyclicalReferences?optional*bool#

Specifies whether to allow cyclical references, effectively disregarding safeguards meant to avoid undeployable templates.

Default: will throw an error on detecting any cyclical references

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.

dehydratedResources?optionalstring[]dehydrated_resources?optionaltyping.List[str]dehydratedResources?optionalList<String>DehydratedResources?optionalstring[]DehydratedResources?optional*[]*string#

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: All resources are hydrated

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.

loadNestedStacks?optional{ [key: string]: CfnIncludeProps }load_nested_stacks?optionaltyping.Mapping[str, CfnIncludeProps]loadNestedStacks?optionalMap<String, CfnIncludeProps>LoadNestedStacks?optionalIDictionary<string, CfnIncludeProps>LoadNestedStacks?optional*map[string]CfnIncludeProps#

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

Default: no nested stacks will be included

notes

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 the 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.

parameters?optional{ [key: string]: any }parameters?optionaltyping.Mapping[str, Any]parameters?optionalMap<String, Object>Parameters?optionalIDictionary<string, object>Parameters?optional*map[string]interface{}#

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

Default: parameters will retain their original definitions

notes

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.

preserveLogicalIds?optionalbooleanpreserve_logical_ids?optionalboolpreserveLogicalIds?optionalBooleanPreserveLogicalIds?optionalboolPreserveLogicalIds?optional*bool= true#

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

notes

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.

templateFilestringtemplate_filestrtemplateFileStringTemplateFilestringTemplateFile*stringrequired#

Path to the template file.

Both JSON and YAML template formats are supported.