Amazonka.Firehose.Types.S3DestinationUpdate

Documentation

data S3DestinationUpdate

Describes an update for a destination in Amazon S3.

See: newS3DestinationUpdate smart constructor.

Constructors

S3DestinationUpdate'

Fields

• bucketARN :: Maybe Text

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

• bufferingHints :: Maybe BufferingHints

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

• cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions

  The CloudWatch logging options for your delivery stream.

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

• encryptionConfiguration :: Maybe EncryptionConfiguration

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

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

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

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

Instances

ToJSON S3DestinationUpdate

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

Methods

toJSON :: S3DestinationUpdate -> Value

toEncoding :: S3DestinationUpdate -> Encoding

toJSONList :: [S3DestinationUpdate] -> Value

toEncodingList :: [S3DestinationUpdate] -> Encoding

Generic S3DestinationUpdate

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

Associated Types

type Rep S3DestinationUpdate :: Type -> Type

Methods

from :: S3DestinationUpdate -> Rep S3DestinationUpdate x

to :: Rep S3DestinationUpdate x -> S3DestinationUpdate

Read S3DestinationUpdate

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

Methods

readsPrec :: Int -> ReadS S3DestinationUpdate

readList :: ReadS [S3DestinationUpdate]

readPrec :: ReadPrec S3DestinationUpdate

readListPrec :: ReadPrec [S3DestinationUpdate]

Show S3DestinationUpdate

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

Methods

showsPrec :: Int -> S3DestinationUpdate -> ShowS

show :: S3DestinationUpdate -> String

showList :: [S3DestinationUpdate] -> ShowS

NFData S3DestinationUpdate

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

Methods

rnf :: S3DestinationUpdate -> ()

Eq S3DestinationUpdate

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

Methods

(==) :: S3DestinationUpdate -> S3DestinationUpdate -> Bool

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

Hashable S3DestinationUpdate

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

Methods

hashWithSalt :: Int -> S3DestinationUpdate -> Int

hash :: S3DestinationUpdate -> Int

type Rep S3DestinationUpdate

Defined in Amazonka.Firehose.Types.S3DestinationUpdate

type Rep S3DestinationUpdate = D1 ('MetaData "S3DestinationUpdate" "Amazonka.Firehose.Types.S3DestinationUpdate" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "S3DestinationUpdate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bucketARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BufferingHints))) :*: (S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :*: S1 ('MetaSel ('Just "compressionFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CompressionFormat)))) :*: ((S1 ('MetaSel ('Just "encryptionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionConfiguration)) :*: S1 ('MetaSel ('Just "errorOutputPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newS3DestinationUpdate :: S3DestinationUpdate

Create a value of S3DestinationUpdate 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:bucketARN:S3DestinationUpdate', s3DestinationUpdate_bucketARN - The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

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

$sel:cloudWatchLoggingOptions:S3DestinationUpdate', s3DestinationUpdate_cloudWatchLoggingOptions - The CloudWatch logging options for your delivery stream.

$sel:compressionFormat:S3DestinationUpdate', s3DestinationUpdate_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:encryptionConfiguration:S3DestinationUpdate', s3DestinationUpdate_encryptionConfiguration - The encryption configuration. If no value is specified, the default is no encryption.

$sel:errorOutputPrefix:S3DestinationUpdate', s3DestinationUpdate_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:prefix:S3DestinationUpdate', s3DestinationUpdate_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:roleARN:S3DestinationUpdate', s3DestinationUpdate_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.

s3DestinationUpdate_bucketARN :: Lens' S3DestinationUpdate (Maybe Text)

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

s3DestinationUpdate_bufferingHints :: Lens' S3DestinationUpdate (Maybe BufferingHints)

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

s3DestinationUpdate_cloudWatchLoggingOptions :: Lens' S3DestinationUpdate (Maybe CloudWatchLoggingOptions)

The CloudWatch logging options for your delivery stream.

s3DestinationUpdate_compressionFormat :: Lens' S3DestinationUpdate (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.

s3DestinationUpdate_encryptionConfiguration :: Lens' S3DestinationUpdate (Maybe EncryptionConfiguration)

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

s3DestinationUpdate_errorOutputPrefix :: Lens' S3DestinationUpdate (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.

s3DestinationUpdate_prefix :: Lens' S3DestinationUpdate (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.

s3DestinationUpdate_roleARN :: Lens' S3DestinationUpdate (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.