software.amazon.awscdk.services.stepfunctions.tasks

Class DynamoPutItem.Builder

java.lang.Object

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

Enclosing class:

DynamoPutItem

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

A fluent builder for DynamoPutItem.

Method Summary

Modifier and Type	Method and Description
DynamoPutItem	build()
DynamoPutItem.Builder	conditionExpression(String conditionExpression) A condition that must be satisfied in order for a conditional PutItem operation to succeed.
static DynamoPutItem.Builder	create() EXPERIMENTAL
DynamoPutItem.Builder	expressionAttributeNames(Map<String,String> expressionAttributeNames) One or more substitution tokens for attribute names in an expression.
DynamoPutItem.Builder	expressionAttributeValues(DynamoAttributeValueMap expressionAttributeValues) One or more values that can be substituted in an expression.
DynamoPutItem.Builder	item(DynamoAttributeValueMap item) A map of attribute name/value pairs, one for each attribute.
DynamoPutItem.Builder	returnConsumedCapacity(DynamoConsumedCapacity returnConsumedCapacity) Determines the level of detail about provisioned throughput consumption that is returned in the response.
DynamoPutItem.Builder	returnItemCollectionMetrics(DynamoItemCollectionMetrics returnItemCollectionMetrics) The item collection metrics to returned in the response.
DynamoPutItem.Builder	returnValues(DynamoReturnValues returnValues) Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.
DynamoPutItem.Builder	tableName(String tableName) The name of the table where the item should be writen .

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 DynamoPutItem.Builder create()

EXPERIMENTAL

Returns:

a new instance of DynamoPutItem.Builder.

item

@Stability(value=Experimental)
public DynamoPutItem.Builder item(DynamoAttributeValueMap item)

A map of attribute name/value pairs, one for each attribute.

Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

EXPERIMENTAL

Parameters:

item - A map of attribute name/value pairs, one for each attribute. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-Item

tableName

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

The name of the table where the item should be writen .

EXPERIMENTAL

Parameters:

tableName - The name of the table where the item should be writen . This parameter is required.

Returns:

this

conditionExpression

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

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

Default: - No condition expression

EXPERIMENTAL

Parameters:

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

Returns:

this

See Also:

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

expressionAttributeNames

@Stability(value=Experimental)
public DynamoPutItem.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_PutItem.html#DDB-PutItem-request-ExpressionAttributeNames

expressionAttributeValues

@Stability(value=Experimental)
public DynamoPutItem.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_PutItem.html#DDB-PutItem-request-ExpressionAttributeValues

returnConsumedCapacity

@Stability(value=Experimental)
public DynamoPutItem.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_PutItem.html#DDB-PutItem-request-ReturnConsumedCapacity

returnItemCollectionMetrics

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

The item collection metrics to returned in the response.

Default: DynamoItemCollectionMetrics.NONE

EXPERIMENTAL

Parameters:

returnItemCollectionMetrics - The item collection metrics to returned in the response. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LSI.html#LSI.ItemCollections

returnValues

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

Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.

Default: DynamoReturnValues.NONE

EXPERIMENTAL

Parameters:

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

Returns:

this

See Also:

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

build

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