Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

2.181.1

interface DynamoPutItemJsonPathProps

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

Properties for DynamoPutItem Task using JSONPath.

Example

// 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_dynamodb as dynamodb } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const assign: any;
declare const dynamoAttributeValue: stepfunctions_tasks.DynamoAttributeValue;
declare const resultSelector: any;
declare const table: dynamodb.Table;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const dynamoPutItemJsonPathProps: stepfunctions_tasks.DynamoPutItemJsonPathProps = {
  item: {
    itemKey: dynamoAttributeValue,
  },
  table: table,

  // 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),
};

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 .
assign?{ [string]: any }Workflow variables to store in this step.
comment?stringA comment describing 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 part of the state to be the output to this state.
queryLanguage?QueryLanguageThe name of the query language used by the 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.
stateName?stringOptional name for this state.
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 .

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.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

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.

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

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.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html

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

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.

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

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.

← PreviousNext →