interface DynamoDeleteItemProps

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

Properties for DynamoDeleteItem Task.

Example

declare const myTable: dynamodb.Table;
new tasks.DynamoDeleteItem(this, 'DeleteItem', {
  key: { MessageId: tasks.DynamoAttributeValue.fromString('message-007') },
  table: myTable,
  resultPath: sfn.JsonPath.DISCARD,
});

Properties

Name	Type	Description
key	{ [string]: DynamoAttributeValue }	Primary key of the item to retrieve.
table	ITable	The name of the table containing the requested item.
comment?	string	An optional description for this state.
conditionExpression?	string	A condition that must be satisfied in order for a conditional DeleteItem 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 select a portion of the state output to pass to the next 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	Determines whether item collection metrics are returned.
returnValues?	DynamoReturnValues	Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
stateName?	string	Optional name for this state.
taskTimeout?	Timeout	Timeout for the task.
timeout?⚠️	Duration	Timeout for the task.

---

key

Type: { [string]: DynamoAttributeValue }

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.

See also: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-Key

---

table

Type: ITable

The name of the table containing the requested item.

---

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 DeleteItem to succeed.

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

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: 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_DeleteItem.html#DDB-DeleteItem-request-ReturnConsumedCapacity

---

returnItemCollectionMetrics?

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

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

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.

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