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

Interface DynamoUpdateItemProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

DynamoUpdateItemProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:25:08.071Z")
@Stability(Stable)
public interface DynamoUpdateItemProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for DynamoUpdateItem Task.

Example:

 Table myTable;
 DynamoUpdateItem.Builder.create(this, "UpdateItem")
         .key(Map.of(
                 "MessageId", DynamoAttributeValue.fromString("message-007")))
         .table(myTable)
         .expressionAttributeValues(Map.of(
                 ":val", DynamoAttributeValue.numberFromString(JsonPath.stringAt("$.Item.TotalCount.N")),
                 ":rand", DynamoAttributeValue.fromNumber(20)))
         .updateExpression("SET TotalCount = :val + :rand")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DynamoUpdateItemProps.Builder	builder()
default String	getConditionExpression()	A condition that must be satisfied in order for a conditional DeleteItem to succeed.
default Map<String,String>	getExpressionAttributeNames()	One or more substitution tokens for attribute names in an expression.
default Map<String,DynamoAttributeValue>	getExpressionAttributeValues()	One or more values that can be substituted in an expression.
Map<String,DynamoAttributeValue>	getKey()	Primary key of the item to retrieve.
default DynamoConsumedCapacity	getReturnConsumedCapacity()	Determines the level of detail about provisioned throughput consumption that is returned in the response.
default DynamoItemCollectionMetrics	getReturnItemCollectionMetrics()	Determines whether item collection metrics are returned.
default DynamoReturnValues	getReturnValues()	Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
ITable	getTable()	The name of the table containing the requested item.
default String	getUpdateExpression()	An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

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.

getConditionExpression

@Stability(Stable)
@Nullable
default String getConditionExpression()

A condition that must be satisfied in order for a conditional DeleteItem to succeed.

Default: - No condition expression

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html#DDB-UpdateItem-request-ConditionExpression

getExpressionAttributeNames

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

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

Default: - No expression attribute names

See Also:

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

getExpressionAttributeValues

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

One or more values that can be substituted in an expression.

Default: - No expression attribute values

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html#DDB-UpdateItem-request-ExpressionAttributeValues

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_UpdateItem.html#DDB-UpdateItem-request-ReturnConsumedCapacity

getReturnItemCollectionMetrics

@Stability(Stable)
@Nullable
default DynamoItemCollectionMetrics getReturnItemCollectionMetrics()

Determines whether item collection metrics are returned.

If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Default: DynamoItemCollectionMetrics.NONE

getReturnValues

@Stability(Stable)
@Nullable
default DynamoReturnValues getReturnValues()

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.

Default: DynamoReturnValues.NONE

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html#DDB-UpdateItem-request-ReturnValues

getUpdateExpression

@Stability(Stable)
@Nullable
default String getUpdateExpression()

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

Default: - No update expression

See Also:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html#DDB-UpdateItem-request-UpdateExpression

builder

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

Returns:

a DynamoUpdateItemProps.Builder of DynamoUpdateItemProps