Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Firehose.Types.ExtendedS3DestinationUpdate

Description

Synopsis

Documentation

data ExtendedS3DestinationUpdate Source #

Describes an update for a destination in Amazon S3.

See: newExtendedS3DestinationUpdate smart constructor.

Constructors

ExtendedS3DestinationUpdate'

Fields

s3BackupMode :: Maybe 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.
prefix :: Maybe Text
The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.
cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
errorOutputPrefix :: Maybe Text
A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.
s3BackupUpdate :: Maybe S3DestinationUpdate
The Amazon S3 destination for backup.
encryptionConfiguration :: Maybe EncryptionConfiguration
The encryption configuration. If no value is specified, the default is no encryption.
dynamicPartitioningConfiguration :: Maybe DynamicPartitioningConfiguration
The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations. For more information, see https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html
compressionFormat :: Maybe CompressionFormat
The compression format. If no value is specified, the default is UNCOMPRESSED.
bufferingHints :: Maybe BufferingHints
The buffering option.
dataFormatConversionConfiguration :: Maybe DataFormatConversionConfiguration
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
bucketARN :: Maybe Text
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
processingConfiguration :: Maybe ProcessingConfiguration
The data processing configuration.
roleARN :: Maybe Text
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Instances

Instances details

Eq ExtendedS3DestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate Methods (==) :: ExtendedS3DestinationUpdate -> ExtendedS3DestinationUpdate -> Bool # (/=) :: ExtendedS3DestinationUpdate -> ExtendedS3DestinationUpdate -> Bool #
Read ExtendedS3DestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate Methods readsPrec :: Int -> ReadS ExtendedS3DestinationUpdate # readList :: ReadS [ExtendedS3DestinationUpdate] # readPrec :: ReadPrec ExtendedS3DestinationUpdate # readListPrec :: ReadPrec [ExtendedS3DestinationUpdate] #
Show ExtendedS3DestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate Methods showsPrec :: Int -> ExtendedS3DestinationUpdate -> ShowS # show :: ExtendedS3DestinationUpdate -> String # showList :: [ExtendedS3DestinationUpdate] -> ShowS #
Generic ExtendedS3DestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate Associated Types type Rep ExtendedS3DestinationUpdate :: Type -> Type # Methods from :: ExtendedS3DestinationUpdate -> Rep ExtendedS3DestinationUpdate x # to :: Rep ExtendedS3DestinationUpdate x -> ExtendedS3DestinationUpdate #
NFData ExtendedS3DestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate Methods rnf :: ExtendedS3DestinationUpdate -> () #
Hashable ExtendedS3DestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate Methods hashWithSalt :: Int -> ExtendedS3DestinationUpdate -> Int # hash :: ExtendedS3DestinationUpdate -> Int #
ToJSON ExtendedS3DestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate Methods toJSON :: ExtendedS3DestinationUpdate -> Value # toEncoding :: ExtendedS3DestinationUpdate -> Encoding # toJSONList :: [ExtendedS3DestinationUpdate] -> Value # toEncodingList :: [ExtendedS3DestinationUpdate] -> Encoding #
type Rep ExtendedS3DestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.ExtendedS3DestinationUpdate type Rep ExtendedS3DestinationUpdate = D1 ('MetaData "ExtendedS3DestinationUpdate" "Amazonka.Firehose.Types.ExtendedS3DestinationUpdate" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "ExtendedS3DestinationUpdate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3BackupMode)) :: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)))) :: (S1 ('MetaSel ('Just "errorOutputPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "s3BackupUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationUpdate)) :: S1 ('MetaSel ('Just "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfiguration))))) :: ((S1 ('MetaSel ('Just "dynamicPartitioningConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamicPartitioningConfiguration)) :: (S1 ('MetaSel ('Just "compressionFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CompressionFormat)) :: S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BufferingHints)))) :: ((S1 ('MetaSel ('Just "dataFormatConversionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataFormatConversionConfiguration)) :: S1 ('MetaSel ('Just "bucketARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)) :: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newExtendedS3DestinationUpdate :: ExtendedS3DestinationUpdate Source #

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

$sel:s3BackupMode:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_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:prefix:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_prefix - The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

$sel:cloudWatchLoggingOptions:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

$sel:errorOutputPrefix:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_errorOutputPrefix - A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

$sel:s3BackupUpdate:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_s3BackupUpdate - The Amazon S3 destination for backup.

$sel:encryptionConfiguration:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_encryptionConfiguration - The encryption configuration. If no value is specified, the default is no encryption.

$sel:dynamicPartitioningConfiguration:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_dynamicPartitioningConfiguration - The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations. For more information, see https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html

$sel:compressionFormat:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_compressionFormat - The compression format. If no value is specified, the default is UNCOMPRESSED.

$sel:bufferingHints:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_bufferingHints - The buffering option.

$sel:dataFormatConversionConfiguration:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_dataFormatConversionConfiguration - The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

$sel:bucketARN:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_bucketARN - The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

$sel:processingConfiguration:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_processingConfiguration - The data processing configuration.

$sel:roleARN:ExtendedS3DestinationUpdate', extendedS3DestinationUpdate_roleARN - The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

extendedS3DestinationUpdate_s3BackupMode :: Lens' ExtendedS3DestinationUpdate (Maybe S3BackupMode) 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.

extendedS3DestinationUpdate_prefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

extendedS3DestinationUpdate_cloudWatchLoggingOptions :: Lens' ExtendedS3DestinationUpdate (Maybe CloudWatchLoggingOptions) Source #

The Amazon CloudWatch logging options for your delivery stream.

extendedS3DestinationUpdate_errorOutputPrefix :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

extendedS3DestinationUpdate_s3BackupUpdate :: Lens' ExtendedS3DestinationUpdate (Maybe S3DestinationUpdate) Source #

The Amazon S3 destination for backup.

extendedS3DestinationUpdate_encryptionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe EncryptionConfiguration) Source #

The encryption configuration. If no value is specified, the default is no encryption.

extendedS3DestinationUpdate_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe DynamicPartitioningConfiguration) Source #

The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations. For more information, see https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html

extendedS3DestinationUpdate_compressionFormat :: Lens' ExtendedS3DestinationUpdate (Maybe CompressionFormat) Source #

The compression format. If no value is specified, the default is UNCOMPRESSED.

extendedS3DestinationUpdate_bufferingHints :: Lens' ExtendedS3DestinationUpdate (Maybe BufferingHints) Source #

The buffering option.

extendedS3DestinationUpdate_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe DataFormatConversionConfiguration) Source #

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

extendedS3DestinationUpdate_bucketARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #

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

extendedS3DestinationUpdate_processingConfiguration :: Lens' ExtendedS3DestinationUpdate (Maybe ProcessingConfiguration) Source #

The data processing configuration.

extendedS3DestinationUpdate_roleARN :: Lens' ExtendedS3DestinationUpdate (Maybe Text) Source #

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