Package 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("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:

  • Method Details

    • 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 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 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 return RedshiftS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().

      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:

    • 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 return RedshiftS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().

      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:

    • 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()
      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 final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

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

    • sdkFields

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