Class DynamoGetItemProps
Properties for DynamoGetItem Task.
Inheritance
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public class DynamoGetItemProps : Object, IDynamoGetItemProps, ITaskStateBaseProps
Syntax (vb)
Public Class DynamoGetItemProps
Inherits Object
Implements IDynamoGetItemProps, ITaskStateBaseProps
Remarks
ExampleMetadata: infused
Examples
Table myTable;
new DynamoGetItem(this, "Get Item", new DynamoGetItemProps {
Key = new Dictionary<string, DynamoAttributeValue> { { "messageId", DynamoAttributeValue.FromString("message-007") } },
Table = myTable
});
Synopsis
Constructors
DynamoGetItemProps() |
Properties
Comment | An optional description for this state. |
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. |
Heartbeat | Timeout for the heartbeat. |
InputPath | JSONPath expression to select part of the state to be the input to this state. |
IntegrationPattern | AWS Step Functions integrates with services directly in the Amazon States Language. |
Key | Primary key of the item to retrieve. |
OutputPath | JSONPath expression to select select a portion of the state output to pass to the next state. |
ProjectionExpression | An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table. |
ResultPath | JSONPath expression to indicate where to inject the state's output. |
ResultSelector | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
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. |
Timeout | Timeout for the state machine. |
Constructors
DynamoGetItemProps()
public DynamoGetItemProps()
Properties
Comment
An optional description for this state.
public string Comment { get; set; }
Property Value
System.String
Remarks
Default: - No comment
ConsistentRead
Determines the read consistency model: If set to true, then the operation uses strongly consistent reads;
public Nullable<bool> ConsistentRead { get; set; }
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.
public IDictionary<string, string> ExpressionAttributeNames { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - No expression attributes
Heartbeat
Timeout for the heartbeat.
public Duration Heartbeat { get; set; }
Property Value
Remarks
Default: - None
InputPath
JSONPath expression to select part of the state to be the input to this state.
public string InputPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: - The entire task input (JSON path '$')
IntegrationPattern
AWS Step Functions integrates with services directly in the Amazon States Language.
public Nullable<IntegrationPattern> IntegrationPattern { get; set; }
Property Value
System.Nullable<IntegrationPattern>
Remarks
You can control these AWS services using service integration patterns
Default: - IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:
BatchSubmitJob
, EmrAddStep
, EmrCreateCluster
, EmrTerminationCluster
, and EmrContainersStartJobRun
.
See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
Key
Primary key of the item to retrieve.
public IDictionary<string, DynamoAttributeValue> Key { get; set; }
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.
OutputPath
JSONPath expression to select select a portion of the state output to pass to the next state.
public string OutputPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
ProjectionExpression
An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table.
public DynamoProjectionExpression[] ProjectionExpression { get; set; }
Property Value
Remarks
These attributes can include scalars, sets, or elements of a JSON document.
Default: - No projection expression
ResultPath
JSONPath expression to indicate where to inject the state's output.
public string ResultPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
Default: - Replaces the entire input with the result (JSON path '$')
ResultSelector
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
public IDictionary<string, object> ResultSelector { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
ReturnConsumedCapacity
Determines the level of detail about provisioned throughput consumption that is returned in the response.
public Nullable<DynamoConsumedCapacity> ReturnConsumedCapacity { get; set; }
Property Value
System.Nullable<DynamoConsumedCapacity>
Remarks
Default: DynamoConsumedCapacity.NONE
Table
The name of the table containing the requested item.
public ITable Table { get; set; }
Property Value
Timeout
Timeout for the state machine.
public Duration Timeout { get; set; }
Property Value
Remarks
Default: - None