software.amazon.awscdk.services.stepfunctions.tasks

Interface DynamoGetItemProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DynamoGetItemProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.5.0 (build 46538f8)",
           date="2020-05-21T11:02:02.743Z")
 @Stability(value=Experimental)
public interface DynamoGetItemProps
extends software.amazon.jsii.JsiiSerializable

Properties for DynamoGetItem Task.

EXPERIMENTAL

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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.
DynamoAttribute	getPartitionKey() A attribute representing the partition 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.
default DynamoAttribute	getSortKey() A attribute representing the sort key of the item to retrieve.
String	getTableName() The name of the table containing the requested item.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPartitionKey

@Stability(value=Experimental)
 @NotNull
DynamoAttribute getPartitionKey()

A attribute representing the partition key of the item to retrieve.

EXPERIMENTAL

See Also:

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

getTableName

@Stability(value=Experimental)
 @NotNull
String getTableName()

The name of the table containing the requested item.

EXPERIMENTAL

getConsistentRead

@Stability(value=Experimental)
 @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

EXPERIMENTAL

getExpressionAttributeNames

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getExpressionAttributeNames()

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

Default: - No expression attributes

EXPERIMENTAL

See Also:

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

getProjectionExpression

@Stability(value=Experimental)
 @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

EXPERIMENTAL

See Also:

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

getReturnConsumedCapacity

@Stability(value=Experimental)
 @Nullable
default DynamoConsumedCapacity getReturnConsumedCapacity()

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

Default: DynamoConsumedCapacity.NONE

EXPERIMENTAL

See Also:

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

getSortKey

@Stability(value=Experimental)
 @Nullable
default DynamoAttribute getSortKey()

A attribute representing the sort key of the item to retrieve.

Default: - No sort key

EXPERIMENTAL

See Also:

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

builder

@Stability(value=Experimental)
static DynamoGetItemProps.Builder builder()

Returns:

a DynamoGetItemProps.Builder of DynamoGetItemProps