Class DynamoPutItemProps
Properties for DynamoPutItem Task.
Inheritance
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public class DynamoPutItemProps : Object, IDynamoPutItemProps, ITaskStateBaseProps
Syntax (vb)
Public Class DynamoPutItemProps
Inherits Object
Implements IDynamoPutItemProps, ITaskStateBaseProps
Remarks
ExampleMetadata: infused
Examples
Table myTable;
new DynamoPutItem(this, "PutItem", new DynamoPutItemProps {
Item = new Dictionary<string, DynamoAttributeValue> {
{ "MessageId", DynamoAttributeValue.FromString("message-id") }
},
Table = myTable,
ResultPath = "$.Item"
});
Synopsis
Constructors
DynamoPutItemProps() |
Properties
Comment | An optional description for this state. |
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. |
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. |
Item | A map of attribute name/value pairs, one for each attribute. |
OutputPath | JSONPath expression to select select a portion of the state output to pass to the next state. |
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. |
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 . |
Timeout | Timeout for the state machine. |
Constructors
DynamoPutItemProps()
public DynamoPutItemProps()
Properties
Comment
An optional description for this state.
public string Comment { get; set; }
Property Value
System.String
Remarks
Default: - No comment
ConditionExpression
A condition that must be satisfied in order for a conditional PutItem operation to succeed.
public string ConditionExpression { get; set; }
Property Value
System.String
Remarks
Default: - No condition expression
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 attribute names
ExpressionAttributeValues
One or more values that can be substituted in an expression.
public IDictionary<string, DynamoAttributeValue> ExpressionAttributeValues { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, DynamoAttributeValue>
Remarks
Default: - No expression attribute values
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
Item
A map of attribute name/value pairs, one for each attribute.
public IDictionary<string, DynamoAttributeValue> Item { get; set; }
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.
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 '$')
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
ReturnItemCollectionMetrics
The item collection metrics to returned in the response.
public Nullable<DynamoItemCollectionMetrics> ReturnItemCollectionMetrics { get; set; }
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.
public Nullable<DynamoReturnValues> ReturnValues { get; set; }
Property Value
System.Nullable<DynamoReturnValues>
Remarks
Default: DynamoReturnValues.NONE
Table
The name of the table where the item should be written .
public ITable Table { get; set; }
Property Value
Timeout
Timeout for the state machine.
public Duration Timeout { get; set; }
Property Value
Remarks
Default: - None