class CfnInclude (construct)

Language	Type name
.NET	`Amazon.CDK.CloudFormation.Include.CfnInclude`
Java	`software.amazon.awscdk.cloudformation.include.CfnInclude`
Python	`aws_cdk.cloudformation_include.CfnInclude`
TypeScript (source)	`@aws-cdk/cloudformation-include` » `CfnInclude`

Implements IConstruct, IConstruct, IDependable

Construct to import an existing CloudFormation template file into a CDK application.

All resources defined in the template file can be retrieved by calling the {@link getResource} method. Any modifications made on the returned resource objects will be reflected in the resulting CDK template.

Example

const cfnTemplate = new cfn_inc.CfnInclude(this, 'Template', {
  templateFile: 'my-template.json',
});

Initializer

new CfnInclude(scope: Construct, id: string, props: CfnIncludeProps)

Parameters

scope Construct
id string
props CfnIncludeProps

Construct Props

Name	Type	Description
templateFile	`string`	Path to the template file.
loadNestedStacks?	`{ [string]:` `CfnIncludeProps` `}`	Specifies the template files that define nested stacks that should be included.
parameters?	`{ [string]: any }`	Specifies parameters to be replaced by the values in this mapping.
preserveLogicalIds?	`boolean`	Whether the resources should have the same logical IDs in the resulting CDK template as they did in the original CloudFormation template file.

templateFile

Type: string

Path to the template file.

Both JSON and YAML template formats are supported.

loadNestedStacks?

Type: { [string]: CfnIncludeProps } (optional, default: no nested stacks will be included)

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.

parameters?

Type: { [string]: any } (optional, default: no parameters will be replaced)

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.

preserveLogicalIds?

Type: boolean (optional, default: true)

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.

Properties

Name	Type	Description
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
stack	`Stack`	The stack in which this element is defined.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Methods

Name	Description
getCondition(conditionName)	Returns the CfnCondition object from the 'Conditions' section of the CloudFormation template with the given name.
getHook(hookLogicalId)	Returns the CfnHook object from the 'Hooks' section of the included CloudFormation template with the given logical ID.
getMapping(mappingName)	Returns the CfnMapping object from the 'Mappings' section of the included template.
getNestedStack(logicalId)	Returns a loaded NestedStack with name logicalId.
getOutput(logicalId)	Returns the CfnOutput object from the 'Outputs' section of the included template.
getParameter(parameterName)	Returns the CfnParameter object from the 'Parameters' section of the included template.
getResource(logicalId)	Returns the low-level CfnResource from the template with the given logical ID.
getRule(ruleName)	Returns the CfnRule object from the 'Rules' section of the CloudFormation template with the given name.
loadNestedStack(logicalId, nestedStackProps)	Includes a template for a child stack inside of this parent template.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.

getCondition(conditionName)

public getCondition(conditionName: string): CfnCondition

Parameters

conditionName string — the name of the Condition in the CloudFormation template file.

Returns

CfnCondition

Returns the CfnCondition object from the 'Conditions' section of the CloudFormation template with the given name.

Any modifications performed on that object will be reflected in the resulting CDK template.

If a Condition with the given name is not present in the template, throws an exception.

getHook(hookLogicalId)

public getHook(hookLogicalId: string): CfnHook

Parameters

hookLogicalId string — the logical ID of the Hook in the included CloudFormation template's 'Hooks' section.

Returns

CfnHook

Returns the CfnHook object from the 'Hooks' section of the included CloudFormation template with the given logical ID.

Any modifications performed on the returned object will be reflected in the resulting CDK template.

If a Hook with the given logical ID is not present in the template, an exception will be thrown.

getMapping(mappingName)

public getMapping(mappingName: string): CfnMapping

Parameters

mappingName string — the name of the Mapping in the template to retrieve.

Returns

CfnMapping

Returns the CfnMapping object from the 'Mappings' section of the included template.

Any modifications performed on that object will be reflected in the resulting CDK template.

If a Mapping with the given name is not present in the template, an exception will be thrown.

getNestedStack(logicalId)

public getNestedStack(logicalId: string): IncludedNestedStack

Parameters

logicalId string — the ID of the stack to retrieve, as it appears in the template.

Returns

IncludedNestedStack

Returns a loaded NestedStack with name logicalId.

For a nested stack to be returned by this method, it must be specified either in the {@link CfnIncludeProps.loadNestedStacks} property, or through the {@link loadNestedStack} method.

getOutput(logicalId)

public getOutput(logicalId: string): CfnOutput

Parameters

logicalId string — the name of the output to retrieve.

Returns

CfnOutput

Returns the CfnOutput object from the 'Outputs' section of the included template.

Any modifications performed on that object will be reflected in the resulting CDK template.

If an Output with the given name is not present in the template, throws an exception.

getParameter(parameterName)

public getParameter(parameterName: string): CfnParameter

Parameters

parameterName string — the name of the parameter to retrieve.

Returns

CfnParameter

Returns the CfnParameter object from the 'Parameters' section of the included template.

Any modifications performed on that object will be reflected in the resulting CDK template.

If a Parameter with the given name is not present in the template, throws an exception.

getResource(logicalId)

public getResource(logicalId: string): CfnResource

Parameters

logicalId string — the logical ID of the resource in the CloudFormation template file.

Returns

CfnResource

Returns the low-level CfnResource from the template with the given logical ID.

Any modifications performed on that resource will be reflected in the resulting CDK template.

The returned object will be of the proper underlying class; you can always cast it to the correct type in your code:

 // assume the template contains an AWS::S3::Bucket with logical ID 'Bucket'
 const cfnBucket = cfnTemplate.getResource('Bucket') as s3.CfnBucket;
 // cfnBucket is of type s3.CfnBucket

If the template does not contain a resource with the given logical ID, an exception will be thrown.

getRule(ruleName)

public getRule(ruleName: string): CfnRule

Parameters

ruleName string — the name of the Rule in the CloudFormation template.

Returns

CfnRule

Returns the CfnRule object from the 'Rules' section of the CloudFormation template with the given name.

Any modifications performed on that object will be reflected in the resulting CDK template.

If a Rule with the given name is not present in the template, an exception will be thrown.

loadNestedStack(logicalId, nestedStackProps)

public loadNestedStack(logicalId: string, nestedStackProps: CfnIncludeProps): IncludedNestedStack

Parameters

logicalId string — the ID of the stack to retrieve, as it appears in the template.
nestedStackProps CfnIncludeProps — the properties of the included child Stack.

Returns

IncludedNestedStack

Includes a template for a child stack inside of this parent template.

A child with this logical ID must exist in the template, and be of type AWS::CloudFormation::Stack. This is equivalent to specifying the value in the {@link CfnIncludeProps.loadNestedStacks} property on object construction.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.