software.amazon.awssdk.services.firehose.model

Class RedshiftDestinationConfiguration

java.lang.Object

software.amazon.awssdk.services.firehose.model.RedshiftDestinationConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RedshiftDestinationConfiguration.Builder,RedshiftDestinationConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class RedshiftDestinationConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RedshiftDestinationConfiguration.Builder,RedshiftDestinationConfiguration>

Describes the configuration of a destination in Amazon Redshift.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RedshiftDestinationConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static RedshiftDestinationConfiguration.Builder	builder()
CloudWatchLoggingOptions	cloudWatchLoggingOptions() The CloudWatch logging options for your delivery stream.
String	clusterJDBCURL() The database connection string.
CopyCommand	copyCommand() The COPY command.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	password() The user password.
ProcessingConfiguration	processingConfiguration() The data processing configuration.
RedshiftRetryOptions	retryOptions() The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.
String	roleARN() The Amazon Resource Name (ARN) of the AWS credentials.
S3DestinationConfiguration	s3BackupConfiguration() The configuration for backup in Amazon S3.
RedshiftS3BackupMode	s3BackupMode() The Amazon S3 backup mode.
String	s3BackupModeAsString() The Amazon S3 backup mode.
S3DestinationConfiguration	s3Configuration() The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data.
List<SdkField<?>>	sdkFields()
static Class<? extends RedshiftDestinationConfiguration.Builder>	serializableBuilderClass()
RedshiftDestinationConfiguration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	username() The name of the user.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

roleARN

public String roleARN()

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

Returns:

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

clusterJDBCURL

public String clusterJDBCURL()

The database connection string.

Returns:

The database connection string.

copyCommand

public CopyCommand copyCommand()

The COPY command.

Returns:

The COPY command.

username

public String username()

The name of the user.

Returns:

The name of the user.

password

public String password()

The user password.

Returns:

The user password.

retryOptions

public RedshiftRetryOptions retryOptions()

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

Returns:

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

s3Configuration

public 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.

Returns:

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.

processingConfiguration

public ProcessingConfiguration processingConfiguration()

The data processing configuration.

Returns:

The data processing configuration.

s3BackupMode

public RedshiftS3BackupMode s3BackupMode()

The Amazon S3 backup mode.

If the service returns an enum value that is not available in the current SDK version, s3BackupMode will return RedshiftS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().

Returns:

The Amazon S3 backup mode.

See Also:

RedshiftS3BackupMode

s3BackupModeAsString

public String s3BackupModeAsString()

The Amazon S3 backup mode.

If the service returns an enum value that is not available in the current SDK version, s3BackupMode will return RedshiftS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().

Returns:

The Amazon S3 backup mode.

See Also:

RedshiftS3BackupMode

s3BackupConfiguration

public S3DestinationConfiguration s3BackupConfiguration()

The configuration for backup in Amazon S3.

Returns:

The configuration for backup in Amazon S3.

cloudWatchLoggingOptions

public CloudWatchLoggingOptions cloudWatchLoggingOptions()

The CloudWatch logging options for your delivery stream.

Returns:

The CloudWatch logging options for your delivery stream.

toBuilder

public RedshiftDestinationConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RedshiftDestinationConfiguration.Builder,RedshiftDestinationConfiguration>

Returns:

a builder for type T

builder

public static RedshiftDestinationConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends RedshiftDestinationConfiguration.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.