libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Firehose.Types.ExtendedS3DestinationDescription

Description

 
Synopsis

Documentation

data ExtendedS3DestinationDescription Source #

Describes a destination in Amazon S3.

See: newExtendedS3DestinationDescription smart constructor.

Constructors

ExtendedS3DestinationDescription' 

Fields

Instances

Instances details
Eq ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

Methods

(==) :: ExtendedS3DestinationDescription -> ExtendedS3DestinationDescription -> Bool #

(/=) :: ExtendedS3DestinationDescription -> ExtendedS3DestinationDescription -> Bool #

Read ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

Methods

readsPrec :: Int -> ReadS ExtendedS3DestinationDescription #

readList :: ReadS [ExtendedS3DestinationDescription] #

readPrec :: ReadPrec ExtendedS3DestinationDescription #

readListPrec :: ReadPrec [ExtendedS3DestinationDescription] #

Show ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

Methods

showsPrec :: Int -> ExtendedS3DestinationDescription -> ShowS #

show :: ExtendedS3DestinationDescription -> String #

showList :: [ExtendedS3DestinationDescription] -> ShowS #

Generic ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

Associated Types

type Rep ExtendedS3DestinationDescription :: Type -> Type #

Methods

from :: ExtendedS3DestinationDescription -> Rep ExtendedS3DestinationDescription x #

to :: Rep ExtendedS3DestinationDescription x -> ExtendedS3DestinationDescription #

NFData ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

Methods

rnf :: ExtendedS3DestinationDescription -> () #

Hashable ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

Methods

hashWithSalt :: Int -> ExtendedS3DestinationDescription -> Int #

hash :: ExtendedS3DestinationDescription -> Int #

FromJSON ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

Methods

parseJSON :: Value -> Parser ExtendedS3DestinationDescription #

parseJSONList :: Value -> Parser [ExtendedS3DestinationDescription] #

type Rep ExtendedS3DestinationDescription Source # 
Instance details

Defined in Amazonka.Firehose.Types.ExtendedS3DestinationDescription

type Rep ExtendedS3DestinationDescription = D1 ('MetaData "ExtendedS3DestinationDescription" "Amazonka.Firehose.Types.ExtendedS3DestinationDescription" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "ExtendedS3DestinationDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3BackupMode)) :*: (S1 ('MetaSel ('Just "s3BackupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationDescription)) :*: 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 "dynamicPartitioningConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DynamicPartitioningConfiguration))))) :*: ((S1 ('MetaSel ('Just "dataFormatConversionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataFormatConversionConfiguration)) :*: (S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "bucketARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BufferingHints)) :*: (S1 ('MetaSel ('Just "compressionFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CompressionFormat) :*: S1 ('MetaSel ('Just "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncryptionConfiguration))))))

newExtendedS3DestinationDescription Source #

Arguments

:: Text

$sel:roleARN:ExtendedS3DestinationDescription'

-> Text

$sel:bucketARN:ExtendedS3DestinationDescription'

-> BufferingHints

$sel:bufferingHints:ExtendedS3DestinationDescription'

-> CompressionFormat

$sel:compressionFormat:ExtendedS3DestinationDescription'

-> EncryptionConfiguration

$sel:encryptionConfiguration:ExtendedS3DestinationDescription'

-> ExtendedS3DestinationDescription 

Create a value of ExtendedS3DestinationDescription 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:ExtendedS3DestinationDescription', extendedS3DestinationDescription_s3BackupMode - The Amazon S3 backup mode.

$sel:s3BackupDescription:ExtendedS3DestinationDescription', extendedS3DestinationDescription_s3BackupDescription - The configuration for backup in Amazon S3.

$sel:prefix:ExtendedS3DestinationDescription', extendedS3DestinationDescription_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:ExtendedS3DestinationDescription', extendedS3DestinationDescription_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

$sel:errorOutputPrefix:ExtendedS3DestinationDescription', extendedS3DestinationDescription_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:dynamicPartitioningConfiguration:ExtendedS3DestinationDescription', extendedS3DestinationDescription_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:dataFormatConversionConfiguration:ExtendedS3DestinationDescription', extendedS3DestinationDescription_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:processingConfiguration:ExtendedS3DestinationDescription', extendedS3DestinationDescription_processingConfiguration - The data processing configuration.

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

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

$sel:bufferingHints:ExtendedS3DestinationDescription', extendedS3DestinationDescription_bufferingHints - The buffering option.

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

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

extendedS3DestinationDescription_s3BackupMode :: Lens' ExtendedS3DestinationDescription (Maybe S3BackupMode) Source #

The Amazon S3 backup mode.

extendedS3DestinationDescription_s3BackupDescription :: Lens' ExtendedS3DestinationDescription (Maybe S3DestinationDescription) Source #

The configuration for backup in Amazon S3.

extendedS3DestinationDescription_prefix :: Lens' ExtendedS3DestinationDescription (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.

extendedS3DestinationDescription_cloudWatchLoggingOptions :: Lens' ExtendedS3DestinationDescription (Maybe CloudWatchLoggingOptions) Source #

The Amazon CloudWatch logging options for your delivery stream.

extendedS3DestinationDescription_errorOutputPrefix :: Lens' ExtendedS3DestinationDescription (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.

extendedS3DestinationDescription_dynamicPartitioningConfiguration :: Lens' ExtendedS3DestinationDescription (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

extendedS3DestinationDescription_dataFormatConversionConfiguration :: Lens' ExtendedS3DestinationDescription (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.

extendedS3DestinationDescription_processingConfiguration :: Lens' ExtendedS3DestinationDescription (Maybe ProcessingConfiguration) Source #

The data processing configuration.

extendedS3DestinationDescription_roleARN :: Lens' ExtendedS3DestinationDescription Text Source #

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

extendedS3DestinationDescription_bucketARN :: Lens' ExtendedS3DestinationDescription Text Source #

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

extendedS3DestinationDescription_bufferingHints :: Lens' ExtendedS3DestinationDescription BufferingHints Source #

The buffering option.

extendedS3DestinationDescription_compressionFormat :: Lens' ExtendedS3DestinationDescription CompressionFormat Source #

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

extendedS3DestinationDescription_encryptionConfiguration :: Lens' ExtendedS3DestinationDescription EncryptionConfiguration Source #

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