aws-cdk-lib.aws_stepfunctions_tasks.DynamoPutItemProps

interface DynamoPutItemProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.Tasks.DynamoPutItemProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#DynamoPutItemProps
Javasoftware.amazon.awscdk.services.stepfunctions.tasks.DynamoPutItemProps
Pythonaws_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

NameTypeDescription
item{ [string]: DynamoAttributeValue }A map of attribute name/value pairs, one for each attribute.
tableITableThe name of the table where the item should be written .
comment?stringAn optional description for this state.
conditionExpression?stringA condition that must be satisfied in order for a conditional PutItem operation 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?DynamoItemCollectionMetricsThe item collection metrics to returned in the response.
returnValues?DynamoReturnValuesUse ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.
taskTimeout?TimeoutTimeout for the task.
timeout?⚠️DurationTimeout 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.

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


table

Type: ITable

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


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 PutItem operation to succeed.

See also: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-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_PutItem.html#DDB-PutItem-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_PutItem.html#DDB-PutItem-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_PutItem.html#DDB-PutItem-request-ReturnConsumedCapacity


returnItemCollectionMetrics?

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

The item collection metrics to returned in the response.

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


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.

See also: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-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.