Package software.amazon.awscdk.cloudformation.include

Class CfnIncludeProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.cloudformation.include.CfnIncludeProps.Jsii$Proxy
All Implemented Interfaces:
CfnIncludeProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnIncludeProps
@Stability(Stable) @Internal public static final class CfnIncludeProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnIncludeProps
An implementation for CfnIncludeProps

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.cloudformation.include.CfnIncludeProps

    CfnIncludeProps.Builder, CfnIncludeProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(CfnIncludeProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the CfnIncludeProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final Boolean
    getAllowCyclicalReferences()
    Specifies whether to allow cyclical references, effectively disregarding safeguards meant to avoid undeployable templates.
    final List<String>
    getDehydratedResources()
    Specifies a list of LogicalIDs for resources that will be included in the CDK Stack, but will not be parsed and converted to CDK types.
    final Map<String,CfnIncludeProps>
    getLoadNestedStacks()
    Specifies the template files that define nested stacks that should be included.
    final Map<String,Object>
    getParameters()
    Specifies parameters to be replaced by the values in this mapping.
    final 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.
    final String
    getTemplateFile()
    Path to the template file.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CfnIncludeProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnIncludeProps.Builder.

  • Method Details

    • getTemplateFile

      public final String getTemplateFile()
      Description copied from interface: CfnIncludeProps
      Path to the template file.

      Both JSON and YAML template formats are supported.

      Specified by:
      getTemplateFile in interface CfnIncludeProps

    • getAllowCyclicalReferences

      public final Boolean getAllowCyclicalReferences()
      Description copied from interface: CfnIncludeProps
      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.

      Default: - will throw an error on detecting any cyclical references

      Specified by:
      getAllowCyclicalReferences in interface CfnIncludeProps

    • getDehydratedResources

      public final List<String> getDehydratedResources()
      Description copied from interface: CfnIncludeProps
      Specifies a list of LogicalIDs for resources that will be included in the CDK Stack, but will not be parsed and converted to CDK types.

      This allows you to use CFN templates that rely on Intrinsic placement that cfn-include would otherwise reject, such as non-primitive values in resource update policies.

      Default: - All resources are hydrated

      Specified by:
      getDehydratedResources in interface CfnIncludeProps

    • getLoadNestedStacks

      public final Map<String,CfnIncludeProps> getLoadNestedStacks()
      Description copied from interface: CfnIncludeProps
      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.

      Default: - no nested stacks will be included

      Specified by:
      getLoadNestedStacks in interface CfnIncludeProps

    • getParameters

      public final Map<String,Object> getParameters()
      Description copied from interface: CfnIncludeProps
      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.

      Default: - parameters will retain their original definitions

      Specified by:
      getParameters in interface CfnIncludeProps

    • getPreserveLogicalIds

      public final Boolean getPreserveLogicalIds()
      Description copied from interface: CfnIncludeProps
      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.

      Default: true

      Specified by:
      getPreserveLogicalIds in interface CfnIncludeProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object