salesforce Dreamforce On-Demand
Contact Us 1-800-596-4880
  1. Homepage
  2. Amazon Redshift Connector (1.0)

  3. Amazon Redshift Connector Reference

All Connectors

Amazon Redshift Connector 1.0 Reference

Anypoint Connector for Amazon Redshift (Amazon Redshift Connector) is a bulk-load connector that enables you to connect to the Amazon Redshift database to perform inserts, deletes, updates, and to execute SQL queries.

Configurations

Name Type Description Default Value Required

Name

String

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

x

Connection

The connection types to provide to this configuration.

x

Name

String

The identifier of this element used to reference it in other components

x

Expiration Policy

Expiration Policy

Minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

Basic Connection

This connection uses database credentials for authentication.

Name Type Description Default Value Required

Pooling Profile

Pooling Profile

Provides a way to configure database connection pooling.

Column Types

Array of Column Type

Specifies non-standard column types.

Transaction Isolation

Enumeration, one of:

  • NONE

  • READ_COMMITTED

  • READ_UNCOMMITTED

  • REPEATABLE_READ

  • SERIALIZABLE

  • NOT_CONFIGURED

Transaction isolation level to set on the driver when connecting to the database.

NOT_CONFIGURED

Use XA Transactions

Boolean

Indicates whether or not the created datasource must support XA transactions. The default is false.

false

Cluster Id

String

Cluster identifier.

x

Region Endpoint

String

Region to use for authentication against the database.

us-east-1

Port

Number

Configures the port of the database.

5439

Database

String

Database name.

x

User

String

Database user name.

x

Connection Properties

Object

Specifies a list of custom key-value connection properties to configure on the driver when connecting to the database.

Password

String

Password to use for authentication against the database.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

IAM Connection

This connection uses IAM credentials to retrieve temporary database credentials for authentication.

Name Type Description Default Value Required

Pooling Profile

Pooling Profile

Provides a way to configure database connection pooling.

Column Types

Array of Column Type

Specifies non-standard column types.

Transaction Isolation

Enumeration, one of:

  • NONE

  • READ_COMMITTED

  • READ_UNCOMMITTED

  • REPEATABLE_READ

  • SERIALIZABLE

  • NOT_CONFIGURED

Transaction isolation level to set on the driver when connecting to the database.

NOT_CONFIGURED

Use XA Transactions

Boolean

Indicates whether or not the created datasource must support XA transactions. The default is false.

false

Cluster Id

String

Cluster identifier.

x

Region Endpoint

String

Region to use for authentication against the database.

us-east-1

Port

Number

Configures the port of the database.

5439

Database

String

Database name.

x

User

String

Database user name.

x

Connection Properties

Object

Specifies a list of custom key-value connection properties to configure on the driver when connecting to the database.

Access Key

String

Access key provided by Amazon for retrieving temporary database credentials.

x

Secret Key

String

Secret key provided by Amazon for retrieving temporary database credentials.

x

Role

Role

Role configuration.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Sources

On Table Row

<redshift:listener>

Selects from a table at a regular interval and generates one message per row that is obtained. Optionally, watermark and ID columns can be provided. If a watermark column is provided, the values taken from that column will be used to filter the contents of the next poll, so that only rows with a greater watermark value are returned. If an ID column is provided, this component automatically ensures that the same row is not picked twice by concurrent polls.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Table

String

Name of the table to select from.

x

Watermark Column

String

Name of the column to use for the watermark. Values taken from the watermark column will be used to filter the contents of the next poll, so that only rows with a greater watermark value are processed.

Id Column

String

Name of the column to use as the row ID. If provided, this component ensures that the same row is not processed twice by concurrent polls.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Transactional Action

Enumeration, one of:

  • ALWAYS_BEGIN

  • NONE

The type of beginning action that sources can take for transactions.

NONE

Transaction Type

Enumeration, one of:

  • LOCAL

  • XA

