aws-cdk-lib.aws_kinesisfirehose.CfnDeliveryStream.RedshiftDestinationConfigurationProperty

interface RedshiftDestinationConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.KinesisFirehose.CfnDeliveryStream.RedshiftDestinationConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#CfnDeliveryStream_RedshiftDestinationConfigurationProperty
Javasoftware.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.RedshiftDestinationConfigurationProperty
Pythonaws_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',
  },
  password: 'password',
  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',
  },
  username: 'username',

  // the properties below are optional
  cloudWatchLoggingOptions: {
    enabled: false,
    logGroupName: 'logGroupName',
    logStreamName: 'logStreamName',
  },
  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',
};

Properties

NameTypeDescription
clusterJdbcurlstringThe connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift cluster.
copyCommandIResolvable | CopyCommandPropertyConfigures the Amazon Redshift COPY command that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket.
passwordstringThe password for the Amazon Redshift user that you specified in the Username property.
roleArnstringThe 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).
s3ConfigurationIResolvable | S3DestinationConfigurationPropertyThe S3 bucket where Kinesis Data Firehose first delivers data.
usernamestringThe Amazon Redshift user that has permission to access the Amazon Redshift cluster.
cloudWatchLoggingOptions?IResolvable | CloudWatchLoggingOptionsPropertyThe CloudWatch logging options for your delivery stream.
processingConfiguration?IResolvable | ProcessingConfigurationPropertyThe data processing configuration for the Kinesis Data Firehose delivery stream.
retryOptions?IResolvable | RedshiftRetryOptionsPropertyThe retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.
s3BackupConfiguration?IResolvable | S3DestinationConfigurationPropertyThe configuration for backup in Amazon S3.
s3BackupMode?stringThe Amazon S3 backup mode.

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.


password

Type: string

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


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.


username

Type: string

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.


cloudWatchLoggingOptions?

Type: IResolvable | CloudWatchLoggingOptionsProperty (optional)

The CloudWatch logging options for your delivery stream.


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 Kinesis Data 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 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.