interface DynamoPutItemProps

Language	Type name
.NET	`Amazon.CDK.AWS.StepFunctions.Tasks.DynamoPutItemProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#DynamoPutItemProps`
Java	`software.amazon.awscdk.services.stepfunctions.tasks.DynamoPutItemProps`
Python	`aws_cdk.aws_stepfunctions_tasks.DynamoPutItemProps`
TypeScript (source)	`aws-cdk-lib` » `aws_stepfunctions_tasks` » `DynamoPutItemProps`

Properties for DynamoPutItem Task.

Example

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

Name	Type	Description
item	`{ [string]:` `DynamoAttributeValue` `}`	A map of attribute name/value pairs, one for each attribute.
table	`ITable`	The name of the table where the item should be written .
assign?	`{ [string]: any }`	Workflow variables to store in this step.
comment?	`string`	A comment describing this state.
conditionExpression?	`string`	A condition that must be satisfied in order for a conditional PutItem operation to succeed.
credentials?	`Credentials`	Credentials 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?⚠️	`Duration`	Timeout for the heartbeat.
heartbeatTimeout?	`Timeout`	Timeout for the heartbeat.
inputPath?	`string`	JSONPath expression to select part of the state to be the input to this state.
integrationPattern?	`IntegrationPattern`	AWS Step Functions integrates with services directly in the Amazon States Language.
outputPath?	`string`	JSONPath expression to select part of the state to be the output to this state.
outputs?	`any`	Used to specify and transform output from the state.
queryLanguage?	`QueryLanguage`	The name of the query language used by the state.
resultPath?	`string`	JSONPath 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?	`DynamoConsumedCapacity`	Determines the level of detail about provisioned throughput consumption that is returned in the response.
returnItemCollectionMetrics?	`DynamoItemCollectionMetrics`	The item collection metrics to returned in the response.
returnValues?	`DynamoReturnValues`	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.
taskTimeout?	`Timeout`	Timeout for the task.
timeout?⚠️	`Duration`	Timeout for the task.

item

Type: { [string]: DynamoAttributeValue }

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.

table

Type: ITable

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

assign?

Type: { [string]: any } (optional, default: Not assign variables)

Workflow variables to store in this step.

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

comment?

Type: string (optional, default: No comment)

A comment describing this state.

conditionExpression?

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

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

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.

expressionAttributeNames?

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

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

expressionAttributeValues?

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

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

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: $)

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.

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

outputPath?

Type: string (optional, default: $)

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?

Type: any (optional, default: $states.result or $states.errorOutput)

Used to specify and transform output from the state.

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?

Type: QueryLanguage (optional, default: 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?

Type: string (optional, default: $)

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.

returnConsumedCapacity?

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

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

returnItemCollectionMetrics?

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

The item collection metrics to returned in the response.

returnValues?

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

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

stateName?

Type: string (optional, default: The construct ID will be used as state name)

Optional name for this state.

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.