RedshiftDataParameters
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
Contents
- Database
-
The name of the database. Required when authenticating using temporary credentials.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
- DbUser
-
The database user name. Required when authenticating using temporary credentials.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- SecretManagerArn
-
The name or ARN of the secret that enables access to the database. Required when authenticating using AWS Secrets Manager.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
(^arn:aws([a-z]|\-)*:secretsmanager:[a-z0-9-.]+:.*)|(\$(\.[\w_-]+(\[(\d+|\*)\])*)*)Required: No
- Sql
-
The SQL statement text to run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
Required: No
- Sqls
-
One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 40 items.
Length Constraints: Minimum length of 1. Maximum length of 100000.
Required: No
- StatementName
-
The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: No
- WithEvent
-
Indicates whether to send an event back to EventBridge after the SQL statement runs.
Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
