Package com.hashicorp.cdktf

Interface IResolveContext

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IResolveContext.Jsii$Default
All Known Implementing Classes:
IResolveContext.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)", date="2025-01-21T14:44:58.000Z") @Stability(Experimental) public interface IResolveContext extends software.amazon.jsii.JsiiSerializable
(experimental) Current resolution context for tokens.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    IResolveContext.Jsii$Default
    Internal default implementation for IResolveContext.
    static final class 
    IResolveContext.Jsii$Proxy
    A proxy class which represents a concrete javascript instance of this type.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Boolean
    getIgnoreEscapes()
    (experimental) True when ${} should not be parsed, and treated as literals.
    default String
    getIteratorContext()
    (experimental) TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g.
    Boolean
    getPreparing()
    (experimental) True when we are still preparing, false if we're rendering the final output.
    software.constructs.IConstruct
    getScope()
    (experimental) The scope from which resolution has been initiated.
    default Boolean
    getSuppressBraces()
    (experimental) True when ${} should be ommitted (because already inside them), false otherwise.
    default Boolean
    getWarnEscapes()
    (experimental) True when ${} should not be included in the string to be resolved, outputs a warning.
    void
    registerPostProcessor(IPostProcessor postProcessor)
    (experimental) Use this postprocessor after the entire token structure has been resolved.
    Object
    resolve(Object x)
    (experimental) Resolve an inner object.
    default void
    setIgnoreEscapes(Boolean value)
    (experimental) True when ${} should not be parsed, and treated as literals.
    default void
    setIteratorContext(String value)
    (experimental) TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g.
    default void
    setSuppressBraces(Boolean value)
    (experimental) True when ${} should be ommitted (because already inside them), false otherwise.
    default void
    setWarnEscapes(Boolean value)
    (experimental) True when ${} should not be included in the string to be resolved, outputs a warning.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getPreparing

      @Stability(Experimental) @NotNull Boolean getPreparing()
      (experimental) True when we are still preparing, false if we're rendering the final output.

    • getScope

      @Stability(Experimental) @NotNull software.constructs.IConstruct getScope()
      (experimental) The scope from which resolution has been initiated.

    • getIgnoreEscapes

      @Stability(Experimental) @Nullable default Boolean getIgnoreEscapes()
      (experimental) True when ${} should not be parsed, and treated as literals.

    • setIgnoreEscapes

      @Optional default void setIgnoreEscapes(@Nullable Boolean value)
      (experimental) True when ${} should not be parsed, and treated as literals.

    • getIteratorContext

      @Stability(Experimental) @Nullable default String getIteratorContext()
      (experimental) TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g. a dynamic block needs each.key while a for expression just needs key.

    • setIteratorContext

      @Optional default void setIteratorContext(@Nullable String value)
      (experimental) TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g. a dynamic block needs each.key while a for expression just needs key.

    • getSuppressBraces

      @Stability(Experimental) @Nullable default Boolean getSuppressBraces()
      (experimental) True when ${} should be ommitted (because already inside them), false otherwise.

    • setSuppressBraces

      @Optional default void setSuppressBraces(@Nullable Boolean value)
      (experimental) True when ${} should be ommitted (because already inside them), false otherwise.

    • getWarnEscapes

      @Stability(Experimental) @Nullable default Boolean getWarnEscapes()
      (experimental) True when ${} should not be included in the string to be resolved, outputs a warning.

      Default: false

    • setWarnEscapes

      @Optional default void setWarnEscapes(@Nullable Boolean value)
      (experimental) True when ${} should not be included in the string to be resolved, outputs a warning.

      Default: false

    • registerPostProcessor

      @Stability(Experimental) void registerPostProcessor(@NotNull IPostProcessor postProcessor)
      (experimental) Use this postprocessor after the entire token structure has been resolved.

      Parameters:
      postProcessor - This parameter is required.

    • resolve

      @Stability(Experimental) @NotNull Object resolve(@NotNull Object x)
      (experimental) Resolve an inner object.

      Parameters:
      x - This parameter is required.