DynamoAttributeValue

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.stepfunctions.tasks.DynamoAttributeValue

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:50.181Z")
public class DynamoAttributeValue
extends software.amazon.jsii.JsiiObject

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.

Example:

 Table myTable;
 DynamoDeleteItem.Builder.create(this, "DeleteItem")
         .key(Map.of("MessageId", DynamoAttributeValue.fromString("message-007")))
         .table(myTable)
         .resultPath(JsonPath.DISCARD)
         .build();

See Also:: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_AttributeValue.html

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DynamoAttributeValue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`DynamoAttributeValue(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DynamoAttributeValue`	`booleanFromJsonPath(java.lang.String value)` Sets an attribute of type Boolean from state input through Json path.
`static DynamoAttributeValue`	`fromBinary(java.lang.String value)` Sets an attribute of type Binary.
`static DynamoAttributeValue`	`fromBinarySet(java.util.List<java.lang.String> value)` Sets an attribute of type Binary Set.
`static DynamoAttributeValue`	`fromBoolean(java.lang.Boolean value)` Sets an attribute of type Boolean.
`static DynamoAttributeValue`	`fromList(java.util.List<? extends DynamoAttributeValue> value)` Sets an attribute of type List.
`static DynamoAttributeValue`	`fromMap(java.util.Map<java.lang.String,? extends DynamoAttributeValue> value)` Sets an attribute of type Map.
`static DynamoAttributeValue`	`fromNull(java.lang.Boolean value)` Sets an attribute of type Null.
`static DynamoAttributeValue`	`fromNumber(java.lang.Number value)` Sets a literal number.
`static DynamoAttributeValue`	`fromNumberSet(java.util.List<? extends java.lang.Number> value)` Sets an attribute of type Number Set.
`static DynamoAttributeValue`	`fromString(java.lang.String value)` Sets an attribute of type String.
`static DynamoAttributeValue`	`fromStringSet(java.util.List<java.lang.String> value)` Sets an attribute of type String Set.
`java.lang.Object`	`getAttributeValue()` Represents the data for the attribute.
`static DynamoAttributeValue`	`listFromJsonPath(java.lang.String value)` Sets an attribute of type List.
`static DynamoAttributeValue`	`mapFromJsonPath(java.lang.String value)` Sets an attribute of type Map.
`static DynamoAttributeValue`	`numberFromString(java.lang.String value)` Sets an attribute of type Number.
`static DynamoAttributeValue`	`numberSetFromStrings(java.util.List<java.lang.String> value)` Sets an attribute of type Number Set.
`java.lang.Object`	`toObject()` Returns the DynamoDB attribute value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DynamoAttributeValue
```
protected DynamoAttributeValue(software.amazon.jsii.JsiiObjectRef objRef)
```
  - DynamoAttributeValue
```
protected DynamoAttributeValue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
- Method Detail
  - booleanFromJsonPath
```
public static DynamoAttributeValue booleanFromJsonPath(java.lang.String value)
```
    Sets an attribute of type Boolean from state input through Json path.
    For example: "BOOL": true
    
    Parameters:
    
    value - Json path that specifies state input to be used. This parameter is required.
  - fromBinary
```
public static DynamoAttributeValue fromBinary(java.lang.String value)
```
    Sets an attribute of type Binary.
    For example: "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
    
    Parameters:
    
    value - base-64 encoded string. This parameter is required.
  - fromBinarySet
```
public static DynamoAttributeValue fromBinarySet(java.util.List<java.lang.String> value)
```
    Sets an attribute of type Binary Set.
    For example: "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]
    
    Parameters:
    
    value - This parameter is required.
  - fromBoolean
```
public static DynamoAttributeValue fromBoolean(java.lang.Boolean value)
```
    Sets an attribute of type Boolean.
    For example: "BOOL": true
    
    Parameters:
    
    value - This parameter is required.
  - fromList
```
public static DynamoAttributeValue fromList(java.util.List<? extends DynamoAttributeValue> value)
```
    Sets an attribute of type List.
    For example: "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]
    
    Parameters:
    
    value - This parameter is required.
  - fromMap
```
public static DynamoAttributeValue fromMap(java.util.Map<java.lang.String,? extends DynamoAttributeValue> value)
```
    Sets an attribute of type Map.
    For example: "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}
    
    Parameters:
    
    value - This parameter is required.
  - fromNull
```
public static DynamoAttributeValue fromNull(java.lang.Boolean value)
```
    Sets an attribute of type Null.
    For example: "NULL": true
    
    Parameters:
    
    value - This parameter is required.
  - fromNumber
```
public static DynamoAttributeValue fromNumber(java.lang.Number value)
```
    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 - This parameter is required.
  - fromNumberSet
```
public static DynamoAttributeValue fromNumberSet(java.util.List<? extends java.lang.Number> value)
```
    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 - This parameter is required.
  - fromString
```
public static DynamoAttributeValue fromString(java.lang.String value)
```
    Sets an attribute of type String.
    For example: "S": "Hello" Strings may be literal values or as JsonPath. Example values:
    - DynamoAttributeValue.fromString('someValue')
    - DynamoAttributeValue.fromString(JsonPath.stringAt('$.bar'))
    Parameters:
    
    value - This parameter is required.
  - fromStringSet
```
public static DynamoAttributeValue fromStringSet(java.util.List<java.lang.String> value)
```
    Sets an attribute of type String Set.
    For example: "SS": ["Giraffe", "Hippo" ,"Zebra"]
    
    Parameters:
    
    value - This parameter is required.
  - listFromJsonPath
```
public static DynamoAttributeValue listFromJsonPath(java.lang.String value)
```
    Sets an attribute of type List.
    For example: "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"S", "Veggies"}]
    
    Parameters:
    
    value - Json path that specifies state input to be used. This parameter is required.
  - mapFromJsonPath
```
public static DynamoAttributeValue mapFromJsonPath(java.lang.String value)
```
    Sets an attribute of type Map.
    For example: "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}
    
    Parameters:
    
    value - Json path that specifies state input to be used. This parameter is required.
  - numberFromString
```
public static DynamoAttributeValue numberFromString(java.lang.String value)
```
    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 JsonPath
    
    Parameters:
    
    value - This parameter is required.
  - numberSetFromStrings
```
public static DynamoAttributeValue numberSetFromStrings(java.util.List<java.lang.String> value)
```
    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 - This parameter is required.
  - toObject
```
public java.lang.Object toObject()
```
    Returns the DynamoDB attribute value.
  - getAttributeValue
```
public java.lang.Object getAttributeValue()
```
    Represents the data for the attribute.
    Data can be i.e. "S": "Hello"

Class DynamoAttributeValue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DynamoAttributeValue

DynamoAttributeValue

Method Detail

booleanFromJsonPath

fromBinary

fromBinarySet

fromBoolean

fromList

fromMap

fromNull

fromNumber

fromNumberSet

fromString

fromStringSet

listFromJsonPath

mapFromJsonPath

numberFromString

numberSetFromStrings

toObject

getAttributeValue