# DynamoUpdateItemJsonPathProps

Properties for DynamoUpdateItem Task using JSONPath.

Extends: DynamoUpdateItemJsonPathProps
Extends: TaskStateJsonPathBaseProps

- Source: [`aws-stepfunctions-tasks/lib/dynamodb/update-item.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/dynamodb/update-item.ts#L95)
- Type last changed: v2.234.0 · 8 Jan 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';
import { aws_dynamodb as interfaces_dynamodb } from 'aws-cdk-lib/interfaces';

declare const assign: any;
declare const dynamoAttributeValue: stepfunctions_tasks.DynamoAttributeValue;
declare const resultSelector: any;
declare const tableRef: interfaces_dynamodb.ITableRef;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const dynamoUpdateItemJsonPathProps: stepfunctions_tasks.DynamoUpdateItemJsonPathProps = {
  key: {
    keyKey: dynamoAttributeValue,
  },
  table: tableRef,

  // the properties below are optional
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  conditionExpression: 'conditionExpression',
  credentials: {
    role: taskRole,
  },
  expressionAttributeNames: {
    expressionAttributeNamesKey: 'expressionAttributeNames',
  },
  expressionAttributeValues: {
    expressionAttributeValuesKey: dynamoAttributeValue,
  },
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  inputPath: 'inputPath',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  outputPath: 'outputPath',
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  returnConsumedCapacity: stepfunctions_tasks.DynamoConsumedCapacity.INDEXES,
  returnItemCollectionMetrics: stepfunctions_tasks.DynamoItemCollectionMetrics.SIZE,
  returnValues: stepfunctions_tasks.DynamoReturnValues.NONE,
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
  updateExpression: 'updateExpression',
};
```

## Properties

- `assign`: { [key: string]: any } — Workflow variables to store in this step.

  **Default:** Not assign variables

  Using workflow variables, you can store data in a step and retrieve that data in future steps.

- `comment`: string — A comment describing this state.

  **Default:** No comment

- `conditionExpression`: string — A condition that must be satisfied in order for a conditional DeleteItem to succeed.

  **Default:** No condition expression

- `credentials`: [Credentials](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Credentials.html) — Credentials for an IAM Role that the State Machine assumes for executing the task.

  **Default:** None (Task is executed using the State Machine's execution role)

  This enables cross-account resource invocations.

- `expressionAttributeNames`: { [key: string]: string } — One or more substitution tokens for attribute names in an expression.

  **Default:** No expression attribute names

- `expressionAttributeValues`: { [key: string]: [DynamoAttributeValue](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue.html) } — One or more values that can be substituted in an expression.

  **Default:** No expression attribute values

- `heartbeat`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = None — use `heartbeatTimeout`

- `heartbeatTimeout`: [Timeout](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Timeout.html) = None — Timeout for the heartbeat.

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

- `inputPath`: string = $ — 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`: [IntegrationPattern](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.IntegrationPattern.html) — AWS Step Functions integrates with services directly in the Amazon States Language.

  **Default:** `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

  You can control these AWS services using service integration patterns.

  Depending on the AWS Service, the Service Integration Pattern availability will vary.

- `key`: { [key: string]: [DynamoAttributeValue](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.DynamoAttributeValue.html) } (required) — 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.

- `outputPath`: string = $ — JSONPath expression to select part of the state to be the output to this state.

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

- `queryLanguage`: [QueryLanguage](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.QueryLanguage.html) = JSONPath — The name of the query language used by the state.

  If the state does not contain a `queryLanguage` field,
  then it will use the query language specified in the top-level `queryLanguage` field.

- `resultPath`: string = $ — 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`: { [key: string]: any } = 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.

- `returnConsumedCapacity`: [DynamoConsumedCapacity](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.DynamoConsumedCapacity.html) = DynamoConsumedCapacity.NONE — Determines the level of detail about provisioned throughput consumption that is returned in the response.

- `returnItemCollectionMetrics`: [DynamoItemCollectionMetrics](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.DynamoItemCollectionMetrics.html) = 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`: [DynamoReturnValues](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.DynamoReturnValues.html) = DynamoReturnValues.NONE — Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.

- `stateName`: string — Optional name for this state.

  **Default:** The construct ID will be used as state name

- `table`: [ITableRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_dynamodb.ITableRef.html) (required) — The name of the table containing the requested item.

- `taskTimeout`: [Timeout](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Timeout.html) = None — Timeout for the task.

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

- `timeout`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = None — use `taskTimeout`

- `updateExpression`: string — 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