Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Firehose.Types.RedshiftDestinationUpdate

Description

Synopsis

Documentation

data RedshiftDestinationUpdate Source #

Describes an update for a destination in Amazon Redshift.

See: newRedshiftDestinationUpdate smart constructor.

Constructors

RedshiftDestinationUpdate'

Fields

cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
clusterJDBCURL :: Maybe Text
The database connection string.
copyCommand :: Maybe CopyCommand
The COPY command.
password :: Maybe (Sensitive Text)
The user password.
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).
roleARN :: Maybe 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.
s3BackupMode :: Maybe RedshiftS3BackupMode
You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
s3BackupUpdate :: Maybe S3DestinationUpdate
The Amazon S3 destination for backup.
s3Update :: Maybe S3DestinationUpdate
The Amazon S3 destination.
The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.
username :: Maybe (Sensitive Text)
The name of the user.

Instances

Instances details

ToJSON RedshiftDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.RedshiftDestinationUpdate Methods toJSON :: RedshiftDestinationUpdate -> Value # toEncoding :: RedshiftDestinationUpdate -> Encoding # toJSONList :: [RedshiftDestinationUpdate] -> Value # toEncodingList :: [RedshiftDestinationUpdate] -> Encoding #
Generic RedshiftDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.RedshiftDestinationUpdate Associated Types type Rep RedshiftDestinationUpdate :: Type -> Type # Methods from :: RedshiftDestinationUpdate -> Rep RedshiftDestinationUpdate x # to :: Rep RedshiftDestinationUpdate x -> RedshiftDestinationUpdate #
Show RedshiftDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.RedshiftDestinationUpdate Methods showsPrec :: Int -> RedshiftDestinationUpdate -> ShowS # show :: RedshiftDestinationUpdate -> String # showList :: [RedshiftDestinationUpdate] -> ShowS #
NFData RedshiftDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.RedshiftDestinationUpdate Methods rnf :: RedshiftDestinationUpdate -> () #
Eq RedshiftDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.RedshiftDestinationUpdate Methods (==) :: RedshiftDestinationUpdate -> RedshiftDestinationUpdate -> Bool # (/=) :: RedshiftDestinationUpdate -> RedshiftDestinationUpdate -> Bool #
Hashable RedshiftDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.RedshiftDestinationUpdate Methods hashWithSalt :: Int -> RedshiftDestinationUpdate -> Int # hash :: RedshiftDestinationUpdate -> Int #
type Rep RedshiftDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.RedshiftDestinationUpdate type Rep RedshiftDestinationUpdate = D1 ('MetaData "RedshiftDestinationUpdate" "Amazonka.Firehose.Types.RedshiftDestinationUpdate" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "RedshiftDestinationUpdate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :: S1 ('MetaSel ('Just "clusterJDBCURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "copyCommand") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CopyCommand)) :: (S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration))))) :: ((S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftRetryOptions)) :: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedshiftS3BackupMode)))) :: (S1 ('MetaSel ('Just "s3BackupUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationUpdate)) :: (S1 ('MetaSel ('Just "s3Update") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationUpdate)) :: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))))))

newRedshiftDestinationUpdate :: RedshiftDestinationUpdate Source #

Create a value of RedshiftDestinationUpdate 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:

RedshiftDestinationUpdate, redshiftDestinationUpdate_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

$sel:clusterJDBCURL:RedshiftDestinationUpdate', redshiftDestinationUpdate_clusterJDBCURL - The database connection string.

$sel:copyCommand:RedshiftDestinationUpdate', redshiftDestinationUpdate_copyCommand - The COPY command.

$sel:password:RedshiftDestinationUpdate', redshiftDestinationUpdate_password - The user password.

$sel:processingConfiguration:RedshiftDestinationUpdate', redshiftDestinationUpdate_processingConfiguration - The data processing configuration.

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

RedshiftDestinationUpdate, redshiftDestinationUpdate_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:s3BackupMode:RedshiftDestinationUpdate', redshiftDestinationUpdate_s3BackupMode - You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

$sel:s3BackupUpdate:RedshiftDestinationUpdate', redshiftDestinationUpdate_s3BackupUpdate - The Amazon S3 destination for backup.

$sel:s3Update:RedshiftDestinationUpdate', redshiftDestinationUpdate_s3Update - The Amazon S3 destination.

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

$sel:username:RedshiftDestinationUpdate', redshiftDestinationUpdate_username - The name of the user.

redshiftDestinationUpdate_cloudWatchLoggingOptions :: Lens' RedshiftDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #

The Amazon CloudWatch logging options for your delivery stream.

redshiftDestinationUpdate_clusterJDBCURL :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #

The database connection string.

redshiftDestinationUpdate_copyCommand :: Lens' RedshiftDestinationUpdate (Maybe CopyCommand) Source #

The COPY command.

redshiftDestinationUpdate_password :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #

The user password.

redshiftDestinationUpdate_processingConfiguration :: Lens' RedshiftDestinationUpdate (Maybe ProcessingConfiguration) Source #

The data processing configuration.

redshiftDestinationUpdate_retryOptions :: Lens' RedshiftDestinationUpdate (Maybe RedshiftRetryOptions) Source #

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

redshiftDestinationUpdate_roleARN :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #

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.

redshiftDestinationUpdate_s3BackupMode :: Lens' RedshiftDestinationUpdate (Maybe RedshiftS3BackupMode) Source #

You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

redshiftDestinationUpdate_s3BackupUpdate :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate) Source #

The Amazon S3 destination for backup.

redshiftDestinationUpdate_s3Update :: Lens' RedshiftDestinationUpdate (Maybe S3DestinationUpdate) Source #

The Amazon S3 destination.

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

redshiftDestinationUpdate_username :: Lens' RedshiftDestinationUpdate (Maybe Text) Source #

The name of the user.