Class DynamoUpdateItemProps

Properties for DynamoUpdateItem Task.

Inheritance

System.Object

DynamoUpdateItemProps

Implements

IDynamoUpdateItemProps

ITaskStateBaseProps

Namespace: Amazon.CDK.AWS.StepFunctions.Tasks

Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll

Syntax (csharp)

public class DynamoUpdateItemProps : Object, IDynamoUpdateItemProps, ITaskStateBaseProps

Syntax (vb)

Public Class DynamoUpdateItemProps
    Inherits Object
    Implements IDynamoUpdateItemProps, ITaskStateBaseProps

Remarks

ExampleMetadata: infused

Examples

Table myTable;

new DynamoUpdateItem(this, "UpdateItem", new DynamoUpdateItemProps {
    Key = new Dictionary<string, DynamoAttributeValue> {
        { "MessageId", DynamoAttributeValue.FromString("message-007") }
    },
    Table = myTable,
    ExpressionAttributeValues = new Dictionary<string, DynamoAttributeValue> {
        { ":val", DynamoAttributeValue.NumberFromString(JsonPath.StringAt("$.Item.TotalCount.N")) },
        { ":rand", DynamoAttributeValue.FromNumber(20) }
    },
    UpdateExpression = "SET TotalCount = :val + :rand"
});

Synopsis

Constructors

DynamoUpdateItemProps()

Properties

Comment	An optional description for this state.
ConditionExpression	A condition that must be satisfied in order for a conditional DeleteItem 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.
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.
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	Determines whether item collection metrics are returned.
ReturnValues	Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
Table	The name of the table containing the requested item.
Timeout	Timeout for the state machine.
UpdateExpression	An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

Constructors

DynamoUpdateItemProps()

public DynamoUpdateItemProps()

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 DeleteItem to succeed.

public string ConditionExpression { get; set; }

Property Value

System.String

Remarks

Default: - No condition expression

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

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

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

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

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

Heartbeat

Timeout for the heartbeat.

public Duration Heartbeat { get; set; }

Property Value

Duration

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.

See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-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 '$')

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

See: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

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

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

ReturnItemCollectionMetrics

Determines whether item collection metrics are returned.

public Nullable<DynamoItemCollectionMetrics> ReturnItemCollectionMetrics { get; set; }

Property Value

System.Nullable<DynamoItemCollectionMetrics>

Remarks

If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

Default: DynamoItemCollectionMetrics.NONE

ReturnValues

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.

public Nullable<DynamoReturnValues> ReturnValues { get; set; }

Property Value

System.Nullable<DynamoReturnValues>

Remarks

Default: DynamoReturnValues.NONE

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

Table

The name of the table containing the requested item.

public ITable Table { get; set; }

Property Value

ITable

Timeout

Timeout for the state machine.

public Duration Timeout { get; set; }

Property Value

Duration

Remarks

Default: - None

UpdateExpression

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

public string UpdateExpression { get; set; }

Property Value

System.String

Remarks

Default: - No update expression

See: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html#DDB-UpdateItem-request-UpdateExpression

Implements

IDynamoUpdateItemProps

ITaskStateBaseProps