The type of transaction to create. Availability depends on Mule version.

LOCAL

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Query Timeout

Number

Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

SECONDS

Fetch Size

Number

Limit for the number of records to retrieve in a single page.

Max Rows

Number

Indicates the maximum number of rows to fetch from the result set.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Operations

Bulk Delete

<redshift:bulk-delete>

Enables the execution of one delete statement at various times using different parameter bindings. This uses a single database statement, which has performance advantages compared to executing a single delete operation at various times.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Input Parameters

Array of Object

A java.util.List of java.util.Maps in which every list item represents a row to be inserted. The map contains the parameter names as keys and the value the parameter is bound to.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take for transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Limit for the number of records to retrieve in a single page.

Max Rows

Number

Indicates the maximum number of rows to fetch from the result set.

SQL Query Text

String

SQL query to execute.

x

Parameter Types

Array of Parameter Type

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Number

For Configurations

Throws

  • REDSHIFT:BAD_SQL_SYNTAX

  • REDSHIFT:CONNECTIVITY

  • REDSHIFT:QUERY_EXECUTION

  • REDSHIFT:RETRY_EXHAUSTED

Bulk Insert

<redshift:bulk-insert>

Enables the execution of one insert statement at various times using different parameter bindings. This uses a single database statement, which has performance advantages compared to executing a single update operation at various times.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Input Parameters

Array of Object

A java.util.List of java.util.Maps in which every list item represents a row to be inserted. The map contains the parameter names as keys and the value the parameter is bound to.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take for transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Limit for the number of records to retrieve in a single page.

Max Rows

Number

Indicates the maximum number of rows to fetch from the result set.

SQL Query Text

String

SQL query to execute.

x

Parameter Types

Array of Parameter Type

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Number

For Configurations

Throws

  • REDSHIFT:BAD_SQL_SYNTAX

  • REDSHIFT:CONNECTIVITY

  • REDSHIFT:QUERY_EXECUTION

  • REDSHIFT:RETRY_EXHAUSTED

Bulk Update

<redshift:bulk-update>

Enables the execution of one update statement at various times using different parameter bindings. This uses a single database statement, which has performance advantages compared to executing a single update operation at various times.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Input Parameters

Array of Object

A java.util.List of java.util.Maps in which every list item represents a row to be inserted. The map contains the parameter names as keys and the value the parameter is bound to.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take for transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Limit for the number of records to retrieve in a single page.

Max Rows

Number

Indicates the maximum number of rows to fetch from the result set.

SQL Query Text

String

SQL query to execute.

x

Parameter Types

Array of Parameter Type

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Number

For Configurations

Throws

  • REDSHIFT:BAD_SQL_SYNTAX

  • REDSHIFT:CONNECTIVITY

  • REDSHIFT:QUERY_EXECUTION

  • REDSHIFT:RETRY_EXHAUSTED

Delete

<redshift:delete>

Deletes data in a database.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take for transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Limit for the number of records to retrieve in a single page.

Max Rows

Number

Indicates the maximum number of rows to fetch from the result set.

SQL Query Text

String

SQL query to execute.

x

Parameter Types

Array of Parameter Type

Input Parameters

Object

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • REDSHIFT:BAD_SQL_SYNTAX

  • REDSHIFT:CONNECTIVITY

  • REDSHIFT:QUERY_EXECUTION

  • REDSHIFT:RETRY_EXHAUSTED

Execute DDL

<redshift:execute-ddl>

Enables execution of DDL queries against a database.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

SQL Query Text

String

Text of the SQL query to execute.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take for transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Limit for the number of records to retrieve in a single page.

Max Rows

Number

Indicates the maximum number of rows to fetch from the result set.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • REDSHIFT:BAD_SQL_SYNTAX

  • REDSHIFT:CONNECTIVITY

  • REDSHIFT:QUERY_EXECUTION

  • REDSHIFT:RETRY_EXHAUSTED

