software.amazon.awscdk.services.stepfunctions.tasks

Class DynamoDeleteItem.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.DynamoDeleteItem.Builder

Enclosing class:

DynamoDeleteItem

@Stability(value=Experimental)
public static final class DynamoDeleteItem.Builder
extends Object

A fluent builder for DynamoDeleteItem.

Method Summary

Modifier and Type	Method and Description
DynamoDeleteItem	build()
DynamoDeleteItem.Builder	conditionExpression(String conditionExpression) A condition that must be satisfied in order for a conditional DeleteItem to succeed.
static DynamoDeleteItem.Builder	create() EXPERIMENTAL
DynamoDeleteItem.Builder	expressionAttributeNames(Map<String,String> expressionAttributeNames) One or more substitution tokens for attribute names in an expression.
DynamoDeleteItem.Builder	expressionAttributeValues(DynamoAttributeValueMap expressionAttributeValues) One or more values that can be substituted in an expression.
DynamoDeleteItem.Builder	partitionKey(DynamoAttribute partitionKey) An attribute representing the partition key of the item to delete.
DynamoDeleteItem.Builder	returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity) Determines the level of detail about provisioned throughput consumption that is returned in the response.
DynamoDeleteItem.Builder	returnItemCollectionMetrics(DynamoItemCollectionMetrics returnItemCollectionMetrics) Determines whether item collection metrics are returned.
DynamoDeleteItem.Builder	returnValues(DynamoReturnValues returnValues) Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
DynamoDeleteItem.Builder	sortKey(DynamoAttribute sortKey) An attribute representing the sort key of the item to delete.
DynamoDeleteItem.Builder	tableName(String tableName) The name of the table containing the requested item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static DynamoDeleteItem.Builder create()

EXPERIMENTAL

Returns:

a new instance of DynamoDeleteItem.Builder.

partitionKey

@Stability(value=Experimental)
public DynamoDeleteItem.Builder partitionKey(DynamoAttribute partitionKey)

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

EXPERIMENTAL

Parameters:

partitionKey - An attribute representing the partition key of the item to delete. This parameter is required.

Returns:

this

See Also:

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

tableName

@Stability(value=Experimental)
public DynamoDeleteItem.Builder tableName(String tableName)

The name of the table containing the requested item.

EXPERIMENTAL

Parameters:

tableName - The name of the table containing the requested item. This parameter is required.

Returns:

this

conditionExpression

@Stability(value=Experimental)
public DynamoDeleteItem.Builder conditionExpression(String conditionExpression)

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

Default: - No condition expression

EXPERIMENTAL

Parameters:

conditionExpression - A condition that must be satisfied in order for a conditional DeleteItem to succeed. This parameter is required.

Returns:

this

See Also:

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

expressionAttributeNames

@Stability(value=Experimental)
public DynamoDeleteItem.Builder expressionAttributeNames(Map<String,String> expressionAttributeNames)

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

Default: - No expression attribute names

EXPERIMENTAL

Parameters:

expressionAttributeNames - One or more substitution tokens for attribute names in an expression. This parameter is required.

Returns:

this

See Also:

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

expressionAttributeValues

@Stability(value=Experimental)
public DynamoDeleteItem.Builder expressionAttributeValues(DynamoAttributeValueMap expressionAttributeValues)

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

Default: - No expression attribute values

EXPERIMENTAL

Parameters:

expressionAttributeValues - One or more values that can be substituted in an expression. This parameter is required.

Returns:

this

See Also:

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

returnConsumedCapacity

@Stability(value=Experimental)
public DynamoDeleteItem.Builder returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity)

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

Default: DynamoConsumedCapacity.NONE

EXPERIMENTAL

Parameters:

returnConsumedCapacity - Determines the level of detail about provisioned throughput consumption that is returned in the response. This parameter is required.

Returns:

this

See Also:

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

returnItemCollectionMetrics

@Stability(value=Experimental)
public DynamoDeleteItem.Builder returnItemCollectionMetrics(DynamoItemCollectionMetrics returnItemCollectionMetrics)

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

Parameters:

returnItemCollectionMetrics - Determines whether item collection metrics are returned. This parameter is required.

Returns:

this

returnValues

@Stability(value=Experimental)
public DynamoDeleteItem.Builder returnValues(DynamoReturnValues returnValues)

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

Default: DynamoReturnValues.NONE

EXPERIMENTAL

Parameters:

returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. This parameter is required.

Returns:

this

See Also:

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

sortKey

@Stability(value=Experimental)
public DynamoDeleteItem.Builder sortKey(DynamoAttribute sortKey)

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

Default: - No sort key

EXPERIMENTAL

Parameters:

sortKey - An attribute representing the sort key of the item to delete. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(value=Experimental)
public DynamoDeleteItem build()