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
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classstatic final classAn implementation forCfnDeliveryStream.RedshiftDestinationConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectThe CloudWatch logging options for your Firehose stream.The connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift cluster.Configures the Amazon RedshiftCOPYcommand that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket.default StringThe password for the Amazon Redshift user that you specified in theUsernameproperty.default ObjectThe data processing configuration for the Kinesis Data Firehose delivery stream.default ObjectThe 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 ObjectThe configuration for backup in Amazon S3.default StringThe Amazon S3 backup mode.The S3 bucket where Kinesis Data Firehose first delivers data.default ObjectThe configuration that defines how you access secrets for Amazon Redshift.default StringThe 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 RedshiftCOPYcommand that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket.Returns union: either
IResolvableorCfnDeliveryStream.CopyCommandProperty- 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
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.Returns union: either
IResolvableorCfnDeliveryStream.S3DestinationConfigurationProperty- See Also:
-
getCloudWatchLoggingOptions
The CloudWatch logging options for your Firehose stream.Returns union: either
IResolvableorCfnDeliveryStream.CloudWatchLoggingOptionsProperty- See Also:
-
getPassword
The password for the Amazon Redshift user that you specified in theUsernameproperty.- See Also:
-
getProcessingConfiguration
The data processing configuration for the Kinesis Data Firehose delivery stream.Returns union: either
IResolvableorCfnDeliveryStream.ProcessingConfigurationProperty- See Also:
-
getRetryOptions
The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.Default value is 3600 (60 minutes).
Returns union: either
IResolvableorCfnDeliveryStream.RedshiftRetryOptionsProperty- See Also:
-
getS3BackupConfiguration
The configuration for backup in Amazon S3.Returns union: either
IResolvableorCfnDeliveryStream.S3DestinationConfigurationProperty- See Also:
-
getS3BackupMode
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.
- See Also:
-
getSecretsManagerConfiguration
The configuration that defines how you access secrets for Amazon Redshift.Returns union: either
IResolvableorCfnDeliveryStream.SecretsManagerConfigurationProperty- See Also:
-
getUsername
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.- See Also:
-
builder
@Stability(Stable) static CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder builder()
-