Class KeyCondition
Factory class for DynamoDB key conditions.
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class KeyCondition : DeputyBaseSyntax (vb)
Public Class KeyCondition Inherits DeputyBaseRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;
var keyCondition = KeyCondition.BeginsWith("keyName", "arg");Synopsis
Methods
| And(KeyCondition) | Conjunction between two conditions. |
| BeginsWith(string, string) | Condition (k, arg). |
| Between(string, string, string) | Condition k BETWEEN arg1 AND arg2, true if k >= arg1 and k <= arg2. |
| Eq(string, string) | Condition k = arg, true if the key attribute k is equal to the Query argument. |
| Ge(string, string) | Condition k >= arg, true if the key attribute k is greater or equal to the Query argument. |
| Gt(string, string) | Condition k > arg, true if the key attribute k is greater than the the Query argument. |
| Le(string, string) | Condition k <= arg, true if the key attribute k is less than or equal to the Query argument. |
| Lt(string, string) | Condition k < arg, true if the key attribute k is less than the Query argument. |
| RenderTemplate() | Renders the key condition to a VTL string. |
Methods
And(KeyCondition)
Conjunction between two conditions.
public virtual KeyCondition And(KeyCondition keyCond)Parameters
- keyCond KeyCondition
Returns
Remarks
ExampleMetadata: fixture=_generated
BeginsWith(string, string)
Condition (k, arg).
public static KeyCondition BeginsWith(string keyName, string arg)Parameters
Returns
Remarks
True if the key attribute k begins with the Query argument.
Between(string, string, string)
Condition k BETWEEN arg1 AND arg2, true if k >= arg1 and k <= arg2.
public static KeyCondition Between(string keyName, string arg1, string arg2)Parameters
Returns
Remarks
ExampleMetadata: fixture=_generated
Eq(string, string)
Condition k = arg, true if the key attribute k is equal to the Query argument.
public static KeyCondition Eq(string keyName, string arg)Parameters
Returns
Remarks
ExampleMetadata: fixture=_generated
Ge(string, string)
Condition k >= arg, true if the key attribute k is greater or equal to the Query argument.
public static KeyCondition Ge(string keyName, string arg)Parameters
Returns
Remarks
ExampleMetadata: fixture=_generated
Gt(string, string)
Condition k > arg, true if the key attribute k is greater than the the Query argument.
public static KeyCondition Gt(string keyName, string arg)Parameters
Returns
Remarks
ExampleMetadata: fixture=_generated
Le(string, string)
Condition k <= arg, true if the key attribute k is less than or equal to the Query argument.
public static KeyCondition Le(string keyName, string arg)Parameters
Returns
Remarks
ExampleMetadata: fixture=_generated
Lt(string, string)
Condition k < arg, true if the key attribute k is less than the Query argument.
public static KeyCondition Lt(string keyName, string arg)Parameters
Returns
Remarks
ExampleMetadata: fixture=_generated
RenderTemplate()
Renders the key condition to a VTL string.
public virtual string RenderTemplate()Returns
Remarks
ExampleMetadata: fixture=_generated