Amazon EventBridge Pipes · JSON Structure

Amazon Eventbridge Pipes Pipe Target Redshift Data Parameters Structure

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: 6 Required: 2
Amazon Web ServicesEvent-DrivenIntegrationMessagingServerless

PipeTargetRedshiftDataParameters is a JSON Structure definition published by Amazon EventBridge Pipes, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Database DbUser SecretManagerArn Sqls StatementName WithEvent

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-eventbridge-pipes/refs/heads/main/json-structure/amazon-eventbridge-pipes-pipe-target-redshift-data-parameters-structure.json",
  "name": "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"
  ]
}