Execute Script

<redshift:execute-script>

Executes a SQL script in a single database statement. The script is executed as provided by the user, without any parameter binding.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take for transactions.

JOIN_IF_POSSIBLE

SQL Query Text

String

SQL query to execute.

Script Path

String

Query Timeout

Number

Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Limit for the number of records to retrieve in a single page.

Max Rows

Number

Indicates the maximum number of rows to fetch from the result set.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Number

For Configurations

Throws

  • REDSHIFT:BAD_SQL_SYNTAX

  • REDSHIFT:CONNECTIVITY

  • REDSHIFT:QUERY_EXECUTION

  • REDSHIFT:RETRY_EXHAUSTED

Insert

<redshift:insert>

Inserts data into a database.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take for transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Limit for the number of records to retrieve in a single page.

Max Rows

Number

Indicates the maximum number of rows to fetch from the result set.

SQL Query Text

String

SQL query to execute.

x

Parameter Types

Array of Parameter Type

Input Parameters

Object

Auto Generate Keys

Boolean

Indicates when to make auto-generated keys available for retrieval.

false

Auto Generated Keys Column Indexes

Array of Number

List of column indexes that indicates which auto-generated keys to make available for retrieval.

Auto Generated Keys Column Names

Array of String

List of column names that indicates which auto-generated keys to make available for retrieval.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Statement Result

For Configurations

Throws

  • REDSHIFT:BAD_SQL_SYNTAX

  • REDSHIFT:CONNECTIVITY

  • REDSHIFT:QUERY_EXECUTION

  • REDSHIFT:RETRY_EXHAUSTED

Query Single

<redshift:query-single>

Selects a single result from a database. If the specified SQL query returns more than one record, only the first record is returned. Streaming is not used for this operation, so you must be careful because all selected fields will be loaded to memory.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take for transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Limit for the number of records to retrieve in a single page.

Max Rows

Number

Indicates the maximum number of rows to fetch from the result set.

SQL Query Text

String

SQL query to execute.

x

Parameter Types

Array of Parameter Type

Input Parameters

Object

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • REDSHIFT:BAD_SQL_SYNTAX

  • REDSHIFT:CONNECTIVITY

  • REDSHIFT:QUERY_EXECUTION

  • REDSHIFT:RETRY_EXHAUSTED

Select

<redshift:select>

Selects data from a database. Streaming is automatically applied to avoid performance and memory issues that can be caused by preemptive consumption of results.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take for transactions.

JOIN_IF_POSSIBLE

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Query Timeout

Number

Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Limit for the number of records to retrieve in a single page.

Max Rows

Number

Indicates the maximum number of rows to fetch from the result set.

SQL Query Text

String

SQL query to execute.

x

Parameter Types

Array of Parameter Type

Input Parameters

Object

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

Throws

  • REDSHIFT:BAD_SQL_SYNTAX

  • REDSHIFT:CONNECTIVITY

  • REDSHIFT:QUERY_EXECUTION

Stored Procedure

<redshift:stored-procedure>

Invokes a Stored Procedure on the database. When the stored procedure returns one or more java.sql.ResultSet instances, streaming is automatically applied to avoid performance and memory issues that can be caused by preemptive consumption of results.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take for transactions.

JOIN_IF_POSSIBLE

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Query Timeout

Number

Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Limit for the number of records to retrieve in a single page.

Max Rows

Number

Indicates the maximum number of rows to fetch from the result set.

SQL Query Text

String

SQL query to execute.

x

Parameter Types

Array of Parameter Type

Input Parameters

Object

Input - Output Parameters

Object

Output Parameters

Array of Output Parameter

Auto Generate Keys

Boolean

Indicates when to make auto-generated keys available for retrieval.

false

Auto Generated Keys Column Indexes

Array of Number

List of column indexes that indicates which auto-generated keys to make available for retrieval.

Auto Generated Keys Column Names

