Class KeyCondition

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.appsync.KeyCondition
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:14.676Z") @Stability(Stable) public class KeyCondition extends software.amazon.jsii.JsiiObject
Factory class for DynamoDB key conditions.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 KeyCondition keyCondition = KeyCondition.beginsWith("keyName", "arg");
 
  • Nested Class Summary

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

    software.amazon.jsii.JsiiObject.InitializationMode
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    KeyCondition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    KeyCondition(software.amazon.jsii.JsiiObjectRef objRef)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    and(KeyCondition keyCond)
    Conjunction between two conditions.
    beginsWith(String keyName, String arg)
    Condition (k, arg).
    between(String keyName, String arg1, String arg2)
    Condition k BETWEEN arg1 AND arg2, true if k >= arg1 and k <= arg2.
    eq(String keyName, String arg)
    Condition k = arg, true if the key attribute k is equal to the Query argument.
    ge(String keyName, String arg)
    Condition k >= arg, true if the key attribute k is greater or equal to the Query argument.
    gt(String keyName, String arg)
    Condition k > arg, true if the key attribute k is greater than the the Query argument.
    le(String keyName, String arg)
    Condition k <= arg, true if the key attribute k is less than or equal to the Query argument.
    lt(String keyName, String arg)
    Condition k < arg, true if the key attribute k is less than the Query argument.
    Renders the key condition to a VTL string.

    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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson
  • Constructor Details

    • KeyCondition

      protected KeyCondition(software.amazon.jsii.JsiiObjectRef objRef)
    • KeyCondition

      protected KeyCondition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
  • Method Details

    • beginsWith

      @Stability(Stable) @NotNull public static KeyCondition beginsWith(@NotNull String keyName, @NotNull String arg)
      Condition (k, arg).

      True if the key attribute k begins with the Query argument.

      Parameters:
      keyName - This parameter is required.
      arg - This parameter is required.
    • between

      @Stability(Stable) @NotNull public static KeyCondition between(@NotNull String keyName, @NotNull String arg1, @NotNull String arg2)
      Condition k BETWEEN arg1 AND arg2, true if k >= arg1 and k <= arg2.

      Parameters:
      keyName - This parameter is required.
      arg1 - This parameter is required.
      arg2 - This parameter is required.
    • eq

      @Stability(Stable) @NotNull public static KeyCondition eq(@NotNull String keyName, @NotNull String arg)
      Condition k = arg, true if the key attribute k is equal to the Query argument.

      Parameters:
      keyName - This parameter is required.
      arg - This parameter is required.
    • ge

      @Stability(Stable) @NotNull public static KeyCondition ge(@NotNull String keyName, @NotNull String arg)
      Condition k >= arg, true if the key attribute k is greater or equal to the Query argument.

      Parameters:
      keyName - This parameter is required.
      arg - This parameter is required.
    • gt

      @Stability(Stable) @NotNull public static KeyCondition gt(@NotNull String keyName, @NotNull String arg)
      Condition k > arg, true if the key attribute k is greater than the the Query argument.

      Parameters:
      keyName - This parameter is required.
      arg - This parameter is required.
    • le

      @Stability(Stable) @NotNull public static KeyCondition le(@NotNull String keyName, @NotNull String arg)
      Condition k <= arg, true if the key attribute k is less than or equal to the Query argument.

      Parameters:
      keyName - This parameter is required.
      arg - This parameter is required.
    • lt

      @Stability(Stable) @NotNull public static KeyCondition lt(@NotNull String keyName, @NotNull String arg)
      Condition k < arg, true if the key attribute k is less than the Query argument.

      Parameters:
      keyName - This parameter is required.
      arg - This parameter is required.
    • and

      @Stability(Stable) @NotNull public KeyCondition and(@NotNull KeyCondition keyCond)
      Conjunction between two conditions.

      Parameters:
      keyCond - This parameter is required.
    • renderTemplate

      @Stability(Stable) @NotNull public String renderTemplate()
      Renders the key condition to a VTL string.