Interface RedshiftDestinationConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RedshiftDestinationConfiguration.Builder,RedshiftDestinationConfiguration>, SdkBuilder<RedshiftDestinationConfiguration.Builder,RedshiftDestinationConfiguration>, SdkPojo

Enclosing class:

RedshiftDestinationConfiguration

@Mutable
@NotThreadSafe
public static interface RedshiftDestinationConfiguration.Builder
extends SdkPojo, CopyableBuilder<RedshiftDestinationConfiguration.Builder,RedshiftDestinationConfiguration>

Method Summary

Modifier and Type	Method	Description
default RedshiftDestinationConfiguration.Builder	cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)	The CloudWatch logging options for your Firehose stream.
RedshiftDestinationConfiguration.Builder	cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)	The CloudWatch logging options for your Firehose stream.
RedshiftDestinationConfiguration.Builder	clusterJDBCURL(String clusterJDBCURL)	The database connection string.
default RedshiftDestinationConfiguration.Builder	copyCommand(Consumer<CopyCommand.Builder> copyCommand)	The COPY command.
RedshiftDestinationConfiguration.Builder	copyCommand(CopyCommand copyCommand)	The COPY command.
RedshiftDestinationConfiguration.Builder	password(String password)	The user password.
default RedshiftDestinationConfiguration.Builder	processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)	The data processing configuration.
RedshiftDestinationConfiguration.Builder	processingConfiguration(ProcessingConfiguration processingConfiguration)	The data processing configuration.
default RedshiftDestinationConfiguration.Builder	retryOptions(Consumer<RedshiftRetryOptions.Builder> retryOptions)	The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.
RedshiftDestinationConfiguration.Builder	retryOptions(RedshiftRetryOptions retryOptions)	The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.
RedshiftDestinationConfiguration.Builder	roleARN(String roleARN)	The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
default RedshiftDestinationConfiguration.Builder	s3BackupConfiguration(Consumer<S3DestinationConfiguration.Builder> s3BackupConfiguration)	The configuration for backup in Amazon S3.
RedshiftDestinationConfiguration.Builder	s3BackupConfiguration(S3DestinationConfiguration s3BackupConfiguration)	The configuration for backup in Amazon S3.
RedshiftDestinationConfiguration.Builder	s3BackupMode(String s3BackupMode)	The Amazon S3 backup mode.
RedshiftDestinationConfiguration.Builder	s3BackupMode(RedshiftS3BackupMode s3BackupMode)	The Amazon S3 backup mode.
default RedshiftDestinationConfiguration.Builder	s3Configuration(Consumer<S3DestinationConfiguration.Builder> s3Configuration)	The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data.
RedshiftDestinationConfiguration.Builder	s3Configuration(S3DestinationConfiguration s3Configuration)	The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data.
default RedshiftDestinationConfiguration.Builder	secretsManagerConfiguration(Consumer<SecretsManagerConfiguration.Builder> secretsManagerConfiguration)	The configuration that defines how you access secrets for Amazon Redshift.
RedshiftDestinationConfiguration.Builder	secretsManagerConfiguration(SecretsManagerConfiguration secretsManagerConfiguration)	The configuration that defines how you access secrets for Amazon Redshift.
RedshiftDestinationConfiguration.Builder	username(String username)	The name of the user.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

roleARN

RedshiftDestinationConfiguration.Builder roleARN(String roleARN)

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Parameters:

roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Returns:

Returns a reference to this object so that method calls can be chained together.

clusterJDBCURL

RedshiftDestinationConfiguration.Builder clusterJDBCURL(String clusterJDBCURL)

The database connection string.

Parameters:

clusterJDBCURL - The database connection string.

Returns:

Returns a reference to this object so that method calls can be chained together.

copyCommand

RedshiftDestinationConfiguration.Builder copyCommand(CopyCommand copyCommand)

The COPY command.

Parameters:

copyCommand - The COPY command.

Returns:

Returns a reference to this object so that method calls can be chained together.

copyCommand

default RedshiftDestinationConfiguration.Builder copyCommand(Consumer<CopyCommand.Builder> copyCommand)

The COPY command.

This is a convenience method that creates an instance of the CopyCommand.Builder avoiding the need to create one manually via CopyCommand.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to copyCommand(CopyCommand).

Parameters:

copyCommand - a consumer that will call methods on CopyCommand.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• copyCommand(CopyCommand)

username

RedshiftDestinationConfiguration.Builder username(String username)

The name of the user.

Parameters:

username - The name of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

password

RedshiftDestinationConfiguration.Builder password(String password)

The user password.

Parameters:

password - The user password.

Returns:

Returns a reference to this object so that method calls can be chained together.

retryOptions

RedshiftDestinationConfiguration.Builder retryOptions(RedshiftRetryOptions retryOptions)

