Class RedshiftDestinationConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.firehose.model.RedshiftDestinationConfiguration
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RedshiftDestinationConfiguration.Builder,RedshiftDestinationConfiguration>
@Generated("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 Description static interface
RedshiftDestinationConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RedshiftDestinationConfiguration.Builder
builder()
CloudWatchLoggingOptions
cloudWatchLoggingOptions()
The CloudWatch logging options for your delivery stream.String
clusterJDBCURL()
The database connection string.CopyCommand
copyCommand()
TheCOPY
command.boolean
equals(Object obj)
boolean
equalsBySdkFields(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 Firehose is unable to deliver documents to Amazon Redshift.String
roleARN()
The Amazon Resource Name (ARN) of the Amazon Web Services 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()
SecretsManagerConfiguration
secretsManagerConfiguration()
The configuration that defines how you access secrets for Amazon Redshift.static Class<? extends RedshiftDestinationConfiguration.Builder>
serializableBuilderClass()
RedshiftDestinationConfiguration.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
username()
The name of the user.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
roleARN
public final 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.
- Returns:
- 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.
-
clusterJDBCURL
public final String clusterJDBCURL()
The database connection string.
- Returns:
- The database connection string.
-
copyCommand
public final CopyCommand copyCommand()
The
COPY
command.- Returns:
- The
COPY
command.
-
username
public final String username()
The name of the user.
- Returns:
- The name of the user.
-
password
public final String password()
The user password.
- Returns:
- The user password.
-
retryOptions
public final RedshiftRetryOptions retryOptions()
The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
- Returns:
- The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
-
s3Configuration
public final 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
orZIP
cannot be specified inRedshiftDestinationConfiguration.S3Configuration
because the Amazon RedshiftCOPY
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
orZIP
cannot be specified inRedshiftDestinationConfiguration.S3Configuration
because the Amazon RedshiftCOPY
operation that reads from the S3 bucket doesn't support these compression formats.
-
processingConfiguration
public final ProcessingConfiguration processingConfiguration()
The data processing configuration.
- Returns:
- The data processing configuration.
-
s3BackupMode
public final RedshiftS3BackupMode s3BackupMode()
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.
If the service returns an enum value that is not available in the current SDK version,
s3BackupMode
will returnRedshiftS3BackupMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3BackupModeAsString()
.- Returns:
- 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:
RedshiftS3BackupMode
-
s3BackupModeAsString
public final String s3BackupModeAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
s3BackupMode
will returnRedshiftS3BackupMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3BackupModeAsString()
.- Returns:
- 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:
RedshiftS3BackupMode
-
s3BackupConfiguration
public final S3DestinationConfiguration s3BackupConfiguration()
The configuration for backup in Amazon S3.
- Returns:
- The configuration for backup in Amazon S3.
-
cloudWatchLoggingOptions
public final CloudWatchLoggingOptions cloudWatchLoggingOptions()
The CloudWatch logging options for your delivery stream.
- Returns:
- The CloudWatch logging options for your delivery stream.
-
secretsManagerConfiguration
public final SecretsManagerConfiguration secretsManagerConfiguration()
The configuration that defines how you access secrets for Amazon Redshift.
- Returns:
- The configuration that defines how you access secrets for Amazon Redshift.
-
toBuilder
public RedshiftDestinationConfiguration.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<RedshiftDestinationConfiguration.Builder,RedshiftDestinationConfiguration>
-
builder
public static RedshiftDestinationConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends RedshiftDestinationConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-