software.amazon.awscdk.cloudformation.include

Class CfnIncludeProps.Builder

java.lang.Object

software.amazon.awscdk.cloudformation.include.CfnIncludeProps.Builder

Enclosing interface:

CfnIncludeProps

public static final class CfnIncludeProps.Builder
extends java.lang.Object

A builder for CfnIncludeProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnIncludeProps	build() Builds the configured instance.
CfnIncludeProps.Builder	loadNestedStacks(java.util.Map<java.lang.String,? extends CfnIncludeProps> loadNestedStacks) Sets the value of CfnIncludeProps.getLoadNestedStacks()
CfnIncludeProps.Builder	parameters(java.util.Map<java.lang.String,? extends java.lang.Object> parameters) Sets the value of CfnIncludeProps.getParameters()
CfnIncludeProps.Builder	preserveLogicalIds(java.lang.Boolean preserveLogicalIds) Sets the value of CfnIncludeProps.getPreserveLogicalIds()
CfnIncludeProps.Builder	templateFile(java.lang.String templateFile) Sets the value of CfnIncludeProps.getTemplateFile()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

templateFile

public CfnIncludeProps.Builder templateFile(java.lang.String templateFile)

Sets the value of CfnIncludeProps.getTemplateFile()

Parameters:

templateFile - Path to the template file. This parameter is required. Both JSON and YAML template formats are supported.

Returns:

this

loadNestedStacks

public CfnIncludeProps.Builder loadNestedStacks(java.util.Map<java.lang.String,? extends CfnIncludeProps> loadNestedStacks)

Sets the value of CfnIncludeProps.getLoadNestedStacks()

Parameters:

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

Returns:

this

parameters

public CfnIncludeProps.Builder parameters(java.util.Map<java.lang.String,? extends java.lang.Object> parameters)

Sets the value of CfnIncludeProps.getParameters()

Parameters:

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

Returns:

this

preserveLogicalIds

public CfnIncludeProps.Builder preserveLogicalIds(java.lang.Boolean preserveLogicalIds)

Sets the value of CfnIncludeProps.getPreserveLogicalIds()

Parameters:

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

Returns:

this

build

public CfnIncludeProps build()

Builds the configured instance.

Returns:

a new instance of CfnIncludeProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided