KeyCondition

class aws_cdk.aws_appsync.KeyCondition(*args: Any, **kwargs)

Bases: object

(experimental) Factory class for DynamoDB key conditions.

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_appsync as appsync

key_condition = appsync.KeyCondition.begins_with("keyName", "arg")

Methods

and_(key_cond)

(experimental) Conjunction between two conditions.

Parameters:

key_cond (KeyCondition) –

Stability:

experimental

Return type:

KeyCondition

render_template()

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

Stability:

experimental

Return type:

str

Static Methods

classmethod begins_with(key_name, arg)

(experimental) Condition (k, arg).

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

Parameters:

  • key_name (str) –

  • arg (str) –

Stability:

experimental

Return type:

KeyCondition

classmethod between(key_name, arg1, arg2)

(experimental) Condition k BETWEEN arg1 AND arg2, true if k >= arg1 and k <= arg2.

Parameters:

  • key_name (str) –

  • arg1 (str) –

  • arg2 (str) –

Stability:

experimental

Return type:

KeyCondition

classmethod eq(key_name, arg)

(experimental) Condition k = arg, true if the key attribute k is equal to the Query argument.

Parameters:

  • key_name (str) –

  • arg (str) –

Stability:

experimental

Return type:

KeyCondition

classmethod ge(key_name, arg)

(experimental) Condition k >= arg, true if the key attribute k is greater or equal to the Query argument.

Parameters:

  • key_name (str) –

  • arg (str) –

Stability:

experimental

Return type:

KeyCondition

classmethod gt(key_name, arg)

(experimental) Condition k > arg, true if the key attribute k is greater than the the Query argument.

Parameters:

  • key_name (str) –

  • arg (str) –

Stability:

experimental

Return type:

KeyCondition

classmethod le(key_name, arg)

(experimental) Condition k <= arg, true if the key attribute k is less than or equal to the Query argument.

Parameters:

  • key_name (str) –

  • arg (str) –

Stability:

experimental

Return type:

KeyCondition

classmethod lt(key_name, arg)

(experimental) Condition k < arg, true if the key attribute k is less than the Query argument.

Parameters:

  • key_name (str) –

  • arg (str) –

Stability:

experimental

Return type:

KeyCondition