software.amazon.awscdk.services.stepfunctions.tasks

Class DynamoUpdateItem.Builder

java.lang.Object

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

Enclosing class:

DynamoUpdateItem

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

A fluent builder for DynamoUpdateItem.

Method Summary

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

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

Method Detail

create

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

EXPERIMENTAL

Returns:

a new instance of DynamoUpdateItem.Builder.

partitionKey

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

The partition key of the item to be updated.

EXPERIMENTAL

Parameters:

partitionKey - The partition key of the item to be updated. This parameter is required.

Returns:

this

See Also:

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

tableName

@Stability(value=Experimental)
public DynamoUpdateItem.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 DynamoUpdateItem.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_UpdateItem.html#DDB-UpdateItem-request-ConditionExpression

expressionAttributeNames

@Stability(value=Experimental)
public DynamoUpdateItem.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_UpdateItem.html#DDB-UpdateItem-request-ExpressionAttributeNames

expressionAttributeValues

@Stability(value=Experimental)
public DynamoUpdateItem.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_UpdateItem.html#DDB-UpdateItem-request-ExpressionAttributeValues

returnConsumedCapacity

@Stability(value=Experimental)
public DynamoUpdateItem.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_UpdateItem.html#DDB-UpdateItem-request-ReturnConsumedCapacity

returnItemCollectionMetrics

@Stability(value=Experimental)
public DynamoUpdateItem.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 DynamoUpdateItem.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_UpdateItem.html#DDB-UpdateItem-request-ReturnValues

sortKey

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

The sort key of the item to be updated.

Default: - No sort key

EXPERIMENTAL

Parameters:

sortKey - The sort key of the item to be updated. This parameter is required.

Returns:

this

See Also:

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

updateExpression

@Stability(value=Experimental)
public DynamoUpdateItem.Builder updateExpression(String updateExpression)

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

EXPERIMENTAL

Parameters:

updateExpression - An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them. This parameter is required.

Returns:

this

See Also:

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

build

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