Package software.amazon.awscdk.services.stepfunctions.tasks

Interface DynamoGetItemProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

DynamoGetItemProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:10.287Z")
@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

Nested Classes

Modifier and Type	Interface	Description
static final class	DynamoGetItemProps.Builder	A builder for DynamoGetItemProps
static final class	DynamoGetItemProps.Jsii$Proxy	An implementation for DynamoGetItemProps

Method Summary

Modifier and Type	Method	Description
static DynamoGetItemProps.Builder	builder()
default Boolean	getConsistentRead()	Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;
default Map<String,String>	getExpressionAttributeNames()	One or more substitution tokens for attribute names in an expression.
Map<String,DynamoAttributeValue>	getKey()	Primary key of the item to retrieve.
default List<DynamoProjectionExpression>	getProjectionExpression()	An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table.
default DynamoConsumedCapacity	getReturnConsumedCapacity()	Determines the level of detail about provisioned throughput consumption that is returned in the response.
ITable	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, getCredentials, getHeartbeat, getHeartbeatTimeout, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getStateName, getTaskTimeout, getTimeout

Method Details

getKey

@Stability(Stable)
@NotNull
Map<String,DynamoAttributeValue> 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.

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-Key

getTable

@Stability(Stable)
@NotNull
ITable getTable()

The name of the table containing the requested item.

getConsistentRead

@Stability(Stable)
@Nullable
default Boolean 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

@Stability(Stable)
@Nullable
default Map<String,String> getExpressionAttributeNames()

One or more substitution tokens for attribute names in an expression.

Default: - No expression attributes

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-ExpressionAttributeNames

getProjectionExpression

@Stability(Stable)
@Nullable
default List<DynamoProjectionExpression> 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

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-ProjectionExpression

getReturnConsumedCapacity

@Stability(Stable)
@Nullable
default DynamoConsumedCapacity getReturnConsumedCapacity()

Determines the level of detail about provisioned throughput consumption that is returned in the response.

Default: DynamoConsumedCapacity.NONE

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-ReturnConsumedCapacity

builder

@Stability(Stable)
static DynamoGetItemProps.Builder builder()

Returns:

a DynamoGetItemProps.Builder of DynamoGetItemProps