Interface DynamoDeleteItemJsonPathProps
- All Superinterfaces:
AssignableStateOptions,software.amazon.jsii.JsiiSerializable,JsonPathCommonOptions,StateBaseProps,TaskStateBaseOptions,TaskStateJsonPathBaseProps
- All Known Implementing Classes:
DynamoDeleteItemJsonPathProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-24T13:34:48.083Z")
@Stability(Stable)
public interface DynamoDeleteItemJsonPathProps
extends software.amazon.jsii.JsiiSerializable, TaskStateJsonPathBaseProps
Properties for DynamoDeleteItem Task using JSONPath.
Example:
// 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.dynamodb.*;
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awscdk.services.stepfunctions.tasks.*;
Object assign;
DynamoAttributeValue dynamoAttributeValue;
Object resultSelector;
Table table;
TaskRole taskRole;
Timeout timeout;
DynamoDeleteItemJsonPathProps dynamoDeleteItemJsonPathProps = DynamoDeleteItemJsonPathProps.builder()
.key(Map.of(
"keyKey", dynamoAttributeValue))
.table(table)
// 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)
.inputPath("inputPath")
.integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
.outputPath("outputPath")
.queryLanguage(QueryLanguage.JSON_PATH)
.resultPath("resultPath")
.resultSelector(Map.of(
"resultSelectorKey", resultSelector))
.returnConsumedCapacity(DynamoConsumedCapacity.INDEXES)
.returnItemCollectionMetrics(DynamoItemCollectionMetrics.SIZE)
.returnValues(DynamoReturnValues.NONE)
.stateName("stateName")
.taskTimeout(timeout)
.timeout(Duration.minutes(30))
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forDynamoDeleteItemJsonPathPropsstatic final classAn implementation forDynamoDeleteItemJsonPathProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringA condition that must be satisfied in order for a conditional DeleteItem to succeed.One or more substitution tokens for attribute names in an expression.default Map<String, DynamoAttributeValue> One or more values that can be substituted in an expression.getKey()Primary key of the item to retrieve.default DynamoConsumedCapacityDetermines the level of detail about provisioned throughput consumption that is returned in the response.default DynamoItemCollectionMetricsDetermines whether item collection metrics are returned.default DynamoReturnValuesUse ReturnValues if you want to get the item attributes as they appeared before they were deleted.getTable()The name of the table containing the requested item.Methods inherited from interface software.amazon.awscdk.services.stepfunctions.AssignableStateOptions
getAssignMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJsonMethods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonPathCommonOptions
getInputPath, getOutputPathMethods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBaseProps
getComment, getQueryLanguage, getStateNameMethods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseOptions
getCredentials, getHeartbeat, getHeartbeatTimeout, getIntegrationPattern, getTaskTimeout, getTimeoutMethods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateJsonPathBaseProps
getResultPath, getResultSelector
-
Method Details
-
getKey
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:
-
getTable
The name of the table containing the requested item. -
getConditionExpression
A condition that must be satisfied in order for a conditional DeleteItem to succeed.Default: - No condition expression
- See Also:
-
getExpressionAttributeNames
One or more substitution tokens for attribute names in an expression.Default: - No expression attribute names
- See Also:
-
getExpressionAttributeValues
@Stability(Stable) @Nullable default Map<String,DynamoAttributeValue> getExpressionAttributeValues()One or more values that can be substituted in an expression.Default: - No expression attribute values
- See Also:
-
getReturnConsumedCapacity
Determines the level of detail about provisioned throughput consumption that is returned in the response.Default: DynamoConsumedCapacity.NONE
- See Also:
-
getReturnItemCollectionMetrics
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.
Default: DynamoItemCollectionMetrics.NONE
-
getReturnValues
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.Default: DynamoReturnValues.NONE
- See Also:
-
builder
-