AWS::KinesisFirehose::DeliveryStream RedshiftDestinationConfiguration - AWS CloudFormation

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:

Properties

CloudWatchLoggingOptions

The CloudWatch logging options for your delivery 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: 1

Maximum: 512

Update requires: No interruption

CopyCommand

Configures the Amazon Redshift COPY command 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 Username property.

Required: Yes

Type: String

Minimum: 6

Maximum: 512

Update 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: 1

Maximum: 512

Update 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 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.

Required: No

Type: String

Allowed values: Disabled | Enabled

Update 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 COPY command to load the data into the Amazon Redshift cluster. For the Amazon S3 bucket's compression format, don't specify SNAPPY or ZIP because the Amazon Redshift COPY command doesn't support them.

Required: Yes

Type: S3DestinationConfiguration

Update requires: No interruption

Username

The Amazon Redshift user that has permission to access the Amazon Redshift cluster. This user must have INSERT privileges for copying data from the Amazon S3 bucket to the cluster.

Required: Yes

Type: String

Minimum: 1

Maximum: 512

Update requires: No interruption