RedshiftDestinationDescription - Amazon Data Firehose
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

RedshiftDestinationDescription

Describes a destination in Amazon Redshift.

Contents

ClusterJDBCURL

The database connection string.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: jdbc:(redshift|postgresql)://((?!-)[A-Za-z0-9-]{1,63}(?<!-)\.)+(redshift(-serverless)?)\.([a-zA-Z0-9\.\-]+):\d{1,5}/[a-zA-Z0-9_$-]+

Required: Yes

CopyCommand

The COPY command.

Type: CopyCommand object

Required: Yes

RoleARN

The Amazon Resource Name (ARN) of the Amazon credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: arn:.*:iam::\d{12}:role/[a-zA-Z_0-9+=,.@\-_/]+

Required: Yes

S3DestinationDescription

The Amazon S3 destination.

Type: S3DestinationDescription object

Required: Yes

CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your Firehose stream.

Type: CloudWatchLoggingOptions object

Required: No

ProcessingConfiguration

The data processing configuration.

Type: ProcessingConfiguration object

Required: No

RetryOptions

The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

Type: RedshiftRetryOptions object

Required: No

S3BackupDescription

The configuration for backup in Amazon S3.

Type: S3DestinationDescription object

Required: No

S3BackupMode

The Amazon S3 backup mode.

Type: String

Valid Values: Disabled | Enabled

Required: No

SecretsManagerConfiguration

The configuration that defines how you access secrets for Amazon Redshift.

Type: SecretsManagerConfiguration object

Required: No

Username

The name of the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: .*

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: