Class KeyCondition
(experimental) Factory class for DynamoDB key conditions.
Inheritance
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.AWS.AppSync.dll
Syntax (csharp)
public class KeyCondition : DeputyBase
Syntax (vb)
Public Class KeyCondition
Inherits DeputyBase
Remarks
Stability: Experimental
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
Constructors
KeyCondition(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
KeyCondition(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Methods
And(KeyCondition) | (experimental) Conjunction between two conditions. |
BeginsWith(String, String) | (experimental) Condition (k, arg). |
Between(String, String, String) | (experimental) Condition k BETWEEN arg1 AND arg2, true if k >= arg1 and k <= arg2. |
Eq(String, String) | (experimental) Condition k = arg, true if the key attribute k is equal to the Query argument. |
Ge(String, String) | (experimental) Condition k >= arg, true if the key attribute k is greater or equal to the Query argument. |
Gt(String, String) | (experimental) Condition k > arg, true if the key attribute k is greater than the the Query argument. |
Le(String, String) | (experimental) Condition k <= arg, true if the key attribute k is less than or equal to the Query argument. |
Lt(String, String) | (experimental) Condition k < arg, true if the key attribute k is less than the Query argument. |
RenderTemplate() | (experimental) Renders the key condition to a VTL string. |
Constructors
KeyCondition(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected KeyCondition(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
KeyCondition(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected KeyCondition(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Methods
And(KeyCondition)
(experimental) Conjunction between two conditions.
public virtual KeyCondition And(KeyCondition keyCond)
Parameters
- keyCond KeyCondition
Returns
Remarks
Stability: Experimental
BeginsWith(String, String)
(experimental) Condition (k, arg).
public static KeyCondition BeginsWith(string keyName, string arg)
Parameters
- keyName System.String
- arg System.String
Returns
Remarks
True if the key attribute k begins with the Query argument.
Stability: Experimental
Between(String, String, String)
(experimental) Condition k BETWEEN arg1 AND arg2, true if k >= arg1 and k <= arg2.
public static KeyCondition Between(string keyName, string arg1, string arg2)
Parameters
- keyName System.String
- arg1 System.String
- arg2 System.String
Returns
Remarks
Stability: Experimental
Eq(String, String)
(experimental) Condition k = arg, true if the key attribute k is equal to the Query argument.
public static KeyCondition Eq(string keyName, string arg)
Parameters
- keyName System.String
- arg System.String
Returns
Remarks
Stability: Experimental
Ge(String, String)
(experimental) 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
- keyName System.String
- arg System.String
Returns
Remarks
Stability: Experimental
Gt(String, String)
(experimental) 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
- keyName System.String
- arg System.String
Returns
Remarks
Stability: Experimental
Le(String, String)
(experimental) 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
- keyName System.String
- arg System.String
Returns
Remarks
Stability: Experimental
Lt(String, String)
(experimental) Condition k < arg, true if the key attribute k is less than the Query argument.
public static KeyCondition Lt(string keyName, string arg)
Parameters
- keyName System.String
- arg System.String
Returns
Remarks
Stability: Experimental
RenderTemplate()
(experimental) Renders the key condition to a VTL string.
public virtual string RenderTemplate()
Returns
System.String
Remarks
Stability: Experimental