Interface IDynamoPutItemProps
Properties for DynamoPutItem Task.
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDynamoPutItemProps : ITaskStateBaseProps
Syntax (vb)
Public Interface IDynamoPutItemProps
Inherits ITaskStateBaseProps
Remarks
ExampleMetadata: infused
Examples
Table myTable;
new DynamoPutItem(this, "PutItem", new DynamoPutItemProps {
Item = new Dictionary<string, DynamoAttributeValue> {
{ "MessageId", DynamoAttributeValue.FromString("message-007") },
{ "Text", DynamoAttributeValue.FromString(JsonPath.StringAt("$.bar")) },
{ "TotalCount", DynamoAttributeValue.FromNumber(10) }
},
Table = myTable
});
Synopsis
Properties
ConditionExpression | A condition that must be satisfied in order for a conditional PutItem operation 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. |
Item | A map of attribute name/value pairs, one for each attribute. |
ReturnConsumedCapacity | Determines the level of detail about provisioned throughput consumption that is returned in the response. |
ReturnItemCollectionMetrics | The item collection metrics to returned in the response. |
ReturnValues | Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. |
Table | The name of the table where the item should be written . |
Properties
ConditionExpression
A condition that must be satisfied in order for a conditional PutItem operation to succeed.
virtual string ConditionExpression { get; }
Property Value
System.String
Remarks
Default: - No condition expression
ExpressionAttributeNames
One or more substitution tokens for attribute names in an expression.
virtual IDictionary<string, string> ExpressionAttributeNames { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - No expression attribute names
ExpressionAttributeValues
One or more values that can be substituted in an expression.
virtual IDictionary<string, DynamoAttributeValue> ExpressionAttributeValues { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, DynamoAttributeValue>
Remarks
Default: - No expression attribute values
Item
A map of attribute name/value pairs, one for each attribute.
IDictionary<string, DynamoAttributeValue> Item { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, DynamoAttributeValue>
Remarks
Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.
ReturnConsumedCapacity
Determines the level of detail about provisioned throughput consumption that is returned in the response.
virtual Nullable<DynamoConsumedCapacity> ReturnConsumedCapacity { get; }
Property Value
System.Nullable<DynamoConsumedCapacity>
Remarks
Default: DynamoConsumedCapacity.NONE
ReturnItemCollectionMetrics
The item collection metrics to returned in the response.
virtual Nullable<DynamoItemCollectionMetrics> ReturnItemCollectionMetrics { get; }
Property Value
System.Nullable<DynamoItemCollectionMetrics>
Remarks
Default: DynamoItemCollectionMetrics.NONE
See: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LSI.html#LSI.ItemCollections
ReturnValues
Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.
virtual Nullable<DynamoReturnValues> ReturnValues { get; }
Property Value
System.Nullable<DynamoReturnValues>
Remarks
Default: DynamoReturnValues.NONE
Table
The name of the table where the item should be written .
ITable Table { get; }
Property Value