Skip to content

/AWS1/CL_KFKS3STORAGE

Storage configuration for an Amazon S3 destination bucket.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_bucketarn TYPE /AWS1/KFK__STRING /AWS1/KFK__STRING

The Amazon Resource Name (ARN) of the destination Amazon S3 bucket.

iv_compressiontype TYPE /AWS1/KFKS3COMPRESSIONTYPE /AWS1/KFKS3COMPRESSIONTYPE

The compression codec applied to delivered Amazon S3 objects.

iv_storageclass TYPE /AWS1/KFKS3STORAGECLASS /AWS1/KFKS3STORAGECLASS

The Amazon S3 storage class for delivered objects.

Optional arguments:

iv_outputprefix TYPE /AWS1/KFK__STRING /AWS1/KFK__STRING

An optional prefix prepended to every Amazon S3 object key written by the channel.

iv_outputkeytemplate TYPE /AWS1/KFK__STRING /AWS1/KFK__STRING

An optional template that controls the Amazon S3 object key for each delivered record. Supports the placeholders !{partition-id}, !{sequence-number}, and !{kafka-offset}.

iv_expectedbucketowner TYPE /AWS1/KFK__STRING /AWS1/KFK__STRING

Optional 12-digit AWS account ID expected to own the Amazon S3 bucket.


Queryable Attributes

BucketArn

The Amazon Resource Name (ARN) of the destination Amazon S3 bucket.

Accessible with the following methods

Method Description
GET_BUCKETARN() Getter for BUCKETARN, with configurable default
ASK_BUCKETARN() Getter for BUCKETARN w/ exceptions if field has no value
HAS_BUCKETARN() Determine if BUCKETARN has a value

CompressionType

The compression codec applied to delivered Amazon S3 objects.

Accessible with the following methods

Method Description
GET_COMPRESSIONTYPE() Getter for COMPRESSIONTYPE, with configurable default
ASK_COMPRESSIONTYPE() Getter for COMPRESSIONTYPE w/ exceptions if field has no val
HAS_COMPRESSIONTYPE() Determine if COMPRESSIONTYPE has a value

OutputPrefix

An optional prefix prepended to every Amazon S3 object key written by the channel.

Accessible with the following methods

Method Description
GET_OUTPUTPREFIX() Getter for OUTPUTPREFIX, with configurable default
ASK_OUTPUTPREFIX() Getter for OUTPUTPREFIX w/ exceptions if field has no value
HAS_OUTPUTPREFIX() Determine if OUTPUTPREFIX has a value

OutputKeyTemplate

An optional template that controls the Amazon S3 object key for each delivered record. Supports the placeholders !{partition-id}, !{sequence-number}, and !{kafka-offset}.

Accessible with the following methods

Method Description
GET_OUTPUTKEYTEMPLATE() Getter for OUTPUTKEYTEMPLATE, with configurable default
ASK_OUTPUTKEYTEMPLATE() Getter for OUTPUTKEYTEMPLATE w/ exceptions if field has no v
HAS_OUTPUTKEYTEMPLATE() Determine if OUTPUTKEYTEMPLATE has a value

StorageClass

The Amazon S3 storage class for delivered objects.

Accessible with the following methods

Method Description
GET_STORAGECLASS() Getter for STORAGECLASS, with configurable default
ASK_STORAGECLASS() Getter for STORAGECLASS w/ exceptions if field has no value
HAS_STORAGECLASS() Determine if STORAGECLASS has a value

ExpectedBucketOwner

Optional 12-digit AWS account ID expected to own the Amazon S3 bucket.

Accessible with the following methods

Method Description
GET_EXPECTEDBUCKETOWNER() Getter for EXPECTEDBUCKETOWNER, with configurable default
ASK_EXPECTEDBUCKETOWNER() Getter for EXPECTEDBUCKETOWNER w/ exceptions if field has no
HAS_EXPECTEDBUCKETOWNER() Determine if EXPECTEDBUCKETOWNER has a value