Show / Hide Table of Contents

Class DynamoUpdateItemProps

Properties for DynamoUpdateItem Task.

Inheritance
object
DynamoUpdateItemProps
Implements
IDynamoUpdateItemProps
ITaskStateBaseProps
IStateBaseProps
ITaskStateBaseOptions
IAssignableStateOptions
IJsonPathCommonOptions
IJsonataCommonOptions
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DynamoUpdateItemProps : IDynamoUpdateItemProps, ITaskStateBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptions, IJsonataCommonOptions
Syntax (vb)
Public Class DynamoUpdateItemProps Implements IDynamoUpdateItemProps, ITaskStateBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptions, IJsonataCommonOptions
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 for DynamoUpdateItem Task.

Properties

Assign

Workflow variables to store in this step.

Comment

A comment describing this state.

ConditionExpression

A condition that must be satisfied in order for a conditional DeleteItem to succeed.

Credentials

Credentials for an IAM Role that the State Machine assumes for executing the task.

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

(deprecated) Timeout for the heartbeat.

HeartbeatTimeout

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 part of the state to be the output to this state.

Outputs

Used to specify and transform output from the state.

QueryLanguage

The name of the query language used by the 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.

StateName

Optional name for this state.

Table

The name of the table containing the requested item.

TaskTimeout

Timeout for the task.

Timeout

(deprecated) Timeout for the task.

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()

Properties for DynamoUpdateItem Task.

public DynamoUpdateItemProps()
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"
            });

Properties

Assign

Workflow variables to store in this step.

public IDictionary<string, object>? Assign { get; set; }
Property Value

IDictionary<string, object>

Remarks

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default: - Not assign variables

See: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

Comment

A comment describing this state.

public string? Comment { get; set; }
Property Value

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

string

Remarks

Default: - No condition expression

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

Credentials

Credentials for an IAM Role that the State Machine assumes for executing the task.

public ICredentials? Credentials { get; set; }
Property Value

ICredentials

Remarks

This enables cross-account resource invocations.

Default: - None (Task is executed using the State Machine's execution role)

See: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

ExpressionAttributeNames

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

public IDictionary<string, string>? ExpressionAttributeNames { get; set; }
Property Value

IDictionary<string, 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

IDictionary<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

(deprecated) Timeout for the heartbeat.

[Obsolete("use `heartbeatTimeout`")]
public Duration? Heartbeat { get; set; }
Property Value

Duration

Remarks

Default: - None

Stability: Deprecated

HeartbeatTimeout

Timeout for the heartbeat.

public Timeout? HeartbeatTimeout { get; set; }
Property Value

Timeout

Remarks

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

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

string

Remarks

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Default: $

IntegrationPattern

AWS Step Functions integrates with services directly in the Amazon States Language.

public IntegrationPattern? IntegrationPattern { get; set; }
Property Value

IntegrationPattern?

Remarks

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

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-supported-services.html

Key

Primary key of the item to retrieve.

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

IDictionary<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 part of the state to be the output to this state.

public string? OutputPath { get; set; }
Property Value

string

Remarks

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Default: $

Outputs

Used to specify and transform output from the state.

public object? Outputs { get; set; }
Property Value

object

Remarks

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default: - $states.result or $states.errorOutput

See: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

QueryLanguage

The name of the query language used by the state.

public QueryLanguage? QueryLanguage { get; set; }
Property Value

QueryLanguage?

Remarks

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Default: - JSONPath

ResultPath

JSONPath expression to indicate where to inject the state's output.

public string? ResultPath { get; set; }
Property Value

string

Remarks

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Default: $

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

IDictionary<string, 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 DynamoConsumedCapacity? ReturnConsumedCapacity { get; set; }
Property Value

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 DynamoItemCollectionMetrics? ReturnItemCollectionMetrics { get; set; }
Property Value

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 DynamoReturnValues? ReturnValues { get; set; }
Property Value

DynamoReturnValues?

Remarks

Default: DynamoReturnValues.NONE

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

StateName

Optional name for this state.

public string? StateName { get; set; }
Property Value

string

Remarks

Default: - The construct ID will be used as state name

Table

The name of the table containing the requested item.

public ITable Table { get; set; }
Property Value

ITable

Remarks

ExampleMetadata: infused

TaskTimeout

Timeout for the task.

public Timeout? TaskTimeout { get; set; }
Property Value

Timeout

Remarks

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default: - None

Timeout

(deprecated) Timeout for the task.

[Obsolete("use `taskTimeout`")]
public Duration? Timeout { get; set; }
Property Value

Duration

Remarks

Default: - None

Stability: Deprecated

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

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
IStateBaseProps
ITaskStateBaseOptions
IAssignableStateOptions
IJsonPathCommonOptions
IJsonataCommonOptions
Back to top Generated by DocFX