Package software.amazon.awscdk.services.stepfunctions.tasks

Interface DynamoPutItemProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

DynamoPutItemProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:25.420Z")
@Stability(Stable)
public interface DynamoPutItemProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for DynamoPutItem Task.

Example:

 Table myTable;
 DynamoPutItem.Builder.create(this, "PutItem")
         .item(Map.of(
                 "MessageId", DynamoAttributeValue.fromString("message-007"),
                 "Text", DynamoAttributeValue.fromString(JsonPath.stringAt("$.bar")),
                 "TotalCount", DynamoAttributeValue.fromNumber(10)))
         .table(myTable)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DynamoPutItemProps.Builder	builder()
default String	getConditionExpression()	A condition that must be satisfied in order for a conditional PutItem operation to succeed.
default Map<String,String>	getExpressionAttributeNames()	One or more substitution tokens for attribute names in an expression.
default Map<String,DynamoAttributeValue>	getExpressionAttributeValues()	One or more values that can be substituted in an expression.
Map<String,DynamoAttributeValue>	getItem()	A map of attribute name/value pairs, one for each attribute.
default DynamoConsumedCapacity	getReturnConsumedCapacity()	Determines the level of detail about provisioned throughput consumption that is returned in the response.
default DynamoItemCollectionMetrics	getReturnItemCollectionMetrics()	The item collection metrics to returned in the response.
default DynamoReturnValues	getReturnValues()	Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.
ITable	getTable()	The name of the table where the item should be written .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getCredentials, getHeartbeat, getHeartbeatTimeout, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getStateName, getTaskTimeout, getTimeout

Method Details

getItem

@Stability(Stable)
@NotNull
Map<String,DynamoAttributeValue> getItem()

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.

See Also:

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

getTable

@Stability(Stable)
@NotNull
ITable getTable()

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

getConditionExpression

@Stability(Stable)
@Nullable
default String getConditionExpression()

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

Default: - No condition expression

See Also:

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

getExpressionAttributeNames

@Stability(Stable)
@Nullable
default Map<String,String> getExpressionAttributeNames()

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

Default: - No expression attribute names

See Also:

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

getExpressionAttributeValues

@Stability(Stable)
@Nullable
default Map<String,DynamoAttributeValue> getExpressionAttributeValues()

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

Default: - No expression attribute values

See Also:

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

getReturnConsumedCapacity

@Stability(Stable)
@Nullable
default DynamoConsumedCapacity getReturnConsumedCapacity()

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

Default: DynamoConsumedCapacity.NONE

See Also:

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

getReturnItemCollectionMetrics

@Stability(Stable)
@Nullable
default DynamoItemCollectionMetrics getReturnItemCollectionMetrics()

The item collection metrics to returned in the response.

Default: DynamoItemCollectionMetrics.NONE

See Also:

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

getReturnValues

@Stability(Stable)
@Nullable
default DynamoReturnValues getReturnValues()

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

Default: DynamoReturnValues.NONE

See Also:

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

builder

@Stability(Stable)
static DynamoPutItemProps.Builder builder()

Returns:

a DynamoPutItemProps.Builder of DynamoPutItemProps