Interface IDynamoUpdateItemJsonataProps
Properties for DynamoUpdateItem Task using JSONata.
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDynamoUpdateItemJsonataProps : ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptionsSyntax (vb)
Public Interface IDynamoUpdateItemJsonataProps Inherits ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptionsRemarks
ExampleMetadata: fixture=_generated
Examples
// 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.DynamoDB;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
var assign;
DynamoAttributeValue dynamoAttributeValue;
var outputs;
Table table;
TaskRole taskRole;
Timeout timeout;
var dynamoUpdateItemJsonataProps = new DynamoUpdateItemJsonataProps {
Key = new Dictionary<string, DynamoAttributeValue> {
{ "keyKey", dynamoAttributeValue }
},
Table = table,
// 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),
UpdateExpression = "updateExpression"
};Synopsis
Properties
| ConditionExpression | A condition that must be satisfied in order for a conditional DeleteItem to succeed. |
| ExpressionAttributeNames | One or more substitution tokens for attribute names in an expression. |
| ExpressionAttributeValues | One or more values that can be substituted in an expression. |
| Key | Primary key of the item to retrieve. |
| ReturnConsumedCapacity | Determines the level of detail about provisioned throughput consumption that is returned in the response. |
| ReturnItemCollectionMetrics | Determines whether item collection metrics are returned. |
| ReturnValues | Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. |
| Table | The name of the table containing the requested item. |
| UpdateExpression | An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them. |
Properties
ConditionExpression
A condition that must be satisfied in order for a conditional DeleteItem to succeed.
string? ConditionExpression { get; }Property Value
Remarks
Default: - No condition expression
ExpressionAttributeNames
One or more substitution tokens for attribute names in an expression.
IDictionary<string, string>? ExpressionAttributeNames { get; }Property Value
Remarks
Default: - No expression attribute names
ExpressionAttributeValues
One or more values that can be substituted in an expression.
IDictionary<string, DynamoAttributeValue>? ExpressionAttributeValues { get; }Property Value
IDictionary<string, DynamoAttributeValue>
Remarks
Default: - No expression attribute values
Key
Primary key of the item to retrieve.
IDictionary<string, DynamoAttributeValue> Key { get; }Property Value
IDictionary<string, DynamoAttributeValue>
Remarks
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.
ReturnConsumedCapacity
Determines the level of detail about provisioned throughput consumption that is returned in the response.
DynamoConsumedCapacity? ReturnConsumedCapacity { get; }Property Value
Remarks
Default: DynamoConsumedCapacity.NONE
ReturnItemCollectionMetrics
Determines whether item collection metrics are returned.
DynamoItemCollectionMetrics? ReturnItemCollectionMetrics { get; }Property Value
Remarks
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
ReturnValues
Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
DynamoReturnValues? ReturnValues { get; }Property Value
Remarks
Default: DynamoReturnValues.NONE
Table
The name of the table containing the requested item.
ITable Table { get; }Property Value
Remarks
ExampleMetadata: fixture=_generated
UpdateExpression
An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.
string? UpdateExpression { get; }Property Value
Remarks
Default: - No update expression