Package software.amazon.awscdk

Class GetContextValueOptions.Jsii$Proxy

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

  • 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(GetContextValueOptions.Builder builder)
      Constructor that initializes the object based on literal property values passed by the GetContextValueOptions.Builder.

  • Method Details

    • getDummyValue

      public final Object getDummyValue()
      Description copied from interface: GetContextValueOptions
      The value to return if the lookup has not yet been performed.

      Upon first synthesis, the lookups has not yet been performed. The getValue() operation returns this value instead, so that synthesis can proceed. After synthesis completes the first time, the actual lookup will be performed and synthesis will run again with the real value.

      Dummy values should preferably have valid shapes so that downstream consumers of lookup values don't throw validation exceptions if they encounter a dummy value (or all possible downstream consumers need to effectively check for the well-known shape of the dummy value); throwing an exception would error out the synthesis operation and prevent the lookup and the second, real, synthesis from happening.

      Connection to mustExist

      dummyValue is also used as the official value to return if the lookup has failed and mustExist == false.

      Specified by:
      getDummyValue in interface GetContextValueOptions

    • getIgnoreErrorOnMissingContext

      public final Boolean getIgnoreErrorOnMissingContext()
      Description copied from interface: GetContextValueOptions
      (deprecated) Ignore a lookup failure and return the dummyValue instead.

      mustExist is the recommended alias for this deprecated property (note that its value is reversed).

      Default: false

      Specified by:
      getIgnoreErrorOnMissingContext in interface GetContextValueOptions

    • getMustExist

      public final Boolean getMustExist()
      Description copied from interface: GetContextValueOptions
      Whether the resource must exist.

      If this is set (the default), the query fails if the value or resource we tried to look up doesn't exist.

      If this is false and the value we tried to look up could not be found, the failure is suppressed and dummyValue is officially returned instead.

      When this happens, dummyValue is encoded into cached context and it will never be refreshed anymore until the user runs cdk context --reset <key>.

      Note that it is not possible for the CDK app code to make a distinction between "the lookup has not been performed yet" and "the lookup didn't find anything and we returned a default value instead".

      Context providers

      This feature must explicitly be supported by context providers. It is currently supported by:

      • KMS key provider
      • SSM parameter provider

      Note to implementors

      The dummy value should not be returned for all SDK lookup failures. For example, "no network" or "no credentials" or "malformed query" should not lead to the dummy value being returned. Only the case of "no such resource" should.

      Default: true

      Specified by:
      getMustExist in interface GetContextValueOptions

    • getProvider

      public final String getProvider()
      Description copied from interface: GetContextKeyOptions
      The context provider to query.
      Specified by:
      getProvider in interface GetContextKeyOptions

    • getAdditionalCacheKey

      public final String getAdditionalCacheKey()
      Description copied from interface: GetContextKeyOptions
      Adds an additional discriminator to the cdk.context.json cache key.

      Default: - no additional cache key

      Specified by:
      getAdditionalCacheKey in interface GetContextKeyOptions

    • getIncludeEnvironment

      public final Boolean getIncludeEnvironment()
      Description copied from interface: GetContextKeyOptions
      Whether to include the stack's account and region automatically.

      Default: true

      Specified by:
      getIncludeEnvironment in interface GetContextKeyOptions

    • getProps

      public final Map<String,Object> getProps()
      Description copied from interface: GetContextKeyOptions
      Provider-specific properties.
      Specified by:
      getProps in interface GetContextKeyOptions

    • $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