Interface IDynamoPutItemJsonPathProps

Properties for DynamoPutItem Task using JSONPath.

Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDynamoPutItemJsonPathProps : ITaskStateJsonPathBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptions
Syntax (vb)
Public Interface IDynamoPutItemJsonPathProps
    Inherits ITaskStateJsonPathBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptions
Remarks

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 resultSelector;
Table table;
TaskRole taskRole;
Timeout timeout;

var dynamoPutItemJsonPathProps = new DynamoPutItemJsonPathProps {
    Item = new Dictionary<string, DynamoAttributeValue> {
        { "itemKey", 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,
    InputPath = "inputPath",
    IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
    OutputPath = "outputPath",
    QueryLanguage = QueryLanguage.JSON_PATH,
    ResultPath = "resultPath",
    ResultSelector = new Dictionary<string, object> {
        { "resultSelectorKey", resultSelector }
    },
    ReturnConsumedCapacity = DynamoConsumedCapacity.INDEXES,
    ReturnItemCollectionMetrics = DynamoItemCollectionMetrics.SIZE,
    ReturnValues = DynamoReturnValues.NONE,
    StateName = "stateName",
    TaskTimeout = timeout,
    Timeout = Duration.Minutes(30)
};

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

See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-ConditionExpression

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

See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-ExpressionAttributeNames

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

See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-ExpressionAttributeValues

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.

See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-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

See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-ReturnConsumedCapacity

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

See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-ReturnValues

Table

The name of the table where the item should be written .

ITable Table { get; }
Property Value

ITable