Interface CfnIncludeProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-31T18:44:21.640Z") @Stability(Stable) public interface CfnIncludeProps extends
Construction properties of CfnInclude.


 CfnInclude parentTemplate = CfnInclude.Builder.create(this, "ParentStack")
                 "ChildStack", CfnIncludeProps.builder()
  • Method Details

    • getTemplateFile

      @Stability(Stable) @NotNull String getTemplateFile()
      Path to the template file.

      Both JSON and YAML template formats are supported.

    • getLoadNestedStacks

      @Stability(Stable) @Nullable default Map<String,CfnIncludeProps> getLoadNestedStacks()
      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

    • getParameters

      @Stability(Stable) @Nullable default Map<String,Object> getParameters()
      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

    • getPreserveLogicalIds

      @Stability(Stable) @Nullable default Boolean getPreserveLogicalIds()
      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

    • builder

      @Stability(Stable) static CfnIncludeProps.Builder builder()
      a CfnIncludeProps.Builder of CfnIncludeProps