DynamoUpdateItemJsonataProps Struct
Properties for DynamoUpdateItem Task using JSONata.
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_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 dynamoUpdateItemJsonataProps: stepfunctions_tasks.DynamoUpdateItemJsonataProps = {
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),
updateExpression: 'updateExpression',
};
Properties
assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{}#Default: Not assign variables
Using workflow variables, you can store data in a step and retrieve that data in future steps.
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#Default: No comment
conditionExpressionoptionalstringcondition_expressionoptionalstrconditionExpressionoptionalStringConditionExpressionoptionalstringConditionExpressionoptional*string#Default: No condition expression
credentialsoptionalCredentialscredentialsoptionalCredentialscredentialsoptionalCredentialsCredentialsoptionalCredentialsCredentialsoptionalCredentials#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#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#Default: No expression attribute values
heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration= Nonedeprecated#heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout= None#[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern#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#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{}#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#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#returnItemCollectionMetricsoptionalDynamoItemCollectionMetricsreturn_item_collection_metricsoptionalDynamoItemCollectionMetricsreturnItemCollectionMetricsoptionalDynamoItemCollectionMetricsReturnItemCollectionMetricsoptionalDynamoItemCollectionMetricsReturnItemCollectionMetricsoptionalDynamoItemCollectionMetrics= DynamoItemCollectionMetrics.NONE#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#stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#Default: The construct ID will be used as state name
taskTimeoutoptionalTimeouttask_timeoutoptionalTimeouttaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeout= None#[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration= Nonedeprecated#updateExpressionoptionalstringupdate_expressionoptionalstrupdateExpressionoptionalStringUpdateExpressionoptionalstringUpdateExpressionoptional*string#Default: No update expression