@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:50.184Z") public interface DynamoDeleteItemProps extends TaskStateBaseProps
Example:
Table myTable; DynamoDeleteItem.Builder.create(this, "DeleteItem") .key(Map.of("MessageId", DynamoAttributeValue.fromString("message-007"))) .table(myTable) .resultPath(JsonPath.DISCARD) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
DynamoDeleteItemProps.Builder
A builder for
DynamoDeleteItemProps |
static class |
DynamoDeleteItemProps.Jsii$Proxy
An implementation for
DynamoDeleteItemProps |
Modifier and Type | Method and Description |
---|---|
static DynamoDeleteItemProps.Builder |
builder() |
default java.lang.String |
getConditionExpression()
A condition that must be satisfied in order for a conditional DeleteItem to succeed.
|
default java.util.Map<java.lang.String,java.lang.String> |
getExpressionAttributeNames()
One or more substitution tokens for attribute names in an expression.
|
default java.util.Map<java.lang.String,DynamoAttributeValue> |
getExpressionAttributeValues()
One or more values that can be substituted in an expression.
|
java.util.Map<java.lang.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.
|
getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout
java.util.Map<java.lang.String,DynamoAttributeValue> getKey()
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.
ITable getTable()
default java.lang.String getConditionExpression()
Default: - No condition expression
default java.util.Map<java.lang.String,java.lang.String> getExpressionAttributeNames()
Default: - No expression attribute names
default java.util.Map<java.lang.String,DynamoAttributeValue> getExpressionAttributeValues()
Default: - No expression attribute values
default DynamoConsumedCapacity getReturnConsumedCapacity()
Default: DynamoConsumedCapacity.NONE
default DynamoItemCollectionMetrics getReturnItemCollectionMetrics()
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
default DynamoReturnValues getReturnValues()
Default: DynamoReturnValues.NONE
static DynamoDeleteItemProps.Builder builder()
builder
in interface TaskStateBaseProps
DynamoDeleteItemProps.Builder
of DynamoDeleteItemProps