AWS::KinesisFirehose::DeliveryStream RedshiftDestinationConfiguration
The RedshiftDestinationConfiguration property type specifies an Amazon
Redshift cluster to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers
data.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "CloudWatchLoggingOptions" :CloudWatchLoggingOptions, "ClusterJDBCURL" :String, "CopyCommand" :CopyCommand, "Password" :String, "ProcessingConfiguration" :ProcessingConfiguration, "RetryOptions" :RedshiftRetryOptions, "RoleARN" :String, "S3BackupConfiguration" :S3DestinationConfiguration, "S3BackupMode" :String, "S3Configuration" :S3DestinationConfiguration, "SecretsManagerConfiguration" :SecretsManagerConfiguration, "Username" :String}
YAML
CloudWatchLoggingOptions:CloudWatchLoggingOptionsClusterJDBCURL:StringCopyCommand:CopyCommandPassword:StringProcessingConfiguration:ProcessingConfigurationRetryOptions:RedshiftRetryOptionsRoleARN:StringS3BackupConfiguration:S3DestinationConfigurationS3BackupMode:StringS3Configuration:S3DestinationConfigurationSecretsManagerConfiguration:SecretsManagerConfigurationUsername:String
Properties
CloudWatchLoggingOptions-
The CloudWatch logging options for your Firehose stream.
Required: No
Type: CloudWatchLoggingOptions
Update requires: No interruption
ClusterJDBCURL-
The connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift cluster.
Required: Yes
Type: String
Minimum:
1Maximum:
512Update requires: No interruption
CopyCommand-
Configures the Amazon Redshift
COPYcommand that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket.Required: Yes
Type: CopyCommand
Update requires: No interruption
Password-
The password for the Amazon Redshift user that you specified in the
Usernameproperty.Required: No
Type: String
Minimum:
6Maximum:
512Update requires: No interruption
ProcessingConfiguration-
The data processing configuration for the Kinesis Data Firehose delivery stream.
Required: No
Type: ProcessingConfiguration
Update requires: No interruption
RetryOptions-
The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
Required: No
Type: RedshiftRetryOptions
Update requires: No interruption
RoleARN-
The ARN of the AWS Identity and Access Management (IAM) role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you enable data encryption). For more information, see Grant Kinesis Data Firehose Access to an Amazon Redshift Destination in the Amazon Kinesis Data Firehose Developer Guide.
Required: Yes
Type: String
Pattern:
arn:.*Minimum:
1Maximum:
512Update requires: No interruption
S3BackupConfiguration-
The configuration for backup in Amazon S3.
Required: No
Type: S3DestinationConfiguration
Update requires: No interruption
S3BackupMode-
The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.
Required: No
Type: String
Allowed values:
Disabled | EnabledUpdate requires: No interruption
S3Configuration-
The S3 bucket where Kinesis Data Firehose first delivers data. After the data is in the bucket, Kinesis Data Firehose uses the
COPYcommand to load the data into the Amazon Redshift cluster. For the Amazon S3 bucket's compression format, don't specifySNAPPYorZIPbecause the Amazon RedshiftCOPYcommand doesn't support them.Required: Yes
Type: S3DestinationConfiguration
Update requires: No interruption
SecretsManagerConfiguration-
The configuration that defines how you access secrets for Amazon Redshift.
Required: No
Type: SecretsManagerConfiguration
Update requires: No interruption
Username-
The Amazon Redshift user that has permission to access the Amazon Redshift cluster. This user must have
INSERTprivileges for copying data from the Amazon S3 bucket to the cluster.Required: No
Type: String
Minimum:
1Maximum:
512Update requires: No interruption
