Class: AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Inherits:
Jsii::Object
  • Object
show all
Defined in:
step_functions_tasks/dynamo_attribute_value.rb

Overview

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ DynamoAttributeValue

Returns a new instance of DynamoAttributeValue.

Raises:

  • (NoMethodError) 


13
14
15
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 13

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

Class Method Details

.boolean_from_json_path(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type Boolean from state input through Json path.

For example: "BOOL": true

Parameters:

  • value (String) —

    Json path that specifies state input to be used.

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


41
42
43
44
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 41

def self.boolean_from_json_path(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "booleanFromJsonPath", [value])
end

.boolean_from_jsonata(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type Boolean from state input through JSONata expression.

For example: "BOOL": true

Parameters:

  • value (String) —

    JSONata expression that specifies state input to be used.

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


30
31
32
33
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 30

def self.boolean_from_jsonata(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "booleanFromJsonata", [value])
end

.from_binary(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type Binary.

For example: "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

Parameters:

  • value (String) —

    base-64 encoded string.

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


52
53
54
55
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 52

def self.from_binary(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "fromBinary", [value])
end

.from_binary_set(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type Binary Set.

For example: "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

Parameters:

  • value (Array<String>)

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


63
64
65
66
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 63

def self.from_binary_set(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "fromBinarySet", [value])
end

.from_boolean(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type Boolean.

For example: "BOOL": true

Parameters:

  • value (Boolean)

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


74
75
76
77
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 74

def self.from_boolean(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "fromBoolean", [value])
end

.from_list(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type List.

For example: "L": [ "Cookies" , "Coffee", "3.14159"]

Parameters:

  • value (Array<AWSCDK::StepFunctionsTasks::DynamoAttributeValue>)

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


85
86
87
88
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 85

def self.from_list(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLkR5bmFtb0F0dHJpYnV0ZVZhbHVlIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "fromList", [value])
end

.from_map(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type Map.

For example: "M": {"S": "Joe", "Age": "35"}

Parameters:

  • value (Hash{String => AWSCDK::StepFunctionsTasks::DynamoAttributeValue})

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


96
97
98
99
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 96

def self.from_map(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zX3Rhc2tzLkR5bmFtb0F0dHJpYnV0ZVZhbHVlIn0sImtpbmQiOiJtYXAifX0=")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "fromMap", [value])
end

.from_null(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type Null.

For example: "NULL": true

Parameters:

  • value (Boolean)

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


107
108
109
110
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 107

def self.from_null(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "fromNull", [value])
end

.from_number(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets a literal number.

For example: 1234 Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

Parameters:

  • value (Numeric)

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


121
122
123
124
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 121

def self.from_number(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "fromNumber", [value])
end

.from_number_set(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type Number Set.

For example: "NS": ["42.2", "-19", "7.5", "3.14"] Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

Parameters:

  • value (Array<Numeric>)

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


135
136
137
138
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 135

def self.from_number_set(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6Im51bWJlciJ9LCJraW5kIjoiYXJyYXkifX0=")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "fromNumberSet", [value])
end

.from_string(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type String.

For example: "S": "Hello" Strings may be literal values or as JSONata expression or as JsonPath. Example values:

  • DynamoAttributeValue.fromString('someValue')
  • DynamoAttributeValue.fromString('{% $bar %}')
  • DynamoAttributeValue.fromString(JsonPath.stringAt('$.bar'))

Parameters:

  • value (String)

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


151
152
153
154
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 151

def self.from_string(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "fromString", [value])
end

.from_string_set(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type String Set.

For example: "SS": ["Giraffe", "Hippo" ,"Zebra"]

Parameters:

  • value (Array<String>)

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


162
163
164
165
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 162

def self.from_string_set(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "fromStringSet", [value])
end

.jsii_overridable_methods ⇒ Object 



17
18
19
20
21
22
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 17

def self.jsii_overridable_methods
  {
    :attribute_value => { kind: :property, name: "attributeValue", is_optional: false },
    :to_object => { kind: :method, name: "toObject", is_optional: false },
  }
end

.list_from_json_path(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type List.

For example: "L": [ "Cookies" , "Coffee", "Veggies"]

Parameters:

  • value (String) —

    Json path that specifies state input to be used.

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


184
185
186
187
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 184

def self.list_from_json_path(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "listFromJsonPath", [value])
end

.list_from_jsonata(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type List.

For example: "L": [ "Cookies" , "Coffee", "Veggies"]

Parameters:

  • value (String) —

    JSONata expression that specifies state input to be used.

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


173
174
175
176
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 173

def self.list_from_jsonata(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "listFromJsonata", [value])
end

.map_from_json_path(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type Map.

For example: "M": {"S": "Joe", "Age": "35"}

Parameters:

  • value (String) —

    Json path that specifies state input to be used.

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


206
207
208
209
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 206

def self.map_from_json_path(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "mapFromJsonPath", [value])
end

.map_from_jsonata(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type Map.

For example: "M": {"S": "Joe", "Age": "35"}

Parameters:

  • value (String) —

    JSONata expression that specifies state input to be used.

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


195
196
197
198
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 195

def self.map_from_jsonata(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "mapFromJsonata", [value])
end

.number_from_string(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type Number.

For example: "N": "123.45" Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

Numbers may be expressed as literal strings or as JSONata expression or as JsonPath

Parameters:

  • value (String)

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


222
223
224
225
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 222

def self.number_from_string(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "numberFromString", [value])
end

.number_set_from_strings(value) ⇒ AWSCDK::StepFunctionsTasks::DynamoAttributeValue

Sets an attribute of type Number Set.

For example: "NS": ["42.2", "-19", "7.5", "3.14"] Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

Numbers may be expressed as literal strings or as JsonPath

Parameters:

  • value (Array<String>)

Returns:

  • (AWSCDK::StepFunctionsTasks::DynamoAttributeValue) 


238
239
240
241
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 238

def self.number_set_from_strings(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "value")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue", "numberSetFromStrings", [value])
end

Instance Method Details

#attribute_value ⇒ Object

Represents the data for the attribute.

Data can be i.e. "S": "Hello"

Returns:

  • (Object) 


249
250
251
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 249

def attribute_value()
  jsii_get_property("attributeValue")
end

#to_object ⇒ Object

Returns the DynamoDB attribute value.

Returns:

  • (Object) 


256
257
258
 
# File 'step_functions_tasks/dynamo_attribute_value.rb', line 256

def to_object()
  jsii_call_method("toObject", [])
end