DynamoUpdateItemJsonPathProps Struct
Properties for DynamoUpdateItem 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_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 resultSelector: any;
declare const tableRef: interfaces_dynamodb.ITableRef;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const dynamoUpdateItemJsonPathProps: stepfunctions_tasks.DynamoUpdateItemJsonPathProps = {
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,
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),
updateExpression: 'updateExpression',
};
Properties
assign{ [key: string]: any }assigntyping.Mapping[str, Any]assignMap<String, Object>AssignIDictionary<string, object>Assign*map[string]interface{}= Not assign variables#Using workflow variables, you can store data in a step and retrieve that data in future steps.
conditionExpressionstringcondition_expressionstrconditionExpressionStringConditionExpressionstringConditionExpression*string= No condition expression#credentialsCredentialscredentialsCredentialscredentialsCredentialsCredentialsCredentialsCredentialsCredentials= None (Task is executed using the…#This enables cross-account resource invocations.
default
Default: None (Task is executed using the State Machine's execution role)
expressionAttributeNames{ [key: string]: string }expression_attribute_namestyping.Mapping[str, str]expressionAttributeNamesMap<String, String>ExpressionAttributeNamesIDictionary<string, string>ExpressionAttributeNames*map[string]*string= No expression attribute names#expressionAttributeValues{ [key: string]: DynamoAttributeValue }expression_attribute_valuestyping.Mapping[str, DynamoAttributeValue]expressionAttributeValuesMap<String, DynamoAttributeValue>ExpressionAttributeValuesIDictionary<string, DynamoAttributeValue>ExpressionAttributeValues*map[string]DynamoAttributeValue= No expression attribute values#heartbeatDurationheartbeatDurationheartbeatDurationHeartbeatDurationHeartbeatDuration= Nonedeprecated#heartbeatTimeoutTimeoutheartbeat_timeoutTimeoutheartbeatTimeoutTimeoutHeartbeatTimeoutTimeoutHeartbeatTimeoutTimeout= None#[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
integrationPatternIntegrationPatternintegration_patternIntegrationPatternintegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPattern= `IntegrationPattern.REQUEST_RESP…#You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
default
Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.
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.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
queryLanguageQueryLanguagequery_languageQueryLanguagequeryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguage= JSONPath#If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultSelector{ [key: string]: any }result_selectortyping.Mapping[str, Any]resultSelectorMap<String, Object>ResultSelectorIDictionary<string, object>ResultSelector*map[string]interface{}= None#You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
returnConsumedCapacityDynamoConsumedCapacityreturn_consumed_capacityDynamoConsumedCapacityreturnConsumedCapacityDynamoConsumedCapacityReturnConsumedCapacityDynamoConsumedCapacityReturnConsumedCapacityDynamoConsumedCapacity= DynamoConsumedCapacity.NONE#returnItemCollectionMetricsDynamoItemCollectionMetricsreturn_item_collection_metricsDynamoItemCollectionMetricsreturnItemCollectionMetricsDynamoItemCollectionMetricsReturnItemCollectionMetricsDynamoItemCollectionMetricsReturnItemCollectionMetricsDynamoItemCollectionMetrics= 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.
returnValuesDynamoReturnValuesreturn_valuesDynamoReturnValuesreturnValuesDynamoReturnValuesReturnValuesDynamoReturnValuesReturnValuesDynamoReturnValues= DynamoReturnValues.NONE#stateNamestringstate_namestrstateNameStringStateNamestringStateName*string= The construct ID will be used as…#default
Default: The construct ID will be used as state name
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
updateExpressionstringupdate_expressionstrupdateExpressionStringUpdateExpressionstringUpdateExpression*string= No update expression#