Interface IDynamoGetItemJsonPathProps

Properties for DynamoGetItem Task using JSONPath.

Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDynamoGetItemJsonPathProps : ITaskStateJsonPathBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptions
Syntax (vb)
Public Interface IDynamoGetItemJsonPathProps
    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;
DynamoProjectionExpression dynamoProjectionExpression;
var resultSelector;
Table table;
TaskRole taskRole;
Timeout timeout;

var dynamoGetItemJsonPathProps = new DynamoGetItemJsonPathProps {
    Key = new Dictionary<string, DynamoAttributeValue> {
        { "keyKey", dynamoAttributeValue }
    },
    Table = table,

    // the properties below are optional
    Assign = new Dictionary<string, object> {
        { "assignKey", assign }
    },
    Comment = "comment",
    ConsistentRead = false,
    Credentials = new Credentials {
        Role = taskRole
    },
    ExpressionAttributeNames = new Dictionary<string, string> {
        { "expressionAttributeNamesKey", "expressionAttributeNames" }
    },
    Heartbeat = Duration.Minutes(30),
    HeartbeatTimeout = timeout,
    InputPath = "inputPath",
    IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
    OutputPath = "outputPath",
    ProjectionExpression = new [] { dynamoProjectionExpression },
    QueryLanguage = QueryLanguage.JSON_PATH,
    ResultPath = "resultPath",
    ResultSelector = new Dictionary<string, object> {
        { "resultSelectorKey", resultSelector }
    },
    ReturnConsumedCapacity = DynamoConsumedCapacity.INDEXES,
    StateName = "stateName",
    TaskTimeout = timeout,
    Timeout = Duration.Minutes(30)
};

Synopsis

Properties

ConsistentRead

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;
ExpressionAttributeNames

One or more substitution tokens for attribute names in an expression.
Key

Primary key of the item to retrieve.
ProjectionExpression

An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table.
ReturnConsumedCapacity

Determines the level of detail about provisioned throughput consumption that is returned in the response.
Table

The name of the table containing the requested item.

Properties

ConsistentRead

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;

virtual Nullable<bool> ConsistentRead { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

otherwise, the operation uses eventually consistent reads.

Default: false

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 attributes

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

Key

Primary key of the item to retrieve.

IDictionary<string, DynamoAttributeValue> Key { get; }
Property Value

System.Collections.Generic.IDictionary<System.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.

See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-Key

ProjectionExpression

An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table.

virtual DynamoProjectionExpression[] ProjectionExpression { get; }
Property Value

DynamoProjectionExpression[]

Remarks

These attributes can include scalars, sets, or elements of a JSON document.

Default: - No projection expression

See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-ProjectionExpression

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_GetItem.html#DDB-GetItem-request-ReturnConsumedCapacity

Table

The name of the table containing the requested item.

ITable Table { get; }
Property Value

ITable