# DynamoPutItemProps

Properties for DynamoPutItem Task.

Extends: DynamoPutItemProps
Extends: TaskStateBaseProps
Used as props by: DynamoPutItem

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

## Example

```ts
declare const myTable: dynamodb.Table;
new tasks.DynamoPutItem(this, 'PutItem', {
  item: {
    MessageId: tasks.DynamoAttributeValue.fromString('message-007'),
    Text: tasks.DynamoAttributeValue.fromString(sfn.JsonPath.stringAt('$.bar')),
    TotalCount: tasks.DynamoAttributeValue.fromNumber(10),
  },
  table: myTable,
});
```

## 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 PutItem operation 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.

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

- `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 {}.

- `outputs`: any — Used to specify and transform output from the state.

  **Default:** $states.result or $states.errorOutput

  When specified, the value overrides the state output default.
  The output field accepts any JSON value (object, array, string, number, boolean, null).
  Any string value, including those inside objects or arrays,
  will be evaluated as JSONata if surrounded by {% %} characters.
  Output also accepts a JSONata expression directly.

- `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 — The item collection metrics to returned in the response.

- `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 updated with the PutItem request.

- `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 where the item should be written .

- `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`