aws-cdk-lib.aws_stepfunctions_tasks.DynamoUpdateItemProps

interface DynamoUpdateItemProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.Tasks.DynamoUpdateItemProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#DynamoUpdateItemProps
Javasoftware.amazon.awscdk.services.stepfunctions.tasks.DynamoUpdateItemProps
Pythonaws_cdk.aws_stepfunctions_tasks.DynamoUpdateItemProps
TypeScript (source)aws-cdk-lib » aws_stepfunctions_tasks » DynamoUpdateItemProps

Properties for DynamoUpdateItem Task.

Example

declare const myTable: dynamodb.Table;
new tasks.DynamoUpdateItem(this, 'UpdateItem', {
  key: {
    MessageId: tasks.DynamoAttributeValue.fromString('message-007')
  },
  table: myTable,
  expressionAttributeValues: {
    ':val': tasks.DynamoAttributeValue.numberFromString(sfn.JsonPath.stringAt('$.Item.TotalCount.N')),
    ':rand': tasks.DynamoAttributeValue.fromNumber(20),
  },
  updateExpression: 'SET TotalCount = :val + :rand',
});

Properties

NameTypeDescription
key{ [string]: DynamoAttributeValue }Primary key of the item to retrieve.
tableITableThe name of the table containing the requested item.
comment?stringAn optional description for this state.
conditionExpression?stringA condition that must be satisfied in order for a conditional DeleteItem to succeed.
credentials?CredentialsCredentials for an IAM Role that the State Machine assumes for executing the task.
expressionAttributeNames?{ [string]: string }One or more substitution tokens for attribute names in an expression.
expressionAttributeValues?{ [string]: DynamoAttributeValue }One or more values that can be substituted in an expression.
heartbeat?⚠️DurationTimeout for the heartbeat.
heartbeatTimeout?TimeoutTimeout for the heartbeat.
inputPath?stringJSONPath expression to select part of the state to be the input to this state.
integrationPattern?IntegrationPatternAWS Step Functions integrates with services directly in the Amazon States Language.
outputPath?stringJSONPath expression to select select a portion of the state output to pass to the next state.
resultPath?stringJSONPath expression to indicate where to inject the state's output.
resultSelector?{ [string]: any }The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
returnConsumedCapacity?DynamoConsumedCapacityDetermines the level of detail about provisioned throughput consumption that is returned in the response.
returnItemCollectionMetrics?DynamoItemCollectionMetricsDetermines whether item collection metrics are returned.
returnValues?DynamoReturnValuesUse ReturnValues if you want to get the item attributes as they appeared before they were deleted.
taskTimeout?TimeoutTimeout for the task.
timeout?⚠️DurationTimeout for the task.
updateExpression?stringAn expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

key

Type: { [string]: DynamoAttributeValue }

Primary key of the item to retrieve.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

See also: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-Key


table

Type: ITable

The name of the table containing the requested item.


comment?

Type: string (optional, default: No comment)

An optional description for this state.


conditionExpression?

Type: string (optional, default: No condition expression)

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

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


credentials?

Type: Credentials (optional, default: None (Task is executed using the State Machine's execution role))

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html


expressionAttributeNames?

Type: { [string]: string } (optional, default: No expression attribute names)

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

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


expressionAttributeValues?

Type: { [string]: DynamoAttributeValue } (optional, default: No expression attribute values)

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

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


heartbeat?⚠️

⚠️ Deprecated: use heartbeatTimeout

Type: Duration (optional, default: None)

Timeout for the heartbeat.


heartbeatTimeout?

Type: Timeout (optional, default: None)

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface


inputPath?

Type: string (optional, default: The entire task input (JSON path '$'))

JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.


integrationPattern?

Type: IntegrationPattern (optional, default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.)

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token


outputPath?

Type: string (optional, default: The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$'))

JSONPath expression to select select a portion of the state output to pass to the next state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.


resultPath?

Type: string (optional, default: Replaces the entire input with the result (JSON path '$'))

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.


resultSelector?

Type: { [string]: any } (optional, default: None)

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector


returnConsumedCapacity?

Type: DynamoConsumedCapacity (optional, default: DynamoConsumedCapacity.NONE)

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

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


returnItemCollectionMetrics?

Type: DynamoItemCollectionMetrics (optional, default: DynamoItemCollectionMetrics.NONE)

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.


returnValues?

Type: DynamoReturnValues (optional, default: DynamoReturnValues.NONE)

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

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


taskTimeout?

Type: Timeout (optional, default: None)

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface


timeout?⚠️

⚠️ Deprecated: use taskTimeout

Type: Duration (optional, default: None)

Timeout for the task.


updateExpression?

Type: string (optional, default: No update expression)

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

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