Skip to content
v2.277.0

DynamoDeleteItemJsonataProps Struct ​

Properties for DynamoDeleteItem Task using JSONata.

Example ​

ts
// 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_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';
import { aws_dynamodb as interfaces_dynamodb } from 'aws-cdk-lib/interfaces';

declare const assign: any;
declare const dynamoAttributeValue: stepfunctions_tasks.DynamoAttributeValue;
declare const outputs: any;
declare const tableRef: interfaces_dynamodb.ITableRef;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const dynamoDeleteItemJsonataProps: stepfunctions_tasks.DynamoDeleteItemJsonataProps = {
  key: {
    keyKey: dynamoAttributeValue,
  },
  table: tableRef,

  // 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,
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  outputs: outputs,
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  returnConsumedCapacity: stepfunctions_tasks.DynamoConsumedCapacity.INDEXES,
  returnItemCollectionMetrics: stepfunctions_tasks.DynamoItemCollectionMetrics.SIZE,
  returnValues: stepfunctions_tasks.DynamoReturnValues.NONE,
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks
from aws_cdk.interfaces import aws_dynamodb as interfaces_dynamodb

# assign: Any
# dynamo_attribute_value: stepfunctions_tasks.DynamoAttributeValue
# outputs: Any
# table_ref: interfaces_dynamodb.ITableRef
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout

dynamo_delete_item_jsonata_props = stepfunctions_tasks.DynamoDeleteItemJsonataProps(
    key={
        "key_key": dynamo_attribute_value
    },
    table=table_ref,

    # the properties below are optional
    assign={
        "assign_key": assign
    },
    comment="comment",
    condition_expression="conditionExpression",
    credentials=stepfunctions.Credentials(
        role=task_role
    ),
    expression_attribute_names={
        "expression_attribute_names_key": "expressionAttributeNames"
    },
    expression_attribute_values={
        "expression_attribute_values_key": dynamo_attribute_value
    },
    heartbeat=cdk.Duration.minutes(30),
    heartbeat_timeout=timeout,
    integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
    outputs=outputs,
    query_language=stepfunctions.QueryLanguage.JSON_PATH,
    return_consumed_capacity=stepfunctions_tasks.DynamoConsumedCapacity.INDEXES,
    return_item_collection_metrics=stepfunctions_tasks.DynamoItemCollectionMetrics.SIZE,
    return_values=stepfunctions_tasks.DynamoReturnValues.NONE,
    state_name="stateName",
    task_timeout=timeout,
    timeout=cdk.Duration.minutes(30)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awscdk.services.stepfunctions.tasks.*;
import software.amazon.awscdk.interfaces.dynamodb.*;

Object assign;
DynamoAttributeValue dynamoAttributeValue;
Object outputs;
ITableRef tableRef;
TaskRole taskRole;
Timeout timeout;

DynamoDeleteItemJsonataProps dynamoDeleteItemJsonataProps = DynamoDeleteItemJsonataProps.builder()
        .key(Map.of(
                "keyKey", dynamoAttributeValue))
        .table(tableRef)

        // the properties below are optional
        .assign(Map.of(
                "assignKey", assign))
        .comment("comment")
        .conditionExpression("conditionExpression")
        .credentials(Credentials.builder()
                .role(taskRole)
                .build())
        .expressionAttributeNames(Map.of(
                "expressionAttributeNamesKey", "expressionAttributeNames"))
        .expressionAttributeValues(Map.of(
                "expressionAttributeValuesKey", dynamoAttributeValue))
        .heartbeat(Duration.minutes(30))
        .heartbeatTimeout(timeout)
        .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
        .outputs(outputs)
        .queryLanguage(QueryLanguage.JSON_PATH)
        .returnConsumedCapacity(DynamoConsumedCapacity.INDEXES)
        .returnItemCollectionMetrics(DynamoItemCollectionMetrics.SIZE)
        .returnValues(DynamoReturnValues.NONE)
        .stateName("stateName")
        .taskTimeout(timeout)
        .timeout(Duration.minutes(30))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
using Amazon.CDK.Interfaces.DynamoDB;

var assign;
DynamoAttributeValue dynamoAttributeValue;
var outputs;
ITableRef tableRef;
TaskRole taskRole;
Timeout timeout;

var dynamoDeleteItemJsonataProps = new DynamoDeleteItemJsonataProps {
    Key = new Dictionary<string, DynamoAttributeValue> {
        { "keyKey", dynamoAttributeValue }
    },
    Table = tableRef,

    // the properties below are optional
    Assign = new Dictionary<string, object> {
        { "assignKey", assign }
    },
    Comment = "comment",
    ConditionExpression = "conditionExpression",
    Credentials = new Credentials {
        Role = taskRole
    },
    ExpressionAttributeNames = new Dictionary<string, string> {
        { "expressionAttributeNamesKey", "expressionAttributeNames" }
    },
    ExpressionAttributeValues = new Dictionary<string, DynamoAttributeValue> {
        { "expressionAttributeValuesKey", dynamoAttributeValue }
    },
    Heartbeat = Duration.Minutes(30),
    HeartbeatTimeout = timeout,
    IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
    Outputs = outputs,
    QueryLanguage = QueryLanguage.JSON_PATH,
    ReturnConsumedCapacity = DynamoConsumedCapacity.INDEXES,
    ReturnItemCollectionMetrics = DynamoItemCollectionMetrics.SIZE,
    ReturnValues = DynamoReturnValues.NONE,
    StateName = "stateName",
    TaskTimeout = timeout,
    Timeout = Duration.Minutes(30)
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var assign interface{}
var dynamoAttributeValue DynamoAttributeValue
var outputs interface{}
var tableRef ITableRef
var taskRole TaskRole
var timeout Timeout

dynamoDeleteItemJsonataProps := &DynamoDeleteItemJsonataProps{
	Key: map[string]DynamoAttributeValue{
		"keyKey": dynamoAttributeValue,
	},
	Table: tableRef,

	// the properties below are optional
	Assign: map[string]interface{}{
		"assignKey": assign,
	},
	Comment: jsii.String("comment"),
	ConditionExpression: jsii.String("conditionExpression"),
	Credentials: &Credentials{
		Role: taskRole,
	},
	ExpressionAttributeNames: map[string]*string{
		"expressionAttributeNamesKey": jsii.String("expressionAttributeNames"),
	},
	ExpressionAttributeValues: map[string]DynamoAttributeValue{
		"expressionAttributeValuesKey": dynamoAttributeValue,
	},
	Heartbeat: cdk.Duration_Minutes(jsii.Number(30)),
	HeartbeatTimeout: timeout,
	IntegrationPattern: awscdk.Aws_stepfunctions.IntegrationPattern_REQUEST_RESPONSE,
	Outputs: outputs,
	QueryLanguage: awscdk.*Aws_stepfunctions.QueryLanguage_JSON_PATH,
	ReturnConsumedCapacity: awscdk.Aws_stepfunctions_tasks.DynamoConsumedCapacity_INDEXES,
	ReturnItemCollectionMetrics: awscdk.*Aws_stepfunctions_tasks.DynamoItemCollectionMetrics_SIZE,
	ReturnValues: awscdk.*Aws_stepfunctions_tasks.DynamoReturnValues_NONE,
	StateName: jsii.String("stateName"),
	TaskTimeout: timeout,
	Timeout: cdk.Duration_*Minutes(jsii.Number(30)),
}

Properties ​

assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{}#
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.

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#
A comment describing this state.

Default: No comment

conditionExpressionoptionalstringcondition_expressionoptionalstrconditionExpressionoptionalStringConditionExpressionoptionalstringConditionExpressionoptional*string#
A condition that must be satisfied in order for a conditional DeleteItem to succeed.

Default: No condition expression

credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials#
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.

expressionAttributeNamesoptional{ [key: string]: string }expression_attribute_namesoptionaltyping.Mapping[str, str]expressionAttributeNamesoptionalMap<String, String>ExpressionAttributeNamesoptionalIDictionary<string, string>ExpressionAttributeNamesoptional*map[string]*string#
One or more substitution tokens for attribute names in an expression.

Default: No expression attribute names

expressionAttributeValuesoptional{ [key: string]: DynamoAttributeValue }expression_attribute_valuesoptionaltyping.Mapping[str, DynamoAttributeValue]expressionAttributeValuesoptionalMap<String, DynamoAttributeValue>ExpressionAttributeValuesoptionalIDictionary<string, DynamoAttributeValue>ExpressionAttributeValuesoptional*map[string]DynamoAttributeValue#
One or more values that can be substituted in an expression.

Default: No expression attribute values

heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration= Nonedeprecated#
use `heartbeatTimeout`
heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout= None#
Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern#
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.

key{ [key: string]: DynamoAttributeValue }keytyping.Mapping[str, DynamoAttributeValue]keyMap<String, DynamoAttributeValue>KeyIDictionary<string, DynamoAttributeValue>Key*map[string]DynamoAttributeValuerequired#
Primary key of the item to retrieve.
notes

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.

outputsoptionalanyoutputsoptionalAnyoutputsoptionalObjectOutputsoptionalobjectOutputsoptionalinterface{}#
Used to specify and transform output from the state.

Default: $states.result or $states.errorOutput

notes

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.

queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= 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.

returnConsumedCapacityoptionalDynamoConsumedCapacityreturn_consumed_capacityoptionalDynamoConsumedCapacityreturnConsumedCapacityoptionalDynamoConsumedCapacityReturnConsumedCapacityoptionalDynamoConsumedCapacityReturnConsumedCapacityoptionalDynamoConsumedCapacity= DynamoConsumedCapacity.NONE#
Determines the level of detail about provisioned throughput consumption that is returned in the response.
returnItemCollectionMetricsoptionalDynamoItemCollectionMetricsreturn_item_collection_metricsoptionalDynamoItemCollectionMetricsreturnItemCollectionMetricsoptionalDynamoItemCollectionMetricsReturnItemCollectionMetricsoptionalDynamoItemCollectionMetricsReturnItemCollectionMetricsoptionalDynamoItemCollectionMetrics= 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.

returnValuesoptionalDynamoReturnValuesreturn_valuesoptionalDynamoReturnValuesreturnValuesoptionalDynamoReturnValuesReturnValuesoptionalDynamoReturnValuesReturnValuesoptionalDynamoReturnValues= DynamoReturnValues.NONE#
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#
Optional name for this state.

Default: The construct ID will be used as state name

tableITableReftableITableReftableITableRefTableITableRefTableITableRefrequired#
The name of the table containing the requested item.
taskTimeoutoptionalTimeouttask_timeoutoptionalTimeouttaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeout= None#
Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration= Nonedeprecated#
use `taskTimeout`