Class CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder
java.lang.Object
software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDeliveryStream.RedshiftDestinationConfigurationProperty>
- Enclosing interface:
CfnDeliveryStream.RedshiftDestinationConfigurationProperty
@Stability(Stable)
public static final class CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDeliveryStream.RedshiftDestinationConfigurationProperty>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.cloudWatchLoggingOptions
(IResolvable cloudWatchLoggingOptions) cloudWatchLoggingOptions
(CfnDeliveryStream.CloudWatchLoggingOptionsProperty cloudWatchLoggingOptions) clusterJdbcurl
(String clusterJdbcurl) copyCommand
(IResolvable copyCommand) copyCommand
(CfnDeliveryStream.CopyCommandProperty copyCommand) Sets the value ofCfnDeliveryStream.RedshiftDestinationConfigurationProperty.getPassword()
processingConfiguration
(IResolvable processingConfiguration) processingConfiguration
(CfnDeliveryStream.ProcessingConfigurationProperty processingConfiguration) retryOptions
(IResolvable retryOptions) retryOptions
(CfnDeliveryStream.RedshiftRetryOptionsProperty retryOptions) Sets the value ofCfnDeliveryStream.RedshiftDestinationConfigurationProperty.getRoleArn()
s3BackupConfiguration
(IResolvable s3BackupConfiguration) s3BackupConfiguration
(CfnDeliveryStream.S3DestinationConfigurationProperty s3BackupConfiguration) s3BackupMode
(String s3BackupMode) s3Configuration
(IResolvable s3Configuration) s3Configuration
(CfnDeliveryStream.S3DestinationConfigurationProperty s3Configuration) secretsManagerConfiguration
(IResolvable secretsManagerConfiguration) secretsManagerConfiguration
(CfnDeliveryStream.SecretsManagerConfigurationProperty secretsManagerConfiguration) Sets the value ofCfnDeliveryStream.RedshiftDestinationConfigurationProperty.getUsername()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
clusterJdbcurl
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder clusterJdbcurl(String clusterJdbcurl) - Parameters:
clusterJdbcurl
- The connection string that Kinesis Data Firehose uses to connect to the Amazon Redshift cluster. This parameter is required.- Returns:
this
-
copyCommand
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder copyCommand(IResolvable copyCommand) - Parameters:
copyCommand
- Configures the Amazon RedshiftCOPY
command that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket. This parameter is required.- Returns:
this
-
copyCommand
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder copyCommand(CfnDeliveryStream.CopyCommandProperty copyCommand) - Parameters:
copyCommand
- Configures the Amazon RedshiftCOPY
command that Kinesis Data Firehose uses to load data into the cluster from the Amazon S3 bucket. This parameter is required.- Returns:
this
-
roleArn
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder roleArn(String roleArn) Sets the value ofCfnDeliveryStream.RedshiftDestinationConfigurationProperty.getRoleArn()
- Parameters:
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). This parameter is required. For more information, see Grant Kinesis Data Firehose Access to an Amazon Redshift Destination in the Amazon Kinesis Data Firehose Developer Guide .- Returns:
this
-
s3Configuration
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder s3Configuration(IResolvable s3Configuration) - Parameters:
s3Configuration
- The S3 bucket where Kinesis Data Firehose first delivers data. This parameter is required. After the data is in the bucket, Kinesis Data Firehose uses theCOPY
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.- Returns:
this
-
s3Configuration
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder s3Configuration(CfnDeliveryStream.S3DestinationConfigurationProperty s3Configuration) - Parameters:
s3Configuration
- The S3 bucket where Kinesis Data Firehose first delivers data. This parameter is required. After the data is in the bucket, Kinesis Data Firehose uses theCOPY
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.- Returns:
this
-
cloudWatchLoggingOptions
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder cloudWatchLoggingOptions(IResolvable cloudWatchLoggingOptions) Sets the value ofCfnDeliveryStream.RedshiftDestinationConfigurationProperty.getCloudWatchLoggingOptions()
- Parameters:
cloudWatchLoggingOptions
- The CloudWatch logging options for your Firehose stream.- Returns:
this
-
cloudWatchLoggingOptions
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder cloudWatchLoggingOptions(CfnDeliveryStream.CloudWatchLoggingOptionsProperty cloudWatchLoggingOptions) Sets the value ofCfnDeliveryStream.RedshiftDestinationConfigurationProperty.getCloudWatchLoggingOptions()
- Parameters:
cloudWatchLoggingOptions
- The CloudWatch logging options for your Firehose stream.- Returns:
this
-
password
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder password(String password) Sets the value ofCfnDeliveryStream.RedshiftDestinationConfigurationProperty.getPassword()
- Parameters:
password
- The password for the Amazon Redshift user that you specified in theUsername
property.- Returns:
this
-
processingConfiguration
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder processingConfiguration(IResolvable processingConfiguration) Sets the value ofCfnDeliveryStream.RedshiftDestinationConfigurationProperty.getProcessingConfiguration()
- Parameters:
processingConfiguration
- The data processing configuration for the Kinesis Data Firehose delivery stream.- Returns:
this
-
processingConfiguration
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder processingConfiguration(CfnDeliveryStream.ProcessingConfigurationProperty processingConfiguration) Sets the value ofCfnDeliveryStream.RedshiftDestinationConfigurationProperty.getProcessingConfiguration()
- Parameters:
processingConfiguration
- The data processing configuration for the Kinesis Data Firehose delivery stream.- Returns:
this
-
retryOptions
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder retryOptions(IResolvable retryOptions) - Parameters:
retryOptions
- The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).- Returns:
this
-
retryOptions
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder retryOptions(CfnDeliveryStream.RedshiftRetryOptionsProperty retryOptions) - Parameters:
retryOptions
- The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).- Returns:
this
-
s3BackupConfiguration
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder s3BackupConfiguration(IResolvable s3BackupConfiguration) Sets the value ofCfnDeliveryStream.RedshiftDestinationConfigurationProperty.getS3BackupConfiguration()
- Parameters:
s3BackupConfiguration
- The configuration for backup in Amazon S3.- Returns:
this
-
s3BackupConfiguration
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder s3BackupConfiguration(CfnDeliveryStream.S3DestinationConfigurationProperty s3BackupConfiguration) Sets the value ofCfnDeliveryStream.RedshiftDestinationConfigurationProperty.getS3BackupConfiguration()
- Parameters:
s3BackupConfiguration
- The configuration for backup in Amazon S3.- Returns:
this
-
s3BackupMode
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder s3BackupMode(String s3BackupMode) - Parameters:
s3BackupMode
- 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.- Returns:
this
-
secretsManagerConfiguration
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder secretsManagerConfiguration(IResolvable secretsManagerConfiguration) Sets the value ofCfnDeliveryStream.RedshiftDestinationConfigurationProperty.getSecretsManagerConfiguration()
- Parameters:
secretsManagerConfiguration
- The configuration that defines how you access secrets for Amazon Redshift.- Returns:
this
-
secretsManagerConfiguration
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder secretsManagerConfiguration(CfnDeliveryStream.SecretsManagerConfigurationProperty secretsManagerConfiguration) Sets the value ofCfnDeliveryStream.RedshiftDestinationConfigurationProperty.getSecretsManagerConfiguration()
- Parameters:
secretsManagerConfiguration
- The configuration that defines how you access secrets for Amazon Redshift.- Returns:
this
-
username
@Stability(Stable) public CfnDeliveryStream.RedshiftDestinationConfigurationProperty.Builder username(String username) Sets the value ofCfnDeliveryStream.RedshiftDestinationConfigurationProperty.getUsername()
- Parameters:
username
- The Amazon Redshift user that has permission to access the Amazon Redshift cluster. This user must haveINSERT
privileges for copying data from the Amazon S3 bucket to the cluster.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDeliveryStream.RedshiftDestinationConfigurationProperty>
- Returns:
- a new instance of
CfnDeliveryStream.RedshiftDestinationConfigurationProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-