RedshiftDestinationConfiguration
Describes the configuration of 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\.([a-zA-Z0-9\.]+):\d{1,5}/[a-zA-Z0-9_$-]+
Required: Yes
- CopyCommand
-
The
COPY
command.Type: CopyCommand object
Required: Yes
- Password
-
The user password.
Type: String
Length Constraints: Minimum length of 6. Maximum length of 512.
Pattern:
.*
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:.*
Required: Yes
- S3Configuration
-
The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.
The compression formats
SNAPPY
orZIP
cannot be specified inRedshiftDestinationConfiguration.S3Configuration
because the Amazon RedshiftCOPY
operation that reads from the S3 bucket doesn't support these compression formats.Type: S3DestinationConfiguration object
Required: Yes
- Username
-
The name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
.*
Required: Yes
- CloudWatchLoggingOptions
-
The CloudWatch logging options for your delivery stream.
Type: CloudWatchLoggingOptions object
Required: No
- ProcessingConfiguration
-
The data processing configuration.
Type: ProcessingConfiguration object
Required: No
- RetryOptions
-
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
Type: RedshiftRetryOptions object
Required: No
- S3BackupConfiguration
-
The configuration for backup in Amazon S3.
Type: S3DestinationConfiguration object
Required: No
- S3BackupMode
-
The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
Type: String
Valid Values:
Disabled | Enabled
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: