interface RedshiftDestinationConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.KinesisFirehose.CfnDeliveryStream.RedshiftDestinationConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#CfnDeliveryStream_RedshiftDestinationConfigurationProperty`
Java	`software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.RedshiftDestinationConfigurationProperty`
Python	`aws_cdk.aws_kinesisfirehose.CfnDeliveryStream.RedshiftDestinationConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_kinesisfirehose` » `CfnDeliveryStream` » `RedshiftDestinationConfigurationProperty`

The RedshiftDestinationConfiguration property type specifies an Amazon Redshift cluster to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesisfirehose as kinesisfirehose } from 'aws-cdk-lib';
const redshiftDestinationConfigurationProperty: kinesisfirehose.CfnDeliveryStream.RedshiftDestinationConfigurationProperty = {
  clusterJdbcurl: 'clusterJdbcurl',
  copyCommand: {
    dataTableName: 'dataTableName',

    // the properties below are optional
    copyOptions: 'copyOptions',
    dataTableColumns: 'dataTableColumns',
  },
  roleArn: 'roleArn',
  s3Configuration: {
    bucketArn: 'bucketArn',
    roleArn: 'roleArn',

    // the properties below are optional
    bufferingHints: {
      intervalInSeconds: 123,
      sizeInMBs: 123,
    },
    cloudWatchLoggingOptions: {
      enabled: false,
      logGroupName: 'logGroupName',
      logStreamName: 'logStreamName',
    },
    compressionFormat: 'compressionFormat',
    encryptionConfiguration: {
      kmsEncryptionConfig: {
        awskmsKeyArn: 'awskmsKeyArn',
      },
      noEncryptionConfig: 'noEncryptionConfig',
    },
    errorOutputPrefix: 'errorOutputPrefix',
    prefix: 'prefix',
  },

  // the properties below are optional
  cloudWatchLoggingOptions: {
    enabled: false,
    logGroupName: 'logGroupName',
    logStreamName: 'logStreamName',
  },
  password: 'password',
  processingConfiguration: {
    enabled: false,
    processors: [{
      type: 'type',

      // the properties below are optional
      parameters: [{
        parameterName: 'parameterName',
        parameterValue: 'parameterValue',
      }],
    }],
  },
  retryOptions: {
    durationInSeconds: 123,
  },
  s3BackupConfiguration: {
    bucketArn: 'bucketArn',
    roleArn: 'roleArn',

    // the properties below are optional
    bufferingHints: {
      intervalInSeconds: 123,
      sizeInMBs: 123,
    },
    cloudWatchLoggingOptions: {
      enabled: false,
      logGroupName: 'logGroupName',
      logStreamName: 'logStreamName',
    },
    compressionFormat: 'compressionFormat',
    encryptionConfiguration: {
      kmsEncryptionConfig: {
        awskmsKeyArn: 'awskmsKeyArn',
      },
      noEncryptionConfig: 'noEncryptionConfig',
    },
    errorOutputPrefix: 'errorOutputPrefix',
    prefix: 'prefix',
  },
  s3BackupMode: 's3BackupMode',
  secretsManagerConfiguration: {
    enabled: false,

    // the properties below are optional
    roleArn: 'roleArn',
    secretArn: 'secretArn',
  },
  username: 'username',
};

Properties

Name	Type	Description
clusterJdbcurl	`string`	The connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift cluster.
copyCommand	`IResolvable` `\|` `CopyCommandProperty`	Configures the Amazon Redshift `COPY` command that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket.
roleArn	`string`	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).
s3Configuration	`IResolvable` `\|` `S3DestinationConfigurationProperty`	The S3 bucket where Kinesis Data Firehose first delivers data.
cloudWatchLoggingOptions?	`IResolvable` `\|` `CloudWatchLoggingOptionsProperty`	The CloudWatch logging options for your Firehose stream.
password?	`string`	The password for the Amazon Redshift user that you specified in the `Username` property.
processingConfiguration?	`IResolvable` `\|` `ProcessingConfigurationProperty`	The data processing configuration for the Kinesis Data Firehose delivery stream.
retryOptions?	`IResolvable` `\|` `RedshiftRetryOptionsProperty`	The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.
s3BackupConfiguration?	`IResolvable` `\|` `S3DestinationConfigurationProperty`	The configuration for backup in Amazon S3.
s3BackupMode?	`string`	The Amazon S3 backup mode.
secretsManagerConfiguration?	`IResolvable` `\|` `SecretsManagerConfigurationProperty`	The configuration that defines how you access secrets for Amazon Redshift.
username?	`string`	The Amazon Redshift user that has permission to access the Amazon Redshift cluster.

clusterJdbcurl

Type: string

The connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift cluster.

copyCommand

Type: IResolvable | CopyCommandProperty

Configures the Amazon Redshift COPY command that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket.

roleArn

Type: string

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 .

s3Configuration

Type: IResolvable | S3DestinationConfigurationProperty

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.

cloudWatchLoggingOptions?

Type: IResolvable | CloudWatchLoggingOptionsProperty (optional)

The CloudWatch logging options for your Firehose stream.

password?

Type: string (optional)

The password for the Amazon Redshift user that you specified in the Username property.

processingConfiguration?

Type: IResolvable | ProcessingConfigurationProperty (optional)

The data processing configuration for the Kinesis Data Firehose delivery stream.

retryOptions?

Type: IResolvable | RedshiftRetryOptionsProperty (optional)

The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.

Default value is 3600 (60 minutes).

s3BackupConfiguration?

Type: IResolvable | S3DestinationConfigurationProperty (optional)

The configuration for backup in Amazon S3.

s3BackupMode?

Type: string (optional)

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.

secretsManagerConfiguration?

Type: IResolvable | SecretsManagerConfigurationProperty (optional)

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

username?

Type: string (optional)

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.