/AWS1/CL_FRHEXTENDEDS3DSTDESC¶
Describes a destination in Amazon S3.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_rolearn TYPE /AWS1/FRHROLEARN /AWS1/FRHROLEARN¶
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.
iv_bucketarn TYPE /AWS1/FRHBUCKETARN /AWS1/FRHBUCKETARN¶
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
io_bufferinghints TYPE REF TO /AWS1/CL_FRHBUFFERINGHINTS /AWS1/CL_FRHBUFFERINGHINTS¶
The buffering option.
iv_compressionformat TYPE /AWS1/FRHCOMPRESSIONFORMAT /AWS1/FRHCOMPRESSIONFORMAT¶
The compression format. If no value is specified, the default is
UNCOMPRESSED.
io_encryptionconfiguration TYPE REF TO /AWS1/CL_FRHENCRYPTIONCONF /AWS1/CL_FRHENCRYPTIONCONF¶
The encryption configuration. If no value is specified, the default is no encryption.
Optional arguments:¶
iv_prefix TYPE /AWS1/FRHPREFIX /AWS1/FRHPREFIX¶
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.
iv_erroroutputprefix TYPE /AWS1/FRHERROROUTPUTPREFIX /AWS1/FRHERROROUTPUTPREFIX¶
A prefix that 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.
io_cloudwatchloggingoptions TYPE REF TO /AWS1/CL_FRHCLOUDWATCHLOGOPTS /AWS1/CL_FRHCLOUDWATCHLOGOPTS¶
The Amazon CloudWatch logging options for your Firehose stream.
io_processingconfiguration TYPE REF TO /AWS1/CL_FRHPROCESSINGCONF /AWS1/CL_FRHPROCESSINGCONF¶
The data processing configuration.
iv_s3backupmode TYPE /AWS1/FRHS3BACKUPMODE /AWS1/FRHS3BACKUPMODE¶
The Amazon S3 backup mode.
io_s3backupdescription TYPE REF TO /AWS1/CL_FRHS3DSTDESCRIPTION /AWS1/CL_FRHS3DSTDESCRIPTION¶
The configuration for backup in Amazon S3.
io_dataformatconversionconf TYPE REF TO /AWS1/CL_FRHDATAFMTCONVRSCONF /AWS1/CL_FRHDATAFMTCONVRSCONF¶
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
io_dynamicpartitioningconf TYPE REF TO /AWS1/CL_FRHDYNPARTITIONINGC00 /AWS1/CL_FRHDYNPARTITIONINGC00¶
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.
iv_fileextension TYPE /AWS1/FRHFILEEXTENSION /AWS1/FRHFILEEXTENSION¶
Specify a file extension. It will override the default file extension
iv_customtimezone TYPE /AWS1/FRHCUSTOMTIMEZONE /AWS1/FRHCUSTOMTIMEZONE¶
The time zone you prefer. UTC is the default.
Queryable Attributes¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
BucketARN¶
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
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 |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PREFIX() |
Getter for PREFIX, with configurable default |
ASK_PREFIX() |
Getter for PREFIX w/ exceptions if field has no value |
HAS_PREFIX() |
Determine if PREFIX has a value |
ErrorOutputPrefix¶
A prefix that 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ERROROUTPUTPREFIX() |
Getter for ERROROUTPUTPREFIX, with configurable default |
ASK_ERROROUTPUTPREFIX() |
Getter for ERROROUTPUTPREFIX w/ exceptions if field has no v |
HAS_ERROROUTPUTPREFIX() |
Determine if ERROROUTPUTPREFIX has a value |
BufferingHints¶
The buffering option.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BUFFERINGHINTS() |
Getter for BUFFERINGHINTS |
CompressionFormat¶
The compression format. If no value is specified, the default is
UNCOMPRESSED.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COMPRESSIONFORMAT() |
Getter for COMPRESSIONFORMAT, with configurable default |
ASK_COMPRESSIONFORMAT() |
Getter for COMPRESSIONFORMAT w/ exceptions if field has no v |
HAS_COMPRESSIONFORMAT() |
Determine if COMPRESSIONFORMAT has a value |
EncryptionConfiguration¶
The encryption configuration. If no value is specified, the default is no encryption.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENCRYPTIONCONFIGURATION() |
Getter for ENCRYPTIONCONFIGURATION |
CloudWatchLoggingOptions¶
The Amazon CloudWatch logging options for your Firehose stream.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLOUDWATCHLOGGINGOPTIONS() |
Getter for CLOUDWATCHLOGGINGOPTIONS |
ProcessingConfiguration¶
The data processing configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PROCESSINGCONFIGURATION() |
Getter for PROCESSINGCONFIGURATION |
S3BackupMode¶
The Amazon S3 backup mode.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_S3BACKUPMODE() |
Getter for S3BACKUPMODE, with configurable default |
ASK_S3BACKUPMODE() |
Getter for S3BACKUPMODE w/ exceptions if field has no value |
HAS_S3BACKUPMODE() |
Determine if S3BACKUPMODE has a value |
S3BackupDescription¶
The configuration for backup in Amazon S3.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_S3BACKUPDESCRIPTION() |
Getter for S3BACKUPDESCRIPTION |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATAFORMATCONVERSIONCONF() |
Getter for DATAFORMATCONVERSIONCONF |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DYNAMICPARTITIONINGCONF() |
Getter for DYNAMICPARTITIONINGCONF |
FileExtension¶
Specify a file extension. It will override the default file extension
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FILEEXTENSION() |
Getter for FILEEXTENSION, with configurable default |
ASK_FILEEXTENSION() |
Getter for FILEEXTENSION w/ exceptions if field has no value |
HAS_FILEEXTENSION() |
Determine if FILEEXTENSION has a value |
CustomTimeZone¶
The time zone you prefer. UTC is the default.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CUSTOMTIMEZONE() |
Getter for CUSTOMTIMEZONE, with configurable default |
ASK_CUSTOMTIMEZONE() |
Getter for CUSTOMTIMEZONE w/ exceptions if field has no valu |
HAS_CUSTOMTIMEZONE() |
Determine if CUSTOMTIMEZONE has a value |