software.amazon.awscdk.services.stepfunctions.tasks

Interface DynamoDeleteItemProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DynamoDeleteItemProps.Jsii$Proxy

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

Properties for DynamoDeleteItem Task.

EXPERIMENTAL

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DynamoDeleteItemProps.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 DynamoAttributeValueMap	getExpressionAttributeValues() One or more values that can be substituted in an expression.
DynamoAttribute	getPartitionKey() An attribute representing the partition key of the item to delete.
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.
default DynamoAttribute	getSortKey() An attribute representing the sort key of the item to delete.
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()

An attribute representing the partition key of the item to delete.

EXPERIMENTAL

See Also:

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

getTableName

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

The name of the table containing the requested item.

EXPERIMENTAL

getConditionExpression

@Stability(value=Experimental)
 @Nullable
default String getConditionExpression()

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

Default: - No condition expression

EXPERIMENTAL

See Also:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html#DDB-DeleteItem-request-ConditionExpression

getExpressionAttributeNames

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

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

Default: - No expression attribute names

EXPERIMENTAL

See Also:

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

getExpressionAttributeValues

@Stability(value=Experimental)
 @Nullable
default DynamoAttributeValueMap getExpressionAttributeValues()

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

Default: - No expression attribute values

EXPERIMENTAL

See Also:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html#DDB-DeleteItem-request-ExpressionAttributeValues

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_DeleteItem.html#DDB-DeleteItem-request-ReturnConsumedCapacity

getReturnItemCollectionMetrics

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

EXPERIMENTAL

getReturnValues

@Stability(value=Experimental)
 @Nullable
default DynamoReturnValues getReturnValues()

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

Default: DynamoReturnValues.NONE

EXPERIMENTAL

See Also:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html#DDB-DeleteItem-request-ReturnValues

getSortKey

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

An attribute representing the sort key of the item to delete.

Default: - No sort key

EXPERIMENTAL

See Also:

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

builder

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

Returns:

a DynamoDeleteItemProps.Builder of DynamoDeleteItemProps