software.amazon.awscdk.services.appsync

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.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:42.858Z")
 @Stability(value=Experimental)
public class KeyCondition
extends software.amazon.jsii.JsiiObject

(experimental) 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 and Description
protected	KeyCondition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	KeyCondition(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
KeyCondition	and(KeyCondition keyCond) (experimental) Conjunction between two conditions.
static KeyCondition	beginsWith(String keyName, String arg) (experimental) Condition (k, arg).
static KeyCondition	between(String keyName, String arg1, String arg2) (experimental) Condition k BETWEEN arg1 AND arg2, true if k >= arg1 and k <= arg2.
static KeyCondition	eq(String keyName, String arg) (experimental) Condition k = arg, true if the key attribute k is equal to the Query argument.
static KeyCondition	ge(String keyName, String arg) (experimental) Condition k >= arg, true if the key attribute k is greater or equal to the Query argument.
static KeyCondition	gt(String keyName, String arg) (experimental) Condition k > arg, true if the key attribute k is greater than the the Query argument.
static KeyCondition	le(String keyName, String arg) (experimental) Condition k <= arg, true if the key attribute k is less than or equal to the Query argument.
static KeyCondition	lt(String keyName, String arg) (experimental) Condition k < arg, true if the key attribute k is less than the Query argument.
String	renderTemplate() (experimental) 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 Detail

KeyCondition

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

KeyCondition

protected KeyCondition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

beginsWith

@Stability(value=Experimental)
 @NotNull
public static KeyCondition beginsWith(@NotNull
                                                                               String keyName,
                                                                               @NotNull
                                                                               String arg)

(experimental) 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(value=Experimental)
 @NotNull
public static KeyCondition between(@NotNull
                                                                            String keyName,
                                                                            @NotNull
                                                                            String arg1,
                                                                            @NotNull
                                                                            String arg2)

(experimental) 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(value=Experimental)
 @NotNull
public static KeyCondition eq(@NotNull
                                                                       String keyName,
                                                                       @NotNull
                                                                       String arg)

(experimental) 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(value=Experimental)
 @NotNull
public static KeyCondition ge(@NotNull
                                                                       String keyName,
                                                                       @NotNull
                                                                       String arg)

(experimental) 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(value=Experimental)
 @NotNull
public static KeyCondition gt(@NotNull
                                                                       String keyName,
                                                                       @NotNull
                                                                       String arg)

(experimental) 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(value=Experimental)
 @NotNull
public static KeyCondition le(@NotNull
                                                                       String keyName,
                                                                       @NotNull
                                                                       String arg)

(experimental) 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(value=Experimental)
 @NotNull
public static KeyCondition lt(@NotNull
                                                                       String keyName,
                                                                       @NotNull
                                                                       String arg)

(experimental) 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(value=Experimental)
 @NotNull
public KeyCondition and(@NotNull
                                                                 KeyCondition keyCond)

(experimental) Conjunction between two conditions.

Parameters:

keyCond - This parameter is required.

renderTemplate

@Stability(value=Experimental)
 @NotNull
public String renderTemplate()

(experimental) Renders the key condition to a VTL string.