Amazon EventBridge Pipes · Schema
PipeTargetRedshiftDataParameters
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.
Amazon Web ServicesEvent-DrivenIntegrationMessagingServerless
Properties
| Name | Type | Description |
|---|---|---|
| Database | object | |
| DbUser | object | |
| SecretManagerArn | object | |
| Sqls | object | |
| StatementName | object | |
| WithEvent | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-eventbridge-pipes/refs/heads/main/json-schema/amazon-eventbridge-pipes-pipe-target-redshift-data-parameters-schema.json",
"title": "PipeTargetRedshiftDataParameters",
"description": "These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement.",
"type": "object",
"properties": {
"Database": {
"allOf": [
{
"$ref": "#/components/schemas/Database"
},
{
"description": "The name of the database. Required when authenticating using temporary credentials."
}
]
},
"DbUser": {
"allOf": [
{
"$ref": "#/components/schemas/DbUser"
},
{
"description": "The database user name. Required when authenticating using temporary credentials."
}
]
},
"SecretManagerArn": {
"allOf": [
{
"$ref": "#/components/schemas/SecretManagerArnOrJsonPath"
},
{
"description": "The name or ARN of the secret that enables access to the database. Required when authenticating using SageMaker."
}
]
},
"Sqls": {
"allOf": [
{
"$ref": "#/components/schemas/Sqls"
},
{
"description": "The SQL statement text to run."
}
]
},
"StatementName": {
"allOf": [
{
"$ref": "#/components/schemas/StatementName"
},
{
"description": "The name of the SQL statement. You can name the SQL statement when you create it to identify the query."
}
]
},
"WithEvent": {
"allOf": [
{
"$ref": "#/components/schemas/Boolean"
},
{
"description": "Indicates whether to send an event back to EventBridge after the SQL statement runs."
}
]
}
},
"required": [
"Database",
"Sqls"
]
}