The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

Parameters:

retryOptions - The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

Returns:

Returns a reference to this object so that method calls can be chained together.

retryOptions

default RedshiftDestinationConfiguration.Builder retryOptions(Consumer<RedshiftRetryOptions.Builder> retryOptions)

The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

This is a convenience method that creates an instance of the RedshiftRetryOptions.Builder avoiding the need to create one manually via RedshiftRetryOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retryOptions(RedshiftRetryOptions).

Parameters:

retryOptions - a consumer that will call methods on RedshiftRetryOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• retryOptions(RedshiftRetryOptions)

s3Configuration

RedshiftDestinationConfiguration.Builder s3Configuration(S3DestinationConfiguration s3Configuration)

The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.

The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

Parameters:

s3Configuration - The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.

The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

Returns:

Returns a reference to this object so that method calls can be chained together.

s3Configuration

default RedshiftDestinationConfiguration.Builder s3Configuration(Consumer<S3DestinationConfiguration.Builder> s3Configuration)

The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.

The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

This is a convenience method that creates an instance of the S3DestinationConfiguration.Builder avoiding the need to create one manually via S3DestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3Configuration(S3DestinationConfiguration).

Parameters:

s3Configuration - a consumer that will call methods on S3DestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• s3Configuration(S3DestinationConfiguration)

processingConfiguration

RedshiftDestinationConfiguration.Builder processingConfiguration(ProcessingConfiguration processingConfiguration)

The data processing configuration.

Parameters:

processingConfiguration - The data processing configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

processingConfiguration

default RedshiftDestinationConfiguration.Builder processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)

The data processing configuration.

This is a convenience method that creates an instance of the ProcessingConfiguration.Builder avoiding the need to create one manually via ProcessingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to processingConfiguration(ProcessingConfiguration).

Parameters:

processingConfiguration - a consumer that will call methods on ProcessingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• processingConfiguration(ProcessingConfiguration)

s3BackupMode

RedshiftDestinationConfiguration.Builder s3BackupMode(String 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.

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

• RedshiftS3BackupMode
• RedshiftS3BackupMode

s3BackupMode

RedshiftDestinationConfiguration.Builder s3BackupMode(RedshiftS3BackupMode 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.

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

• RedshiftS3BackupMode
• RedshiftS3BackupMode

s3BackupConfiguration

RedshiftDestinationConfiguration.Builder s3BackupConfiguration(S3DestinationConfiguration s3BackupConfiguration)

The configuration for backup in Amazon S3.

Parameters:

s3BackupConfiguration - The configuration for backup in Amazon S3.

Returns:

Returns a reference to this object so that method calls can be chained together.

s3BackupConfiguration

default RedshiftDestinationConfiguration.Builder s3BackupConfiguration(Consumer<S3DestinationConfiguration.Builder> s3BackupConfiguration)

The configuration for backup in Amazon S3.

This is a convenience method that creates an instance of the S3DestinationConfiguration.Builder avoiding the need to create one manually via S3DestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3BackupConfiguration(S3DestinationConfiguration).

Parameters:

s3BackupConfiguration - a consumer that will call methods on S3DestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• s3BackupConfiguration(S3DestinationConfiguration)

cloudWatchLoggingOptions

RedshiftDestinationConfiguration.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)

The CloudWatch logging options for your Firehose stream.

Parameters:

cloudWatchLoggingOptions - The CloudWatch logging options for your Firehose stream.

Returns:

Returns a reference to this object so that method calls can be chained together.

cloudWatchLoggingOptions

default RedshiftDestinationConfiguration.Builder cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)

The CloudWatch logging options for your Firehose stream.

This is a convenience method that creates an instance of the CloudWatchLoggingOptions.Builder avoiding the need to create one manually via CloudWatchLoggingOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudWatchLoggingOptions(CloudWatchLoggingOptions).

Parameters:

cloudWatchLoggingOptions - a consumer that will call methods on CloudWatchLoggingOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• cloudWatchLoggingOptions(CloudWatchLoggingOptions)

secretsManagerConfiguration

RedshiftDestinationConfiguration.Builder secretsManagerConfiguration(SecretsManagerConfiguration secretsManagerConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

secretsManagerConfiguration

default RedshiftDestinationConfiguration.Builder secretsManagerConfiguration(Consumer<SecretsManagerConfiguration.Builder> secretsManagerConfiguration)

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

This is a convenience method that creates an instance of the SecretsManagerConfiguration.Builder avoiding the need to create one manually via SecretsManagerConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to secretsManagerConfiguration(SecretsManagerConfiguration).

Parameters:

secretsManagerConfiguration - a consumer that will call methods on SecretsManagerConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• secretsManagerConfiguration(SecretsManagerConfiguration)