Array of String

List of column names that indicates which auto-generated keys to make available for retrieval.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Object

For Configurations

Throws

  • REDSHIFT:BAD_SQL_SYNTAX

  • REDSHIFT:CONNECTIVITY

  • REDSHIFT:QUERY_EXECUTION

  • REDSHIFT:RETRY_EXHAUSTED

Update

<redshift:update>

Updates data in a database.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take for transactions.

JOIN_IF_POSSIBLE

Query Timeout

Number

Indicates the minimum amount of time before a running statement is canceled. By default, no timeout is used.

0

Query Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Query Timeout field.

SECONDS

Fetch Size

Number

Limit for the number of records to retrieve in a single page.

Max Rows

Number

Indicates the maximum number of rows to fetch from the result set.

SQL Query Text

String

SQL query to execute.

x

Parameter Types

Array of Parameter Type

Input Parameters

Object

Auto Generate Keys

Boolean

Indicates when to make auto-generated keys available for retrieval.

false

Auto Generated Keys Column Indexes

Array of Number

List of column indexes that indicates which auto-generated keys to make available for retrieval.

Auto Generated Keys Column Names

Array of String

List of column names that indicates which auto-generated keys to make available for retrieval.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Statement Result

For Configurations

Throws

  • REDSHIFT:BAD_SQL_SYNTAX

  • REDSHIFT:CONNECTIVITY

  • REDSHIFT:QUERY_EXECUTION

  • REDSHIFT:RETRY_EXHAUSTED

Types

Pooling Profile

Field Type Description Default Value Required

Max Pool Size

Number

5

Min Pool Size

Number

0

Acquire Increment

Number

1

Prepared Statement Cache Size

Number

5

Max Wait

Number

0

Max Wait Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

SECONDS

Max Idle Time

Number

0

Additional Properties

Object

Column Type

Field Type Description Default Value Required

Id

Number

x

Type Name

String

x

Class Name

String

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Role

Field Type Description Default Value Required

Arn

String

The Amazon Resource Name (ARN) of the role to assume.

x

External Id

String

A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provides an external ID, then provide that value in this field.

Duration

Number

The duration of the role session.

3600

Duration Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Duration value.

SECONDS

Referred Policy Arns

Array of String

The Amazon Resource Names (ARNs) of the IAM-managed policies to use as managed session policies. The policies must exist in the same account as the role.

Tags

Object

A list of session tags that you want to pass. Each session tag consists of a key name and an associated value.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

SHA-256

Message Identifier

Redelivery Policy Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

The object store where the redelivery counter for each message is stored.

Redelivery Policy Message Identifier

Field Type Description Default Value Required

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if Use Secure Hash is false.

Parameter Type

Field Type Description Default Value Required

Key

String

x

Type Classifier

Type Classifier

x

Type Classifier

Field Type Description Default Value Required

Type

Enumeration, one of:

  • BIT

  • TINYINT

  • SMALLINT

  • INTEGER

  • BIGINT

  • FLOAT

  • REAL

  • DOUBLE

  • NUMERIC

  • DECIMAL

  • CHAR

  • VARCHAR

  • LONGVARCHAR

  • DATE

  • TIME

  • TIMESTAMP

  • BINARY

  • VARBINARY

  • LONGVARBINARY

  • NULL

  • OTHER

  • JAVA_OBJECT

  • DISTINCT

  • STRUCT

  • ARRAY

  • BLOB

  • CLOB

  • REF

  • DATALINK

  • BOOLEAN

  • ROWID

  • NCHAR

  • NVARCHAR

  • LONGNVARCHAR

  • NCLOB

  • SQLXML

  • UNKNOWN

Custom Type

String

Statement Result

Field Type Description Default Value Required

Affected Rows

Number

Generated Keys

Object

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Output Parameter

Field Type Description Default Value Required

Key

String

x

Type Classifier

Type Classifier

x

See Also

Back to top
View on GitHub