Class DynamoUpdateItemJsonataProps

public class DynamoUpdateItemJsonataProps : IDynamoUpdateItemJsonataProps, ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptions

Syntax (vb)

Public Class DynamoUpdateItemJsonataProps Implements IDynamoUpdateItemJsonataProps, ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptions

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;
            var outputs;
            Table table;
            TaskRole taskRole;
            Timeout timeout;

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

                // the properties below are optional
                Assign = new Dictionary<string, object> {
                    { "assignKey", assign }
                },
                Comment = "comment",
                ConditionExpression = "conditionExpression",
                Credentials = new Credentials {
                    Role = taskRole
                },
                ExpressionAttributeNames = new Dictionary<string, string> {
                    { "expressionAttributeNamesKey", "expressionAttributeNames" }
                },
                ExpressionAttributeValues = new Dictionary<string, DynamoAttributeValue> {
                    { "expressionAttributeValuesKey", dynamoAttributeValue }
                },
                Heartbeat = Duration.Minutes(30),
                HeartbeatTimeout = timeout,
                IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
                Outputs = outputs,
                QueryLanguage = QueryLanguage.JSON_PATH,
                ReturnConsumedCapacity = DynamoConsumedCapacity.INDEXES,
                ReturnItemCollectionMetrics = DynamoItemCollectionMetrics.SIZE,
                ReturnValues = DynamoReturnValues.NONE,
                StateName = "stateName",
                TaskTimeout = timeout,
                Timeout = Duration.Minutes(30),
                UpdateExpression = "updateExpression"
            };

Synopsis

Constructors

DynamoUpdateItemJsonataProps()

Properties for DynamoUpdateItem Task using JSONata.

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.
IntegrationPattern	AWS Step Functions integrates with services directly in the Amazon States Language.
Key	Primary key of the item to retrieve.
Outputs	Used to specify and transform output from the state.
QueryLanguage	The name of the query language used by the state.
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

DynamoUpdateItemJsonataProps()

Properties for DynamoUpdateItem Task using JSONata.

public DynamoUpdateItemJsonataProps()

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;
            var outputs;
            Table table;
            TaskRole taskRole;
            Timeout timeout;

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

                // the properties below are optional
                Assign = new Dictionary<string, object> {
                    { "assignKey", assign }
                },
                Comment = "comment",
                ConditionExpression = "conditionExpression",
                Credentials = new Credentials {
                    Role = taskRole
                },
                ExpressionAttributeNames = new Dictionary<string, string> {
                    { "expressionAttributeNamesKey", "expressionAttributeNames" }
                },
                ExpressionAttributeValues = new Dictionary<string, DynamoAttributeValue> {
                    { "expressionAttributeValuesKey", dynamoAttributeValue }
                },
                Heartbeat = Duration.Minutes(30),
                HeartbeatTimeout = timeout,
                IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
                Outputs = outputs,
                QueryLanguage = QueryLanguage.JSON_PATH,
                ReturnConsumedCapacity = DynamoConsumedCapacity.INDEXES,
                ReturnItemCollectionMetrics = DynamoItemCollectionMetrics.SIZE,
                ReturnValues = DynamoReturnValues.NONE,
                StateName = "stateName",
                TaskTimeout = timeout,
                Timeout = Duration.Minutes(30),
                UpdateExpression = "updateExpression"
            };

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

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

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

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: fixture=_generated

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

IDynamoUpdateItemJsonataProps

ITaskStateJsonataBaseProps

IStateBaseProps

ITaskStateBaseOptions

IAssignableStateOptions

IJsonataCommonOptions