Class: AWSCDK::AppSync::KeyCondition

Inherits:
Jsii::Object
  • Object
show all
Defined in:
app_sync/key_condition.rb

Overview

Factory class for DynamoDB key conditions.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ KeyCondition

Returns a new instance of KeyCondition.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'app_sync/key_condition.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_appsync.KeyCondition does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.begins_with(key_name, arg) ⇒ AWSCDK::AppSync::KeyCondition

Condition (k, arg).

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

Parameters:

  • key_name (String)
  • arg (String)

Returns:

  • (AWSCDK::AppSync::KeyCondition) 


26
27
28
29
30
 
# File 'app_sync/key_condition.rb', line 26

def self.begins_with(key_name, arg)
  Jsii::Type.check_type(key_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyName")
  Jsii::Type.check_type(arg, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arg")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.KeyCondition", "beginsWith", [key_name, arg])
end

.between(key_name, arg1, arg2) ⇒ AWSCDK::AppSync::KeyCondition

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

Parameters:

  • key_name (String)
  • arg1 (String)
  • arg2 (String)

Returns:

  • (AWSCDK::AppSync::KeyCondition) 


38
39
40
41
42
43
 
# File 'app_sync/key_condition.rb', line 38

def self.between(key_name, arg1, arg2)
  Jsii::Type.check_type(key_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyName")
  Jsii::Type.check_type(arg1, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arg1")
  Jsii::Type.check_type(arg2, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arg2")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.KeyCondition", "between", [key_name, arg1, arg2])
end

.eq(key_name, arg) ⇒ AWSCDK::AppSync::KeyCondition

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

Parameters:

  • key_name (String)
  • arg (String)

Returns:

  • (AWSCDK::AppSync::KeyCondition) 


50
51
52
53
54
 
# File 'app_sync/key_condition.rb', line 50

def self.eq(key_name, arg)
  Jsii::Type.check_type(key_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyName")
  Jsii::Type.check_type(arg, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arg")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.KeyCondition", "eq", [key_name, arg])
end

.ge(key_name, arg) ⇒ AWSCDK::AppSync::KeyCondition

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

Parameters:

  • key_name (String)
  • arg (String)

Returns:

  • (AWSCDK::AppSync::KeyCondition) 


61
62
63
64
65
 
# File 'app_sync/key_condition.rb', line 61

def self.ge(key_name, arg)
  Jsii::Type.check_type(key_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyName")
  Jsii::Type.check_type(arg, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arg")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.KeyCondition", "ge", [key_name, arg])
end

.gt(key_name, arg) ⇒ AWSCDK::AppSync::KeyCondition

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

Parameters:

  • key_name (String)
  • arg (String)

Returns:

  • (AWSCDK::AppSync::KeyCondition) 


72
73
74
75
76
 
# File 'app_sync/key_condition.rb', line 72

def self.gt(key_name, arg)
  Jsii::Type.check_type(key_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyName")
  Jsii::Type.check_type(arg, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arg")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.KeyCondition", "gt", [key_name, arg])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
 
# File 'app_sync/key_condition.rb', line 12

def self.jsii_overridable_methods
  {
    :_and => { kind: :method, name: "and", is_optional: false },
    :render_template => { kind: :method, name: "renderTemplate", is_optional: false },
  }
end

.le(key_name, arg) ⇒ AWSCDK::AppSync::KeyCondition

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

Parameters:

  • key_name (String)
  • arg (String)

Returns:

  • (AWSCDK::AppSync::KeyCondition) 


83
84
85
86
87
 
# File 'app_sync/key_condition.rb', line 83

def self.le(key_name, arg)
  Jsii::Type.check_type(key_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyName")
  Jsii::Type.check_type(arg, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arg")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.KeyCondition", "le", [key_name, arg])
end

.lt(key_name, arg) ⇒ AWSCDK::AppSync::KeyCondition

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

Parameters:

  • key_name (String)
  • arg (String)

Returns:

  • (AWSCDK::AppSync::KeyCondition) 


94
95
96
97
98
 
# File 'app_sync/key_condition.rb', line 94

def self.lt(key_name, arg)
  Jsii::Type.check_type(key_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyName")
  Jsii::Type.check_type(arg, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arg")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.KeyCondition", "lt", [key_name, arg])
end

Instance Method Details

#_and(key_cond) ⇒ AWSCDK::AppSync::KeyCondition

Conjunction between two conditions.

Parameters:

  • key_cond (AWSCDK::AppSync::KeyCondition)

Returns:

  • (AWSCDK::AppSync::KeyCondition) 


104
105
106
107
 
# File 'app_sync/key_condition.rb', line 104

def _and(key_cond)
  Jsii::Type.check_type(key_cond, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5LZXlDb25kaXRpb24ifQ==")), "keyCond")
  jsii_call_method("and", [key_cond])
end

#render_template ⇒ String

Renders the key condition to a VTL string.

Returns:

  • (String) 


112
113
114
 
# File 'app_sync/key_condition.rb', line 112

def render_template()
  jsii_call_method("renderTemplate", [])
end