AWS::Pipes::Pipe PipeTargetRedshiftDataParameters - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Pipes::Pipe PipeTargetRedshiftDataParameters

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Database" : String,
  "DbUser" : String,
  "SecretManagerArn" : String,
  "Sqls" : [ String, ... ],
  "StatementName" : String,
  "WithEvent" : Boolean
}

YAML

  Database: String
  DbUser: String
  SecretManagerArn: String
  Sqls: 
    - String
  StatementName: String
  WithEvent: Boolean

Properties

Database

The name of the database. Required when authenticating using temporary credentials.

Required: Yes

Type: String

Minimum: 1

Maximum: 64

Update requires: No interruption

DbUser

The database user name. Required when authenticating using temporary credentials.

Required: No

Type: String

Minimum: 1

Maximum: 128

Update requires: No interruption

SecretManagerArn

The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets Manager.

Required: No

Type: String

Pattern: ^(^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1}):(\d{12}):secret:.+)|(\$(\.[\w/_-]+(\[(\d+|\*)\])*)*)$

Minimum: 1

Maximum: 1600

Update requires: No interruption

Sqls

The SQL statement text to run.

Required: Yes

Type: Array of String

Minimum: 1 | 1

Maximum: 100000 | 40

Update requires: No interruption

StatementName

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

Required: No

Type: String

Minimum: 1

Maximum: 500

Update requires: No interruption

WithEvent

Indicates whether to send an event back to EventBridge after the SQL statement runs.

Required: No

Type: Boolean

Update requires: No interruption