Package software.amazon.awscdk.cloudformation.include

Class CfnIncludeProps.Builder

java.lang.Object
software.amazon.awscdk.cloudformation.include.CfnIncludeProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnIncludeProps>
Enclosing interface:
CfnIncludeProps
@Stability(Stable) public static final class CfnIncludeProps.Builder extends Object implements software.amazon.jsii.Builder<CfnIncludeProps>
A builder for CfnIncludeProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • templateFile

      @Stability(Stable) public CfnIncludeProps.Builder templateFile(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

    • allowCyclicalReferences

      @Stability(Stable) public CfnIncludeProps.Builder allowCyclicalReferences(Boolean allowCyclicalReferences)
      Sets the value of CfnIncludeProps.getAllowCyclicalReferences()
      Parameters:
      allowCyclicalReferences - 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.
      Returns:
      this

    • loadNestedStacks

      @Stability(Stable) public CfnIncludeProps.Builder loadNestedStacks(Map<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 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.

      Returns:
      this

    • parameters

      @Stability(Stable) public CfnIncludeProps.Builder parameters(Map<String,? extends 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.

      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.

      Returns:
      this

    • preserveLogicalIds

      @Stability(Stable) public CfnIncludeProps.Builder preserveLogicalIds(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 CfnInclude.getResource and related methods always uses the original logical ID of the resource/element, as specified in the template file.

      Returns:
      this

    • build

      @Stability(Stable) public CfnIncludeProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnIncludeProps>
      Returns:
      a new instance of CfnIncludeProps
      Throws:
      NullPointerException - if any required attribute was not provided