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.S3DestinationConfiguration

Description

Synopsis

Documentation

data S3DestinationConfiguration Source #

Describes the configuration of a destination in Amazon S3.

See: newS3DestinationConfiguration smart constructor.

Constructors

S3DestinationConfiguration'

Fields

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 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.
encryptionConfiguration :: Maybe EncryptionConfiguration
The encryption configuration. If no value is specified, the default is no encryption.
compressionFormat :: Maybe CompressionFormat
The compression format. If no value is specified, the default is UNCOMPRESSED.
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
bufferingHints :: Maybe BufferingHints
The buffering option. If no value is specified, BufferingHints object default values are used.
roleARN :: Text
The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
bucketARN :: Text
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Instances

Instances details

Eq S3DestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.S3DestinationConfiguration Methods (==) :: S3DestinationConfiguration -> S3DestinationConfiguration -> Bool # (/=) :: S3DestinationConfiguration -> S3DestinationConfiguration -> Bool #
Read S3DestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.S3DestinationConfiguration Methods readsPrec :: Int -> ReadS S3DestinationConfiguration # readList :: ReadS [S3DestinationConfiguration] # readPrec :: ReadPrec S3DestinationConfiguration # readListPrec :: ReadPrec [S3DestinationConfiguration] #
Show S3DestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.S3DestinationConfiguration Methods showsPrec :: Int -> S3DestinationConfiguration -> ShowS # show :: S3DestinationConfiguration -> String # showList :: [S3DestinationConfiguration] -> ShowS #
Generic S3DestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.S3DestinationConfiguration Associated Types type Rep S3DestinationConfiguration :: Type -> Type # Methods from :: S3DestinationConfiguration -> Rep S3DestinationConfiguration x # to :: Rep S3DestinationConfiguration x -> S3DestinationConfiguration #
NFData S3DestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.S3DestinationConfiguration Methods rnf :: S3DestinationConfiguration -> () #
Hashable S3DestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.S3DestinationConfiguration Methods hashWithSalt :: Int -> S3DestinationConfiguration -> Int # hash :: S3DestinationConfiguration -> Int #
ToJSON S3DestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.S3DestinationConfiguration Methods toJSON :: S3DestinationConfiguration -> Value # toEncoding :: S3DestinationConfiguration -> Encoding # toJSONList :: [S3DestinationConfiguration] -> Value # toEncodingList :: [S3DestinationConfiguration] -> Encoding #
type Rep S3DestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.S3DestinationConfiguration type Rep S3DestinationConfiguration = D1 ('MetaData "S3DestinationConfiguration" "Amazonka.Firehose.Types.S3DestinationConfiguration" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "S3DestinationConfiguration'" 'PrefixI 'True) (((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 "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfiguration)))) :: ((S1 ('MetaSel ('Just "compressionFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CompressionFormat)) :: S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BufferingHints))) :: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "bucketARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newS3DestinationConfiguration Source #

Arguments

:: Text	`$sel:roleARN:S3DestinationConfiguration'`
-> Text	`$sel:bucketARN:S3DestinationConfiguration'`
-> S3DestinationConfiguration

Create a value of S3DestinationConfiguration 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:prefix:S3DestinationConfiguration', s3DestinationConfiguration_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:S3DestinationConfiguration', s3DestinationConfiguration_cloudWatchLoggingOptions - The CloudWatch logging options for your delivery stream.

$sel:errorOutputPrefix:S3DestinationConfiguration', s3DestinationConfiguration_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:encryptionConfiguration:S3DestinationConfiguration', s3DestinationConfiguration_encryptionConfiguration - The encryption configuration. If no value is specified, the default is no encryption.

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

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

$sel:bufferingHints:S3DestinationConfiguration', s3DestinationConfiguration_bufferingHints - The buffering option. If no value is specified, BufferingHints object default values are used.

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

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

s3DestinationConfiguration_prefix :: Lens' S3DestinationConfiguration (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.

s3DestinationConfiguration_cloudWatchLoggingOptions :: Lens' S3DestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #

The CloudWatch logging options for your delivery stream.

s3DestinationConfiguration_errorOutputPrefix :: Lens' S3DestinationConfiguration (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.

s3DestinationConfiguration_encryptionConfiguration :: Lens' S3DestinationConfiguration (Maybe EncryptionConfiguration) Source #

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

s3DestinationConfiguration_compressionFormat :: Lens' S3DestinationConfiguration (Maybe CompressionFormat) Source #

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

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

s3DestinationConfiguration_bufferingHints :: Lens' S3DestinationConfiguration (Maybe BufferingHints) Source #

The buffering option. If no value is specified, BufferingHints object default values are used.

s3DestinationConfiguration_roleARN :: Lens' S3DestinationConfiguration Text Source #

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

s3DestinationConfiguration_bucketARN :: Lens' S3DestinationConfiguration Text Source #

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