Amazonka.Firehose.Types.RedshiftDestinationConfiguration

Documentation

data RedshiftDestinationConfiguration

Describes the configuration of a destination in Amazon Redshift.

See: newRedshiftDestinationConfiguration smart constructor.

Constructors

RedshiftDestinationConfiguration'

Fields

• cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions

  The CloudWatch logging options for your delivery stream.

• processingConfiguration :: Maybe ProcessingConfiguration

  The data processing configuration.

• retryOptions :: Maybe RedshiftRetryOptions

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

• s3BackupConfiguration :: Maybe S3DestinationConfiguration

  The configuration for backup in Amazon S3.

• s3BackupMode :: Maybe RedshiftS3BackupMode

  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.

• roleARN :: Text

  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 :: Text

  The database connection string.

• copyCommand :: CopyCommand

  The COPY command.

• username :: Sensitive Text

  The name of the user.

• password :: Sensitive Text

  The user password.

• s3Configuration :: S3DestinationConfiguration

  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.

Instances

ToJSON RedshiftDestinationConfiguration

Defined in Amazonka.Firehose.Types.RedshiftDestinationConfiguration

Methods

toJSON :: RedshiftDestinationConfiguration -> Value

toEncoding :: RedshiftDestinationConfiguration -> Encoding

toJSONList :: [RedshiftDestinationConfiguration] -> Value

toEncodingList :: [RedshiftDestinationConfiguration] -> Encoding

Generic RedshiftDestinationConfiguration

Defined in Amazonka.Firehose.Types.RedshiftDestinationConfiguration

Associated Types

type Rep RedshiftDestinationConfiguration :: Type -> Type

Methods

from :: RedshiftDestinationConfiguration -> Rep RedshiftDestinationConfiguration x

to :: Rep RedshiftDestinationConfiguration x -> RedshiftDestinationConfiguration

Show RedshiftDestinationConfiguration

Defined in Amazonka.Firehose.Types.RedshiftDestinationConfiguration

Methods

showsPrec :: Int -> RedshiftDestinationConfiguration -> ShowS

show :: RedshiftDestinationConfiguration -> String

showList :: [RedshiftDestinationConfiguration] -> ShowS

NFData RedshiftDestinationConfiguration

Defined in Amazonka.Firehose.Types.RedshiftDestinationConfiguration

Methods

rnf :: RedshiftDestinationConfiguration -> ()

Eq RedshiftDestinationConfiguration

Defined in Amazonka.Firehose.Types.RedshiftDestinationConfiguration

Methods

(==) :: RedshiftDestinationConfiguration -> RedshiftDestinationConfiguration -> Bool

(/=) :: RedshiftDestinationConfiguration -> RedshiftDestinationConfiguration -> Bool

Hashable RedshiftDestinationConfiguration

Defined in Amazonka.Firehose.Types.RedshiftDestinationConfiguration

Methods

hashWithSalt :: Int -> RedshiftDestinationConfiguration -> Int

hash :: RedshiftDestinationConfiguration -> Int

type Rep RedshiftDestinationConfiguration

Defined in Amazonka.Firehose.Types.RedshiftDestinationConfiguration

type Rep RedshiftDestinationConfiguration = D1 ('MetaData "RedshiftDestinationConfiguration" "Amazonka.Firehose.Types.RedshiftDestinationConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "RedshiftDestinationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration))) :*: (S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftRetryOptions)) :*: (S1 ('MetaSel ('Just "s3BackupConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationConfiguration)) :*: S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftS3BackupMode))))) :*: ((S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "clusterJDBCURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "copyCommand") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CopyCommand))) :*: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: (S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "s3Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3DestinationConfiguration))))))

newRedshiftDestinationConfiguration

Arguments

:: Text

RedshiftDestinationConfiguration

-> Text

$sel:clusterJDBCURL:RedshiftDestinationConfiguration'

-> CopyCommand

$sel:copyCommand:RedshiftDestinationConfiguration'

-> Text

$sel:username:RedshiftDestinationConfiguration'

-> Text

$sel:password:RedshiftDestinationConfiguration'

-> S3DestinationConfiguration

$sel:s3Configuration:RedshiftDestinationConfiguration'

-> RedshiftDestinationConfiguration

Create a value of RedshiftDestinationConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

RedshiftDestinationConfiguration, redshiftDestinationConfiguration_cloudWatchLoggingOptions - The CloudWatch logging options for your delivery stream.

$sel:processingConfiguration:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_processingConfiguration - The data processing configuration.

$sel:retryOptions:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

$sel:s3BackupConfiguration:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_s3BackupConfiguration - The configuration for backup in Amazon S3.

$sel:s3BackupMode:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_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.

RedshiftDestinationConfiguration, redshiftDestinationConfiguration_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.

$sel:clusterJDBCURL:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_clusterJDBCURL - The database connection string.

$sel:copyCommand:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_copyCommand - The COPY command.

$sel:username:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_username - The name of the user.

$sel:password:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_password - The user password.

$sel:s3Configuration:RedshiftDestinationConfiguration', redshiftDestinationConfiguration_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.

redshiftDestinationConfiguration_cloudWatchLoggingOptions :: Lens' RedshiftDestinationConfiguration (Maybe CloudWatchLoggingOptions)

The CloudWatch logging options for your delivery stream.

redshiftDestinationConfiguration_processingConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe ProcessingConfiguration)

The data processing configuration.

redshiftDestinationConfiguration_retryOptions :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftRetryOptions)

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

redshiftDestinationConfiguration_s3BackupConfiguration :: Lens' RedshiftDestinationConfiguration (Maybe S3DestinationConfiguration)

The configuration for backup in Amazon S3.

redshiftDestinationConfiguration_s3BackupMode :: Lens' RedshiftDestinationConfiguration (Maybe RedshiftS3BackupMode)

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.

redshiftDestinationConfiguration_roleARN :: Lens' RedshiftDestinationConfiguration Text

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.

redshiftDestinationConfiguration_clusterJDBCURL :: Lens' RedshiftDestinationConfiguration Text

The database connection string.

redshiftDestinationConfiguration_copyCommand :: Lens' RedshiftDestinationConfiguration CopyCommand

The COPY command.

redshiftDestinationConfiguration_username :: Lens' RedshiftDestinationConfiguration Text

The name of the user.

redshiftDestinationConfiguration_password :: Lens' RedshiftDestinationConfiguration Text

The user password.

redshiftDestinationConfiguration_s3Configuration :: Lens' RedshiftDestinationConfiguration S3DestinationConfiguration

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.