Amazon DynamoDB Connector Reference - Mule 4

String

The name for this configuration. Connectors reference the configuration with this name.

x

The connection types to provide to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

String

The name for this configuration. Connectors reference the configuration with this name.

x

Streams

The connection types to provide to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

String

The name of the configuration to use.

x

Object

One or more items to delete from the table.

x

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

Object

A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table.

x

Enumeration, one of:

Determines the level of detail about provisioned throughput consumption that is returned in the response.

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

Object

One or more items to insert into table.

x

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The name of the table to create.

x

Array of Attribute Definition

An array of attributes that describe the key schema for the table and indexes.

x

Array of Key Schema Element

Specifies the attributes that make up the primary key for a table or an index.

x

Number

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

x

Number

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

x

Array of Global Secondary Index

One or more global secondary indexes (the maximum is five) to be created on the table.

Array of Local Secondary Index

One or more local secondary indexes (the maximum is five) to be created on the table.

Enumeration, one of:

When an item in the table is modified, StreamViewType determines what information is written to the table’s stream.

Boolean

Indicates whether to enable Streams (true) or disable Streams (false).

false

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

Table name.

x

Object

Primary key name and value map.

#[payload]

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The name of the table to delete.

x

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The name of the table to describe.

x

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The name of the table containing the requested item.

x

Object

A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.

#[payload]

Array of String

This is a legacy parameter. Use ProjectionExpression instead.

Boolean

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

false

Object

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

String

A string that identifies one or more attributes to retrieve from the table.

Enumeration, one of:

Determines the level of detail about provisioned throughput consumption returned in the response.

NONE

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation.

Number

A maximum number of table names to return. If this parameter is not specified, the limit is 100.

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The condition that specifies the key values for items to retrieve by the Query operation.

Object

This is a legacy parameter. Use Key Condition Expression instead.

Boolean

Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.

false

Enumeration, one of:

The attributes to return in the result.

Object

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

Object

One or more values to substitute in an expression.

String

Name of the table containing the requested item.

x

Array of String

This is a legacy parameter. Use the Projection Expression field instead.

Enumeration, one of:

A logical operator to apply to the conditions.

Boolean

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

false

Object

The primary key of the first item that this operation evaluates.

String

A string that contains conditions that DynamoDB applies after the operation, but before the data is returned to you. Items that do not satisfy the criteria are not returned.

String

The name of a secondary index to scan. This index can be any local secondary index or global secondary index.

Number

The maximum number of items to evaluate (not necessarily the number of matching items).

String

A string that identifies one or more attributes to retrieve from the table.

Object

The condition that evaluates the query results after the items are read and returns only the desired values.

Enumeration, one of:

The level of detail of the provisioned throughput consumption returned in the response.

String

Name of the variable that stores the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

Table name.

x

Object

Item to be inserted.

#[payload]

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The condition that specifies the key values for items to be retrieved by the Query action.

Object

This is a legacy parameter. Use KeyConditionExpression instead.

Boolean

Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.

false

Enumeration, one of:

The attributes to be returned in the result.

Object

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

Object

One or more values to substitute in an expression.

String

Name of the table containing the requested item.

x

Array of String

This is a legacy parameter. Use the Projection Expression field instead.

Enumeration, one of:

A logical operator to apply to the conditions.

Boolean

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

false

Object

The primary key of the first item that this operation evaluates.

String

A string that contains conditions that DynamoDB applies after the operation, but before the data is returned to you. Items that do not satisfy the criteria are not returned.

String

The name of a secondary index to scan. This index can be any local secondary index or global secondary index.

Number

The maximum number of items to evaluate (not necessarily the number of matching items).

String

A string that identifies one or more attributes to retrieve from the table.

Object

The condition that evaluates the query results after the items are read and returns only the desired values.

Enumeration, one of:

The level of detail of the provisioned throughput consumption returned in the response.

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

Number

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

Enumeration, one of:

The attributes to be returned in the result.

Number

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation is divided.

Object

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

Object

One or more values to substitute in an expression.

String

Name of the table containing the requested item.

x

Array of String

This is a legacy field. Use the Projection Expression field instead.

Enumeration, one of:

A logical operator to apply to the conditions.

Boolean

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

false

Object

The primary key of the first item that this operation evaluates.

String

A string that contains conditions that DynamoDB applies after the operation, but before the data is returned to you. Items that do not satisfy the criteria are not returned.

String

The name of a secondary index to scan. This index can be any local secondary index or global secondary index.

Number

The maximum number of items to evaluate (not necessarily the number of matching items).

String

A string that identifies one or more attributes to retrieve from the table.

Object

The condition that evaluates the query results after the items are read and returns only the desired values.

Enumeration, one of:

The level of detail of the provisioned throughput consumption returned in the response..

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

Table name.

x

Object

Primary key.

#[payload]

Enumeration, one of:

Determines the level of detail about provisioned throughput consumption that is returned in the response.

Enumeration, one of:

Determines whether item collection metrics are returned.

Enumeration, one of:

Use if you want to get the item attributes as they appear before or after they are updated.

String

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

Object

This is a legacy parameter. Use updateExpression instead.

Object

This is a legacy parameter. Use conditionExpression instead.

Enumeration, one of:

String

Object

Object

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

The name of the table to update.

x

Array of Attribute Definition

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key elements of the new index.

Number

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

Number

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

Array of Global Secondary Index Update

An array of one or more global secondary indexes for the table.

Enumeration, one of:

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.

Boolean

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

false

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

x

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

x

Configure to use repeatable streams.

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

x

String

x

String

String

x

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.

String

The name of the configuration to use.

x

String

Configure to use repeatable streams.

String

The name of a variable to store the operation’s output.

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

A retry strategy in case of connectivity errors.