2024/01/18 - Amazon Kinesis Firehose - 3 updated api methods
Changes Allow support for Snowflake as a Kinesis Data Firehose delivery destination.
{'SnowflakeDestinationConfiguration': {'AccountUrl': 'string',
'CloudWatchLoggingOptions': {'Enabled': 'boolean',
'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': 'boolean',
'Processors': [{'Parameters': [{'ParameterName': 'LambdaArn '
'| '
'NumberOfRetries '
'| '
'MetadataExtractionQuery '
'| '
'JsonParsingEngine '
'| '
'RoleArn '
'| '
'BufferSizeInMBs '
'| '
'BufferIntervalInSeconds '
'| '
'SubRecordType '
'| '
'Delimiter '
'| '
'CompressionFormat',
'ParameterValue': 'string'}],
'Type': 'RecordDeAggregation '
'| '
'Decompression '
'| '
'Lambda '
'| '
'MetadataExtraction '
'| '
'AppendDelimiterToRecord'}]},
'RetryOptions': {'DurationInSeconds': 'integer'},
'RoleARN': 'string',
'S3BackupMode': 'FailedDataOnly | '
'AllData',
'S3Configuration': {'BucketARN': 'string',
'BufferingHints': {'IntervalInSeconds': 'integer',
'SizeInMBs': 'integer'},
'CloudWatchLoggingOptions': {'Enabled': 'boolean',
'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',
'SnowflakeRoleConfiguration': {'Enabled': 'boolean',
'SnowflakeRole': 'string'},
'SnowflakeVpcConfiguration': {'PrivateLinkVpceId': 'string'},
'Table': 'string',
'User': 'string'}}
Creates a Kinesis Data Firehose delivery stream.
By default, you can create up to 50 delivery streams per Amazon Web Services Region.
This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING . After the delivery stream is created, its status is ACTIVE and it now accepts data. If the delivery 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 delivery stream, use DescribeDeliveryStream .
If the status of a delivery 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 Kinesis Data Firehose delivery 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 delivery 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 delivery stream that doesn't have SSE enabled.
A delivery 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, Kinesis Data 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. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter.
The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation 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 Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions.
Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data 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 Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide .
See also: AWS API Documentation
Request Syntax
client.create_delivery_stream(
DeliveryStreamName='string',
DeliveryStreamType='DirectPut'|'KinesisStreamAsSource'|'MSKAsSource',
KinesisStreamSourceConfiguration={
'KinesisStreamARN': 'string',
'RoleARN': 'string'
},
DeliveryStreamEncryptionConfigurationInput={
'KeyARN': 'string',
'KeyType': 'AWS_OWNED_CMK'|'CUSTOMER_MANAGED_CMK'
},
S3DestinationConfiguration={
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
ExtendedS3DestinationConfiguration={
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'S3BackupMode': 'Disabled'|'Enabled',
'S3BackupConfiguration': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'DataFormatConversionConfiguration': {
'SchemaConfiguration': {
'RoleARN': 'string',
'CatalogId': 'string',
'DatabaseName': 'string',
'TableName': 'string',
'Region': 'string',
'VersionId': 'string'
},
'InputFormatConfiguration': {
'Deserializer': {
'OpenXJsonSerDe': {
'ConvertDotsInJsonKeysToUnderscores': True|False,
'CaseInsensitive': True|False,
'ColumnToJsonKeyMappings': {
'string': 'string'
}
},
'HiveJsonSerDe': {
'TimestampFormats': [
'string',
]
}
}
},
'OutputFormatConfiguration': {
'Serializer': {
'ParquetSerDe': {
'BlockSizeBytes': 123,
'PageSizeBytes': 123,
'Compression': 'UNCOMPRESSED'|'GZIP'|'SNAPPY',
'EnableDictionaryCompression': True|False,
'MaxPaddingBytes': 123,
'WriterVersion': 'V1'|'V2'
},
'OrcSerDe': {
'StripeSizeBytes': 123,
'BlockSizeBytes': 123,
'RowIndexStride': 123,
'EnablePadding': True|False,
'PaddingTolerance': 123.0,
'Compression': 'NONE'|'ZLIB'|'SNAPPY',
'BloomFilterColumns': [
'string',
],
'BloomFilterFalsePositiveProbability': 123.0,
'DictionaryKeyThreshold': 123.0,
'FormatVersion': 'V0_11'|'V0_12'
}
}
},
'Enabled': True|False
},
'DynamicPartitioningConfiguration': {
'RetryOptions': {
'DurationInSeconds': 123
},
'Enabled': True|False
}
},
RedshiftDestinationConfiguration={
'RoleARN': 'string',
'ClusterJDBCURL': 'string',
'CopyCommand': {
'DataTableName': 'string',
'DataTableColumns': 'string',
'CopyOptions': 'string'
},
'Username': 'string',
'Password': 'string',
'RetryOptions': {
'DurationInSeconds': 123
},
'S3Configuration': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'S3BackupMode': 'Disabled'|'Enabled',
'S3BackupConfiguration': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
ElasticsearchDestinationConfiguration={
'RoleARN': 'string',
'DomainARN': 'string',
'ClusterEndpoint': 'string',
'IndexName': 'string',
'TypeName': 'string',
'IndexRotationPeriod': 'NoRotation'|'OneHour'|'OneDay'|'OneWeek'|'OneMonth',
'BufferingHints': {
'IntervalInSeconds': 123,
'SizeInMBs': 123
},
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedDocumentsOnly'|'AllDocuments',
'S3Configuration': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'VpcConfiguration': {
'SubnetIds': [
'string',
],
'RoleARN': 'string',
'SecurityGroupIds': [
'string',
]
},
'DocumentIdOptions': {
'DefaultDocumentIdFormat': 'FIREHOSE_DEFAULT'|'NO_DOCUMENT_ID'
}
},
AmazonopensearchserviceDestinationConfiguration={
'RoleARN': 'string',
'DomainARN': 'string',
'ClusterEndpoint': 'string',
'IndexName': 'string',
'TypeName': 'string',
'IndexRotationPeriod': 'NoRotation'|'OneHour'|'OneDay'|'OneWeek'|'OneMonth',
'BufferingHints': {
'IntervalInSeconds': 123,
'SizeInMBs': 123
},
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedDocumentsOnly'|'AllDocuments',
'S3Configuration': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'VpcConfiguration': {
'SubnetIds': [
'string',
],
'RoleARN': 'string',
'SecurityGroupIds': [
'string',
]
},
'DocumentIdOptions': {
'DefaultDocumentIdFormat': 'FIREHOSE_DEFAULT'|'NO_DOCUMENT_ID'
}
},
SplunkDestinationConfiguration={
'HECEndpoint': 'string',
'HECEndpointType': 'Raw'|'Event',
'HECToken': 'string',
'HECAcknowledgmentTimeoutInSeconds': 123,
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedEventsOnly'|'AllEvents',
'S3Configuration': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'BufferingHints': {
'IntervalInSeconds': 123,
'SizeInMBs': 123
}
},
HttpEndpointDestinationConfiguration={
'EndpointConfiguration': {
'Url': 'string',
'Name': 'string',
'AccessKey': 'string'
},
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'RequestConfiguration': {
'ContentEncoding': 'NONE'|'GZIP',
'CommonAttributes': [
{
'AttributeName': 'string',
'AttributeValue': 'string'
},
]
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'RoleARN': 'string',
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedDataOnly'|'AllData',
'S3Configuration': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
AmazonOpenSearchServerlessDestinationConfiguration={
'RoleARN': 'string',
'CollectionEndpoint': 'string',
'IndexName': 'string',
'BufferingHints': {
'IntervalInSeconds': 123,
'SizeInMBs': 123
},
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedDocumentsOnly'|'AllDocuments',
'S3Configuration': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'VpcConfiguration': {
'SubnetIds': [
'string',
],
'RoleARN': 'string',
'SecurityGroupIds': [
'string',
]
}
},
MSKSourceConfiguration={
'MSKClusterARN': 'string',
'TopicName': 'string',
'AuthenticationConfiguration': {
'RoleARN': 'string',
'Connectivity': 'PUBLIC'|'PRIVATE'
}
},
SnowflakeDestinationConfiguration={
'AccountUrl': 'string',
'PrivateKey': 'string',
'KeyPassphrase': 'string',
'User': 'string',
'Database': 'string',
'Schema': 'string',
'Table': 'string',
'SnowflakeRoleConfiguration': {
'Enabled': True|False,
'SnowflakeRole': 'string'
},
'DataLoadingOption': 'JSON_MAPPING'|'VARIANT_CONTENT_MAPPING'|'VARIANT_CONTENT_AND_METADATA_MAPPING',
'MetaDataColumnName': 'string',
'ContentColumnName': 'string',
'SnowflakeVpcConfiguration': {
'PrivateLinkVpceId': 'string'
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'RoleARN': 'string',
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedDataOnly'|'AllData',
'S3Configuration': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
}
}
)
string
[REQUIRED]
The name of the delivery stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.
string
The delivery stream type. This parameter can be one of the following values:
DirectPut : Provider applications access the delivery stream directly.
KinesisStreamAsSource : The delivery stream uses a Kinesis data stream as a source.
dict
When a Kinesis data stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.
KinesisStreamARN (string) -- [REQUIRED]
The ARN of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format .
RoleARN (string) -- [REQUIRED]
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 .
dict
Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
KeyARN (string) --
If you set KeyType to CUSTOMER_MANAGED_CMK , you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to Amazon Web Services_OWNED_CMK , Kinesis Data Firehose uses a service-account CMK.
KeyType (string) -- [REQUIRED]
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 with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant.
When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data 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 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException .
Warning
To encrypt your delivery stream, use symmetric CMKs. Kinesis Data 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.
dict
[Deprecated] The destination in Amazon S3. You can specify only one destination.
RoleARN (string) -- [REQUIRED]
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 .
BucketARN (string) -- [REQUIRED]
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
dict
The destination in Amazon S3. You can specify only one destination.
RoleARN (string) -- [REQUIRED]
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 .
BucketARN (string) -- [REQUIRED]
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
The data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
S3BackupMode (string) --
The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
S3BackupConfiguration (dict) --
The configuration for backup in Amazon S3.
RoleARN (string) -- [REQUIRED]
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 .
BucketARN (string) -- [REQUIRED]
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
DataFormatConversionConfiguration (dict) --
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
SchemaConfiguration (dict) --
Specifies the Amazon Web Services Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true.
RoleARN (string) --
The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.
Warning
If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.
CatalogId (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 (string) --
Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.
Warning
If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.
TableName (string) --
Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.
Warning
If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.
Region (string) --
If you don't specify an Amazon Web Services Region, the default is the current Region.
VersionId (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 , Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.
InputFormatConfiguration (dict) --
Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON. This parameter is required if Enabled is set to true.
Deserializer (dict) --
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.
OpenXJsonSerDe (dict) --
The OpenX SerDe. Used by Kinesis Data 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.
ConvertDotsInJsonKeysToUnderscores (boolean) --
When set to true , specifies that the names of the keys include dots and that you want Kinesis Data 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 .
CaseInsensitive (boolean) --
When set to true , which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
ColumnToJsonKeyMappings (dict) --
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, timestamp is a Hive keyword. If you have a JSON key named timestamp , set this parameter to {"ts": "timestamp"} to map this key to a column named ts .
(string) --
(string) --
HiveJsonSerDe (dict) --
The native Hive / HCatalog JsonSerDe. Used by Kinesis Data 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.
TimestampFormats (list) --
Indicates how you want Kinesis Data 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 millis to parse timestamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.
(string) --
OutputFormatConfiguration (dict) --
Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if Enabled is set to true.
Serializer (dict) --
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 (dict) --
A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet .
BlockSizeBytes (integer) --
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. Kinesis Data Firehose uses this value for padding calculations.
PageSizeBytes (integer) --
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.
Compression (string) --
The compression code to use over data blocks. The possible values are UNCOMPRESSED , SNAPPY , and GZIP , with the default being SNAPPY . Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.
EnableDictionaryCompression (boolean) --
Indicates whether to enable dictionary compression.
MaxPaddingBytes (integer) --
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.
WriterVersion (string) --
Indicates the version of row format to output. The possible values are V1 and V2 . The default is V1 .
OrcSerDe (dict) --
A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC .
StripeSizeBytes (integer) --
The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
BlockSizeBytes (integer) --
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. Kinesis Data Firehose uses this value for padding calculations.
RowIndexStride (integer) --
The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
EnablePadding (boolean) --
Set this to true to 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 is false .
PaddingTolerance (float) --
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.
Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false .
Compression (string) --
The compression code to use over data blocks. The default is SNAPPY .
BloomFilterColumns (list) --
The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null .
(string) --
BloomFilterFalsePositiveProbability (float) --
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.
DictionaryKeyThreshold (float) --
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.
FormatVersion (string) --
The version of the file to write. The possible values are V0_11 and V0_12 . The default is V0_12 .
Enabled (boolean) --
Defaults to true . Set it to false if you want to disable format conversion while preserving the configuration details.
DynamicPartitioningConfiguration (dict) --
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.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.
DurationInSeconds (integer) --
The period of time during which Kinesis Data Firehose retries to deliver data to the specified Amazon S3 prefix.
Enabled (boolean) --
Specifies that the dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream.
dict
The destination in Amazon Redshift. You can specify only one destination.
RoleARN (string) -- [REQUIRED]
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 .
ClusterJDBCURL (string) -- [REQUIRED]
The database connection string.
CopyCommand (dict) -- [REQUIRED]
The COPY command.
DataTableName (string) -- [REQUIRED]
The name of the target table. The table must already exist in the database.
DataTableColumns (string) --
A comma-separated list of column names.
CopyOptions (string) --
Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command . Some possible examples that would apply to Kinesis Data 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 .
Username (string) -- [REQUIRED]
The name of the user.
Password (string) -- [REQUIRED]
The user password.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
DurationInSeconds (integer) --
The length of time during which Kinesis Data Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Kinesis Data Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.
S3Configuration (dict) -- [REQUIRED]
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 SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.
RoleARN (string) -- [REQUIRED]
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 .
BucketARN (string) -- [REQUIRED]
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
The data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
S3BackupMode (string) --
The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
S3BackupConfiguration (dict) --
The configuration for backup in Amazon S3.
RoleARN (string) -- [REQUIRED]
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 .
BucketARN (string) -- [REQUIRED]
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
dict
The destination in Amazon ES. You can specify only one destination.
RoleARN (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
DomainARN (string) --
The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain , DescribeDomains , and DescribeDomainConfig after assuming the role specified in RoleARN . For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Specify either ClusterEndpoint or DomainARN .
ClusterEndpoint (string) --
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
IndexName (string) -- [REQUIRED]
The Elasticsearch index name.
TypeName (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, Kinesis Data Firehose returns an error during run time.
For Elasticsearch 7.x, don't specify a TypeName .
IndexRotationPeriod (string) --
The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination . The default value is OneDay .
BufferingHints (dict) --
The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.
IntervalInSeconds (integer) --
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 (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
DurationInSeconds (integer) --
After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data 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.
S3BackupMode (string) --
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly , Kinesis Data 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 , Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination . Default value is FailedDocumentsOnly .
You can't change this backup mode after you create the delivery stream.
S3Configuration (dict) -- [REQUIRED]
The configuration for the backup Amazon S3 location.
RoleARN (string) -- [REQUIRED]
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 .
BucketARN (string) -- [REQUIRED]
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
The data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
VpcConfiguration (dict) --
The details of the VPC of the Amazon destination.
SubnetIds (list) -- [REQUIRED]
The IDs of the subnets that you want Kinesis Data 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. Kinesis Data 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 Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data 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 Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
(string) --
RoleARN (string) -- [REQUIRED]
The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data 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 delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
SecurityGroupIds (list) -- [REQUIRED]
The IDs of the security groups that you want Kinesis Data 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.
(string) --
DocumentIdOptions (dict) --
Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
DefaultDocumentIdFormat (string) -- [REQUIRED]
When the FIREHOSE_DEFAULT option is chosen, Kinesis Data 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_ID option is chosen, Kinesis Data 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.
dict
The destination in Amazon OpenSearch Service. You can specify only one destination.
RoleARN (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
DomainARN (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.
ClusterEndpoint (string) --
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
IndexName (string) -- [REQUIRED]
The ElasticsearAmazon OpenSearch Service index name.
TypeName (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, Kinesis Data Firehose returns an error during run time.
IndexRotationPeriod (string) --
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
BufferingHints (dict) --
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
IntervalInSeconds (integer) --
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 (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
DurationInSeconds (integer) --
After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data 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.
S3BackupMode (string) --
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data 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, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
S3Configuration (dict) -- [REQUIRED]
Describes the configuration of a destination in Amazon S3.
RoleARN (string) -- [REQUIRED]
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 .
BucketARN (string) -- [REQUIRED]
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
Describes a data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
CloudWatchLoggingOptions (dict) --
Describes the Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
VpcConfiguration (dict) --
The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
SubnetIds (list) -- [REQUIRED]
The IDs of the subnets that you want Kinesis Data 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. Kinesis Data 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 Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data 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 Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
(string) --
RoleARN (string) -- [REQUIRED]
The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data 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 delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
SecurityGroupIds (list) -- [REQUIRED]
The IDs of the security groups that you want Kinesis Data 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.
(string) --
DocumentIdOptions (dict) --
Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
DefaultDocumentIdFormat (string) -- [REQUIRED]
When the FIREHOSE_DEFAULT option is chosen, Kinesis Data 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_ID option is chosen, Kinesis Data 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.
dict
The destination in Splunk. You can specify only one destination.
HECEndpoint (string) -- [REQUIRED]
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
HECEndpointType (string) -- [REQUIRED]
This type can be either "Raw" or "Event."
HECToken (string) -- [REQUIRED]
This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
HECAcknowledgmentTimeoutInSeconds (integer) --
The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.
DurationInSeconds (integer) --
The total amount of time that Kinesis Data 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 Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt.
S3BackupMode (string) --
Defines how documents should be delivered to Amazon S3. When set to FailedEventsOnly , Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents , Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly .
You can update this backup mode from FailedEventsOnly to AllEvents . You can't update it from AllEvents to FailedEventsOnly .
S3Configuration (dict) -- [REQUIRED]
The configuration for the backup Amazon S3 location.
RoleARN (string) -- [REQUIRED]
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 .
BucketARN (string) -- [REQUIRED]
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
The data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
BufferingHints (dict) --
The buffering options. If no value is specified, the default values for Splunk are used.
IntervalInSeconds (integer) --
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 (integer) --
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
dict
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.
EndpointConfiguration (dict) -- [REQUIRED]
The configuration of the HTTP endpoint selected as the destination.
Url (string) -- [REQUIRED]
The URL of the HTTP endpoint selected as the destination.
Warning
If you choose an HTTP endpoint as your destination, review and follow the instructions in the Appendix - HTTP Endpoint Delivery Request and Response Specifications .
Name (string) --
The name of the HTTP endpoint selected as the destination.
AccessKey (string) --
The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.
BufferingHints (dict) --
The buffering options that can be used before data is delivered to the specified destination. Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
IntervalInSeconds (integer) --
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
CloudWatchLoggingOptions (dict) --
Describes the Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
RequestConfiguration (dict) --
The configuration of the requeste sent to the HTTP endpoint specified as the destination.
ContentEncoding (string) --
Kinesis Data 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.
CommonAttributes (list) --
Describes the metadata sent to the HTTP endpoint destination.
(dict) --
Describes the metadata that's delivered to the specified HTTP endpoint destination.
AttributeName (string) -- [REQUIRED]
The name of the HTTP endpoint common attribute.
AttributeValue (string) -- [REQUIRED]
The value of the HTTP endpoint common attribute.
ProcessingConfiguration (dict) --
Describes a data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
RoleARN (string) --
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
RetryOptions (dict) --
Describes the retry behavior in case Kinesis Data 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.
DurationInSeconds (integer) --
The total amount of time that Kinesis Data 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 Kinesis Data Firehose waits for acknowledgment from the specified destination after each attempt.
S3BackupMode (string) --
Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData ) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly ).
S3Configuration (dict) -- [REQUIRED]
Describes the configuration of a destination in Amazon S3.
RoleARN (string) -- [REQUIRED]
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 .
BucketARN (string) -- [REQUIRED]
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
list
A set of tags to assign to the delivery 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 delivery 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 delivery stream.
(dict) --
Metadata that you can assign to a delivery stream, consisting of a key-value pair.
Key (string) -- [REQUIRED]
A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
Value (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, _ . / = + - % @
dict
The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.
RoleARN (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
CollectionEndpoint (string) --
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
IndexName (string) -- [REQUIRED]
The Serverless offering for Amazon OpenSearch Service index name.
BufferingHints (dict) --
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
IntervalInSeconds (integer) --
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 (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
DurationInSeconds (integer) --
After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data 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.
S3BackupMode (string) --
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data 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, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
S3Configuration (dict) -- [REQUIRED]
Describes the configuration of a destination in Amazon S3.
RoleARN (string) -- [REQUIRED]
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 .
BucketARN (string) -- [REQUIRED]
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
Describes a data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
CloudWatchLoggingOptions (dict) --
Describes the Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
VpcConfiguration (dict) --
The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
SubnetIds (list) -- [REQUIRED]
The IDs of the subnets that you want Kinesis Data 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. Kinesis Data 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 Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data 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 Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
(string) --
RoleARN (string) -- [REQUIRED]
The ARN of the IAM role that you want the delivery stream to use to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data 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 delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
SecurityGroupIds (list) -- [REQUIRED]
The IDs of the security groups that you want Kinesis Data 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.
(string) --
dict
The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
MSKClusterARN (string) -- [REQUIRED]
The ARN of the Amazon MSK cluster.
TopicName (string) -- [REQUIRED]
The topic name within the Amazon MSK cluster.
AuthenticationConfiguration (dict) -- [REQUIRED]
The authentication configuration of the Amazon MSK cluster.
RoleARN (string) -- [REQUIRED]
The ARN of the role used to access the Amazon MSK cluster.
Connectivity (string) -- [REQUIRED]
The type of connectivity used to access the Amazon MSK cluster.
dict
Configure Snowflake destination
AccountUrl (string) -- [REQUIRED]
URL for accessing your Snowflake account. This URL must include your account identifier . Note that the protocol (https://) and port number are optional.
PrivateKey (string) -- [REQUIRED]
The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation .
KeyPassphrase (string) --
Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation .
User (string) -- [REQUIRED]
User login name for the Snowflake account.
Database (string) -- [REQUIRED]
All data in Snowflake is maintained in databases.
Schema (string) -- [REQUIRED]
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views
Table (string) -- [REQUIRED]
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
SnowflakeRoleConfiguration (dict) --
Optionally configure a Snowflake role. Otherwise the default user role will be used.
Enabled (boolean) --
Enable Snowflake role
SnowflakeRole (string) --
The Snowflake role you wish to configure
DataLoadingOption (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.
MetaDataColumnName (string) --
The name of the record metadata column
ContentColumnName (string) --
The name of the record content column
SnowflakeVpcConfiguration (dict) --
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
PrivateLinkVpceId (string) -- [REQUIRED]
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
CloudWatchLoggingOptions (dict) --
Describes the Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
Describes a data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
RoleARN (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Snowflake role
RetryOptions (dict) --
The time period where Kinesis Data Firehose will retry sending data to the chosen HTTP endpoint.
DurationInSeconds (integer) --
the time period where Kinesis Data Firehose will retry sending data to the chosen HTTP endpoint.
S3BackupMode (string) --
Choose an S3 backup mode
S3Configuration (dict) -- [REQUIRED]
Describes the configuration of a destination in Amazon S3.
RoleARN (string) -- [REQUIRED]
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 .
BucketARN (string) -- [REQUIRED]
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
dict
Response Syntax
{
'DeliveryStreamARN': 'string'
}
Response Structure
(dict) --
DeliveryStreamARN (string) --
The ARN of the delivery stream.
{'DeliveryStreamDescription': {'Destinations': {'SnowflakeDestinationDescription': {'AccountUrl': 'string',
'CloudWatchLoggingOptions': {'Enabled': 'boolean',
'LogGroupName': 'string',
'LogStreamName': 'string'},
'ContentColumnName': 'string',
'DataLoadingOption': 'JSON_MAPPING '
'| '
'VARIANT_CONTENT_MAPPING '
'| '
'VARIANT_CONTENT_AND_METADATA_MAPPING',
'Database': 'string',
'MetaDataColumnName': 'string',
'ProcessingConfiguration': {'Enabled': 'boolean',
'Processors': [{'Parameters': [{'ParameterName': 'LambdaArn '
'| '
'NumberOfRetries '
'| '
'MetadataExtractionQuery '
'| '
'JsonParsingEngine '
'| '
'RoleArn '
'| '
'BufferSizeInMBs '
'| '
'BufferIntervalInSeconds '
'| '
'SubRecordType '
'| '
'Delimiter '
'| '
'CompressionFormat',
'ParameterValue': 'string'}],
'Type': 'RecordDeAggregation '
'| '
'Decompression '
'| '
'Lambda '
'| '
'MetadataExtraction '
'| '
'AppendDelimiterToRecord'}]},
'RetryOptions': {'DurationInSeconds': 'integer'},
'RoleARN': 'string',
'S3BackupMode': 'FailedDataOnly '
'| '
'AllData',
'S3DestinationDescription': {'BucketARN': 'string',
'BufferingHints': {'IntervalInSeconds': 'integer',
'SizeInMBs': 'integer'},
'CloudWatchLoggingOptions': {'Enabled': 'boolean',
'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',
'SnowflakeRoleConfiguration': {'Enabled': 'boolean',
'SnowflakeRole': 'string'},
'SnowflakeVpcConfiguration': {'PrivateLinkVpceId': 'string'},
'Table': 'string',
'User': 'string'}}}}
Describes the specified delivery stream and its status. For example, after your delivery stream is created, call DescribeDeliveryStream to see whether the delivery stream is ACTIVE and therefore ready for data to be sent to it.
If the status of a delivery 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.
See also: AWS API Documentation
Request Syntax
client.describe_delivery_stream(
DeliveryStreamName='string',
Limit=123,
ExclusiveStartDestinationId='string'
)
string
[REQUIRED]
The name of the delivery stream.
integer
The limit on the number of destinations to return. You can have one destination per delivery stream.
string
The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream.
dict
Response Syntax
{
'DeliveryStreamDescription': {
'DeliveryStreamName': 'string',
'DeliveryStreamARN': 'string',
'DeliveryStreamStatus': 'CREATING'|'CREATING_FAILED'|'DELETING'|'DELETING_FAILED'|'ACTIVE',
'FailureDescription': {
'Type': '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',
'Details': 'string'
},
'DeliveryStreamEncryptionConfiguration': {
'KeyARN': 'string',
'KeyType': 'AWS_OWNED_CMK'|'CUSTOMER_MANAGED_CMK',
'Status': 'ENABLED'|'ENABLING'|'ENABLING_FAILED'|'DISABLED'|'DISABLING'|'DISABLING_FAILED',
'FailureDescription': {
'Type': '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',
'Details': 'string'
}
},
'DeliveryStreamType': 'DirectPut'|'KinesisStreamAsSource'|'MSKAsSource',
'VersionId': 'string',
'CreateTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'Source': {
'KinesisStreamSourceDescription': {
'KinesisStreamARN': 'string',
'RoleARN': 'string',
'DeliveryStartTimestamp': datetime(2015, 1, 1)
},
'MSKSourceDescription': {
'MSKClusterARN': 'string',
'TopicName': 'string',
'AuthenticationConfiguration': {
'RoleARN': 'string',
'Connectivity': 'PUBLIC'|'PRIVATE'
},
'DeliveryStartTimestamp': datetime(2015, 1, 1)
}
},
'Destinations': [
{
'DestinationId': 'string',
'S3DestinationDescription': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ExtendedS3DestinationDescription': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'S3BackupMode': 'Disabled'|'Enabled',
'S3BackupDescription': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'DataFormatConversionConfiguration': {
'SchemaConfiguration': {
'RoleARN': 'string',
'CatalogId': 'string',
'DatabaseName': 'string',
'TableName': 'string',
'Region': 'string',
'VersionId': 'string'
},
'InputFormatConfiguration': {
'Deserializer': {
'OpenXJsonSerDe': {
'ConvertDotsInJsonKeysToUnderscores': True|False,
'CaseInsensitive': True|False,
'ColumnToJsonKeyMappings': {
'string': 'string'
}
},
'HiveJsonSerDe': {
'TimestampFormats': [
'string',
]
}
}
},
'OutputFormatConfiguration': {
'Serializer': {
'ParquetSerDe': {
'BlockSizeBytes': 123,
'PageSizeBytes': 123,
'Compression': 'UNCOMPRESSED'|'GZIP'|'SNAPPY',
'EnableDictionaryCompression': True|False,
'MaxPaddingBytes': 123,
'WriterVersion': 'V1'|'V2'
},
'OrcSerDe': {
'StripeSizeBytes': 123,
'BlockSizeBytes': 123,
'RowIndexStride': 123,
'EnablePadding': True|False,
'PaddingTolerance': 123.0,
'Compression': 'NONE'|'ZLIB'|'SNAPPY',
'BloomFilterColumns': [
'string',
],
'BloomFilterFalsePositiveProbability': 123.0,
'DictionaryKeyThreshold': 123.0,
'FormatVersion': 'V0_11'|'V0_12'
}
}
},
'Enabled': True|False
},
'DynamicPartitioningConfiguration': {
'RetryOptions': {
'DurationInSeconds': 123
},
'Enabled': True|False
}
},
'RedshiftDestinationDescription': {
'RoleARN': 'string',
'ClusterJDBCURL': 'string',
'CopyCommand': {
'DataTableName': 'string',
'DataTableColumns': 'string',
'CopyOptions': 'string'
},
'Username': 'string',
'RetryOptions': {
'DurationInSeconds': 123
},
'S3DestinationDescription': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'S3BackupMode': 'Disabled'|'Enabled',
'S3BackupDescription': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ElasticsearchDestinationDescription': {
'RoleARN': 'string',
'DomainARN': 'string',
'ClusterEndpoint': 'string',
'IndexName': 'string',
'TypeName': 'string',
'IndexRotationPeriod': 'NoRotation'|'OneHour'|'OneDay'|'OneWeek'|'OneMonth',
'BufferingHints': {
'IntervalInSeconds': 123,
'SizeInMBs': 123
},
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedDocumentsOnly'|'AllDocuments',
'S3DestinationDescription': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'VpcConfigurationDescription': {
'SubnetIds': [
'string',
],
'RoleARN': 'string',
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DocumentIdOptions': {
'DefaultDocumentIdFormat': 'FIREHOSE_DEFAULT'|'NO_DOCUMENT_ID'
}
},
'AmazonopensearchserviceDestinationDescription': {
'RoleARN': 'string',
'DomainARN': 'string',
'ClusterEndpoint': 'string',
'IndexName': 'string',
'TypeName': 'string',
'IndexRotationPeriod': 'NoRotation'|'OneHour'|'OneDay'|'OneWeek'|'OneMonth',
'BufferingHints': {
'IntervalInSeconds': 123,
'SizeInMBs': 123
},
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedDocumentsOnly'|'AllDocuments',
'S3DestinationDescription': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'VpcConfigurationDescription': {
'SubnetIds': [
'string',
],
'RoleARN': 'string',
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
},
'DocumentIdOptions': {
'DefaultDocumentIdFormat': 'FIREHOSE_DEFAULT'|'NO_DOCUMENT_ID'
}
},
'SplunkDestinationDescription': {
'HECEndpoint': 'string',
'HECEndpointType': 'Raw'|'Event',
'HECToken': 'string',
'HECAcknowledgmentTimeoutInSeconds': 123,
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedEventsOnly'|'AllEvents',
'S3DestinationDescription': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'BufferingHints': {
'IntervalInSeconds': 123,
'SizeInMBs': 123
}
},
'HttpEndpointDestinationDescription': {
'EndpointConfiguration': {
'Url': 'string',
'Name': 'string'
},
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'RequestConfiguration': {
'ContentEncoding': 'NONE'|'GZIP',
'CommonAttributes': [
{
'AttributeName': 'string',
'AttributeValue': 'string'
},
]
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'RoleARN': 'string',
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedDataOnly'|'AllData',
'S3DestinationDescription': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
}
},
'SnowflakeDestinationDescription': {
'AccountUrl': 'string',
'User': 'string',
'Database': 'string',
'Schema': 'string',
'Table': 'string',
'SnowflakeRoleConfiguration': {
'Enabled': True|False,
'SnowflakeRole': 'string'
},
'DataLoadingOption': 'JSON_MAPPING'|'VARIANT_CONTENT_MAPPING'|'VARIANT_CONTENT_AND_METADATA_MAPPING',
'MetaDataColumnName': 'string',
'ContentColumnName': 'string',
'SnowflakeVpcConfiguration': {
'PrivateLinkVpceId': 'string'
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'RoleARN': 'string',
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedDataOnly'|'AllData',
'S3DestinationDescription': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
}
},
'AmazonOpenSearchServerlessDestinationDescription': {
'RoleARN': 'string',
'CollectionEndpoint': 'string',
'IndexName': 'string',
'BufferingHints': {
'IntervalInSeconds': 123,
'SizeInMBs': 123
},
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedDocumentsOnly'|'AllDocuments',
'S3DestinationDescription': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'VpcConfigurationDescription': {
'SubnetIds': [
'string',
],
'RoleARN': 'string',
'SecurityGroupIds': [
'string',
],
'VpcId': 'string'
}
}
},
],
'HasMoreDestinations': True|False
}
}
Response Structure
(dict) --
DeliveryStreamDescription (dict) --
Information about the delivery stream.
DeliveryStreamName (string) --
The name of the delivery stream.
DeliveryStreamARN (string) --
The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
DeliveryStreamStatus (string) --
The status of the delivery stream. If the status of a delivery 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.
FailureDescription (dict) --
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream , DeleteDeliveryStream , StartDeliveryStreamEncryption , StopDeliveryStreamEncryption .
Type (string) --
The type of error that caused the failure.
Details (string) --
A message providing details about the error that caused the failure.
DeliveryStreamEncryptionConfiguration (dict) --
Indicates the server-side encryption (SSE) status for the delivery stream.
KeyARN (string) --
If KeyType is CUSTOMER_MANAGED_CMK , this field contains the ARN of the customer managed CMK. If KeyType is Amazon Web Services_OWNED_CMK , DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN .
KeyType (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 (string) --
This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption . If this status is ENABLING_FAILED or DISABLING_FAILED , it is the status of the most recent attempt to enable or disable SSE, respectively.
FailureDescription (dict) --
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream , DeleteDeliveryStream , StartDeliveryStreamEncryption , StopDeliveryStreamEncryption .
Type (string) --
The type of error that caused the failure.
Details (string) --
A message providing details about the error that caused the failure.
DeliveryStreamType (string) --
The delivery stream type. This can be one of the following values:
DirectPut : Provider applications access the delivery stream directly.
KinesisStreamAsSource : The delivery stream uses a Kinesis data stream as a source.
VersionId (string) --
Each time the destination is updated for a delivery 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.
CreateTimestamp (datetime) --
The date and time that the delivery stream was created.
LastUpdateTimestamp (datetime) --
The date and time that the delivery stream was last updated.
Source (dict) --
If the DeliveryStreamType parameter is KinesisStreamAsSource , a SourceDescription object describing the source Kinesis data stream.
KinesisStreamSourceDescription (dict) --
The KinesisStreamSourceDescription value for the source Kinesis data stream.
KinesisStreamARN (string) --
The Amazon Resource Name (ARN) of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format .
RoleARN (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 .
DeliveryStartTimestamp (datetime) --
Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting with this timestamp.
MSKSourceDescription (dict) --
The configuration description for the Amazon MSK cluster to be used as the source for a delivery stream.
MSKClusterARN (string) --
The ARN of the Amazon MSK cluster.
TopicName (string) --
The topic name within the Amazon MSK cluster.
AuthenticationConfiguration (dict) --
The authentication configuration of the Amazon MSK cluster.
RoleARN (string) --
The ARN of the role used to access the Amazon MSK cluster.
Connectivity (string) --
The type of connectivity used to access the Amazon MSK cluster.
DeliveryStartTimestamp (datetime) --
Kinesis Data Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.
Destinations (list) --
The destinations.
(dict) --
Describes the destination for a delivery stream.
DestinationId (string) --
The ID of the destination.
S3DestinationDescription (dict) --
[Deprecated] The destination in Amazon S3.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (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 .
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ExtendedS3DestinationDescription (dict) --
The destination in Amazon S3.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (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 .
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
The data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) --
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) --
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) --
The parameter value.
S3BackupMode (string) --
The Amazon S3 backup mode.
S3BackupDescription (dict) --
The configuration for backup in Amazon S3.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (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 .
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
DataFormatConversionConfiguration (dict) --
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
SchemaConfiguration (dict) --
Specifies the Amazon Web Services Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true.
RoleARN (string) --
The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.
Warning
If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.
CatalogId (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 (string) --
Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.
Warning
If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.
TableName (string) --
Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.
Warning
If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.
Region (string) --
If you don't specify an Amazon Web Services Region, the default is the current Region.
VersionId (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 , Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.
InputFormatConfiguration (dict) --
Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON. This parameter is required if Enabled is set to true.
Deserializer (dict) --
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.
OpenXJsonSerDe (dict) --
The OpenX SerDe. Used by Kinesis Data 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.
ConvertDotsInJsonKeysToUnderscores (boolean) --
When set to true , specifies that the names of the keys include dots and that you want Kinesis Data 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 .
CaseInsensitive (boolean) --
When set to true , which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
ColumnToJsonKeyMappings (dict) --
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, timestamp is a Hive keyword. If you have a JSON key named timestamp , set this parameter to {"ts": "timestamp"} to map this key to a column named ts .
(string) --
(string) --
HiveJsonSerDe (dict) --
The native Hive / HCatalog JsonSerDe. Used by Kinesis Data 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.
TimestampFormats (list) --
Indicates how you want Kinesis Data 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 millis to parse timestamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.
(string) --
OutputFormatConfiguration (dict) --
Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if Enabled is set to true.
Serializer (dict) --
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 (dict) --
A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet .
BlockSizeBytes (integer) --
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. Kinesis Data Firehose uses this value for padding calculations.
PageSizeBytes (integer) --
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.
Compression (string) --
The compression code to use over data blocks. The possible values are UNCOMPRESSED , SNAPPY , and GZIP , with the default being SNAPPY . Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.
EnableDictionaryCompression (boolean) --
Indicates whether to enable dictionary compression.
MaxPaddingBytes (integer) --
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.
WriterVersion (string) --
Indicates the version of row format to output. The possible values are V1 and V2 . The default is V1 .
OrcSerDe (dict) --
A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC .
StripeSizeBytes (integer) --
The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
BlockSizeBytes (integer) --
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. Kinesis Data Firehose uses this value for padding calculations.
RowIndexStride (integer) --
The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
EnablePadding (boolean) --
Set this to true to 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 is false .
PaddingTolerance (float) --
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.
Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false .
Compression (string) --
The compression code to use over data blocks. The default is SNAPPY .
BloomFilterColumns (list) --
The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null .
(string) --
BloomFilterFalsePositiveProbability (float) --
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.
DictionaryKeyThreshold (float) --
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.
FormatVersion (string) --
The version of the file to write. The possible values are V0_11 and V0_12 . The default is V0_12 .
Enabled (boolean) --
Defaults to true . Set it to false if you want to disable format conversion while preserving the configuration details.
DynamicPartitioningConfiguration (dict) --
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.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.
DurationInSeconds (integer) --
The period of time during which Kinesis Data Firehose retries to deliver data to the specified Amazon S3 prefix.
Enabled (boolean) --
Specifies that the dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream.
RedshiftDestinationDescription (dict) --
The destination in Amazon Redshift.
RoleARN (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 .
ClusterJDBCURL (string) --
The database connection string.
CopyCommand (dict) --
The COPY command.
DataTableName (string) --
The name of the target table. The table must already exist in the database.
DataTableColumns (string) --
A comma-separated list of column names.
CopyOptions (string) --
Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command . Some possible examples that would apply to Kinesis Data 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 .
Username (string) --
The name of the user.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
DurationInSeconds (integer) --
The length of time during which Kinesis Data Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Kinesis Data Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.
S3DestinationDescription (dict) --
The Amazon S3 destination.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (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 .
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
The data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) --
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) --
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) --
The parameter value.
S3BackupMode (string) --
The Amazon S3 backup mode.
S3BackupDescription (dict) --
The configuration for backup in Amazon S3.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (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 .
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ElasticsearchDestinationDescription (dict) --
The destination in Amazon ES.
RoleARN (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 .
DomainARN (string) --
The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.
ClusterEndpoint (string) --
The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.
IndexName (string) --
The Elasticsearch index name.
TypeName (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 .
IndexRotationPeriod (string) --
The Elasticsearch index rotation period
BufferingHints (dict) --
The buffering options.
IntervalInSeconds (integer) --
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 (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
RetryOptions (dict) --
The Amazon ES retry options.
DurationInSeconds (integer) --
After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data 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.
S3BackupMode (string) --
The Amazon S3 backup mode.
S3DestinationDescription (dict) --
The Amazon S3 destination.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (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 .
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
The data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) --
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) --
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) --
The parameter value.
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
VpcConfigurationDescription (dict) --
The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.
SubnetIds (list) --
The IDs of the subnets that Kinesis Data 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. Kinesis Data 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 Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data 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 Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
(string) --
RoleARN (string) --
The ARN of the IAM role that the delivery stream uses to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data 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 delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
SecurityGroupIds (list) --
The IDs of the security groups that Kinesis Data 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 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.
(string) --
VpcId (string) --
The ID of the Amazon ES destination's VPC.
DocumentIdOptions (dict) --
Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
DefaultDocumentIdFormat (string) --
When the FIREHOSE_DEFAULT option is chosen, Kinesis Data 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_ID option is chosen, Kinesis Data 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.
AmazonopensearchserviceDestinationDescription (dict) --
The destination in Amazon OpenSearch Service.
RoleARN (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
DomainARN (string) --
The ARN of the Amazon OpenSearch Service domain.
ClusterEndpoint (string) --
The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
IndexName (string) --
The Amazon OpenSearch Service index name.
TypeName (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.
IndexRotationPeriod (string) --
The Amazon OpenSearch Service index rotation period
BufferingHints (dict) --
The buffering options.
IntervalInSeconds (integer) --
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 (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
RetryOptions (dict) --
The Amazon OpenSearch Service retry options.
DurationInSeconds (integer) --
After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data 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.
S3BackupMode (string) --
The Amazon S3 backup mode.
S3DestinationDescription (dict) --
Describes a destination in Amazon S3.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (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 .
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
Describes a data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) --
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) --
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) --
The parameter value.
CloudWatchLoggingOptions (dict) --
Describes the Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
VpcConfigurationDescription (dict) --
The details of the VPC of the Amazon ES destination.
SubnetIds (list) --
The IDs of the subnets that Kinesis Data 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. Kinesis Data 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 Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data 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 Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
(string) --
RoleARN (string) --
The ARN of the IAM role that the delivery stream uses to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data 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 delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
SecurityGroupIds (list) --
The IDs of the security groups that Kinesis Data 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 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.
(string) --
VpcId (string) --
The ID of the Amazon ES destination's VPC.
DocumentIdOptions (dict) --
Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
DefaultDocumentIdFormat (string) --
When the FIREHOSE_DEFAULT option is chosen, Kinesis Data 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_ID option is chosen, Kinesis Data 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.
SplunkDestinationDescription (dict) --
The destination in Splunk.
HECEndpoint (string) --
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
HECEndpointType (string) --
This type can be either "Raw" or "Event."
HECToken (string) --
A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
HECAcknowledgmentTimeoutInSeconds (integer) --
The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
DurationInSeconds (integer) --
The total amount of time that Kinesis Data 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 Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt.
S3BackupMode (string) --
Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly , Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments , Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly .
S3DestinationDescription (dict) --
The Amazon S3 destination.>
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (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 .
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
The data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) --
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) --
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) --
The parameter value.
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
BufferingHints (dict) --
The buffering options. If no value is specified, the default values for Splunk are used.
IntervalInSeconds (integer) --
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 (integer) --
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
HttpEndpointDestinationDescription (dict) --
Describes the specified HTTP endpoint destination.
EndpointConfiguration (dict) --
The configuration of the specified HTTP endpoint destination.
Url (string) --
The URL of the HTTP endpoint selected as the destination.
Name (string) --
The name of the HTTP endpoint selected as the destination.
BufferingHints (dict) --
Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats 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.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
IntervalInSeconds (integer) --
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
CloudWatchLoggingOptions (dict) --
Describes the Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
RequestConfiguration (dict) --
The configuration of request sent to the HTTP endpoint specified as the destination.
ContentEncoding (string) --
Kinesis Data 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.
CommonAttributes (list) --
Describes the metadata sent to the HTTP endpoint destination.
(dict) --
Describes the metadata that's delivered to the specified HTTP endpoint destination.
AttributeName (string) --
The name of the HTTP endpoint common attribute.
AttributeValue (string) --
The value of the HTTP endpoint common attribute.
ProcessingConfiguration (dict) --
Describes a data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) --
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) --
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) --
The parameter value.
RoleARN (string) --
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
RetryOptions (dict) --
Describes the retry behavior in case Kinesis Data 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.
DurationInSeconds (integer) --
The total amount of time that Kinesis Data 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 Kinesis Data Firehose waits for acknowledgment from the specified destination after each attempt.
S3BackupMode (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 Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly ).
S3DestinationDescription (dict) --
Describes a destination in Amazon S3.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (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 .
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
SnowflakeDestinationDescription (dict) --
Optional description for the destination
AccountUrl (string) --
URL for accessing your Snowflake account. This URL must include your account identifier . Note that the protocol (https://) and port number are optional.
User (string) --
User login name for the Snowflake account.
Database (string) --
All data in Snowflake is maintained in databases.
Schema (string) --
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views
Table (string) --
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
SnowflakeRoleConfiguration (dict) --
Optionally configure a Snowflake role. Otherwise the default user role will be used.
Enabled (boolean) --
Enable Snowflake role
SnowflakeRole (string) --
The Snowflake role you wish to configure
DataLoadingOption (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.
MetaDataColumnName (string) --
The name of the record metadata column
ContentColumnName (string) --
The name of the record content column
SnowflakeVpcConfiguration (dict) --
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
PrivateLinkVpceId (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
CloudWatchLoggingOptions (dict) --
Describes the Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
Describes a data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) --
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) --
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) --
The parameter value.
RoleARN (string) --
The Amazon Resource Name (ARN) of the Snowflake role
RetryOptions (dict) --
The time period where Kinesis Data Firehose will retry sending data to the chosen HTTP endpoint.
DurationInSeconds (integer) --
the time period where Kinesis Data Firehose will retry sending data to the chosen HTTP endpoint.
S3BackupMode (string) --
Choose an S3 backup mode
S3DestinationDescription (dict) --
Describes a destination in Amazon S3.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (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 .
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
AmazonOpenSearchServerlessDestinationDescription (dict) --
The destination in the Serverless offering for Amazon OpenSearch Service.
RoleARN (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
CollectionEndpoint (string) --
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
IndexName (string) --
The Serverless offering for Amazon OpenSearch Service index name.
BufferingHints (dict) --
The buffering options.
IntervalInSeconds (integer) --
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 (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
RetryOptions (dict) --
The Serverless offering for Amazon OpenSearch Service retry options.
DurationInSeconds (integer) --
After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data 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.
S3BackupMode (string) --
The Amazon S3 backup mode.
S3DestinationDescription (dict) --
Describes a destination in Amazon S3.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (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 .
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
Describes a data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) --
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) --
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) --
The parameter value.
CloudWatchLoggingOptions (dict) --
Describes the Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
VpcConfigurationDescription (dict) --
The details of the VPC of the Amazon ES destination.
SubnetIds (list) --
The IDs of the subnets that Kinesis Data 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. Kinesis Data 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 Kinesis Data Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Kinesis Data 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 Kinesis Data Firehose can create up to three ENIs for this delivery stream for each of the subnets specified here. For more information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.
(string) --
RoleARN (string) --
The ARN of the IAM role that the delivery stream uses to create endpoints in the destination VPC. You can use your existing Kinesis Data Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Kinesis Data 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 delivery stream, Kinesis Data Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.
SecurityGroupIds (list) --
The IDs of the security groups that Kinesis Data 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 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.
(string) --
VpcId (string) --
The ID of the Amazon ES destination's VPC.
HasMoreDestinations (boolean) --
Indicates whether there are more destinations available to list.
{'SnowflakeDestinationUpdate': {'AccountUrl': 'string',
'CloudWatchLoggingOptions': {'Enabled': 'boolean',
'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': 'boolean',
'Processors': [{'Parameters': [{'ParameterName': 'LambdaArn '
'| '
'NumberOfRetries '
'| '
'MetadataExtractionQuery '
'| '
'JsonParsingEngine '
'| '
'RoleArn '
'| '
'BufferSizeInMBs '
'| '
'BufferIntervalInSeconds '
'| '
'SubRecordType '
'| '
'Delimiter '
'| '
'CompressionFormat',
'ParameterValue': 'string'}],
'Type': 'RecordDeAggregation '
'| '
'Decompression '
'| '
'Lambda '
'| '
'MetadataExtraction '
'| '
'AppendDelimiterToRecord'}]},
'RetryOptions': {'DurationInSeconds': 'integer'},
'RoleARN': 'string',
'S3BackupMode': 'FailedDataOnly | AllData',
'S3Update': {'BucketARN': 'string',
'BufferingHints': {'IntervalInSeconds': 'integer',
'SizeInMBs': 'integer'},
'CloudWatchLoggingOptions': {'Enabled': 'boolean',
'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',
'SnowflakeRoleConfiguration': {'Enabled': 'boolean',
'SnowflakeRole': 'string'},
'Table': 'string',
'User': 'string'}}
Updates the specified destination of the specified delivery 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 delivery stream remains active while the configurations are updated, so data writes to the delivery 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, Kinesis Data 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, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified.
Kinesis Data 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.
See also: AWS API Documentation
Request Syntax
client.update_destination(
DeliveryStreamName='string',
CurrentDeliveryStreamVersionId='string',
DestinationId='string',
S3DestinationUpdate={
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
ExtendedS3DestinationUpdate={
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'S3BackupMode': 'Disabled'|'Enabled',
'S3BackupUpdate': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'DataFormatConversionConfiguration': {
'SchemaConfiguration': {
'RoleARN': 'string',
'CatalogId': 'string',
'DatabaseName': 'string',
'TableName': 'string',
'Region': 'string',
'VersionId': 'string'
},
'InputFormatConfiguration': {
'Deserializer': {
'OpenXJsonSerDe': {
'ConvertDotsInJsonKeysToUnderscores': True|False,
'CaseInsensitive': True|False,
'ColumnToJsonKeyMappings': {
'string': 'string'
}
},
'HiveJsonSerDe': {
'TimestampFormats': [
'string',
]
}
}
},
'OutputFormatConfiguration': {
'Serializer': {
'ParquetSerDe': {
'BlockSizeBytes': 123,
'PageSizeBytes': 123,
'Compression': 'UNCOMPRESSED'|'GZIP'|'SNAPPY',
'EnableDictionaryCompression': True|False,
'MaxPaddingBytes': 123,
'WriterVersion': 'V1'|'V2'
},
'OrcSerDe': {
'StripeSizeBytes': 123,
'BlockSizeBytes': 123,
'RowIndexStride': 123,
'EnablePadding': True|False,
'PaddingTolerance': 123.0,
'Compression': 'NONE'|'ZLIB'|'SNAPPY',
'BloomFilterColumns': [
'string',
],
'BloomFilterFalsePositiveProbability': 123.0,
'DictionaryKeyThreshold': 123.0,
'FormatVersion': 'V0_11'|'V0_12'
}
}
},
'Enabled': True|False
},
'DynamicPartitioningConfiguration': {
'RetryOptions': {
'DurationInSeconds': 123
},
'Enabled': True|False
}
},
RedshiftDestinationUpdate={
'RoleARN': 'string',
'ClusterJDBCURL': 'string',
'CopyCommand': {
'DataTableName': 'string',
'DataTableColumns': 'string',
'CopyOptions': 'string'
},
'Username': 'string',
'Password': 'string',
'RetryOptions': {
'DurationInSeconds': 123
},
'S3Update': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'S3BackupMode': 'Disabled'|'Enabled',
'S3BackupUpdate': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
ElasticsearchDestinationUpdate={
'RoleARN': 'string',
'DomainARN': 'string',
'ClusterEndpoint': 'string',
'IndexName': 'string',
'TypeName': 'string',
'IndexRotationPeriod': 'NoRotation'|'OneHour'|'OneDay'|'OneWeek'|'OneMonth',
'BufferingHints': {
'IntervalInSeconds': 123,
'SizeInMBs': 123
},
'RetryOptions': {
'DurationInSeconds': 123
},
'S3Update': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'DocumentIdOptions': {
'DefaultDocumentIdFormat': 'FIREHOSE_DEFAULT'|'NO_DOCUMENT_ID'
}
},
AmazonopensearchserviceDestinationUpdate={
'RoleARN': 'string',
'DomainARN': 'string',
'ClusterEndpoint': 'string',
'IndexName': 'string',
'TypeName': 'string',
'IndexRotationPeriod': 'NoRotation'|'OneHour'|'OneDay'|'OneWeek'|'OneMonth',
'BufferingHints': {
'IntervalInSeconds': 123,
'SizeInMBs': 123
},
'RetryOptions': {
'DurationInSeconds': 123
},
'S3Update': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'DocumentIdOptions': {
'DefaultDocumentIdFormat': 'FIREHOSE_DEFAULT'|'NO_DOCUMENT_ID'
}
},
SplunkDestinationUpdate={
'HECEndpoint': 'string',
'HECEndpointType': 'Raw'|'Event',
'HECToken': 'string',
'HECAcknowledgmentTimeoutInSeconds': 123,
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedEventsOnly'|'AllEvents',
'S3Update': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'BufferingHints': {
'IntervalInSeconds': 123,
'SizeInMBs': 123
}
},
HttpEndpointDestinationUpdate={
'EndpointConfiguration': {
'Url': 'string',
'Name': 'string',
'AccessKey': 'string'
},
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'RequestConfiguration': {
'ContentEncoding': 'NONE'|'GZIP',
'CommonAttributes': [
{
'AttributeName': 'string',
'AttributeValue': 'string'
},
]
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'RoleARN': 'string',
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedDataOnly'|'AllData',
'S3Update': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
}
},
AmazonOpenSearchServerlessDestinationUpdate={
'RoleARN': 'string',
'CollectionEndpoint': 'string',
'IndexName': 'string',
'BufferingHints': {
'IntervalInSeconds': 123,
'SizeInMBs': 123
},
'RetryOptions': {
'DurationInSeconds': 123
},
'S3Update': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
},
SnowflakeDestinationUpdate={
'AccountUrl': 'string',
'PrivateKey': 'string',
'KeyPassphrase': 'string',
'User': 'string',
'Database': 'string',
'Schema': 'string',
'Table': 'string',
'SnowflakeRoleConfiguration': {
'Enabled': True|False,
'SnowflakeRole': 'string'
},
'DataLoadingOption': 'JSON_MAPPING'|'VARIANT_CONTENT_MAPPING'|'VARIANT_CONTENT_AND_METADATA_MAPPING',
'MetaDataColumnName': 'string',
'ContentColumnName': 'string',
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
},
'ProcessingConfiguration': {
'Enabled': True|False,
'Processors': [
{
'Type': 'RecordDeAggregation'|'Decompression'|'Lambda'|'MetadataExtraction'|'AppendDelimiterToRecord',
'Parameters': [
{
'ParameterName': 'LambdaArn'|'NumberOfRetries'|'MetadataExtractionQuery'|'JsonParsingEngine'|'RoleArn'|'BufferSizeInMBs'|'BufferIntervalInSeconds'|'SubRecordType'|'Delimiter'|'CompressionFormat',
'ParameterValue': 'string'
},
]
},
]
},
'RoleARN': 'string',
'RetryOptions': {
'DurationInSeconds': 123
},
'S3BackupMode': 'FailedDataOnly'|'AllData',
'S3Update': {
'RoleARN': 'string',
'BucketARN': 'string',
'Prefix': 'string',
'ErrorOutputPrefix': 'string',
'BufferingHints': {
'SizeInMBs': 123,
'IntervalInSeconds': 123
},
'CompressionFormat': 'UNCOMPRESSED'|'GZIP'|'ZIP'|'Snappy'|'HADOOP_SNAPPY',
'EncryptionConfiguration': {
'NoEncryptionConfig': 'NoEncryption',
'KMSEncryptionConfig': {
'AWSKMSKeyARN': 'string'
}
},
'CloudWatchLoggingOptions': {
'Enabled': True|False,
'LogGroupName': 'string',
'LogStreamName': 'string'
}
}
}
)
string
[REQUIRED]
The name of the delivery stream.
string
[REQUIRED]
Obtain this value from the VersionId result 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, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration.
string
[REQUIRED]
The ID of the destination.
dict
[Deprecated] Describes an update for a destination in Amazon S3.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
dict
Describes an update for a destination in Amazon S3.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
The data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
S3BackupMode (string) --
You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
S3BackupUpdate (dict) --
The Amazon S3 destination for backup.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
DataFormatConversionConfiguration (dict) --
The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.
SchemaConfiguration (dict) --
Specifies the Amazon Web Services Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true.
RoleARN (string) --
The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.
Warning
If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.
CatalogId (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 (string) --
Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.
Warning
If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.
TableName (string) --
Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.
Warning
If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.
Region (string) --
If you don't specify an Amazon Web Services Region, the default is the current Region.
VersionId (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 , Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.
InputFormatConfiguration (dict) --
Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON. This parameter is required if Enabled is set to true.
Deserializer (dict) --
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.
OpenXJsonSerDe (dict) --
The OpenX SerDe. Used by Kinesis Data 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.
ConvertDotsInJsonKeysToUnderscores (boolean) --
When set to true , specifies that the names of the keys include dots and that you want Kinesis Data 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 .
CaseInsensitive (boolean) --
When set to true , which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.
ColumnToJsonKeyMappings (dict) --
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, timestamp is a Hive keyword. If you have a JSON key named timestamp , set this parameter to {"ts": "timestamp"} to map this key to a column named ts .
(string) --
(string) --
HiveJsonSerDe (dict) --
The native Hive / HCatalog JsonSerDe. Used by Kinesis Data 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.
TimestampFormats (list) --
Indicates how you want Kinesis Data 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 millis to parse timestamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.
(string) --
OutputFormatConfiguration (dict) --
Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if Enabled is set to true.
Serializer (dict) --
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 (dict) --
A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet .
BlockSizeBytes (integer) --
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. Kinesis Data Firehose uses this value for padding calculations.
PageSizeBytes (integer) --
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.
Compression (string) --
The compression code to use over data blocks. The possible values are UNCOMPRESSED , SNAPPY , and GZIP , with the default being SNAPPY . Use SNAPPY for higher decompression speed. Use GZIP if the compression ratio is more important than speed.
EnableDictionaryCompression (boolean) --
Indicates whether to enable dictionary compression.
MaxPaddingBytes (integer) --
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.
WriterVersion (string) --
Indicates the version of row format to output. The possible values are V1 and V2 . The default is V1 .
OrcSerDe (dict) --
A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC .
StripeSizeBytes (integer) --
The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
BlockSizeBytes (integer) --
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. Kinesis Data Firehose uses this value for padding calculations.
RowIndexStride (integer) --
The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
EnablePadding (boolean) --
Set this to true to 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 is false .
PaddingTolerance (float) --
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.
Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false .
Compression (string) --
The compression code to use over data blocks. The default is SNAPPY .
BloomFilterColumns (list) --
The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null .
(string) --
BloomFilterFalsePositiveProbability (float) --
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.
DictionaryKeyThreshold (float) --
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.
FormatVersion (string) --
The version of the file to write. The possible values are V0_11 and V0_12 . The default is V0_12 .
Enabled (boolean) --
Defaults to true . Set it to false if you want to disable format conversion while preserving the configuration details.
DynamicPartitioningConfiguration (dict) --
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.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon S3 prefix.
DurationInSeconds (integer) --
The period of time during which Kinesis Data Firehose retries to deliver data to the specified Amazon S3 prefix.
Enabled (boolean) --
Specifies that the dynamic partitioning is enabled for this Kinesis Data Firehose delivery stream.
dict
Describes an update for a destination in Amazon Redshift.
RoleARN (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 .
ClusterJDBCURL (string) --
The database connection string.
CopyCommand (dict) --
The COPY command.
DataTableName (string) -- [REQUIRED]
The name of the target table. The table must already exist in the database.
DataTableColumns (string) --
A comma-separated list of column names.
CopyOptions (string) --
Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command . Some possible examples that would apply to Kinesis Data 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 .
Username (string) --
The name of the user.
Password (string) --
The user password.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
DurationInSeconds (integer) --
The length of time during which Kinesis Data Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Kinesis Data Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.
S3Update (dict) --
The Amazon S3 destination.
The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
The data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
S3BackupMode (string) --
You can update a delivery stream to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
S3BackupUpdate (dict) --
The Amazon S3 destination for backup.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
dict
Describes an update for a destination in Amazon ES.
RoleARN (string) --
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
DomainARN (string) --
The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain , DescribeDomains , and DescribeDomainConfig after assuming the IAM role specified in RoleARN . For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Specify either ClusterEndpoint or DomainARN .
ClusterEndpoint (string) --
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
IndexName (string) --
The Elasticsearch index name.
TypeName (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, Kinesis Data Firehose returns an error during runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName .
IndexRotationPeriod (string) --
The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination . Default value is OneDay .
BufferingHints (dict) --
The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
IntervalInSeconds (integer) --
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 (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
DurationInSeconds (integer) --
After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data 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.
S3Update (dict) --
The Amazon S3 destination.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
The data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
DocumentIdOptions (dict) --
Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
DefaultDocumentIdFormat (string) -- [REQUIRED]
When the FIREHOSE_DEFAULT option is chosen, Kinesis Data 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_ID option is chosen, Kinesis Data 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.
dict
Describes an update for a destination in Amazon OpenSearch Service.
RoleARN (string) --
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
DomainARN (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.
ClusterEndpoint (string) --
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
IndexName (string) --
The Amazon OpenSearch Service index name.
TypeName (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, Kinesis Data Firehose returns an error during runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
IndexRotationPeriod (string) --
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
BufferingHints (dict) --
The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
IntervalInSeconds (integer) --
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 (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
DurationInSeconds (integer) --
After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data 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.
S3Update (dict) --
Describes an update for a destination in Amazon S3.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
Describes a data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
CloudWatchLoggingOptions (dict) --
Describes the Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
DocumentIdOptions (dict) --
Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
DefaultDocumentIdFormat (string) -- [REQUIRED]
When the FIREHOSE_DEFAULT option is chosen, Kinesis Data 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_ID option is chosen, Kinesis Data 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.
dict
Describes an update for a destination in Splunk.
HECEndpoint (string) --
The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
HECEndpointType (string) --
This type can be either "Raw" or "Event."
HECToken (string) --
A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
HECAcknowledgmentTimeoutInSeconds (integer) --
The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
DurationInSeconds (integer) --
The total amount of time that Kinesis Data 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 Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt.
S3BackupMode (string) --
Specifies how you want Kinesis Data Firehose to back up documents to Amazon S3. When set to FailedDocumentsOnly , Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents , Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly .
You can update this backup mode from FailedEventsOnly to AllEvents . You can't update it from AllEvents to FailedEventsOnly .
S3Update (dict) --
Your update to the configuration of the backup Amazon S3 location.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
The data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
CloudWatchLoggingOptions (dict) --
The Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
BufferingHints (dict) --
The buffering options. If no value is specified, the default values for Splunk are used.
IntervalInSeconds (integer) --
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 (integer) --
Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
dict
Describes an update to the specified HTTP endpoint destination.
EndpointConfiguration (dict) --
Describes the configuration of the HTTP endpoint destination.
Url (string) -- [REQUIRED]
The URL of the HTTP endpoint selected as the destination.
Warning
If you choose an HTTP endpoint as your destination, review and follow the instructions in the Appendix - HTTP Endpoint Delivery Request and Response Specifications .
Name (string) --
The name of the HTTP endpoint selected as the destination.
AccessKey (string) --
The access key required for Kinesis Firehose to authenticate with the HTTP endpoint selected as the destination.
BufferingHints (dict) --
Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats 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.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
IntervalInSeconds (integer) --
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
CloudWatchLoggingOptions (dict) --
Describes the Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
RequestConfiguration (dict) --
The configuration of the request sent to the HTTP endpoint specified as the destination.
ContentEncoding (string) --
Kinesis Data 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.
CommonAttributes (list) --
Describes the metadata sent to the HTTP endpoint destination.
(dict) --
Describes the metadata that's delivered to the specified HTTP endpoint destination.
AttributeName (string) -- [REQUIRED]
The name of the HTTP endpoint common attribute.
AttributeValue (string) -- [REQUIRED]
The value of the HTTP endpoint common attribute.
ProcessingConfiguration (dict) --
Describes a data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
RoleARN (string) --
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
RetryOptions (dict) --
Describes the retry behavior in case Kinesis Data 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.
DurationInSeconds (integer) --
The total amount of time that Kinesis Data 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 Kinesis Data Firehose waits for acknowledgment from the specified destination after each attempt.
S3BackupMode (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 Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly ).
S3Update (dict) --
Describes an update for a destination in Amazon S3.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
dict
Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
RoleARN (string) --
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
CollectionEndpoint (string) --
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
IndexName (string) --
The Serverless offering for Amazon OpenSearch Service index name.
BufferingHints (dict) --
The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
IntervalInSeconds (integer) --
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 (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
RetryOptions (dict) --
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
DurationInSeconds (integer) --
After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data 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.
S3Update (dict) --
Describes an update for a destination in Amazon S3.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
Describes a data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
CloudWatchLoggingOptions (dict) --
Describes the Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
dict
Update to the Snowflake destination condiguration settings
AccountUrl (string) --
URL for accessing your Snowflake account. This URL must include your account identifier . Note that the protocol (https://) and port number are optional.
PrivateKey (string) --
The private key used to encrypt your Snowflake client. For information, see Using Key Pair Authentication & Key Rotation .
KeyPassphrase (string) --
Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation .
User (string) --
User login name for the Snowflake account.
Database (string) --
All data in Snowflake is maintained in databases.
Schema (string) --
Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views
Table (string) --
All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
SnowflakeRoleConfiguration (dict) --
Optionally configure a Snowflake role. Otherwise the default user role will be used.
Enabled (boolean) --
Enable Snowflake role
SnowflakeRole (string) --
The Snowflake role you wish to configure
DataLoadingOption (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.
MetaDataColumnName (string) --
The name of the record metadata column
ContentColumnName (string) --
The name of the content metadata column
CloudWatchLoggingOptions (dict) --
Describes the Amazon CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
ProcessingConfiguration (dict) --
Describes a data processing configuration.
Enabled (boolean) --
Enables or disables data processing.
Processors (list) --
The data processors.
(dict) --
Describes a data processor.
Type (string) -- [REQUIRED]
The type of processor.
Parameters (list) --
The processor parameters.
(dict) --
Describes the processor parameter.
ParameterName (string) -- [REQUIRED]
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds . The BufferSizeInMBs ranges 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 (string) -- [REQUIRED]
The parameter value.
RoleARN (string) --
The Amazon Resource Name (ARN) of the Snowflake role
RetryOptions (dict) --
Specify how long Kinesis Data Firehose retries sending data to the New Relic HTTP endpoint. After sending data, Kinesis 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, Kinesis Data Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Kinesis Data Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket. Every time that Kinesis Data 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, Kinesis Data Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Kinesis Data 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 Kinesis Data Firehose to retry sending data, set this value to 0.
DurationInSeconds (integer) --
the time period where Kinesis Data Firehose will retry sending data to the chosen HTTP endpoint.
S3BackupMode (string) --
Choose an S3 backup mode
S3Update (dict) --
Describes an update for a destination in Amazon S3.
RoleARN (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 .
BucketARN (string) --
The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
Prefix (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 .
ErrorOutputPrefix (string) --
A prefix that Kinesis Data 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 .
BufferingHints (dict) --
The buffering option. If no value is specified, BufferingHints object default values are used.
SizeInMBs (integer) --
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 delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.
IntervalInSeconds (integer) --
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.
CompressionFormat (string) --
The compression format. If no value is specified, the default is UNCOMPRESSED .
The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.
EncryptionConfiguration (dict) --
The encryption configuration. If no value is specified, the default is no encryption.
NoEncryptionConfig (string) --
Specifically override existing encryption information to ensure that no encryption is used.
KMSEncryptionConfig (dict) --
The encryption key.
AWSKMSKeyARN (string) -- [REQUIRED]
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 .
CloudWatchLoggingOptions (dict) --
The CloudWatch logging options for your delivery stream.
Enabled (boolean) --
Enables or disables CloudWatch logging.
LogGroupName (string) --
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
LogStreamName (string) --
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
dict
Response Syntax
{}
Response Structure
(dict) --