software.amazon.awscdk.cloudformation.include

Class CfnInclude.Builder

java.lang.Object

software.amazon.awscdk.cloudformation.include.CfnInclude.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnInclude>

Enclosing class:

CfnInclude

@Stability(value=Experimental)
public static final class CfnInclude.Builder
extends Object
implements software.amazon.jsii.Builder<CfnInclude>

(experimental) A fluent builder for CfnInclude.

Method Summary

Modifier and Type	Method and Description
CfnInclude	build()
static CfnInclude.Builder	create(software.constructs.Construct scope, String id)
CfnInclude.Builder	loadNestedStacks(Map<String,? extends CfnIncludeProps> loadNestedStacks) (experimental) Specifies the template files that define nested stacks that should be included.
CfnInclude.Builder	parameters(Map<String,? extends Object> parameters) (experimental) Specifies parameters to be replaced by the values in this mapping.
CfnInclude.Builder	preserveLogicalIds(Boolean preserveLogicalIds) (experimental) Whether the resources should have the same logical IDs in the resulting CDK template as they did in the original CloudFormation template file.
CfnInclude.Builder	templateFile(String templateFile) (experimental) Path to the template file.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static CfnInclude.Builder create(software.constructs.Construct scope,
                                                                       String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of CfnInclude.Builder.

templateFile

@Stability(value=Experimental)
public CfnInclude.Builder templateFile(String templateFile)

(experimental) Path to the template file.

Both JSON and YAML template formats are supported.

Parameters:

templateFile - Path to the template file. This parameter is required.

Returns:

this

loadNestedStacks

@Stability(value=Experimental)
public CfnInclude.Builder loadNestedStacks(Map<String,? extends CfnIncludeProps> loadNestedStacks)

(experimental) 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.

Default: - no nested stacks will be included

Parameters:

loadNestedStacks - Specifies the template files that define nested stacks that should be included. This parameter is required.

Returns:

this

parameters

@Stability(value=Experimental)
public CfnInclude.Builder parameters(Map<String,? extends Object> parameters)

(experimental) 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.

Default: - no parameters will be replaced

Parameters:

parameters - Specifies parameters to be replaced by the values in this mapping. This parameter is required.

Returns:

this

preserveLogicalIds

@Stability(value=Experimental)
public CfnInclude.Builder preserveLogicalIds(Boolean preserveLogicalIds)

(experimental) 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.

Default: true

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. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public CfnInclude build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnInclude>