Amazon Kinesis Data Firehose API Reference
API Reference (API Version 2015-08-04)

ExtendedS3DestinationConfiguration

Describes the configuration of a destination in Amazon S3.

Contents

BucketARN

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:.*

Required: Yes

BufferingHints

The buffering option.

Type: BufferingHints object

Required: No

CloudWatchLoggingOptions

The Amazon CloudWatch logging options for your delivery stream.

Type: CloudWatchLoggingOptions object

Required: No

CompressionFormat

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

Type: String

Valid Values: UNCOMPRESSED | GZIP | ZIP | Snappy

Required: No

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.

Type: DataFormatConversionConfiguration object

Required: No

EncryptionConfiguration

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

Type: EncryptionConfiguration object

Required: No

Prefix

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Data Firehose Developer Guide.

Type: String

Required: No

ProcessingConfiguration

The data processing configuration.

Type: ProcessingConfiguration object

Required: No

RoleARN

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: arn:.*

Required: Yes

S3BackupConfiguration

The configuration for backup in Amazon S3.

Type: S3DestinationConfiguration object

Required: No

S3BackupMode

The Amazon S3 backup mode.

Type: String

Valid Values: Disabled | Enabled

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: