SDK for PHP 3.x
Amazon Kinesis Firehose 2015-08-04
- Client: Aws\Firehose\FirehoseClient
- Service ID: firehose
- Version: 2015-08-04
This page describes the parameters and results for the operations of the Amazon Kinesis Firehose (2015-08-04), and shows how to use the Aws\Firehose\FirehoseClient object to call the described operations. This documentation is specific to the 2015-08-04 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateDeliveryStream ( array $params = [] )
- Creates a Firehose stream.
- DeleteDeliveryStream ( array $params = [] )
- Deletes a Firehose stream and its data.
- DescribeDeliveryStream ( array $params = [] )
- Describes the specified Firehose stream and its status.
- ListDeliveryStreams ( array $params = [] )
- Lists your Firehose streams in alphabetical order of their names.
- ListTagsForDeliveryStream ( array $params = [] )
- Lists the tags for the specified Firehose stream.
- PutRecord ( array $params = [] )
- Writes a single data record into an Firehose stream.
- PutRecordBatch ( array $params = [] )
- Writes multiple data records into a Firehose stream in a single call, which can achieve higher throughput per producer than when writing single records.
- StartDeliveryStreamEncryption ( array $params = [] )
- Enables server-side encryption (SSE) for the Firehose stream.
- StopDeliveryStreamEncryption ( array $params = [] )
- Disables server-side encryption (SSE) for the Firehose stream.
- TagDeliveryStream ( array $params = [] )
- Adds or updates tags for the specified Firehose stream.
- UntagDeliveryStream ( array $params = [] )
- Removes tags from the specified Firehose stream.
- UpdateDestination ( array $params = [] )
- Updates the specified destination of the specified Firehose stream.
Operations
CreateDeliveryStream
$result = $client->createDeliveryStream([/* ... */]); $promise = $client->createDeliveryStreamAsync([/* ... */]);
Creates a Firehose stream.
By default, you can create up to 50 Firehose streams per Amazon Web Services Region.
This is an asynchronous operation that immediately returns. The initial status of the Firehose stream is CREATING. After the Firehose stream is created, its status is ACTIVE and it now accepts data. If the Firehose stream creation fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a Firehose stream, use DescribeDeliveryStream.
If the status of a Firehose stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.
A Firehose stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter.
To create a Firehose stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing Firehose stream that doesn't have SSE enabled.
A Firehose stream is configured with a single destination, such as Amazon Simple Storage Service (Amazon S3), Amazon Redshift, Amazon OpenSearch Service, Amazon OpenSearch Serverless, Splunk, and any custom HTTP endpoint or HTTP endpoints owned by or supported by third-party service providers, including Datadog, Dynatrace, LogicMonitor, MongoDB, New Relic, and Sumo Logic. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration.
When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.
A few notes about Amazon Redshift as a destination:
-
An Amazon Redshift destination requires an S3 bucket as intermediate location. Firehose first delivers data to Amazon S3 and then uses
COPYsyntax to load data into an Amazon Redshift table. This is specified in theRedshiftDestinationConfiguration.S3Configurationparameter. -
The compression formats
SNAPPYorZIPcannot be specified inRedshiftDestinationConfiguration.S3Configurationbecause the Amazon RedshiftCOPYoperation that reads from the S3 bucket doesn't support these compression formats. -
We strongly recommend that you use the user name and password you provide exclusively with Firehose, and that the permissions for the account are restricted for Amazon Redshift
INSERTpermissions.
Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Firehose Access to an Amazon S3 Destination in the Amazon Firehose Developer Guide.
Parameter Syntax
$result = $client->createDeliveryStream([
'AmazonOpenSearchServerlessDestinationConfiguration' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CollectionEndpoint' => '<string>',
'IndexName' => '<string>', // REQUIRED
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>', // REQUIRED
'S3BackupMode' => 'FailedDocumentsOnly|AllDocuments',
'S3Configuration' => [ // REQUIRED
'BucketARN' => '<string>', // REQUIRED
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>', // REQUIRED
],
'VpcConfiguration' => [
'RoleARN' => '<string>', // REQUIRED
'SecurityGroupIds' => ['<string>', ...], // REQUIRED
'SubnetIds' => ['<string>', ...], // REQUIRED
],
],
'AmazonopensearchserviceDestinationConfiguration' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'ClusterEndpoint' => '<string>',
'DocumentIdOptions' => [
'DefaultDocumentIdFormat' => 'FIREHOSE_DEFAULT|NO_DOCUMENT_ID', // REQUIRED
],
'DomainARN' => '<string>',
'IndexName' => '<string>', // REQUIRED
'IndexRotationPeriod' => 'NoRotation|OneHour|OneDay|OneWeek|OneMonth',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>', // REQUIRED
'S3BackupMode' => 'FailedDocumentsOnly|AllDocuments',
'S3Configuration' => [ // REQUIRED
'BucketARN' => '<string>', // REQUIRED
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>', // REQUIRED
],
'TypeName' => '<string>',
'VpcConfiguration' => [
'RoleARN' => '<string>', // REQUIRED
'SecurityGroupIds' => ['<string>', ...], // REQUIRED
'SubnetIds' => ['<string>', ...], // REQUIRED
],
],
'DatabaseSourceConfiguration' => [
'Columns' => [
'Exclude' => ['<string>', ...],
'Include' => ['<string>', ...],
],
'DatabaseSourceAuthenticationConfiguration' => [ // REQUIRED
'SecretsManagerConfiguration' => [ // REQUIRED
'Enabled' => true || false, // REQUIRED
'RoleARN' => '<string>',
'SecretARN' => '<string>',
],
],
'DatabaseSourceVPCConfiguration' => [ // REQUIRED
'VpcEndpointServiceName' => '<string>', // REQUIRED
],
'Databases' => [ // REQUIRED
'Exclude' => ['<string>', ...],
'Include' => ['<string>', ...],
],
'Endpoint' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
'SSLMode' => 'Disabled|Enabled',
'SnapshotWatermarkTable' => '<string>', // REQUIRED
'SurrogateKeys' => ['<string>', ...],
'Tables' => [ // REQUIRED
'Exclude' => ['<string>', ...],
'Include' => ['<string>', ...],
],
'Type' => 'MySQL|PostgreSQL', // REQUIRED
],
'DeliveryStreamEncryptionConfigurationInput' => [
'KeyARN' => '<string>',
'KeyType' => 'AWS_OWNED_CMK|CUSTOMER_MANAGED_CMK', // REQUIRED
],
'DeliveryStreamName' => '<string>', // REQUIRED
'DeliveryStreamType' => 'DirectPut|KinesisStreamAsSource|MSKAsSource|DatabaseAsSource',
'ElasticsearchDestinationConfiguration' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'ClusterEndpoint' => '<string>',
'DocumentIdOptions' => [
'DefaultDocumentIdFormat' => 'FIREHOSE_DEFAULT|NO_DOCUMENT_ID', // REQUIRED
],
'DomainARN' => '<string>',
'IndexName' => '<string>', // REQUIRED
'IndexRotationPeriod' => 'NoRotation|OneHour|OneDay|OneWeek|OneMonth',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>', // REQUIRED
'S3BackupMode' => 'FailedDocumentsOnly|AllDocuments',
'S3Configuration' => [ // REQUIRED
'BucketARN' => '<string>', // REQUIRED
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>', // REQUIRED
],
'TypeName' => '<string>',
'VpcConfiguration' => [
'RoleARN' => '<string>', // REQUIRED
'SecurityGroupIds' => ['<string>', ...], // REQUIRED
'SubnetIds' => ['<string>', ...], // REQUIRED
],
],
'ExtendedS3DestinationConfiguration' => [
'BucketARN' => '<string>', // REQUIRED
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'CustomTimeZone' => '<string>',
'DataFormatConversionConfiguration' => [
'Enabled' => true || false,
'InputFormatConfiguration' => [
'Deserializer' => [
'HiveJsonSerDe' => [
'TimestampFormats' => ['<string>', ...],
],
'OpenXJsonSerDe' => [
'CaseInsensitive' => true || false,
'ColumnToJsonKeyMappings' => ['<string>', ...],
'ConvertDotsInJsonKeysToUnderscores' => true || false,
],
],
],
'OutputFormatConfiguration' => [
'Serializer' => [
'OrcSerDe' => [
'BlockSizeBytes' => <integer>,
'BloomFilterColumns' => ['<string>', ...],
'BloomFilterFalsePositiveProbability' => <float>,
'Compression' => 'NONE|ZLIB|SNAPPY',
'DictionaryKeyThreshold' => <float>,
'EnablePadding' => true || false,
'FormatVersion' => 'V0_11|V0_12',
'PaddingTolerance' => <float>,
'RowIndexStride' => <integer>,
'StripeSizeBytes' => <integer>,
],
'ParquetSerDe' => [
'BlockSizeBytes' => <integer>,
'Compression' => 'UNCOMPRESSED|GZIP|SNAPPY',
'EnableDictionaryCompression' => true || false,
'MaxPaddingBytes' => <integer>,
'PageSizeBytes' => <integer>,
'WriterVersion' => 'V1|V2',
],
],
],
'SchemaConfiguration' => [
'CatalogId' => '<string>',
'DatabaseName' => '<string>',
'Region' => '<string>',
'RoleARN' => '<string>',
'TableName' => '<string>',
'VersionId' => '<string>',
],
],
'DynamicPartitioningConfiguration' => [
'Enabled' => true || false,
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
],
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'FileExtension' => '<string>',
'Prefix' => '<string>',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RoleARN' => '<string>', // REQUIRED
'S3BackupConfiguration' => [
'BucketARN' => '<string>', // REQUIRED
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>', // REQUIRED
],
'S3BackupMode' => 'Disabled|Enabled',
],
'HttpEndpointDestinationConfiguration' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'EndpointConfiguration' => [ // REQUIRED
'AccessKey' => '<string>',
'Name' => '<string>',
'Url' => '<string>', // REQUIRED
],
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RequestConfiguration' => [
'CommonAttributes' => [
[
'AttributeName' => '<string>', // REQUIRED
'AttributeValue' => '<string>', // REQUIRED
],
// ...
],
'ContentEncoding' => 'NONE|GZIP',
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3BackupMode' => 'FailedDataOnly|AllData',
'S3Configuration' => [ // REQUIRED
'BucketARN' => '<string>', // REQUIRED
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>', // REQUIRED
],
'SecretsManagerConfiguration' => [
'Enabled' => true || false, // REQUIRED
'RoleARN' => '<string>',
'SecretARN' => '<string>',
],
],
'IcebergDestinationConfiguration' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CatalogConfiguration' => [ // REQUIRED
'CatalogARN' => '<string>',
'WarehouseLocation' => '<string>',
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'DestinationTableConfigurationList' => [
[
'DestinationDatabaseName' => '<string>', // REQUIRED
'DestinationTableName' => '<string>', // REQUIRED
'PartitionSpec' => [
'Identity' => [
[
'SourceName' => '<string>', // REQUIRED
],
// ...
],
],
'S3ErrorOutputPrefix' => '<string>',
'UniqueKeys' => ['<string>', ...],
],
// ...
],
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>', // REQUIRED
'S3BackupMode' => 'FailedDataOnly|AllData',
'S3Configuration' => [ // REQUIRED
'BucketARN' => '<string>', // REQUIRED
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>', // REQUIRED
],
'SchemaEvolutionConfiguration' => [
'Enabled' => true || false, // REQUIRED
],
'TableCreationConfiguration' => [
'Enabled' => true || false, // REQUIRED
],
],
'KinesisStreamSourceConfiguration' => [
'KinesisStreamARN' => '<string>', // REQUIRED
'RoleARN' => '<string>', // REQUIRED
],
'MSKSourceConfiguration' => [
'AuthenticationConfiguration' => [ // REQUIRED
'Connectivity' => 'PUBLIC|PRIVATE', // REQUIRED
'RoleARN' => '<string>', // REQUIRED
],
'MSKClusterARN' => '<string>', // REQUIRED
'ReadFromTimestamp' => <integer || string || DateTime>,
'TopicName' => '<string>', // REQUIRED
],
'RedshiftDestinationConfiguration' => [
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'ClusterJDBCURL' => '<string>', // REQUIRED
'CopyCommand' => [ // REQUIRED
'CopyOptions' => '<string>',
'DataTableColumns' => '<string>',
'DataTableName' => '<string>', // REQUIRED
],
'Password' => '<string>',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>', // REQUIRED
'S3BackupConfiguration' => [
'BucketARN' => '<string>', // REQUIRED
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>', // REQUIRED
],
'S3BackupMode' => 'Disabled|Enabled',
'S3Configuration' => [ // REQUIRED
'BucketARN' => '<string>', // REQUIRED
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>', // REQUIRED
],
'SecretsManagerConfiguration' => [
'Enabled' => true || false, // REQUIRED
'RoleARN' => '<string>',
'SecretARN' => '<string>',
],
'Username' => '<string>',
],
'S3DestinationConfiguration' => [
'BucketARN' => '<string>', // REQUIRED
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>', // REQUIRED
],
'SnowflakeDestinationConfiguration' => [
'AccountUrl' => '<string>', // REQUIRED
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'ContentColumnName' => '<string>',
'DataLoadingOption' => 'JSON_MAPPING|VARIANT_CONTENT_MAPPING|VARIANT_CONTENT_AND_METADATA_MAPPING',
'Database' => '<string>', // REQUIRED
'KeyPassphrase' => '<string>',
'MetaDataColumnName' => '<string>',
'PrivateKey' => '<string>',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>', // REQUIRED
'S3BackupMode' => 'FailedDataOnly|AllData',
'S3Configuration' => [ // REQUIRED
'BucketARN' => '<string>', // REQUIRED
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>', // REQUIRED
],
'Schema' => '<string>', // REQUIRED
'SecretsManagerConfiguration' => [
'Enabled' => true || false, // REQUIRED
'RoleARN' => '<string>',
'SecretARN' => '<string>',
],
'SnowflakeRoleConfiguration' => [
'Enabled' => true || false,
'SnowflakeRole' => '<string>',
],
'SnowflakeVpcConfiguration' => [
'PrivateLinkVpceId' => '<string>', // REQUIRED
],
'Table' => '<string>', // REQUIRED
'User' => '<string>',
],
'SplunkDestinationConfiguration' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'HECAcknowledgmentTimeoutInSeconds' => <integer>,
'HECEndpoint' => '<string>', // REQUIRED
'HECEndpointType' => 'Raw|Event', // REQUIRED
'HECToken' => '<string>',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'S3BackupMode' => 'FailedEventsOnly|AllEvents',
'S3Configuration' => [ // REQUIRED
'BucketARN' => '<string>', // REQUIRED
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>', // REQUIRED
],
'SecretsManagerConfiguration' => [
'Enabled' => true || false, // REQUIRED
'RoleARN' => '<string>',
'SecretARN' => '<string>',
],
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- AmazonOpenSearchServerlessDestinationConfiguration
-
- Type: AmazonOpenSearchServerlessDestinationConfiguration structure
The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.
- AmazonopensearchserviceDestinationConfiguration
-
- Type: AmazonopensearchserviceDestinationConfiguration structure
The destination in Amazon OpenSearch Service. You can specify only one destination.
- DatabaseSourceConfiguration
-
- Type: DatabaseSourceConfiguration structure
Amazon Data Firehose is in preview release and is subject to change.
- DeliveryStreamEncryptionConfigurationInput
-
- Type: DeliveryStreamEncryptionConfigurationInput structure
Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
- DeliveryStreamName
-
- Required: Yes
- Type: string
The name of the Firehose stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the Firehose streams are in different accounts or different Regions, you can have multiple Firehose streams with the same name.
- DeliveryStreamType
-
- Type: string
The Firehose stream type. This parameter can be one of the following values:
-
DirectPut: Provider applications access the Firehose stream directly. -
KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
- ElasticsearchDestinationConfiguration
-
- Type: ElasticsearchDestinationConfiguration structure
The destination in Amazon ES. You can specify only one destination.
- ExtendedS3DestinationConfiguration
-
- Type: ExtendedS3DestinationConfiguration structure
The destination in Amazon S3. You can specify only one destination.
- HttpEndpointDestinationConfiguration
-
- Type: HttpEndpointDestinationConfiguration structure
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.
- IcebergDestinationConfiguration
-
- Type: IcebergDestinationConfiguration structure
Configure Apache Iceberg Tables destination.
- KinesisStreamSourceConfiguration
-
- Type: KinesisStreamSourceConfiguration structure
When a Kinesis data stream is used as the source for the Firehose stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.
- MSKSourceConfiguration
-
- Type: MSKSourceConfiguration structure
The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
- RedshiftDestinationConfiguration
-
- Type: RedshiftDestinationConfiguration structure
The destination in Amazon Redshift. You can specify only one destination.
- S3DestinationConfiguration
-
- Type: S3DestinationConfiguration structure
[Deprecated] The destination in Amazon S3. You can specify only one destination.
- SnowflakeDestinationConfiguration
-
- Type: SnowflakeDestinationConfiguration structure
Configure Snowflake destination
- SplunkDestinationConfiguration
-
- Type: SplunkDestinationConfiguration structure
The destination in Splunk. You can specify only one destination.
- Tags
-
- Type: Array of Tag structures
A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
You can specify up to 50 tags when creating a Firehose stream.
If you specify tags in the
CreateDeliveryStreamaction, Amazon Data Firehose performs an additional authorization on thefirehose:TagDeliveryStreamaction to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose Firehose streams with IAM resource tags will fail with anAccessDeniedExceptionsuch as following.AccessDeniedException
User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.
For an example IAM policy, see Tag example.
Result Syntax
[
'DeliveryStreamARN' => '<string>',
]
Result Details
Members
- DeliveryStreamARN
-
- Type: string
The ARN of the Firehose stream.
Errors
- InvalidArgumentException:
The specified input parameter has a value that is not valid.
- LimitExceededException:
You have already reached the limit for a requested resource.
- ResourceInUseException:
The resource is already in use and not available for this operation.
- InvalidKMSResourceException:
Firehose throws this exception when an attempt to put records or to start or stop Firehose stream encryption fails. This happens when the KMS service throws one of the following exception types:
AccessDeniedException,InvalidStateException,DisabledException, orNotFoundException.
DeleteDeliveryStream
$result = $client->deleteDeliveryStream([/* ... */]); $promise = $client->deleteDeliveryStreamAsync([/* ... */]);
Deletes a Firehose stream and its data.
You can delete a Firehose stream only if it is in one of the following states: ACTIVE, DELETING, CREATING_FAILED, or DELETING_FAILED. You can't delete a Firehose stream that is in the CREATING state. To check the state of a Firehose stream, use DescribeDeliveryStream.
DeleteDeliveryStream is an asynchronous API. When an API request to DeleteDeliveryStream succeeds, the Firehose stream is marked for deletion, and it goes into the DELETING state.While the Firehose stream is in the DELETING state, the service might continue to accept records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, first stop any applications that are sending records before you delete a Firehose stream.
Removal of a Firehose stream that is in the DELETING state is a low priority operation for the service. A stream may remain in the DELETING state for several minutes. Therefore, as a best practice, applications should not wait for streams in the DELETING state to be removed.
Parameter Syntax
$result = $client->deleteDeliveryStream([
'AllowForceDelete' => true || false,
'DeliveryStreamName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AllowForceDelete
-
- Type: boolean
Set this to true if you want to delete the Firehose stream even if Firehose is unable to retire the grant for the CMK. Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Firehose. If a failure to retire the grant happens due to an Amazon Web Services KMS issue, Firehose keeps retrying the delete operation.
The default value is false.
- DeliveryStreamName
-
- Required: Yes
- Type: string
The name of the Firehose stream.
Result Syntax
[]
Result Details
Errors
- ResourceInUseException:
The resource is already in use and not available for this operation.
- ResourceNotFoundException:
The specified resource could not be found.
DescribeDeliveryStream
$result = $client->describeDeliveryStream([/* ... */]); $promise = $client->describeDeliveryStreamAsync([/* ... */]);
Describes the specified Firehose stream and its status. For example, after your Firehose stream is created, call DescribeDeliveryStream to see whether the Firehose stream is ACTIVE and therefore ready for data to be sent to it.
If the status of a Firehose stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. If the status is DELETING_FAILED, you can force deletion by invoking DeleteDeliveryStream again but with DeleteDeliveryStreamInput$AllowForceDelete set to true.
Parameter Syntax
$result = $client->describeDeliveryStream([
'DeliveryStreamName' => '<string>', // REQUIRED
'ExclusiveStartDestinationId' => '<string>',
'Limit' => <integer>,
]);
Parameter Details
Members
- DeliveryStreamName
-
- Required: Yes
- Type: string
The name of the Firehose stream.
- ExclusiveStartDestinationId
-
- Type: string
The ID of the destination to start returning the destination information. Firehose supports one destination per Firehose stream.
- Limit
-
- Type: int
The limit on the number of destinations to return. You can have one destination per Firehose stream.
Result Syntax
[
'DeliveryStreamDescription' => [
'CreateTimestamp' => <DateTime>,
'DeliveryStreamARN' => '<string>',
'DeliveryStreamEncryptionConfiguration' => [
'FailureDescription' => [
'Details' => '<string>',
'Type' => 'VPC_ENDPOINT_SERVICE_NAME_NOT_FOUND|VPC_INTERFACE_ENDPOINT_SERVICE_ACCESS_DENIED|RETIRE_KMS_GRANT_FAILED|CREATE_KMS_GRANT_FAILED|KMS_ACCESS_DENIED|DISABLED_KMS_KEY|INVALID_KMS_KEY|KMS_KEY_NOT_FOUND|KMS_OPT_IN_REQUIRED|CREATE_ENI_FAILED|DELETE_ENI_FAILED|SUBNET_NOT_FOUND|SECURITY_GROUP_NOT_FOUND|ENI_ACCESS_DENIED|SUBNET_ACCESS_DENIED|SECURITY_GROUP_ACCESS_DENIED|UNKNOWN_ERROR',
],
'KeyARN' => '<string>',
'KeyType' => 'AWS_OWNED_CMK|CUSTOMER_MANAGED_CMK',
'Status' => 'ENABLED|ENABLING|ENABLING_FAILED|DISABLED|DISABLING|DISABLING_FAILED',
],
'DeliveryStreamName' => '<string>',
'DeliveryStreamStatus' => 'CREATING|CREATING_FAILED|DELETING|DELETING_FAILED|ACTIVE',
'DeliveryStreamType' => 'DirectPut|KinesisStreamAsSource|MSKAsSource|DatabaseAsSource',
'Destinations' => [
[
'AmazonOpenSearchServerlessDestinationDescription' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CollectionEndpoint' => '<string>',
'IndexName' => '<string>',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction',
'ParameterValue' => '<string>',
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord',
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3BackupMode' => 'FailedDocumentsOnly|AllDocuments',
'S3DestinationDescription' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>',
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'VpcConfigurationDescription' => [
'RoleARN' => '<string>',
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'VpcId' => '<string>',
],
],
'AmazonopensearchserviceDestinationDescription' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'ClusterEndpoint' => '<string>',
'DocumentIdOptions' => [
'DefaultDocumentIdFormat' => 'FIREHOSE_DEFAULT|NO_DOCUMENT_ID',
],
'DomainARN' => '<string>',
'IndexName' => '<string>',
'IndexRotationPeriod' => 'NoRotation|OneHour|OneDay|OneWeek|OneMonth',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction',
'ParameterValue' => '<string>',
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord',
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3BackupMode' => 'FailedDocumentsOnly|AllDocuments',
'S3DestinationDescription' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>',
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'TypeName' => '<string>',
'VpcConfigurationDescription' => [
'RoleARN' => '<string>',
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'VpcId' => '<string>',
],
],
'DestinationId' => '<string>',
'ElasticsearchDestinationDescription' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'ClusterEndpoint' => '<string>',
'DocumentIdOptions' => [
'DefaultDocumentIdFormat' => 'FIREHOSE_DEFAULT|NO_DOCUMENT_ID',
],
'DomainARN' => '<string>',
'IndexName' => '<string>',
'IndexRotationPeriod' => 'NoRotation|OneHour|OneDay|OneWeek|OneMonth',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction',
'ParameterValue' => '<string>',
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord',
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3BackupMode' => 'FailedDocumentsOnly|AllDocuments',
'S3DestinationDescription' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>',
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'TypeName' => '<string>',
'VpcConfigurationDescription' => [
'RoleARN' => '<string>',
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
'VpcId' => '<string>',
],
],
'ExtendedS3DestinationDescription' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'CustomTimeZone' => '<string>',
'DataFormatConversionConfiguration' => [
'Enabled' => true || false,
'InputFormatConfiguration' => [
'Deserializer' => [
'HiveJsonSerDe' => [
'TimestampFormats' => ['<string>', ...],
],
'OpenXJsonSerDe' => [
'CaseInsensitive' => true || false,
'ColumnToJsonKeyMappings' => ['<string>', ...],
'ConvertDotsInJsonKeysToUnderscores' => true || false,
],
],
],
'OutputFormatConfiguration' => [
'Serializer' => [
'OrcSerDe' => [
'BlockSizeBytes' => <integer>,
'BloomFilterColumns' => ['<string>', ...],
'BloomFilterFalsePositiveProbability' => <float>,
'Compression' => 'NONE|ZLIB|SNAPPY',
'DictionaryKeyThreshold' => <float>,
'EnablePadding' => true || false,
'FormatVersion' => 'V0_11|V0_12',
'PaddingTolerance' => <float>,
'RowIndexStride' => <integer>,
'StripeSizeBytes' => <integer>,
],
'ParquetSerDe' => [
'BlockSizeBytes' => <integer>,
'Compression' => 'UNCOMPRESSED|GZIP|SNAPPY',
'EnableDictionaryCompression' => true || false,
'MaxPaddingBytes' => <integer>,
'PageSizeBytes' => <integer>,
'WriterVersion' => 'V1|V2',
],
],
],
'SchemaConfiguration' => [
'CatalogId' => '<string>',
'DatabaseName' => '<string>',
'Region' => '<string>',
'RoleARN' => '<string>',
'TableName' => '<string>',
'VersionId' => '<string>',
],
],
'DynamicPartitioningConfiguration' => [
'Enabled' => true || false,
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
],
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>',
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'FileExtension' => '<string>',
'Prefix' => '<string>',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction',
'ParameterValue' => '<string>',
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord',
],
// ...
],
],
'RoleARN' => '<string>',
'S3BackupDescription' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>',
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'S3BackupMode' => 'Disabled|Enabled',
],
'HttpEndpointDestinationDescription' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'EndpointConfiguration' => [
'Name' => '<string>',
'Url' => '<string>',
],
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction',
'ParameterValue' => '<string>',
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord',
],
// ...
],
],
'RequestConfiguration' => [
'CommonAttributes' => [
[
'AttributeName' => '<string>',
'AttributeValue' => '<string>',
],
// ...
],
'ContentEncoding' => 'NONE|GZIP',
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3BackupMode' => 'FailedDataOnly|AllData',
'S3DestinationDescription' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>',
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'SecretsManagerConfiguration' => [
'Enabled' => true || false,
'RoleARN' => '<string>',
'SecretARN' => '<string>',
],
],
'IcebergDestinationDescription' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CatalogConfiguration' => [
'CatalogARN' => '<string>',
'WarehouseLocation' => '<string>',
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'DestinationTableConfigurationList' => [
[
'DestinationDatabaseName' => '<string>',
'DestinationTableName' => '<string>',
'PartitionSpec' => [
'Identity' => [
[
'SourceName' => '<string>',
],
// ...
],
],
'S3ErrorOutputPrefix' => '<string>',
'UniqueKeys' => ['<string>', ...],
],
// ...
],
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction',
'ParameterValue' => '<string>',
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord',
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3BackupMode' => 'FailedDataOnly|AllData',
'S3DestinationDescription' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>',
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'SchemaEvolutionConfiguration' => [
'Enabled' => true || false,
],
'TableCreationConfiguration' => [
'Enabled' => true || false,
],
],
'RedshiftDestinationDescription' => [
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'ClusterJDBCURL' => '<string>',
'CopyCommand' => [
'CopyOptions' => '<string>',
'DataTableColumns' => '<string>',
'DataTableName' => '<string>',
],
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction',
'ParameterValue' => '<string>',
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord',
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3BackupDescription' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>',
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'S3BackupMode' => 'Disabled|Enabled',
'S3DestinationDescription' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>',
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'SecretsManagerConfiguration' => [
'Enabled' => true || false,
'RoleARN' => '<string>',
'SecretARN' => '<string>',
],
'Username' => '<string>',
],
'S3DestinationDescription' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>',
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'SnowflakeDestinationDescription' => [
'AccountUrl' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'ContentColumnName' => '<string>',
'DataLoadingOption' => 'JSON_MAPPING|VARIANT_CONTENT_MAPPING|VARIANT_CONTENT_AND_METADATA_MAPPING',
'Database' => '<string>',
'MetaDataColumnName' => '<string>',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction',
'ParameterValue' => '<string>',
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord',
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3BackupMode' => 'FailedDataOnly|AllData',
'S3DestinationDescription' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>',
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'Schema' => '<string>',
'SecretsManagerConfiguration' => [
'Enabled' => true || false,
'RoleARN' => '<string>',
'SecretARN' => '<string>',
],
'SnowflakeRoleConfiguration' => [
'Enabled' => true || false,
'SnowflakeRole' => '<string>',
],
'SnowflakeVpcConfiguration' => [
'PrivateLinkVpceId' => '<string>',
],
'Table' => '<string>',
'User' => '<string>',
],
'SplunkDestinationDescription' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'HECAcknowledgmentTimeoutInSeconds' => <integer>,
'HECEndpoint' => '<string>',
'HECEndpointType' => 'Raw|Event',
'HECToken' => '<string>',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction',
'ParameterValue' => '<string>',
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord',
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'S3BackupMode' => 'FailedEventsOnly|AllEvents',
'S3DestinationDescription' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>',
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'SecretsManagerConfiguration' => [
'Enabled' => true || false,
'RoleARN' => '<string>',
'SecretARN' => '<string>',
],
],
],
// ...
],
'FailureDescription' => [
'Details' => '<string>',
'Type' => 'VPC_ENDPOINT_SERVICE_NAME_NOT_FOUND|VPC_INTERFACE_ENDPOINT_SERVICE_ACCESS_DENIED|RETIRE_KMS_GRANT_FAILED|CREATE_KMS_GRANT_FAILED|KMS_ACCESS_DENIED|DISABLED_KMS_KEY|INVALID_KMS_KEY|KMS_KEY_NOT_FOUND|KMS_OPT_IN_REQUIRED|CREATE_ENI_FAILED|DELETE_ENI_FAILED|SUBNET_NOT_FOUND|SECURITY_GROUP_NOT_FOUND|ENI_ACCESS_DENIED|SUBNET_ACCESS_DENIED|SECURITY_GROUP_ACCESS_DENIED|UNKNOWN_ERROR',
],
'HasMoreDestinations' => true || false,
'LastUpdateTimestamp' => <DateTime>,
'Source' => [
'DatabaseSourceDescription' => [
'Columns' => [
'Exclude' => ['<string>', ...],
'Include' => ['<string>', ...],
],
'DatabaseSourceAuthenticationConfiguration' => [
'SecretsManagerConfiguration' => [
'Enabled' => true || false,
'RoleARN' => '<string>',
'SecretARN' => '<string>',
],
],
'DatabaseSourceVPCConfiguration' => [
'VpcEndpointServiceName' => '<string>',
],
'Databases' => [
'Exclude' => ['<string>', ...],
'Include' => ['<string>', ...],
],
'Endpoint' => '<string>',
'Port' => <integer>,
'SSLMode' => 'Disabled|Enabled',
'SnapshotInfo' => [
[
'FailureDescription' => [
'Details' => '<string>',
'Type' => 'VPC_ENDPOINT_SERVICE_NAME_NOT_FOUND|VPC_INTERFACE_ENDPOINT_SERVICE_ACCESS_DENIED|RETIRE_KMS_GRANT_FAILED|CREATE_KMS_GRANT_FAILED|KMS_ACCESS_DENIED|DISABLED_KMS_KEY|INVALID_KMS_KEY|KMS_KEY_NOT_FOUND|KMS_OPT_IN_REQUIRED|CREATE_ENI_FAILED|DELETE_ENI_FAILED|SUBNET_NOT_FOUND|SECURITY_GROUP_NOT_FOUND|ENI_ACCESS_DENIED|SUBNET_ACCESS_DENIED|SECURITY_GROUP_ACCESS_DENIED|UNKNOWN_ERROR',
],
'Id' => '<string>',
'RequestTimestamp' => <DateTime>,
'RequestedBy' => 'USER|FIREHOSE',
'Status' => 'IN_PROGRESS|COMPLETE|SUSPENDED',
'Table' => '<string>',
],
// ...
],
'SnapshotWatermarkTable' => '<string>',
'SurrogateKeys' => ['<string>', ...],
'Tables' => [
'Exclude' => ['<string>', ...],
'Include' => ['<string>', ...],
],
'Type' => 'MySQL|PostgreSQL',
],
'KinesisStreamSourceDescription' => [
'DeliveryStartTimestamp' => <DateTime>,
'KinesisStreamARN' => '<string>',
'RoleARN' => '<string>',
],
'MSKSourceDescription' => [
'AuthenticationConfiguration' => [
'Connectivity' => 'PUBLIC|PRIVATE',
'RoleARN' => '<string>',
],
'DeliveryStartTimestamp' => <DateTime>,
'MSKClusterARN' => '<string>',
'ReadFromTimestamp' => <DateTime>,
'TopicName' => '<string>',
],
],
'VersionId' => '<string>',
],
]
Result Details
Members
- DeliveryStreamDescription
-
- Required: Yes
- Type: DeliveryStreamDescription structure
Information about the Firehose stream.
Errors
- ResourceNotFoundException:
The specified resource could not be found.
ListDeliveryStreams
$result = $client->listDeliveryStreams([/* ... */]); $promise = $client->listDeliveryStreamsAsync([/* ... */]);
Lists your Firehose streams in alphabetical order of their names.
The number of Firehose streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of Firehose streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more Firehose streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last Firehose stream returned in the last call.
Parameter Syntax
$result = $client->listDeliveryStreams([
'DeliveryStreamType' => 'DirectPut|KinesisStreamAsSource|MSKAsSource|DatabaseAsSource',
'ExclusiveStartDeliveryStreamName' => '<string>',
'Limit' => <integer>,
]);
Parameter Details
Members
- DeliveryStreamType
-
- Type: string
The Firehose stream type. This can be one of the following values:
-
DirectPut: Provider applications access the Firehose stream directly. -
KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
This parameter is optional. If this parameter is omitted, Firehose streams of all types are returned.
- ExclusiveStartDeliveryStreamName
-
- Type: string
The list of Firehose streams returned by this call to
ListDeliveryStreamswill start with the Firehose stream whose name comes alphabetically immediately after the name you specify inExclusiveStartDeliveryStreamName. - Limit
-
- Type: int
The maximum number of Firehose streams to list. The default value is 10.
Result Syntax
[
'DeliveryStreamNames' => ['<string>', ...],
'HasMoreDeliveryStreams' => true || false,
]
Result Details
Members
- DeliveryStreamNames
-
- Required: Yes
- Type: Array of strings
The names of the Firehose streams.
- HasMoreDeliveryStreams
-
- Required: Yes
- Type: boolean
Indicates whether there are more Firehose streams available to list.
Errors
There are no errors described for this operation.
ListTagsForDeliveryStream
$result = $client->listTagsForDeliveryStream([/* ... */]); $promise = $client->listTagsForDeliveryStreamAsync([/* ... */]);
Lists the tags for the specified Firehose stream. This operation has a limit of five transactions per second per account.
Parameter Syntax
$result = $client->listTagsForDeliveryStream([
'DeliveryStreamName' => '<string>', // REQUIRED
'ExclusiveStartTagKey' => '<string>',
'Limit' => <integer>,
]);
Parameter Details
Members
- DeliveryStreamName
-
- Required: Yes
- Type: string
The name of the Firehose stream whose tags you want to list.
- ExclusiveStartTagKey
-
- Type: string
The key to use as the starting point for the list of tags. If you set this parameter,
ListTagsForDeliveryStreamgets all tags that occur afterExclusiveStartTagKey. - Limit
-
- Type: int
The number of tags to return. If this number is less than the total number of tags associated with the Firehose stream,
HasMoreTagsis set totruein the response. To list additional tags, setExclusiveStartTagKeyto the last key in the response.
Result Syntax
[
'HasMoreTags' => true || false,
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- HasMoreTags
-
- Required: Yes
- Type: boolean
If this is
truein the response, more tags are available. To list the remaining tags, setExclusiveStartTagKeyto the key of the last tag returned and callListTagsForDeliveryStreamagain. - Tags
-
- Required: Yes
- Type: Array of Tag structures
A list of tags associated with
DeliveryStreamName, starting with the first tag afterExclusiveStartTagKeyand up to the specifiedLimit.
Errors
- ResourceNotFoundException:
The specified resource could not be found.
- InvalidArgumentException:
The specified input parameter has a value that is not valid.
- LimitExceededException:
You have already reached the limit for a requested resource.
PutRecord
$result = $client->putRecord([/* ... */]); $promise = $client->putRecordAsync([/* ... */]);
Writes a single data record into an Firehose stream. To write multiple data records into a Firehose stream, use PutRecordBatch. Applications using these operations are referred to as producers.
By default, each Firehose stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each Firehose stream. For more information about limits and how to request an increase, see Amazon Firehose Limits.
Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a Firehose stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics.
You must specify the name of the Firehose stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KiB in size, and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on.
For multi record de-aggregation, you can not put more than 500 records even if the data blob length is less than 1000 KiB. If you include more than 500 records, the request succeeds but the record de-aggregation doesn't work as expected and transformation lambda is invoked with the complete base64 encoded data blob instead of de-aggregated base64 decoded records.
Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.
The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.
If the PutRecord operation throws a ServiceUnavailableException, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the Firehose stream.
Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations.
Data records sent to Firehose are stored for 24 hours from the time they are added to a Firehose stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.
Parameter Syntax
$result = $client->putRecord([
'DeliveryStreamName' => '<string>', // REQUIRED
'Record' => [ // REQUIRED
'Data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
],
]);
Parameter Details
Members
- DeliveryStreamName
-
- Required: Yes
- Type: string
The name of the Firehose stream.
- Record
-
- Required: Yes
- Type: Record structure
The record.
Result Syntax
[
'Encrypted' => true || false,
'RecordId' => '<string>',
]
Result Details
Members
- Encrypted
-
- Type: boolean
Indicates whether server-side encryption (SSE) was enabled during this operation.
- RecordId
-
- Required: Yes
- Type: string
The ID of the record.
Errors
- ResourceNotFoundException:
The specified resource could not be found.
- InvalidArgumentException:
The specified input parameter has a value that is not valid.
- InvalidKMSResourceException:
Firehose throws this exception when an attempt to put records or to start or stop Firehose stream encryption fails. This happens when the KMS service throws one of the following exception types:
AccessDeniedException,InvalidStateException,DisabledException, orNotFoundException.- InvalidSourceException:
Only requests from CloudWatch Logs are supported when CloudWatch Logs decompression is enabled.
- ServiceUnavailableException:
The service is unavailable. Back off and retry the operation. If you continue to see the exception, throughput limits for the Firehose stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Firehose Limits.
PutRecordBatch
$result = $client->putRecordBatch([/* ... */]); $promise = $client->putRecordBatchAsync([/* ... */]);
Writes multiple data records into a Firehose stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a Firehose stream, use PutRecord. Applications using these operations are referred to as producers.
Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a Firehose stream last only for a few seconds. Due to this, the actual spikes in the traffic might not be fully visible in the customer's 1 minute CloudWatch metrics.
For information about service quota, see Amazon Firehose Quota.
Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.
You must specify the name of the Firehose stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on.
For multi record de-aggregation, you can not put more than 500 records even if the data blob length is less than 1000 KiB. If you include more than 500 records, the request succeeds but the record de-aggregation doesn't work as expected and transformation lambda is invoked with the complete base64 encoded data blob instead of de-aggregated base64 decoded records.
Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.
The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, indicating that there are records for which the operation didn't succeed. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records.
A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailableException or InternalFailure. ErrorMessage provides more detailed information about the error.
If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.
If PutRecordBatch throws ServiceUnavailableException, the API is automatically reinvoked (retried) 3 times. If the exception persists, it is possible that the throughput limits have been exceeded for the Firehose stream.
Re-invoking the Put API operations (for example, PutRecord and PutRecordBatch) can result in data duplicates. For larger data assets, allow for a longer time out before retrying Put API operations.
Data records sent to Firehose are stored for 24 hours from the time they are added to a Firehose stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.
Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.
Parameter Syntax
$result = $client->putRecordBatch([
'DeliveryStreamName' => '<string>', // REQUIRED
'Records' => [ // REQUIRED
[
'Data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- DeliveryStreamName
-
- Required: Yes
- Type: string
The name of the Firehose stream.
- Records
-
- Required: Yes
- Type: Array of Record structures
One or more records.
Result Syntax
[
'Encrypted' => true || false,
'FailedPutCount' => <integer>,
'RequestResponses' => [
[
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'RecordId' => '<string>',
],
// ...
],
]
Result Details
Members
- Encrypted
-
- Type: boolean
Indicates whether server-side encryption (SSE) was enabled during this operation.
- FailedPutCount
-
- Required: Yes
- Type: int
The number of records that might have failed processing. This number might be greater than 0 even if the PutRecordBatch call succeeds. Check
FailedPutCountto determine whether there are records that you need to resend. - RequestResponses
-
- Required: Yes
- Type: Array of PutRecordBatchResponseEntry structures
The results array. For each record, the index of the response element is the same as the index used in the request array.
Errors
- ResourceNotFoundException:
The specified resource could not be found.
- InvalidArgumentException:
The specified input parameter has a value that is not valid.
- InvalidKMSResourceException:
Firehose throws this exception when an attempt to put records or to start or stop Firehose stream encryption fails. This happens when the KMS service throws one of the following exception types:
AccessDeniedException,InvalidStateException,DisabledException, orNotFoundException.- InvalidSourceException:
Only requests from CloudWatch Logs are supported when CloudWatch Logs decompression is enabled.
- ServiceUnavailableException:
The service is unavailable. Back off and retry the operation. If you continue to see the exception, throughput limits for the Firehose stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Firehose Limits.
StartDeliveryStreamEncryption
$result = $client->startDeliveryStreamEncryption([/* ... */]); $promise = $client->startDeliveryStreamEncryptionAsync([/* ... */]);
Enables server-side encryption (SSE) for the Firehose stream.
This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to ENABLING, and then to ENABLED. The encryption status of a Firehose stream is the Status property in DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and write data to your Firehose stream while the encryption status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the Firehose stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.
To check the encryption status of a Firehose stream, use DescribeDeliveryStream.
Even if encryption is currently enabled for a Firehose stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, Firehose schedules the grant it had on the old CMK for retirement. If the new CMK is of type CUSTOMER_MANAGED_CMK, Firehose creates a grant that enables it to use the new CMK to encrypt and decrypt data and to manage the grant.
For the KMS grant creation to be successful, the Firehose API operations StartDeliveryStreamEncryption and CreateDeliveryStream should not be called with session credentials that are more than 6 hours old.
If a Firehose stream already has encryption enabled and then you invoke this operation to change the ARN of the CMK or both its type and ARN and you get ENABLING_FAILED, this only means that the attempt to change the CMK failed. In this case, encryption remains enabled with the old CMK.
If the encryption status of your Firehose stream is ENABLING_FAILED, you can invoke this operation again with a valid CMK. The CMK must be enabled and the key policy mustn't explicitly deny the permission for Firehose to invoke KMS encrypt and decrypt operations.
You can enable SSE for a Firehose stream only if it's a Firehose stream that uses DirectPut as its source.
The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per Firehose stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same Firehose stream in a 24-hour period.
Parameter Syntax
$result = $client->startDeliveryStreamEncryption([
'DeliveryStreamEncryptionConfigurationInput' => [
'KeyARN' => '<string>',
'KeyType' => 'AWS_OWNED_CMK|CUSTOMER_MANAGED_CMK', // REQUIRED
],
'DeliveryStreamName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DeliveryStreamEncryptionConfigurationInput
-
- Type: DeliveryStreamEncryptionConfigurationInput structure
Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
- DeliveryStreamName
-
- Required: Yes
- Type: string
The name of the Firehose stream for which you want to enable server-side encryption (SSE).
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource could not be found.
- ResourceInUseException:
The resource is already in use and not available for this operation.
- InvalidArgumentException:
The specified input parameter has a value that is not valid.
- LimitExceededException:
You have already reached the limit for a requested resource.
- InvalidKMSResourceException:
Firehose throws this exception when an attempt to put records or to start or stop Firehose stream encryption fails. This happens when the KMS service throws one of the following exception types:
AccessDeniedException,InvalidStateException,DisabledException, orNotFoundException.
StopDeliveryStreamEncryption
$result = $client->stopDeliveryStreamEncryption([/* ... */]); $promise = $client->stopDeliveryStreamEncryptionAsync([/* ... */]);
Disables server-side encryption (SSE) for the Firehose stream.
This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to DISABLING, and then to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED before all records written to the Firehose stream are no longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.
To check the encryption state of a Firehose stream, use DescribeDeliveryStream.
If SSE is enabled using a customer managed CMK and then you invoke StopDeliveryStreamEncryption, Firehose schedules the related KMS grant for retirement and then retires it after it ensures that it is finished delivering records to the destination.
The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per Firehose stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same Firehose stream in a 24-hour period.
Parameter Syntax
$result = $client->stopDeliveryStreamEncryption([
'DeliveryStreamName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- DeliveryStreamName
-
- Required: Yes
- Type: string
The name of the Firehose stream for which you want to disable server-side encryption (SSE).
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource could not be found.
- ResourceInUseException:
The resource is already in use and not available for this operation.
- InvalidArgumentException:
The specified input parameter has a value that is not valid.
- LimitExceededException:
You have already reached the limit for a requested resource.
TagDeliveryStream
$result = $client->tagDeliveryStream([/* ... */]); $promise = $client->tagDeliveryStreamAsync([/* ... */]);
Adds or updates tags for the specified Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
Each Firehose stream can have up to 50 tags.
This operation has a limit of five transactions per second per account.
Parameter Syntax
$result = $client->tagDeliveryStream([
'DeliveryStreamName' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- DeliveryStreamName
-
- Required: Yes
- Type: string
The name of the Firehose stream to which you want to add the tags.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
A set of key-value pairs to use to create the tags.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource could not be found.
- ResourceInUseException:
The resource is already in use and not available for this operation.
- InvalidArgumentException:
The specified input parameter has a value that is not valid.
- LimitExceededException:
You have already reached the limit for a requested resource.
UntagDeliveryStream
$result = $client->untagDeliveryStream([/* ... */]); $promise = $client->untagDeliveryStreamAsync([/* ... */]);
Removes tags from the specified Firehose stream. Removed tags are deleted, and you can't recover them after this operation successfully completes.
If you specify a tag that doesn't exist, the operation ignores it.
This operation has a limit of five transactions per second per account.
Parameter Syntax
$result = $client->untagDeliveryStream([
'DeliveryStreamName' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- DeliveryStreamName
-
- Required: Yes
- Type: string
The name of the Firehose stream.
- TagKeys
-
- Required: Yes
- Type: Array of strings
A list of tag keys. Each corresponding tag is removed from the delivery stream.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource could not be found.
- ResourceInUseException:
The resource is already in use and not available for this operation.
- InvalidArgumentException:
The specified input parameter has a value that is not valid.
- LimitExceededException:
You have already reached the limit for a requested resource.
UpdateDestination
$result = $client->updateDestination([/* ... */]); $promise = $client->updateDestinationAsync([/* ... */]);
Updates the specified destination of the specified Firehose stream.
Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target Firehose stream remains active while the configurations are updated, so data writes to the Firehose stream can continue during this process. The updated configurations are usually effective within a few minutes.
Switching between Amazon OpenSearch Service and other services is not supported. For an Amazon OpenSearch Service destination, you can only update to another Amazon OpenSearch Service destination.
If the destination type is the same, Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination.
If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Firehose does not merge any parameters. In this case, all parameters must be specified.
Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.
Parameter Syntax
$result = $client->updateDestination([
'AmazonOpenSearchServerlessDestinationUpdate' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CollectionEndpoint' => '<string>',
'IndexName' => '<string>',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3Update' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
],
'AmazonopensearchserviceDestinationUpdate' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'ClusterEndpoint' => '<string>',
'DocumentIdOptions' => [
'DefaultDocumentIdFormat' => 'FIREHOSE_DEFAULT|NO_DOCUMENT_ID', // REQUIRED
],
'DomainARN' => '<string>',
'IndexName' => '<string>',
'IndexRotationPeriod' => 'NoRotation|OneHour|OneDay|OneWeek|OneMonth',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3Update' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'TypeName' => '<string>',
],
'CurrentDeliveryStreamVersionId' => '<string>', // REQUIRED
'DeliveryStreamName' => '<string>', // REQUIRED
'DestinationId' => '<string>', // REQUIRED
'ElasticsearchDestinationUpdate' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'ClusterEndpoint' => '<string>',
'DocumentIdOptions' => [
'DefaultDocumentIdFormat' => 'FIREHOSE_DEFAULT|NO_DOCUMENT_ID', // REQUIRED
],
'DomainARN' => '<string>',
'IndexName' => '<string>',
'IndexRotationPeriod' => 'NoRotation|OneHour|OneDay|OneWeek|OneMonth',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3Update' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'TypeName' => '<string>',
],
'ExtendedS3DestinationUpdate' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'CustomTimeZone' => '<string>',
'DataFormatConversionConfiguration' => [
'Enabled' => true || false,
'InputFormatConfiguration' => [
'Deserializer' => [
'HiveJsonSerDe' => [
'TimestampFormats' => ['<string>', ...],
],
'OpenXJsonSerDe' => [
'CaseInsensitive' => true || false,
'ColumnToJsonKeyMappings' => ['<string>', ...],
'ConvertDotsInJsonKeysToUnderscores' => true || false,
],
],
],
'OutputFormatConfiguration' => [
'Serializer' => [
'OrcSerDe' => [
'BlockSizeBytes' => <integer>,
'BloomFilterColumns' => ['<string>', ...],
'BloomFilterFalsePositiveProbability' => <float>,
'Compression' => 'NONE|ZLIB|SNAPPY',
'DictionaryKeyThreshold' => <float>,
'EnablePadding' => true || false,
'FormatVersion' => 'V0_11|V0_12',
'PaddingTolerance' => <float>,
'RowIndexStride' => <integer>,
'StripeSizeBytes' => <integer>,
],
'ParquetSerDe' => [
'BlockSizeBytes' => <integer>,
'Compression' => 'UNCOMPRESSED|GZIP|SNAPPY',
'EnableDictionaryCompression' => true || false,
'MaxPaddingBytes' => <integer>,
'PageSizeBytes' => <integer>,
'WriterVersion' => 'V1|V2',
],
],
],
'SchemaConfiguration' => [
'CatalogId' => '<string>',
'DatabaseName' => '<string>',
'Region' => '<string>',
'RoleARN' => '<string>',
'TableName' => '<string>',
'VersionId' => '<string>',
],
],
'DynamicPartitioningConfiguration' => [
'Enabled' => true || false,
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
],
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'FileExtension' => '<string>',
'Prefix' => '<string>',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RoleARN' => '<string>',
'S3BackupMode' => 'Disabled|Enabled',
'S3BackupUpdate' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
],
'HttpEndpointDestinationUpdate' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'EndpointConfiguration' => [
'AccessKey' => '<string>',
'Name' => '<string>',
'Url' => '<string>', // REQUIRED
],
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RequestConfiguration' => [
'CommonAttributes' => [
[
'AttributeName' => '<string>', // REQUIRED
'AttributeValue' => '<string>', // REQUIRED
],
// ...
],
'ContentEncoding' => 'NONE|GZIP',
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3BackupMode' => 'FailedDataOnly|AllData',
'S3Update' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'SecretsManagerConfiguration' => [
'Enabled' => true || false, // REQUIRED
'RoleARN' => '<string>',
'SecretARN' => '<string>',
],
],
'IcebergDestinationUpdate' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CatalogConfiguration' => [
'CatalogARN' => '<string>',
'WarehouseLocation' => '<string>',
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'DestinationTableConfigurationList' => [
[
'DestinationDatabaseName' => '<string>', // REQUIRED
'DestinationTableName' => '<string>', // REQUIRED
'PartitionSpec' => [
'Identity' => [
[
'SourceName' => '<string>', // REQUIRED
],
// ...
],
],
'S3ErrorOutputPrefix' => '<string>',
'UniqueKeys' => ['<string>', ...],
],
// ...
],
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3BackupMode' => 'FailedDataOnly|AllData',
'S3Configuration' => [
'BucketARN' => '<string>', // REQUIRED
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>', // REQUIRED
],
'SchemaEvolutionConfiguration' => [
'Enabled' => true || false, // REQUIRED
],
'TableCreationConfiguration' => [
'Enabled' => true || false, // REQUIRED
],
],
'RedshiftDestinationUpdate' => [
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'ClusterJDBCURL' => '<string>',
'CopyCommand' => [
'CopyOptions' => '<string>',
'DataTableColumns' => '<string>',
'DataTableName' => '<string>', // REQUIRED
],
'Password' => '<string>',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3BackupMode' => 'Disabled|Enabled',
'S3BackupUpdate' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'S3Update' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'SecretsManagerConfiguration' => [
'Enabled' => true || false, // REQUIRED
'RoleARN' => '<string>',
'SecretARN' => '<string>',
],
'Username' => '<string>',
],
'S3DestinationUpdate' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'SnowflakeDestinationUpdate' => [
'AccountUrl' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'ContentColumnName' => '<string>',
'DataLoadingOption' => 'JSON_MAPPING|VARIANT_CONTENT_MAPPING|VARIANT_CONTENT_AND_METADATA_MAPPING',
'Database' => '<string>',
'KeyPassphrase' => '<string>',
'MetaDataColumnName' => '<string>',
'PrivateKey' => '<string>',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'RoleARN' => '<string>',
'S3BackupMode' => 'FailedDataOnly|AllData',
'S3Update' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'Schema' => '<string>',
'SecretsManagerConfiguration' => [
'Enabled' => true || false, // REQUIRED
'RoleARN' => '<string>',
'SecretARN' => '<string>',
],
'SnowflakeRoleConfiguration' => [
'Enabled' => true || false,
'SnowflakeRole' => '<string>',
],
'Table' => '<string>',
'User' => '<string>',
],
'SplunkDestinationUpdate' => [
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'HECAcknowledgmentTimeoutInSeconds' => <integer>,
'HECEndpoint' => '<string>',
'HECEndpointType' => 'Raw|Event',
'HECToken' => '<string>',
'ProcessingConfiguration' => [
'Enabled' => true || false,
'Processors' => [
[
'Parameters' => [
[
'ParameterName' => 'LambdaArn|NumberOfRetries|MetadataExtractionQuery|JsonParsingEngine|RoleArn|BufferSizeInMBs|BufferIntervalInSeconds|SubRecordType|Delimiter|CompressionFormat|DataMessageExtraction', // REQUIRED
'ParameterValue' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'RecordDeAggregation|Decompression|CloudWatchLogProcessing|Lambda|MetadataExtraction|AppendDelimiterToRecord', // REQUIRED
],
// ...
],
],
'RetryOptions' => [
'DurationInSeconds' => <integer>,
],
'S3BackupMode' => 'FailedEventsOnly|AllEvents',
'S3Update' => [
'BucketARN' => '<string>',
'BufferingHints' => [
'IntervalInSeconds' => <integer>,
'SizeInMBs' => <integer>,
],
'CloudWatchLoggingOptions' => [
'Enabled' => true || false,
'LogGroupName' => '<string>',
'LogStreamName' => '<string>',
],
'CompressionFormat' => 'UNCOMPRESSED|GZIP|ZIP|Snappy|HADOOP_SNAPPY',
'EncryptionConfiguration' => [
'KMSEncryptionConfig' => [
'AWSKMSKeyARN' => '<string>', // REQUIRED
],
'NoEncryptionConfig' => 'NoEncryption',
],
'ErrorOutputPrefix' => '<string>',
'Prefix' => '<string>',
'RoleARN' => '<string>',
],
'SecretsManagerConfiguration' => [
'Enabled' => true || false, // REQUIRED
'RoleARN' => '<string>',
'SecretARN' => '<string>',
],
],
]);
Parameter Details
Members
- AmazonOpenSearchServerlessDestinationUpdate
-
- Type: AmazonOpenSearchServerlessDestinationUpdate structure
Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
- AmazonopensearchserviceDestinationUpdate
-
- Type: AmazonopensearchserviceDestinationUpdate structure
Describes an update for a destination in Amazon OpenSearch Service.
- CurrentDeliveryStreamVersionId
-
- Required: Yes
- Type: string
Obtain this value from the
VersionIdresult of DeliveryStreamDescription. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, theVersionIdvalue is updated. The service then performs a merge of the old configuration with the new configuration. - DeliveryStreamName
-
- Required: Yes
- Type: string
The name of the Firehose stream.
- DestinationId
-
- Required: Yes
- Type: string
The ID of the destination.
- ElasticsearchDestinationUpdate
-
- Type: ElasticsearchDestinationUpdate structure
Describes an update for a destination in Amazon ES.
- ExtendedS3DestinationUpdate
-
- Type: ExtendedS3DestinationUpdate structure
Describes an update for a destination in Amazon S3.
- HttpEndpointDestinationUpdate
-
- Type: HttpEndpointDestinationUpdate structure
Describes an update to the specified HTTP endpoint destination.
- IcebergDestinationUpdate
-
- Type: IcebergDestinationUpdate structure
Describes an update for a destination in Apache Iceberg Tables.
- RedshiftDestinationUpdate
-
- Type: RedshiftDestinationUpdate structure
Describes an update for a destination in Amazon Redshift.
- S3DestinationUpdate
-
- Type: S3DestinationUpdate structure
[Deprecated] Describes an update for a destination in Amazon S3.
- SnowflakeDestinationUpdate
-
- Type: SnowflakeDestinationUpdate structure
Update to the Snowflake destination configuration settings.
- SplunkDestinationUpdate
-
- Type: SplunkDestinationUpdate structure
Describes an update for a destination in Splunk.
Result Syntax
[]
Result Details
Errors
- InvalidArgumentException:
The specified input parameter has a value that is not valid.
- ResourceInUseException:
The resource is already in use and not available for this operation.
- ResourceNotFoundException:
The specified resource could not be found.
- ConcurrentModificationException:
Another modification has already happened. Fetch
VersionIdagain and use it to update the destination.
Shapes
AmazonOpenSearchServerlessBufferingHints
Description
Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.
Members
- IntervalInSeconds
-
- Type: int
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
- SizeInMBs
-
- Type: int
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
AmazonOpenSearchServerlessDestinationConfiguration
Description
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
Members
- BufferingHints
-
- Type: AmazonOpenSearchServerlessBufferingHints structure
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- CollectionEndpoint
-
- Type: string
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
- IndexName
-
- Required: Yes
- Type: string
The Serverless offering for Amazon OpenSearch Service index name.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RetryOptions
-
- Type: AmazonOpenSearchServerlessRetryOptions structure
The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
- RoleARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
- S3BackupMode
-
- Type: string
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
- S3Configuration
-
- Required: Yes
- Type: S3DestinationConfiguration structure
Describes the configuration of a destination in Amazon S3.
- VpcConfiguration
-
- Type: VpcConfiguration structure
The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
AmazonOpenSearchServerlessDestinationDescription
Description
The destination description in the Serverless offering for Amazon OpenSearch Service.
Members
- BufferingHints
-
- Type: AmazonOpenSearchServerlessBufferingHints structure
The buffering options.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- CollectionEndpoint
-
- Type: string
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
- IndexName
-
- Type: string
The Serverless offering for Amazon OpenSearch Service index name.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RetryOptions
-
- Type: AmazonOpenSearchServerlessRetryOptions structure
The Serverless offering for Amazon OpenSearch Service retry options.
- RoleARN
-
- Type: string
The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
- S3BackupMode
-
- Type: string
The Amazon S3 backup mode.
- S3DestinationDescription
-
- Type: S3DestinationDescription structure
Describes a destination in Amazon S3.
- VpcConfigurationDescription
-
- Type: VpcConfigurationDescription structure
The details of the VPC of the Amazon ES destination.
AmazonOpenSearchServerlessDestinationUpdate
Description
Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
Members
- BufferingHints
-
- Type: AmazonOpenSearchServerlessBufferingHints structure
The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- CollectionEndpoint
-
- Type: string
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
- IndexName
-
- Type: string
The Serverless offering for Amazon OpenSearch Service index name.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RetryOptions
-
- Type: AmazonOpenSearchServerlessRetryOptions structure
The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
- RoleARN
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
- S3Update
-
- Type: S3DestinationUpdate structure
Describes an update for a destination in Amazon S3.
AmazonOpenSearchServerlessRetryOptions
Description
Configures retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
Members
- DurationInSeconds
-
- Type: int
After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
AmazonopensearchserviceBufferingHints
Description
Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.
Members
- IntervalInSeconds
-
- Type: int
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
- SizeInMBs
-
- Type: int
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
AmazonopensearchserviceDestinationConfiguration
Description
Describes the configuration of a destination in Amazon OpenSearch Service
Members
- BufferingHints
-
- Type: AmazonopensearchserviceBufferingHints structure
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- ClusterEndpoint
-
- Type: string
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
- DocumentIdOptions
-
- Type: DocumentIdOptions structure
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
- DomainARN
-
- Type: string
The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.
- IndexName
-
- Required: Yes
- Type: string
The ElasticsearAmazon OpenSearch Service index name.
- IndexRotationPeriod
-
- Type: string
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RetryOptions
-
- Type: AmazonopensearchserviceRetryOptions structure
The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
- RoleARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
- S3BackupMode
-
- Type: string
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
- S3Configuration
-
- Required: Yes
- Type: S3DestinationConfiguration structure
Describes the configuration of a destination in Amazon S3.
- TypeName
-
- Type: string
The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.
- VpcConfiguration
-
- Type: VpcConfiguration structure
The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
AmazonopensearchserviceDestinationDescription
Description
The destination description in Amazon OpenSearch Service.
Members
- BufferingHints
-
- Type: AmazonopensearchserviceBufferingHints structure
The buffering options.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- ClusterEndpoint
-
- Type: string
The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
- DocumentIdOptions
-
- Type: DocumentIdOptions structure
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
- DomainARN
-
- Type: string
The ARN of the Amazon OpenSearch Service domain.
- IndexName
-
- Type: string
The Amazon OpenSearch Service index name.
- IndexRotationPeriod
-
- Type: string
The Amazon OpenSearch Service index rotation period
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RetryOptions
-
- Type: AmazonopensearchserviceRetryOptions structure
The Amazon OpenSearch Service retry options.
- RoleARN
-
- Type: string
The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
- S3BackupMode
-
- Type: string
The Amazon S3 backup mode.
- S3DestinationDescription
-
- Type: S3DestinationDescription structure
Describes a destination in Amazon S3.
- TypeName
-
- Type: string
The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
- VpcConfigurationDescription
-
- Type: VpcConfigurationDescription structure
The details of the VPC of the Amazon ES destination.
AmazonopensearchserviceDestinationUpdate
Description
Describes an update for a destination in Amazon OpenSearch Service.
Members
- BufferingHints
-
- Type: AmazonopensearchserviceBufferingHints structure
The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- ClusterEndpoint
-
- Type: string
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
- DocumentIdOptions
-
- Type: DocumentIdOptions structure
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
- DomainARN
-
- Type: string
The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
- IndexName
-
- Type: string
The Amazon OpenSearch Service index name.
- IndexRotationPeriod
-
- Type: string
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RetryOptions
-
- Type: AmazonopensearchserviceRetryOptions structure
The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
- RoleARN
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
- S3Update
-
- Type: S3DestinationUpdate structure
Describes an update for a destination in Amazon S3.
- TypeName
-
- Type: string
The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your Firehose stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your Firehose stream with a new index name, provide an empty string for TypeName.
AmazonopensearchserviceRetryOptions
Description
Configures retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.
Members
- DurationInSeconds
-
- Type: int
After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
AuthenticationConfiguration
Description
The authentication configuration of the Amazon MSK cluster.
Members
- Connectivity
-
- Required: Yes
- Type: string
The type of connectivity used to access the Amazon MSK cluster.
- RoleARN
-
- Required: Yes
- Type: string
The ARN of the role used to access the Amazon MSK cluster.
BufferingHints
Description
Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Firehose might choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.
Members
- IntervalInSeconds
-
- Type: int
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for
SizeInMBs, and vice versa. - SizeInMBs
-
- Type: int
Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for
IntervalInSeconds, and vice versa.We recommend setting this parameter to a value greater than the amount of data you typically ingest into the Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
CatalogConfiguration
Description
Describes the containers where the destination Apache Iceberg Tables are persisted.
Members
- CatalogARN
-
- Type: string
Specifies the Glue catalog ARN identifier of the destination Apache Iceberg Tables. You must specify the ARN in the format
arn:aws:glue:region:account-id:catalog. - WarehouseLocation
-
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
CloudWatchLoggingOptions
Description
Describes the Amazon CloudWatch logging options for your Firehose stream.
Members
- Enabled
-
- Type: boolean
Enables or disables CloudWatch logging.
- LogGroupName
-
- Type: string
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
- LogStreamName
-
- Type: string
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ConcurrentModificationException
Description
Another modification has already happened. Fetch VersionId again and use it to update the destination.
Members
- message
-
- Type: string
A message that provides information about the error.
CopyCommand
Description
Describes a COPY command for Amazon Redshift.
Members
- CopyOptions
-
- Type: string
Optional parameters to use with the Amazon Redshift
COPYcommand. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Firehose are as follows:delimiter '\t' lzop;- fields are delimited with "\t" (TAB character) and compressed using lzop.delimiter '|'- fields are delimited with "|" (this is the default delimiter).delimiter '|' escape- the delimiter should be escaped.fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'- fields are fixed width in the source, with each width specified after every column in the table.JSON 's3://mybucket/jsonpaths.txt'- data is in JSON format, and the path specified is the format of the data.For more examples, see Amazon Redshift COPY command examples.
- DataTableColumns
-
- Type: string
A comma-separated list of column names.
- DataTableName
-
- Required: Yes
- Type: string
The name of the target table. The table must already exist in the database.
DataFormatConversionConfiguration
Description
Specifies that you want Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Firehose uses the serializer and deserializer that you specify, in addition to the column information from the Amazon Web Services Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Firehose Record Format Conversion.
Members
- Enabled
-
- Type: boolean
Defaults to
true. Set it tofalseif you want to disable format conversion while preserving the configuration details. - InputFormatConfiguration
-
- Type: InputFormatConfiguration structure
Specifies the deserializer that you want Firehose to use to convert the format of your data from JSON. This parameter is required if
Enabledis set to true. - OutputFormatConfiguration
-
- Type: OutputFormatConfiguration structure
Specifies the serializer that you want Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if
Enabledis set to true. - SchemaConfiguration
-
- Type: SchemaConfiguration structure
Specifies the Amazon Web Services Glue Data Catalog table that contains the column information. This parameter is required if
Enabledis set to true.
DatabaseColumnList
Description
Amazon Data Firehose is in preview release and is subject to change.
Members
- Exclude
-
- Type: Array of strings
Amazon Data Firehose is in preview release and is subject to change.
- Include
-
- Type: Array of strings
Amazon Data Firehose is in preview release and is subject to change.
DatabaseList
Description
Amazon Data Firehose is in preview release and is subject to change.
Members
- Exclude
-
- Type: Array of strings
Amazon Data Firehose is in preview release and is subject to change.
- Include
-
- Type: Array of strings
Amazon Data Firehose is in preview release and is subject to change.
DatabaseSnapshotInfo
Description
Amazon Data Firehose is in preview release and is subject to change.
Members
- FailureDescription
-
- Type: FailureDescription structure
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
- Id
-
- Required: Yes
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
- RequestTimestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Amazon Data Firehose is in preview release and is subject to change.
- RequestedBy
-
- Required: Yes
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
- Status
-
- Required: Yes
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
- Table
-
- Required: Yes
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
DatabaseSourceAuthenticationConfiguration
Description
Amazon Data Firehose is in preview release and is subject to change.
Members
- SecretsManagerConfiguration
-
- Required: Yes
- Type: SecretsManagerConfiguration structure
The structure that defines how Firehose accesses the secret.
DatabaseSourceConfiguration
Description
Amazon Data Firehose is in preview release and is subject to change.
Members
- Columns
-
- Type: DatabaseColumnList structure
Amazon Data Firehose is in preview release and is subject to change.
- DatabaseSourceAuthenticationConfiguration
-
- Required: Yes
- Type: DatabaseSourceAuthenticationConfiguration structure
Amazon Data Firehose is in preview release and is subject to change.
- DatabaseSourceVPCConfiguration
-
- Required: Yes
- Type: DatabaseSourceVPCConfiguration structure
Amazon Data Firehose is in preview release and is subject to change.
- Databases
-
- Required: Yes
- Type: DatabaseList structure
Amazon Data Firehose is in preview release and is subject to change.
- Endpoint
-
- Required: Yes
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
- Port
-
- Required: Yes
- Type: int
Amazon Data Firehose is in preview release and is subject to change.
- SSLMode
-
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
- SnapshotWatermarkTable
-
- Required: Yes
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
- SurrogateKeys
-
- Type: Array of strings
Amazon Data Firehose is in preview release and is subject to change.
- Tables
-
- Required: Yes
- Type: DatabaseTableList structure
Amazon Data Firehose is in preview release and is subject to change.
- Type
-
- Required: Yes
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
DatabaseSourceDescription
Description
Amazon Data Firehose is in preview release and is subject to change.
Members
- Columns
-
- Type: DatabaseColumnList structure
Amazon Data Firehose is in preview release and is subject to change.
- DatabaseSourceAuthenticationConfiguration
-
- Type: DatabaseSourceAuthenticationConfiguration structure
Amazon Data Firehose is in preview release and is subject to change.
- DatabaseSourceVPCConfiguration
-
- Type: DatabaseSourceVPCConfiguration structure
Amazon Data Firehose is in preview release and is subject to change.
- Databases
-
- Type: DatabaseList structure
Amazon Data Firehose is in preview release and is subject to change.
- Endpoint
-
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
- Port
-
- Type: int
Amazon Data Firehose is in preview release and is subject to change.
- SSLMode
-
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
- SnapshotInfo
-
- Type: Array of DatabaseSnapshotInfo structures
Amazon Data Firehose is in preview release and is subject to change.
- SnapshotWatermarkTable
-
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
- SurrogateKeys
-
- Type: Array of strings
Amazon Data Firehose is in preview release and is subject to change.
- Tables
-
- Type: DatabaseTableList structure
Amazon Data Firehose is in preview release and is subject to change.
- Type
-
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
DatabaseSourceVPCConfiguration
Description
Amazon Data Firehose is in preview release and is subject to change.
Members
- VpcEndpointServiceName
-
- Required: Yes
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
DatabaseTableList
Description
Amazon Data Firehose is in preview release and is subject to change.
Members
- Exclude
-
- Type: Array of strings
Amazon Data Firehose is in preview release and is subject to change.
- Include
-
- Type: Array of strings
Amazon Data Firehose is in preview release and is subject to change.
DeliveryStreamDescription
Description
Contains information about a Firehose stream.
Members
- CreateTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the Firehose stream was created.
- DeliveryStreamARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Firehose stream. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
- DeliveryStreamEncryptionConfiguration
-
- Type: DeliveryStreamEncryptionConfiguration structure
Indicates the server-side encryption (SSE) status for the Firehose stream.
- DeliveryStreamName
-
- Required: Yes
- Type: string
The name of the Firehose stream.
- DeliveryStreamStatus
-
- Required: Yes
- Type: string
The status of the Firehose stream. If the status of a Firehose stream is
CREATING_FAILED, this status doesn't change, and you can't invokeCreateDeliveryStreamagain on it. However, you can invoke the DeleteDeliveryStream operation to delete it. - DeliveryStreamType
-
- Required: Yes
- Type: string
The Firehose stream type. This can be one of the following values:
-
DirectPut: Provider applications access the Firehose stream directly. -
KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
- Destinations
-
- Required: Yes
- Type: Array of DestinationDescription structures
The destinations.
- FailureDescription
-
- Type: FailureDescription structure
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
- HasMoreDestinations
-
- Required: Yes
- Type: boolean
Indicates whether there are more destinations available to list.
- LastUpdateTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the Firehose stream was last updated.
- Source
-
- Type: SourceDescription structure
If the
DeliveryStreamTypeparameter isKinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream. - VersionId
-
- Required: Yes
- Type: string
Each time the destination is updated for a Firehose stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.
DeliveryStreamEncryptionConfiguration
Description
Contains information about the server-side encryption (SSE) status for the delivery stream, the type customer master key (CMK) in use, if any, and the ARN of the CMK. You can get DeliveryStreamEncryptionConfiguration by invoking the DescribeDeliveryStream operation.
Members
- FailureDescription
-
- Type: FailureDescription structure
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
- KeyARN
-
- Type: string
If
KeyTypeisCUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. IfKeyTypeisAmazon Web Services_OWNED_CMK,DeliveryStreamEncryptionConfigurationdoesn't contain a value forKeyARN. - KeyType
-
- Type: string
Indicates the type of customer master key (CMK) that is used for encryption. The default setting is
Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). - Status
-
- Type: string
This is the server-side encryption (SSE) status for the Firehose stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this status is
ENABLING_FAILEDorDISABLING_FAILED, it is the status of the most recent attempt to enable or disable SSE, respectively.
DeliveryStreamEncryptionConfigurationInput
Description
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
Members
- KeyARN
-
- Type: string
If you set
KeyTypetoCUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you setKeyTypetoAmazon Web Services_OWNED_CMK, Firehose uses a service-account CMK. - KeyType
-
- Required: Yes
- Type: string
Indicates the type of customer master key (CMK) to use for encryption. The default setting is
Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption withKeyTypeset to CUSTOMER_MANAGED_CMK, Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Firehose service to use the customer managed CMK to perform encryption and decryption. Firehose manages that grant.When you invoke StartDeliveryStreamEncryption to change the CMK for a Firehose stream that is encrypted with a customer managed CMK, Firehose schedules the grant it had on the old CMK for retirement.
You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 Firehose streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Firehose throws a
LimitExceededException.To encrypt your Firehose stream, use symmetric CMKs. Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the Amazon Web Services Key Management Service developer guide.
Deserializer
Description
The deserializer you want Firehose to use for converting the input data from JSON. Firehose then serializes the data to its final format using the Serializer. Firehose supports two types of deserializers: the Apache Hive JSON SerDe and the OpenX JSON SerDe.
Members
- HiveJsonSerDe
-
- Type: HiveJsonSerDe structure
The native Hive / HCatalog JsonSerDe. Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
- OpenXJsonSerDe
-
- Type: OpenXJsonSerDe structure
The OpenX SerDe. Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
DestinationDescription
Description
Describes the destination for a Firehose stream.
Members
- AmazonOpenSearchServerlessDestinationDescription
-
- Type: AmazonOpenSearchServerlessDestinationDescription structure
The destination in the Serverless offering for Amazon OpenSearch Service.
- AmazonopensearchserviceDestinationDescription
-
- Type: AmazonopensearchserviceDestinationDescription structure
The destination in Amazon OpenSearch Service.
- DestinationId
-
- Required: Yes
- Type: string
The ID of the destination.
- ElasticsearchDestinationDescription
-
- Type: ElasticsearchDestinationDescription structure
The destination in Amazon ES.
- ExtendedS3DestinationDescription
-
- Type: ExtendedS3DestinationDescription structure
The destination in Amazon S3.
- HttpEndpointDestinationDescription
-
- Type: HttpEndpointDestinationDescription structure
Describes the specified HTTP endpoint destination.
- IcebergDestinationDescription
-
- Type: IcebergDestinationDescription structure
Describes a destination in Apache Iceberg Tables.
- RedshiftDestinationDescription
-
- Type: RedshiftDestinationDescription structure
The destination in Amazon Redshift.
- S3DestinationDescription
-
- Type: S3DestinationDescription structure
[Deprecated] The destination in Amazon S3.
- SnowflakeDestinationDescription
-
- Type: SnowflakeDestinationDescription structure
Optional description for the destination
- SplunkDestinationDescription
-
- Type: SplunkDestinationDescription structure
The destination in Splunk.
DestinationTableConfiguration
Description
Describes the configuration of a destination in Apache Iceberg Tables.
Members
- DestinationDatabaseName
-
- Required: Yes
- Type: string
The name of the Apache Iceberg database.
- DestinationTableName
-
- Required: Yes
- Type: string
Specifies the name of the Apache Iceberg Table.
- PartitionSpec
-
- Type: PartitionSpec structure
Amazon Data Firehose is in preview release and is subject to change.
- S3ErrorOutputPrefix
-
- Type: string
The table specific S3 error output prefix. All the errors that occurred while delivering to this table will be prefixed with this value in S3 destination.
- UniqueKeys
-
- Type: Array of strings
A list of unique keys for a given Apache Iceberg table. Firehose will use these for running Create, Update, or Delete operations on the given Iceberg table.
DocumentIdOptions
Description
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
Members
- DefaultDocumentIdFormat
-
- Required: Yes
- Type: string
When the
FIREHOSE_DEFAULToption is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.When the
NO_DOCUMENT_IDoption is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.
DynamicPartitioningConfiguration
Description
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.
Members
- Enabled
-
- Type: boolean
Specifies that the dynamic partitioning is enabled for this Firehose Firehose stream.
- RetryOptions
-
- Type: RetryOptions structure
The retry behavior in case Firehose is unable to deliver data to an Amazon S3 prefix.
ElasticsearchBufferingHints
Description
Describes the buffering to perform before delivering data to the Amazon ES destination.
Members
- IntervalInSeconds
-
- Type: int
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
- SizeInMBs
-
- Type: int
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
ElasticsearchDestinationConfiguration
Description
Describes the configuration of a destination in Amazon ES.
Members
- BufferingHints
-
- Type: ElasticsearchBufferingHints structure
The buffering options. If no value is specified, the default values for
ElasticsearchBufferingHintsare used. - CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The Amazon CloudWatch logging options for your Firehose stream.
- ClusterEndpoint
-
- Type: string
The endpoint to use when communicating with the cluster. Specify either this
ClusterEndpointor theDomainARNfield. - DocumentIdOptions
-
- Type: DocumentIdOptions structure
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
- DomainARN
-
- Type: string
The ARN of the Amazon ES domain. The IAM role must have permissions for
DescribeDomain,DescribeDomains, andDescribeDomainConfigafter assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.Specify either
ClusterEndpointorDomainARN. - IndexName
-
- Required: Yes
- Type: string
The Elasticsearch index name.
- IndexRotationPeriod
-
- Type: string
The Elasticsearch index rotation period. Index rotation appends a timestamp to the
IndexNameto facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value isOneDay. - ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
The data processing configuration.
- RetryOptions
-
- Type: ElasticsearchRetryOptions structure
The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
- RoleARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
- S3BackupMode
-
- Type: string
Defines how documents should be delivered to Amazon S3. When it is set to
FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, withAmazonOpenSearchService-failed/appended to the key prefix. When set toAllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents withAmazonOpenSearchService-failed/appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value isFailedDocumentsOnly.You can't change this backup mode after you create the Firehose stream.
- S3Configuration
-
- Required: Yes
- Type: S3DestinationConfiguration structure
The configuration for the backup Amazon S3 location.
- TypeName
-
- Type: string
The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.
For Elasticsearch 7.x, don't specify a
TypeName. - VpcConfiguration
-
- Type: VpcConfiguration structure
The details of the VPC of the Amazon destination.
ElasticsearchDestinationDescription
Description
The destination description in Amazon ES.
Members
- BufferingHints
-
- Type: ElasticsearchBufferingHints structure
The buffering options.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The Amazon CloudWatch logging options.
- ClusterEndpoint
-
- Type: string
The endpoint to use when communicating with the cluster. Firehose uses either this
ClusterEndpointor theDomainARNfield to send data to Amazon ES. - DocumentIdOptions
-
- Type: DocumentIdOptions structure
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
- DomainARN
-
- Type: string
The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
Firehose uses either
ClusterEndpointorDomainARNto send data to Amazon ES. - IndexName
-
- Type: string
The Elasticsearch index name.
- IndexRotationPeriod
-
- Type: string
The Elasticsearch index rotation period
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
The data processing configuration.
- RetryOptions
-
- Type: ElasticsearchRetryOptions structure
The Amazon ES retry options.
- RoleARN
-
- Type: string
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.
- S3BackupMode
-
- Type: string
The Amazon S3 backup mode.
- S3DestinationDescription
-
- Type: S3DestinationDescription structure
The Amazon S3 destination.
- TypeName
-
- Type: string
The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for
TypeName. - VpcConfigurationDescription
-
- Type: VpcConfigurationDescription structure
The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.
ElasticsearchDestinationUpdate
Description
Describes an update for a destination in Amazon ES.
Members
- BufferingHints
-
- Type: ElasticsearchBufferingHints structure
The buffering options. If no value is specified,
ElasticsearchBufferingHintsobject default values are used. - CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The CloudWatch logging options for your Firehose stream.
- ClusterEndpoint
-
- Type: string
The endpoint to use when communicating with the cluster. Specify either this
ClusterEndpointor theDomainARNfield. - DocumentIdOptions
-
- Type: DocumentIdOptions structure
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
- DomainARN
-
- Type: string
The ARN of the Amazon ES domain. The IAM role must have permissions for
DescribeDomain,DescribeDomains, andDescribeDomainConfigafter assuming the IAM role specified inRoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.Specify either
ClusterEndpointorDomainARN. - IndexName
-
- Type: string
The Elasticsearch index name.
- IndexRotationPeriod
-
- Type: string
The Elasticsearch index rotation period. Index rotation appends a timestamp to
IndexNameto facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value isOneDay. - ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
The data processing configuration.
- RetryOptions
-
- Type: ElasticsearchRetryOptions structure
The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
- RoleARN
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
- S3Update
-
- Type: S3DestinationUpdate structure
The Amazon S3 destination.
- TypeName
-
- Type: string
The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your Firehose stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your Firehose stream with a new index name, provide an empty string for
TypeName.
ElasticsearchRetryOptions
Description
Configures retry behavior in case Firehose is unable to deliver documents to Amazon ES.
Members
- DurationInSeconds
-
- Type: int
After an initial failure to deliver to Amazon ES, the total amount of time during which Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
EncryptionConfiguration
Description
Describes the encryption for a destination in Amazon S3.
Members
- KMSEncryptionConfig
-
- Type: KMSEncryptionConfig structure
The encryption key.
- NoEncryptionConfig
-
- Type: string
Specifically override existing encryption information to ensure that no encryption is used.
ExtendedS3DestinationConfiguration
Description
Describes the configuration of a destination in Amazon S3.
Members
- BucketARN
-
- Required: Yes
- Type: string
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
- BufferingHints
-
- Type: BufferingHints structure
The buffering option.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The Amazon CloudWatch logging options for your Firehose stream.
- CompressionFormat
-
- Type: string
The compression format. If no value is specified, the default is UNCOMPRESSED.
- CustomTimeZone
-
- Type: string
The time zone you prefer. UTC is the default.
- DataFormatConversionConfiguration
-
- Type: DataFormatConversionConfiguration structure
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
- DynamicPartitioningConfiguration
-
- Type: DynamicPartitioningConfiguration structure
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.
- EncryptionConfiguration
-
- Type: EncryptionConfiguration structure
The encryption configuration. If no value is specified, the default is no encryption.
- ErrorOutputPrefix
-
- Type: string
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.
- FileExtension
-
- Type: string
Specify a file extension. It will override the default file extension
- Prefix
-
- Type: string
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.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
The data processing configuration.
- RoleARN
-
- Required: Yes
- Type: string
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.
- S3BackupConfiguration
-
- Type: S3DestinationConfiguration structure
The configuration for backup in Amazon S3.
- S3BackupMode
-
- Type: string
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.
ExtendedS3DestinationDescription
Description
Describes a destination in Amazon S3.
Members
- BucketARN
-
- Required: Yes
- Type: string
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
- BufferingHints
-
- Required: Yes
- Type: BufferingHints structure
The buffering option.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The Amazon CloudWatch logging options for your Firehose stream.
- CompressionFormat
-
- Required: Yes
- Type: string
The compression format. If no value is specified, the default is
UNCOMPRESSED. - CustomTimeZone
-
- Type: string
The time zone you prefer. UTC is the default.
- DataFormatConversionConfiguration
-
- Type: DataFormatConversionConfiguration structure
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
- DynamicPartitioningConfiguration
-
- Type: DynamicPartitioningConfiguration structure
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.
- EncryptionConfiguration
-
- Required: Yes
- Type: EncryptionConfiguration structure
The encryption configuration. If no value is specified, the default is no encryption.
- ErrorOutputPrefix
-
- Type: string
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.
- FileExtension
-
- Type: string
Specify a file extension. It will override the default file extension
- Prefix
-
- Type: string
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.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
The data processing configuration.
- RoleARN
-
- Required: Yes
- Type: string
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.
- S3BackupDescription
-
- Type: S3DestinationDescription structure
The configuration for backup in Amazon S3.
- S3BackupMode
-
- Type: string
The Amazon S3 backup mode.
ExtendedS3DestinationUpdate
Description
Describes an update for a destination in Amazon S3.
Members
- BucketARN
-
- Type: string
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
- BufferingHints
-
- Type: BufferingHints structure
The buffering option.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The Amazon CloudWatch logging options for your Firehose stream.
- CompressionFormat
-
- Type: string
The compression format. If no value is specified, the default is
UNCOMPRESSED. - CustomTimeZone
-
- Type: string
The time zone you prefer. UTC is the default.
- DataFormatConversionConfiguration
-
- Type: DataFormatConversionConfiguration structure
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
- DynamicPartitioningConfiguration
-
- Type: DynamicPartitioningConfiguration structure
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.
- EncryptionConfiguration
-
- Type: EncryptionConfiguration structure
The encryption configuration. If no value is specified, the default is no encryption.
- ErrorOutputPrefix
-
- Type: string
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.
- FileExtension
-
- Type: string
Specify a file extension. It will override the default file extension
- Prefix
-
- Type: string
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.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
The data processing configuration.
- RoleARN
-
- Type: string
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.
- S3BackupMode
-
- Type: string
You can update a Firehose stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.
- S3BackupUpdate
-
- Type: S3DestinationUpdate structure
The Amazon S3 destination for backup.
FailureDescription
Description
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
Members
- Details
-
- Required: Yes
- Type: string
A message providing details about the error that caused the failure.
- Type
-
- Required: Yes
- Type: string
The type of error that caused the failure.
HiveJsonSerDe
Description
The native Hive / HCatalog JsonSerDe. Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
Members
- TimestampFormats
-
- Type: Array of strings
Indicates how you want Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see Class DateTimeFormat. You can also use the special value
millisto parse timestamps in epoch milliseconds. If you don't specify a format, Firehose usesjava.sql.Timestamp::valueOfby default.
HttpEndpointBufferingHints
Description
Describes the buffering options that can be applied before data is delivered to the HTTP endpoint destination. Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.
Members
- IntervalInSeconds
-
- Type: int
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
- SizeInMBs
-
- Type: int
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
We recommend setting this parameter to a value greater than the amount of data you typically ingest into the Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
HttpEndpointCommonAttribute
Description
Describes the metadata that's delivered to the specified HTTP endpoint destination.
Members
- AttributeName
-
- Required: Yes
- Type: string
The name of the HTTP endpoint common attribute.
- AttributeValue
-
- Required: Yes
- Type: string
The value of the HTTP endpoint common attribute.
HttpEndpointConfiguration
Description
Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.
Members
- AccessKey
-
- Type: string
The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.
- Name
-
- Type: string
The name of the HTTP endpoint selected as the destination.
- Url
-
- Required: Yes
- Type: string
The URL of the HTTP endpoint selected as the destination.
If you choose an HTTP endpoint as your destination, review and follow the instructions in the Appendix - HTTP Endpoint Delivery Request and Response Specifications.
HttpEndpointDescription
Description
Describes the HTTP endpoint selected as the destination.
Members
- Name
-
- Type: string
The name of the HTTP endpoint selected as the destination.
- Url
-
- Type: string
The URL of the HTTP endpoint selected as the destination.
HttpEndpointDestinationConfiguration
Description
Describes the configuration of the HTTP endpoint destination.
Members
- BufferingHints
-
- Type: HttpEndpointBufferingHints structure
The buffering options that can be used before data is delivered to the specified destination. Firehose treats these options as hints, and it might choose to use more optimal values. The
SizeInMBsandIntervalInSecondsparameters are optional. However, if you specify a value for one of them, you must also provide a value for the other. - CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- EndpointConfiguration
-
- Required: Yes
- Type: HttpEndpointConfiguration structure
The configuration of the HTTP endpoint selected as the destination.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RequestConfiguration
-
- Type: HttpEndpointRequestConfiguration structure
The configuration of the request sent to the HTTP endpoint that is specified as the destination.
- RetryOptions
-
- Type: HttpEndpointRetryOptions structure
Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
- RoleARN
-
- Type: string
Firehose uses this IAM role for all the permissions that the delivery stream needs.
- S3BackupMode
-
- Type: string
Describes the S3 bucket backup options for the data that Firehose delivers to the HTTP endpoint destination. You can back up all documents (
AllData) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly). - S3Configuration
-
- Required: Yes
- Type: S3DestinationConfiguration structure
Describes the configuration of a destination in Amazon S3.
- SecretsManagerConfiguration
-
- Type: SecretsManagerConfiguration structure
The configuration that defines how you access secrets for HTTP Endpoint destination.
HttpEndpointDestinationDescription
Description
Describes the HTTP endpoint destination.
Members
- BufferingHints
-
- Type: HttpEndpointBufferingHints structure
Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Firehose teats these options as hints, and it might choose to use more optimal values. The
SizeInMBsandIntervalInSecondsparameters are optional. However, if specify a value for one of them, you must also provide a value for the other. - CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- EndpointConfiguration
-
- Type: HttpEndpointDescription structure
The configuration of the specified HTTP endpoint destination.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RequestConfiguration
-
- Type: HttpEndpointRequestConfiguration structure
The configuration of request sent to the HTTP endpoint specified as the destination.
- RetryOptions
-
- Type: HttpEndpointRetryOptions structure
Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
- RoleARN
-
- Type: string
Firehose uses this IAM role for all the permissions that the delivery stream needs.
- S3BackupMode
-
- Type: string
Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (
AllData) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly). - S3DestinationDescription
-
- Type: S3DestinationDescription structure
Describes a destination in Amazon S3.
- SecretsManagerConfiguration
-
- Type: SecretsManagerConfiguration structure
The configuration that defines how you access secrets for HTTP Endpoint destination.
HttpEndpointDestinationUpdate
Description
Updates the specified HTTP endpoint destination.
Members
- BufferingHints
-
- Type: HttpEndpointBufferingHints structure
Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Firehose teats these options as hints, and it might choose to use more optimal values. The
SizeInMBsandIntervalInSecondsparameters are optional. However, if specify a value for one of them, you must also provide a value for the other. - CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- EndpointConfiguration
-
- Type: HttpEndpointConfiguration structure
Describes the configuration of the HTTP endpoint destination.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RequestConfiguration
-
- Type: HttpEndpointRequestConfiguration structure
The configuration of the request sent to the HTTP endpoint specified as the destination.
- RetryOptions
-
- Type: HttpEndpointRetryOptions structure
Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
- RoleARN
-
- Type: string
Firehose uses this IAM role for all the permissions that the delivery stream needs.
- S3BackupMode
-
- Type: string
Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (
AllData) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly). - S3Update
-
- Type: S3DestinationUpdate structure
Describes an update for a destination in Amazon S3.
- SecretsManagerConfiguration
-
- Type: SecretsManagerConfiguration structure
The configuration that defines how you access secrets for HTTP Endpoint destination.
HttpEndpointRequestConfiguration
Description
The configuration of the HTTP endpoint request.
Members
- CommonAttributes
-
- Type: Array of HttpEndpointCommonAttribute structures
Describes the metadata sent to the HTTP endpoint destination.
- ContentEncoding
-
- Type: string
Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.
HttpEndpointRetryOptions
Description
Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.
Members
- DurationInSeconds
-
- Type: int
The total amount of time that Firehose spends on retries. This duration starts after the initial attempt to send data to the custom destination via HTTPS endpoint fails. It doesn't include the periods during which Firehose waits for acknowledgment from the specified destination after each attempt.
IcebergDestinationConfiguration
Description
Specifies the destination configure settings for Apache Iceberg Table.
Members
- BufferingHints
-
- Type: BufferingHints structure
Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Firehose might choose to use different values when it is optimal. The
SizeInMBsandIntervalInSecondsparameters are optional. However, if specify a value for one of them, you must also provide a value for the other. - CatalogConfiguration
-
- Required: Yes
- Type: CatalogConfiguration structure
Configuration describing where the destination Apache Iceberg Tables are persisted.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- DestinationTableConfigurationList
-
- Type: Array of DestinationTableConfiguration structures
Provides a list of
DestinationTableConfigurationswhich Firehose uses to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here. - ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RetryOptions
-
- Type: RetryOptions structure
The retry behavior in case Firehose is unable to deliver data to a destination.
- RoleARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.
- S3BackupMode
-
- Type: string
Describes how Firehose will backup records. Currently,S3 backup only supports
FailedDataOnly. - S3Configuration
-
- Required: Yes
- Type: S3DestinationConfiguration structure
Describes the configuration of a destination in Amazon S3.
- SchemaEvolutionConfiguration
-
- Type: SchemaEvolutionConfiguration structure
Amazon Data Firehose is in preview release and is subject to change.
- TableCreationConfiguration
-
- Type: TableCreationConfiguration structure
Amazon Data Firehose is in preview release and is subject to change.
IcebergDestinationDescription
Description
Describes a destination in Apache Iceberg Tables.
Members
- BufferingHints
-
- Type: BufferingHints structure
Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Firehose might choose to use different values when it is optimal. The
SizeInMBsandIntervalInSecondsparameters are optional. However, if specify a value for one of them, you must also provide a value for the other. - CatalogConfiguration
-
- Type: CatalogConfiguration structure
Configuration describing where the destination Iceberg tables are persisted.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- DestinationTableConfigurationList
-
- Type: Array of DestinationTableConfiguration structures
Provides a list of
DestinationTableConfigurationswhich Firehose uses to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here. - ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RetryOptions
-
- Type: RetryOptions structure
The retry behavior in case Firehose is unable to deliver data to a destination.
- RoleARN
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.
- S3BackupMode
-
- Type: string
Describes how Firehose will backup records. Currently,Firehose only supports
FailedDataOnly. - S3DestinationDescription
-
- Type: S3DestinationDescription structure
Describes a destination in Amazon S3.
- SchemaEvolutionConfiguration
-
- Type: SchemaEvolutionConfiguration structure
Amazon Data Firehose is in preview release and is subject to change.
- TableCreationConfiguration
-
- Type: TableCreationConfiguration structure
Amazon Data Firehose is in preview release and is subject to change.
IcebergDestinationUpdate
Description
Describes an update for a destination in Apache Iceberg Tables.
Members
- BufferingHints
-
- Type: BufferingHints structure
Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Firehose might choose to use different values when it is optimal. The
SizeInMBsandIntervalInSecondsparameters are optional. However, if specify a value for one of them, you must also provide a value for the other. - CatalogConfiguration
-
- Type: CatalogConfiguration structure
Configuration describing where the destination Iceberg tables are persisted.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- DestinationTableConfigurationList
-
- Type: Array of DestinationTableConfiguration structures
Provides a list of
DestinationTableConfigurationswhich Firehose uses to deliver data to Apache Iceberg Tables. Firehose will write data with insert if table specific configuration is not provided here. - ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RetryOptions
-
- Type: RetryOptions structure
The retry behavior in case Firehose is unable to deliver data to a destination.
- RoleARN
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables.
- S3BackupMode
-
- Type: string
Describes how Firehose will backup records. Currently,Firehose only supports
FailedDataOnly. - S3Configuration
-
- Type: S3DestinationConfiguration structure
Describes the configuration of a destination in Amazon S3.
- SchemaEvolutionConfiguration
-
- Type: SchemaEvolutionConfiguration structure
Amazon Data Firehose is in preview release and is subject to change.
- TableCreationConfiguration
-
- Type: TableCreationConfiguration structure
Amazon Data Firehose is in preview release and is subject to change.
InputFormatConfiguration
Description
Specifies the deserializer you want to use to convert the format of the input data. This parameter is required if Enabled is set to true.
Members
- Deserializer
-
- Type: Deserializer structure
Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.
InvalidArgumentException
Description
The specified input parameter has a value that is not valid.
Members
- message
-
- Type: string
A message that provides information about the error.
InvalidKMSResourceException
Description
Firehose throws this exception when an attempt to put records or to start or stop Firehose stream encryption fails. This happens when the KMS service throws one of the following exception types: AccessDeniedException, InvalidStateException, DisabledException, or NotFoundException.
Members
- code
-
- Type: string
- message
-
- Type: string
InvalidSourceException
Description
Only requests from CloudWatch Logs are supported when CloudWatch Logs decompression is enabled.
Members
- code
-
- Type: string
- message
-
- Type: string
KMSEncryptionConfig
Description
Describes an encryption key for a destination in Amazon S3.
Members
- AWSKMSKeyARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the encryption key. Must belong to the same Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
KinesisStreamSourceConfiguration
Description
The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a Firehose stream.
Members
- KinesisStreamARN
-
- Required: Yes
- Type: string
The ARN of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.
- RoleARN
-
- Required: Yes
- Type: string
The ARN of the role that provides access to the source Kinesis data stream. For more information, see Amazon Web Services Identity and Access Management (IAM) ARN Format.
KinesisStreamSourceDescription
Description
Details about a Kinesis data stream used as the source for a Firehose Firehose stream.
Members
- DeliveryStartTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Firehose starts retrieving records from the Kinesis data stream starting with this timestamp.
- KinesisStreamARN
-
- Type: string
The Amazon Resource Name (ARN) of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.
- RoleARN
-
- Type: string
The ARN of the role used by the source Kinesis data stream. For more information, see Amazon Web Services Identity and Access Management (IAM) ARN Format.
LimitExceededException
Description
You have already reached the limit for a requested resource.
Members
- message
-
- Type: string
A message that provides information about the error.
MSKSourceConfiguration
Description
The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
Members
- AuthenticationConfiguration
-
- Required: Yes
- Type: AuthenticationConfiguration structure
The authentication configuration of the Amazon MSK cluster.
- MSKClusterARN
-
- Required: Yes
- Type: string
The ARN of the Amazon MSK cluster.
- ReadFromTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.
If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the
ReadFromTimestampparameter to Epoch (1970-01-01T00:00:00Z). - TopicName
-
- Required: Yes
- Type: string
The topic name within the Amazon MSK cluster.
MSKSourceDescription
Description
Details about the Amazon MSK cluster used as the source for a Firehose Firehose stream.
Members
- AuthenticationConfiguration
-
- Type: AuthenticationConfiguration structure
The authentication configuration of the Amazon MSK cluster.
- DeliveryStartTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.
- MSKClusterARN
-
- Type: string
The ARN of the Amazon MSK cluster.
- ReadFromTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.
If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the
ReadFromTimestampUTCparameter to Epoch (1970-01-01T00:00:00Z). - TopicName
-
- Type: string
The topic name within the Amazon MSK cluster.
OpenXJsonSerDe
Description
The OpenX SerDe. Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
Members
- CaseInsensitive
-
- Type: boolean
When set to
true, which is the default, Firehose converts JSON keys to lowercase before deserializing them. - ColumnToJsonKeyMappings
-
- Type: Associative array of custom strings keys (NonEmptyStringWithoutWhitespace) to strings
Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example,
timestampis a Hive keyword. If you have a JSON key namedtimestamp, set this parameter to{"ts": "timestamp"}to map this key to a column namedts. - ConvertDotsInJsonKeysToUnderscores
-
- Type: boolean
When set to
true, specifies that the names of the keys include dots and that you want Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option.The default is
false.
OrcSerDe
Description
A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.
Members
- BlockSizeBytes
-
- Type: int
The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding calculations.
- BloomFilterColumns
-
- Type: Array of strings
The column names for which you want Firehose to create bloom filters. The default is
null. - BloomFilterFalsePositiveProbability
-
- Type: double
The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.
- Compression
-
- Type: string
The compression code to use over data blocks. The default is
SNAPPY. - DictionaryKeyThreshold
-
- Type: double
Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.
- EnablePadding
-
- Type: boolean
Set this to
trueto indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default isfalse. - FormatVersion
-
- Type: string
The version of the file to write. The possible values are
V0_11andV0_12. The default isV0_12. - PaddingTolerance
-
- Type: double
A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size.
For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.
Firehose ignores this parameter when OrcSerDe$EnablePadding is
false. - RowIndexStride
-
- Type: int
The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
- StripeSizeBytes
-
- Type: int
The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
OutputFormatConfiguration
Description
Specifies the serializer that you want Firehose to use to convert the format of your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.
Members
- Serializer
-
- Type: Serializer structure
Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.
ParquetSerDe
Description
A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.
Members
- BlockSizeBytes
-
- Type: int
The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding calculations.
- Compression
-
- Type: string
The compression code to use over data blocks. The possible values are
UNCOMPRESSED,SNAPPY, andGZIP, with the default beingSNAPPY. UseSNAPPYfor higher decompression speed. UseGZIPif the compression ratio is more important than speed. - EnableDictionaryCompression
-
- Type: boolean
Indicates whether to enable dictionary compression.
- MaxPaddingBytes
-
- Type: int
The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.
- PageSizeBytes
-
- Type: int
The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.
- WriterVersion
-
- Type: string
Indicates the version of row format to output. The possible values are
V1andV2. The default isV1.
PartitionField
Description
Amazon Data Firehose is in preview release and is subject to change.
Members
- SourceName
-
- Required: Yes
- Type: string
Amazon Data Firehose is in preview release and is subject to change.
PartitionSpec
Description
Amazon Data Firehose is in preview release and is subject to change.
Members
- Identity
-
- Type: Array of PartitionField structures
Amazon Data Firehose is in preview release and is subject to change.
ProcessingConfiguration
Description
Describes a data processing configuration.
Members
- Enabled
-
- Type: boolean
Enables or disables data processing.
- Processors
-
- Type: Array of Processor structures
The data processors.
Processor
Description
Describes a data processor.
If you want to add a new line delimiter between records in objects that are delivered to Amazon S3, choose AppendDelimiterToRecord as a processor type. You don’t have to put a processor parameter when you select AppendDelimiterToRecord.
Members
- Parameters
-
- Type: Array of ProcessorParameter structures
The processor parameters.
- Type
-
- Required: Yes
- Type: string
The type of processor.
ProcessorParameter
Description
Describes the processor parameter.
Members
- ParameterName
-
- Required: Yes
- Type: string
The name of the parameter. Currently the following default values are supported: 3 for
NumberOfRetriesand 60 for theBufferIntervalInSeconds. TheBufferSizeInMBsranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB. - ParameterValue
-
- Required: Yes
- Type: string
The parameter value.
PutRecordBatchResponseEntry
Description
Contains the result for an individual record from a PutRecordBatch request. If the record is successfully added to your Firehose stream, it receives a record ID. If the record fails to be added to your Firehose stream, the result includes an error code and an error message.
Members
- ErrorCode
-
- Type: string
The error code for an individual record result.
- ErrorMessage
-
- Type: string
The error message for an individual record result.
- RecordId
-
- Type: string
The ID of the record.
Record
Description
The unit of data in a Firehose stream.
Members
- Data
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KiB.
RedshiftDestinationConfiguration
Description
Describes the configuration of a destination in Amazon Redshift.
Members
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The CloudWatch logging options for your Firehose stream.
- ClusterJDBCURL
-
- Required: Yes
- Type: string
The database connection string.
- CopyCommand
-
- Required: Yes
- Type: CopyCommand structure
The
COPYcommand. - Password
-
- Type: string
The user password.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
The data processing configuration.
- RetryOptions
-
- Type: RedshiftRetryOptions structure
The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
- RoleARN
-
- Required: Yes
- Type: string
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.
- S3BackupConfiguration
-
- Type: S3DestinationConfiguration structure
The configuration for backup in Amazon S3.
- S3BackupMode
-
- Type: string
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.
- S3Configuration
-
- Required: Yes
- Type: S3DestinationConfiguration structure
The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.
The compression formats
SNAPPYorZIPcannot be specified inRedshiftDestinationConfiguration.S3Configurationbecause the Amazon RedshiftCOPYoperation that reads from the S3 bucket doesn't support these compression formats. - SecretsManagerConfiguration
-
- Type: SecretsManagerConfiguration structure
The configuration that defines how you access secrets for Amazon Redshift.
- Username
-
- Type: string
The name of the user.
RedshiftDestinationDescription
Description
Describes a destination in Amazon Redshift.
Members
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The Amazon CloudWatch logging options for your Firehose stream.
- ClusterJDBCURL
-
- Required: Yes
- Type: string
The database connection string.
- CopyCommand
-
- Required: Yes
- Type: CopyCommand structure
The
COPYcommand. - ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
The data processing configuration.
- RetryOptions
-
- Type: RedshiftRetryOptions structure
The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
- RoleARN
-
- Required: Yes
- Type: string
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.
- S3BackupDescription
-
- Type: S3DestinationDescription structure
The configuration for backup in Amazon S3.
- S3BackupMode
-
- Type: string
The Amazon S3 backup mode.
- S3DestinationDescription
-
- Required: Yes
- Type: S3DestinationDescription structure
The Amazon S3 destination.
- SecretsManagerConfiguration
-
- Type: SecretsManagerConfiguration structure
The configuration that defines how you access secrets for Amazon Redshift.
- Username
-
- Type: string
The name of the user.
RedshiftDestinationUpdate
Description
Describes an update for a destination in Amazon Redshift.
Members
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The Amazon CloudWatch logging options for your Firehose stream.
- ClusterJDBCURL
-
- Type: string
The database connection string.
- CopyCommand
-
- Type: CopyCommand structure
The
COPYcommand. - Password
-
- Type: string
The user password.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
The data processing configuration.
- RetryOptions
-
- Type: RedshiftRetryOptions structure
The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
- RoleARN
-
- Type: string
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.
- S3BackupMode
-
- Type: string
You can update a Firehose stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.
- S3BackupUpdate
-
- Type: S3DestinationUpdate structure
The Amazon S3 destination for backup.
- S3Update
-
- Type: S3DestinationUpdate structure
The Amazon S3 destination.
The compression formats
SNAPPYorZIPcannot be specified inRedshiftDestinationUpdate.S3Updatebecause the Amazon RedshiftCOPYoperation that reads from the S3 bucket doesn't support these compression formats. - SecretsManagerConfiguration
-
- Type: SecretsManagerConfiguration structure
The configuration that defines how you access secrets for Amazon Redshift.
- Username
-
- Type: string
The name of the user.
RedshiftRetryOptions
Description
Configures retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.
Members
- DurationInSeconds
-
- Type: int
The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of
DurationInSecondsis 0 (zero) or if the first delivery attempt takes longer than the current value.
ResourceInUseException
Description
The resource is already in use and not available for this operation.
Members
- message
-
- Type: string
A message that provides information about the error.
ResourceNotFoundException
Description
The specified resource could not be found.
Members
- message
-
- Type: string
A message that provides information about the error.
RetryOptions
Description
The retry behavior in case Firehose is unable to deliver data to a destination.
Members
- DurationInSeconds
-
- Type: int
The period of time during which Firehose retries to deliver data to the specified destination.
S3DestinationConfiguration
Description
Describes the configuration of a destination in Amazon S3.
Members
- BucketARN
-
- Required: Yes
- Type: string
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
- BufferingHints
-
- Type: BufferingHints structure
The buffering option. If no value is specified,
BufferingHintsobject default values are used. - CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The CloudWatch logging options for your Firehose stream.
- CompressionFormat
-
- Type: string
The compression format. If no value is specified, the default is
UNCOMPRESSED.The compression formats
SNAPPYorZIPcannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPYoperation that reads from the S3 bucket. - EncryptionConfiguration
-
- Type: EncryptionConfiguration structure
The encryption configuration. If no value is specified, the default is no encryption.
- ErrorOutputPrefix
-
- Type: string
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.
- Prefix
-
- Type: string
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
-
- Required: Yes
- Type: string
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.
S3DestinationDescription
Description
Describes a destination in Amazon S3.
Members
- BucketARN
-
- Required: Yes
- Type: string
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
- BufferingHints
-
- Required: Yes
- Type: BufferingHints structure
The buffering option. If no value is specified,
BufferingHintsobject default values are used. - CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The Amazon CloudWatch logging options for your Firehose stream.
- CompressionFormat
-
- Required: Yes
- Type: string
The compression format. If no value is specified, the default is
UNCOMPRESSED. - EncryptionConfiguration
-
- Required: Yes
- Type: EncryptionConfiguration structure
The encryption configuration. If no value is specified, the default is no encryption.
- ErrorOutputPrefix
-
- Type: string
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.
- Prefix
-
- Type: string
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
-
- Required: Yes
- Type: string
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
Description
Describes an update for a destination in Amazon S3.
Members
- BucketARN
-
- Type: string
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
- BufferingHints
-
- Type: BufferingHints structure
The buffering option. If no value is specified,
BufferingHintsobject default values are used. - CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The CloudWatch logging options for your Firehose stream.
- CompressionFormat
-
- Type: string
The compression format. If no value is specified, the default is
UNCOMPRESSED.The compression formats
SNAPPYorZIPcannot be specified for Amazon Redshift destinations because they are not supported by the Amazon RedshiftCOPYoperation that reads from the S3 bucket. - EncryptionConfiguration
-
- Type: EncryptionConfiguration structure
The encryption configuration. If no value is specified, the default is no encryption.
- ErrorOutputPrefix
-
- Type: string
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.
- Prefix
-
- Type: string
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
-
- Type: string
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.
SchemaConfiguration
Description
Specifies the schema to which you want Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.
Members
- CatalogId
-
- Type: string
The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.
- DatabaseName
-
- Type: string
Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.
If the
SchemaConfigurationrequest parameter is used as part of invoking theCreateDeliveryStreamAPI, then theDatabaseNameproperty is required and its value must be specified. - Region
-
- Type: string
If you don't specify an Amazon Web Services Region, the default is the current Region.
- RoleARN
-
- Type: string
The role that Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.
If the
SchemaConfigurationrequest parameter is used as part of invoking theCreateDeliveryStreamAPI, then theRoleARNproperty is required and its value must be specified. - TableName
-
- Type: string
Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.
If the
SchemaConfigurationrequest parameter is used as part of invoking theCreateDeliveryStreamAPI, then theTableNameproperty is required and its value must be specified. - VersionId
-
- Type: string
Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to
LATEST, Firehose uses the most recent version. This means that any updates to the table are automatically picked up.
SchemaEvolutionConfiguration
Description
Amazon Data Firehose is in preview release and is subject to change.
Members
- Enabled
-
- Required: Yes
- Type: boolean
Amazon Data Firehose is in preview release and is subject to change.
SecretsManagerConfiguration
Description
The structure that defines how Firehose accesses the secret.
Members
- Enabled
-
- Required: Yes
- Type: boolean
Specifies whether you want to use the secrets manager feature. When set as
Truethe secrets manager configuration overwrites the existing secrets in the destination configuration. When it's set toFalseFirehose falls back to the credentials in the destination configuration. - RoleARN
-
- Type: string
Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk.
- SecretARN
-
- Type: string
The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream and the role. The secret ARN can reside in a different account than the Firehose stream and role as Firehose supports cross-account secret access. This parameter is required when Enabled is set to
True.
Serializer
Description
The serializer that you want Firehose to use to convert data to the target format before writing it to Amazon S3. Firehose supports two types of serializers: the ORC SerDe and the Parquet SerDe.
Members
- OrcSerDe
-
- Type: OrcSerDe structure
A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.
- ParquetSerDe
-
- Type: ParquetSerDe structure
A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.
ServiceUnavailableException
Description
The service is unavailable. Back off and retry the operation. If you continue to see the exception, throughput limits for the Firehose stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Firehose Limits.
Members
- message
-
- Type: string
A message that provides information about the error.
SnowflakeBufferingHints
Description
Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.
Members
- IntervalInSeconds
-
- Type: int
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 0.
- SizeInMBs
-
- Type: int
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 128.
SnowflakeDestinationConfiguration
Description
Configure Snowflake destination
Members
- AccountUrl
-
- Required: Yes
- Type: string
URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.
- BufferingHints
-
- Type: SnowflakeBufferingHints structure
Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- ContentColumnName
-
- Type: string
The name of the record content column
- DataLoadingOption
-
- Type: string
Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.
- Database
-
- Required: Yes
- Type: string
All data in Snowflake is maintained in databases.
- KeyPassphrase
-
- Type: string
Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.
- MetaDataColumnName
-
- Type: string
The name of the record metadata column
- PrivateKey
-
- Type: string
The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RetryOptions
-
- Type: SnowflakeRetryOptions structure
The time period where Firehose will retry sending data to the chosen HTTP endpoint.
- RoleARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Snowflake role
- S3BackupMode
-
- Type: string
Choose an S3 backup mode
- S3Configuration
-
- Required: Yes
- Type: S3DestinationConfiguration structure
Describes the configuration of a destination in Amazon S3.
- Schema
-
- Required: Yes
- Type: string
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views
- SecretsManagerConfiguration
-
- Type: SecretsManagerConfiguration structure
The configuration that defines how you access secrets for Snowflake.
- SnowflakeRoleConfiguration
-
- Type: SnowflakeRoleConfiguration structure
Optionally configure a Snowflake role. Otherwise the default user role will be used.
- SnowflakeVpcConfiguration
-
- Type: SnowflakeVpcConfiguration structure
The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon PrivateLink & Snowflake
- Table
-
- Required: Yes
- Type: string
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
- User
-
- Type: string
User login name for the Snowflake account.
SnowflakeDestinationDescription
Description
Optional Snowflake destination description
Members
- AccountUrl
-
- Type: string
URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.
- BufferingHints
-
- Type: SnowflakeBufferingHints structure
Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- ContentColumnName
-
- Type: string
The name of the record content column
- DataLoadingOption
-
- Type: string
Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.
- Database
-
- Type: string
All data in Snowflake is maintained in databases.
- MetaDataColumnName
-
- Type: string
The name of the record metadata column
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RetryOptions
-
- Type: SnowflakeRetryOptions structure
The time period where Firehose will retry sending data to the chosen HTTP endpoint.
- RoleARN
-
- Type: string
The Amazon Resource Name (ARN) of the Snowflake role
- S3BackupMode
-
- Type: string
Choose an S3 backup mode
- S3DestinationDescription
-
- Type: S3DestinationDescription structure
Describes a destination in Amazon S3.
- Schema
-
- Type: string
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views
- SecretsManagerConfiguration
-
- Type: SecretsManagerConfiguration structure
The configuration that defines how you access secrets for Snowflake.
- SnowflakeRoleConfiguration
-
- Type: SnowflakeRoleConfiguration structure
Optionally configure a Snowflake role. Otherwise the default user role will be used.
- SnowflakeVpcConfiguration
-
- Type: SnowflakeVpcConfiguration structure
The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon PrivateLink & Snowflake
- Table
-
- Type: string
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
- User
-
- Type: string
User login name for the Snowflake account.
SnowflakeDestinationUpdate
Description
Update to configuration settings
Members
- AccountUrl
-
- Type: string
URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.
- BufferingHints
-
- Type: SnowflakeBufferingHints structure
Describes the buffering to perform before delivering data to the Snowflake destination.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
Describes the Amazon CloudWatch logging options for your Firehose stream.
- ContentColumnName
-
- Type: string
The name of the content metadata column
- DataLoadingOption
-
- Type: string
JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.
- Database
-
- Type: string
All data in Snowflake is maintained in databases.
- KeyPassphrase
-
- Type: string
Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation.
- MetaDataColumnName
-
- Type: string
The name of the record metadata column
- PrivateKey
-
- Type: string
The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
Describes a data processing configuration.
- RetryOptions
-
- Type: SnowflakeRetryOptions structure
Specify how long Firehose retries sending data to the New Relic HTTP endpoint. After sending data, Firehose first waits for an acknowledgment from the HTTP endpoint. If an error occurs or the acknowledgment doesn’t arrive within the acknowledgment timeout period, Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket. Every time that Firehose sends data to the HTTP endpoint (either the initial attempt or a retry), it restarts the acknowledgement timeout counter and waits for an acknowledgement from the HTTP endpoint. Even if the retry duration expires, Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Firehose determines whether there's time left in the retry counter. If there is time left, it retries again and repeats the logic until it receives an acknowledgment or determines that the retry time has expired. If you don't want Firehose to retry sending data, set this value to 0.
- RoleARN
-
- Type: string
The Amazon Resource Name (ARN) of the Snowflake role
- S3BackupMode
-
- Type: string
Choose an S3 backup mode. Once you set the mode as
AllData, you can not change it toFailedDataOnly. - S3Update
-
- Type: S3DestinationUpdate structure
Describes an update for a destination in Amazon S3.
- Schema
-
- Type: string
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views
- SecretsManagerConfiguration
-
- Type: SecretsManagerConfiguration structure
Describes the Secrets Manager configuration in Snowflake.
- SnowflakeRoleConfiguration
-
- Type: SnowflakeRoleConfiguration structure
Optionally configure a Snowflake role. Otherwise the default user role will be used.
- Table
-
- Type: string
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
- User
-
- Type: string
User login name for the Snowflake account.
SnowflakeRetryOptions
Description
Specify how long Firehose retries sending data to the New Relic HTTP endpoint. After sending data, Firehose first waits for an acknowledgment from the HTTP endpoint. If an error occurs or the acknowledgment doesn’t arrive within the acknowledgment timeout period, Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket. Every time that Firehose sends data to the HTTP endpoint (either the initial attempt or a retry), it restarts the acknowledgement timeout counter and waits for an acknowledgement from the HTTP endpoint. Even if the retry duration expires, Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Firehose determines whether there's time left in the retry counter. If there is time left, it retries again and repeats the logic until it receives an acknowledgment or determines that the retry time has expired. If you don't want Firehose to retry sending data, set this value to 0.
Members
- DurationInSeconds
-
- Type: int
the time period where Firehose will retry sending data to the chosen HTTP endpoint.
SnowflakeRoleConfiguration
Description
Optionally configure a Snowflake role. Otherwise the default user role will be used.
Members
- Enabled
-
- Type: boolean
Enable Snowflake role
- SnowflakeRole
-
- Type: string
The Snowflake role you wish to configure
SnowflakeVpcConfiguration
Description
Configure a Snowflake VPC
Members
- PrivateLinkVpceId
-
- Required: Yes
- Type: string
The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see Amazon PrivateLink & Snowflake
SourceDescription
Description
Details about a Kinesis data stream used as the source for a Firehose Firehose stream.
Members
- DatabaseSourceDescription
-
- Type: DatabaseSourceDescription structure
Amazon Data Firehose is in preview release and is subject to change.
- KinesisStreamSourceDescription
-
- Type: KinesisStreamSourceDescription structure
The KinesisStreamSourceDescription value for the source Kinesis data stream.
- MSKSourceDescription
-
- Type: MSKSourceDescription structure
The configuration description for the Amazon MSK cluster to be used as the source for a delivery stream.
SplunkBufferingHints
Description
The buffering options. If no value is specified, the default values for Splunk are used.
Members
- IntervalInSeconds
-
- Type: int
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 60 (1 minute).
- SizeInMBs
-
- Type: int
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
SplunkDestinationConfiguration
Description
Describes the configuration of a destination in Splunk.
Members
- BufferingHints
-
- Type: SplunkBufferingHints structure
The buffering options. If no value is specified, the default values for Splunk are used.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The Amazon CloudWatch logging options for your Firehose stream.
- HECAcknowledgmentTimeoutInSeconds
-
- Type: int
The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.
- HECEndpoint
-
- Required: Yes
- Type: string
The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
- HECEndpointType
-
- Required: Yes
- Type: string
This type can be either "Raw" or "Event."
- HECToken
-
- Type: string
This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
The data processing configuration.
- RetryOptions
-
- Type: SplunkRetryOptions structure
The retry behavior in case Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.
- S3BackupMode
-
- Type: string
Defines how documents should be delivered to Amazon S3. When set to
FailedEventsOnly, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set toAllEvents, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value isFailedEventsOnly.You can update this backup mode from
FailedEventsOnlytoAllEvents. You can't update it fromAllEventstoFailedEventsOnly. - S3Configuration
-
- Required: Yes
- Type: S3DestinationConfiguration structure
The configuration for the backup Amazon S3 location.
- SecretsManagerConfiguration
-
- Type: SecretsManagerConfiguration structure
The configuration that defines how you access secrets for Splunk.
SplunkDestinationDescription
Description
Describes a destination in Splunk.
Members
- BufferingHints
-
- Type: SplunkBufferingHints structure
The buffering options. If no value is specified, the default values for Splunk are used.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The Amazon CloudWatch logging options for your Firehose stream.
- HECAcknowledgmentTimeoutInSeconds
-
- Type: int
The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.
- HECEndpoint
-
- Type: string
The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
- HECEndpointType
-
- Type: string
This type can be either "Raw" or "Event."
- HECToken
-
- Type: string
A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
The data processing configuration.
- RetryOptions
-
- Type: SplunkRetryOptions structure
The retry behavior in case Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
- S3BackupMode
-
- Type: string
Defines how documents should be delivered to Amazon S3. When set to
FailedDocumentsOnly, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set toAllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value isFailedDocumentsOnly. - S3DestinationDescription
-
- Type: S3DestinationDescription structure
The Amazon S3 destination.>
- SecretsManagerConfiguration
-
- Type: SecretsManagerConfiguration structure
The configuration that defines how you access secrets for Splunk.
SplunkDestinationUpdate
Description
Describes an update for a destination in Splunk.
Members
- BufferingHints
-
- Type: SplunkBufferingHints structure
The buffering options. If no value is specified, the default values for Splunk are used.
- CloudWatchLoggingOptions
-
- Type: CloudWatchLoggingOptions structure
The Amazon CloudWatch logging options for your Firehose stream.
- HECAcknowledgmentTimeoutInSeconds
-
- Type: int
The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.
- HECEndpoint
-
- Type: string
The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
- HECEndpointType
-
- Type: string
This type can be either "Raw" or "Event."
- HECToken
-
- Type: string
A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
- ProcessingConfiguration
-
- Type: ProcessingConfiguration structure
The data processing configuration.
- RetryOptions
-
- Type: SplunkRetryOptions structure
The retry behavior in case Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
- S3BackupMode
-
- Type: string
Specifies how you want Firehose to back up documents to Amazon S3. When set to
FailedDocumentsOnly, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set toAllEvents, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value isFailedEventsOnly.You can update this backup mode from
FailedEventsOnlytoAllEvents. You can't update it fromAllEventstoFailedEventsOnly. - S3Update
-
- Type: S3DestinationUpdate structure
Your update to the configuration of the backup Amazon S3 location.
- SecretsManagerConfiguration
-
- Type: SecretsManagerConfiguration structure
The configuration that defines how you access secrets for Splunk.
SplunkRetryOptions
Description
Configures retry behavior in case Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.
Members
- DurationInSeconds
-
- Type: int
The total amount of time that Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Firehose waits for acknowledgment from Splunk after each attempt.
TableCreationConfiguration
Description
Amazon Data Firehose is in preview release and is subject to change.
Members
- Enabled
-
- Required: Yes
- Type: boolean
Amazon Data Firehose is in preview release and is subject to change.
Tag
Description
Metadata that you can assign to a Firehose stream, consisting of a key-value pair.
Members
- Key
-
- Required: Yes
- Type: string
A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
- Value
-
- Type: string
An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
VpcConfiguration
Description
The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
Members
- RoleARN
-
- Required: Yes
- Type: string
The ARN of the IAM role that you want the Firehose stream to use to create endpoints in the destination VPC. You can use your existing Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:
-
ec2:DescribeVpcs -
ec2:DescribeVpcAttribute -
ec2:DescribeSubnets -
ec2:DescribeSecurityGroups -
ec2:DescribeNetworkInterfaces -
ec2:CreateNetworkInterface -
ec2:CreateNetworkInterfacePermission -
ec2:DeleteNetworkInterface
When you specify subnets for delivering data to the destination in a private VPC, make sure you have enough number of free IP addresses in chosen subnets. If there is no available free IP address in a specified subnet, Firehose cannot create or add ENIs for the data delivery in the private VPC, and the delivery will be degraded or fail.
- SecurityGroupIds
-
- Required: Yes
- Type: Array of strings
The IDs of the security groups that you want Firehose to use when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.
- SubnetIds
-
- Required: Yes
- Type: Array of strings
The IDs of the subnets that you want Firehose to use to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.
The number of ENIs that Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Firehose can create up to three ENIs for this Firehose stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
VpcConfigurationDescription
Description
The details of the VPC of the Amazon ES destination.
Members
- RoleARN
-
- Required: Yes
- Type: string
The ARN of the IAM role that the Firehose stream uses to create endpoints in the destination VPC. You can use your existing Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:
-
ec2:DescribeVpcs -
ec2:DescribeVpcAttribute -
ec2:DescribeSubnets -
ec2:DescribeSecurityGroups -
ec2:DescribeNetworkInterfaces -
ec2:CreateNetworkInterface -
ec2:CreateNetworkInterfacePermission -
ec2:DeleteNetworkInterface
If you revoke these permissions after you create the Firehose stream, Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
- SecurityGroupIds
-
- Required: Yes
- Type: Array of strings
The IDs of the security groups that Firehose uses when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your Firehose stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.
- SubnetIds
-
- Required: Yes
- Type: Array of strings
The IDs of the subnets that Firehose uses to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.
The number of ENIs that Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Firehose can create up to three ENIs for this Firehose stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
- VpcId
-
- Required: Yes
- Type: string
The ID of the Amazon ES destination's VPC.