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 Amazon Service Namespaces.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:.*:s3:::[\w\.\-]{1,255}
Required: Yes
- RoleARN
-
The Amazon Resource Name (ARN) of the Amazon credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
arn:.*:iam::\d{12}:role/[a-zA-Z_0-9+=,.@\-_/]+
Required: Yes
- BufferingHints
-
The buffering option.
Type: BufferingHints object
Required: No
- CloudWatchLoggingOptions
-
The Amazon CloudWatch logging options for your Firehose 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 | HADOOP_SNAPPY
Required: No
- CustomTimeZone
-
The time zone you prefer. UTC is the default.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern:
^$|[a-zA-Z/_]+
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
- 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.
Type: DynamicPartitioningConfiguration object
Required: No
- EncryptionConfiguration
-
The encryption configuration. If no value is specified, the default is no encryption.
Type: EncryptionConfiguration object
Required: No
- 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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
.*
Required: No
- FileExtension
-
Specify a file extension. It will override the default file extension
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern:
^$|\.[0-9a-z!\-_.*'()]+
Required: No
- 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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
.*
Required: No
- ProcessingConfiguration
-
The data processing configuration.
Type: ProcessingConfiguration object
Required: No
- S3BackupConfiguration
-
The configuration for backup in Amazon S3.
Type: S3DestinationConfiguration object
Required: No
- S3BackupMode
-
The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.
Type: String
Valid Values:
Disabled | Enabled
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: