Interface DynamoGetItemProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
,TaskStateBaseProps
- All Known Implementing Classes:
DynamoGetItemProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:47.941Z")
@Stability(Stable)
public interface DynamoGetItemProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps
Properties for DynamoGetItem Task.
Example:
Table myTable; DynamoGetItem.Builder.create(this, "Get Item") .key(Map.of("messageId", DynamoAttributeValue.fromString("message-007"))) .table(myTable) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forDynamoGetItemProps
static final class
An implementation forDynamoGetItemProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic DynamoGetItemProps.Builder
builder()
default Boolean
Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;One or more substitution tokens for attribute names in an expression.getKey()
Primary key of the item to retrieve.default List<DynamoProjectionExpression>
An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table.default DynamoConsumedCapacity
Determines the level of detail about provisioned throughput consumption that is returned in the response.getTable()
The name of the table containing the requested item.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps
getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout
-
Method Details
-
getKey
Primary key of the item to retrieve.For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
-
getTable
The name of the table containing the requested item. -
getConsistentRead
Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;otherwise, the operation uses eventually consistent reads.
Default: false
-
getExpressionAttributeNames
One or more substitution tokens for attribute names in an expression.Default: - No expression attributes
-
getProjectionExpression
An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table.These attributes can include scalars, sets, or elements of a JSON document.
Default: - No projection expression
-
getReturnConsumedCapacity
Determines the level of detail about provisioned throughput consumption that is returned in the response.Default: DynamoConsumedCapacity.NONE
-
builder
- Returns:
- a
DynamoGetItemProps.Builder
ofDynamoGetItemProps
-