Interface CfnDeliveryStream.RedshiftDestinationConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnDeliveryStream
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 software.amazon.awscdk.services.kinesisfirehose.*; RedshiftDestinationConfigurationProperty redshiftDestinationConfigurationProperty = RedshiftDestinationConfigurationProperty.builder() .clusterJdbcurl("clusterJdbcurl") .copyCommand(CopyCommandProperty.builder() .dataTableName("dataTableName") // the properties below are optional .copyOptions("copyOptions") .dataTableColumns("dataTableColumns") .build()) .roleArn("roleArn") .s3Configuration(S3DestinationConfigurationProperty.builder() .bucketArn("bucketArn") .roleArn("roleArn") // the properties below are optional .bufferingHints(BufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .compressionFormat("compressionFormat") .encryptionConfiguration(EncryptionConfigurationProperty.builder() .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder() .awskmsKeyArn("awskmsKeyArn") .build()) .noEncryptionConfig("noEncryptionConfig") .build()) .errorOutputPrefix("errorOutputPrefix") .prefix("prefix") .build()) // the properties below are optional .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .password("password") .processingConfiguration(ProcessingConfigurationProperty.builder() .enabled(false) .processors(List.of(ProcessorProperty.builder() .type("type") // the properties below are optional .parameters(List.of(ProcessorParameterProperty.builder() .parameterName("parameterName") .parameterValue("parameterValue") .build())) .build())) .build()) .retryOptions(RedshiftRetryOptionsProperty.builder() .durationInSeconds(123) .build()) .s3BackupConfiguration(S3DestinationConfigurationProperty.builder() .bucketArn("bucketArn") .roleArn("roleArn") // the properties below are optional .bufferingHints(BufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .compressionFormat("compressionFormat") .encryptionConfiguration(EncryptionConfigurationProperty.builder() .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder() .awskmsKeyArn("awskmsKeyArn") .build()) .noEncryptionConfig("noEncryptionConfig") .build()) .errorOutputPrefix("errorOutputPrefix") .prefix("prefix") .build()) .s3BackupMode("s3BackupMode") .secretsManagerConfiguration(SecretsManagerConfigurationProperty.builder() .enabled(false) // the properties below are optional .roleArn("roleArn") .secretArn("secretArn") .build()) .username("username") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
static final class
An implementation forCfnDeliveryStream.RedshiftDestinationConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The CloudWatch logging options for your delivery stream.The connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift cluster.Configures the Amazon RedshiftCOPY
command that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket.default String
The password for the Amazon Redshift user that you specified in theUsername
property.default Object
The data processing configuration for the Kinesis Data Firehose delivery stream.default Object
The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.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).default Object
The configuration for backup in Amazon S3.default String
The Amazon S3 backup mode.The S3 bucket where Kinesis Data Firehose first delivers data.default Object
The configuration that defines how you access secrets for Amazon Redshift.default String
The Amazon Redshift user that has permission to access the Amazon Redshift cluster.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getClusterJdbcurl
The connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift cluster.- See Also:
-
getCopyCommand
Configures the Amazon RedshiftCOPY
command that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket.- See Also:
-
getRoleArn
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 .
- See Also:
-
getS3Configuration
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 specifySNAPPY
orZIP
because the Amazon RedshiftCOPY
command doesn't support them.- See Also:
-
getCloudWatchLoggingOptions
The CloudWatch logging options for your delivery stream.- See Also:
-
getPassword
The password for the Amazon Redshift user that you specified in theUsername
property.- See Also:
-
getProcessingConfiguration
The data processing configuration for the Kinesis Data Firehose delivery stream.- See Also:
-
getRetryOptions
The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.Default value is 3600 (60 minutes).
- See Also:
-
getS3BackupConfiguration
The configuration for backup in Amazon S3.- See Also:
-
getS3BackupMode
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.
- See Also:
-
getSecretsManagerConfiguration
The configuration that defines how you access secrets for Amazon Redshift.- See Also:
-
getUsername
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.- See Also:
-
builder
@Stability(Stable) static CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder builder()
-