Skip to content

aws.firehose.describe_delivery_stream

Example SQL Queries

SELECT * FROM
aws.firehose.describe_delivery_stream
WHERE
"delivery_stream_name" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
delivery_stream_name Required Input Column

The name of the delivery stream.

VARCHAR
exclusive_start_destination_id Input Column

The ID of the destination to start returning the destination information. Firehose supports one destination per delivery stream.

VARCHAR
limit Input Column

The limit on the number of destinations to return. You can have one destination per delivery stream.

BIGINT
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
delivery_stream_description

Information about the delivery stream.

STRUCT(
"delivery_stream_name" VARCHAR,
"delivery_stream_arn" VARCHAR,
"delivery_stream_status" VARCHAR,
"failure_description" STRUCT(
"type" VARCHAR,
"details" VARCHAR
),
"delivery_stream_encryption_configuration" STRUCT(
"key_arn" VARCHAR,
"key_type" VARCHAR,
"status" VARCHAR,
"failure_description" STRUCT(
"type" VARCHAR,
"details" VARCHAR
)
),
"delivery_stream_type" VARCHAR,
"version_id" VARCHAR,
"create_timestamp" TIMESTAMP_S,
"last_update_timestamp" TIMESTAMP_S,
"source" STRUCT(
"kinesis_stream_source_description" STRUCT(
"kinesis_stream_arn" VARCHAR,
"role_arn" VARCHAR,
"delivery_start_timestamp" TIMESTAMP_S
),
"msk_source_description" STRUCT(
"msk_cluster_arn" VARCHAR,
"topic_name" VARCHAR,
"authentication_configuration" STRUCT(
"role_arn" VARCHAR,
"connectivity" VARCHAR
),
"delivery_start_timestamp" TIMESTAMP_S,
"read_from_timestamp" TIMESTAMP_S
)
),
"destinations" STRUCT(
"destination_id" VARCHAR,
"s3_destination_description" STRUCT(
"role_arn" VARCHAR,
"bucket_arn" VARCHAR,
"prefix" VARCHAR,
"error_output_prefix" VARCHAR,
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
),
"compression_format" VARCHAR,
"encryption_configuration" STRUCT(
"no_encryption_config" VARCHAR,
"kms_encryption_config" STRUCT(
"awskms_key_arn" VARCHAR
)
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
)
),
"extended_s3_destination_description" STRUCT(
"role_arn" VARCHAR,
"bucket_arn" VARCHAR,
"prefix" VARCHAR,
"error_output_prefix" VARCHAR,
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
),
"compression_format" VARCHAR,
"encryption_configuration" STRUCT(
"no_encryption_config" VARCHAR,
"kms_encryption_config" STRUCT(
"awskms_key_arn" VARCHAR
)
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
),
"processing_configuration" STRUCT(
"enabled" BOOLEAN,
"processors" STRUCT(
"type" VARCHAR,
"parameters" STRUCT(
"parameter_name" VARCHAR,
"parameter_value" VARCHAR
)[]
)[]
),
"s3_backup_mode" VARCHAR,
"s3_backup_description" STRUCT(
"role_arn" VARCHAR,
"bucket_arn" VARCHAR,
"prefix" VARCHAR,
"error_output_prefix" VARCHAR,
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
),
"compression_format" VARCHAR,
"encryption_configuration" STRUCT(
"no_encryption_config" VARCHAR,
"kms_encryption_config" STRUCT(
"awskms_key_arn" VARCHAR
)
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
)
),
"data_format_conversion_configuration" STRUCT(
"schema_configuration" STRUCT(
"role_arn" VARCHAR,
"catalog_id" VARCHAR,
"database_name" VARCHAR,
"table_name" VARCHAR,
"region" VARCHAR,
"version_id" VARCHAR
),
"input_format_configuration" STRUCT(
"deserializer" STRUCT(
"open_x_json_ser_de" STRUCT(
"convert_dots_in_json_keys_to_underscores" BOOLEAN,
"case_insensitive" BOOLEAN,
"column_to_json_key_mappings" MAP(VARCHAR, VARCHAR)
),
"hive_json_ser_de" STRUCT(
"timestamp_formats" VARCHAR[]
)
)
),
"output_format_configuration" STRUCT(
"serializer" STRUCT(
"parquet_ser_de" STRUCT(
"block_size_bytes" BIGINT,
"page_size_bytes" BIGINT,
"compression" VARCHAR,
"enable_dictionary_compression" BOOLEAN,
"max_padding_bytes" BIGINT,
"writer_version" VARCHAR
),
"orc_ser_de" STRUCT(
"stripe_size_bytes" BIGINT,
"block_size_bytes" BIGINT,
"row_index_stride" BIGINT,
"enable_padding" BOOLEAN,
"padding_tolerance" DOUBLE,
"compression" VARCHAR,
"bloom_filter_columns" VARCHAR[],
"bloom_filter_false_positive_probability" DOUBLE,
"dictionary_key_threshold" DOUBLE,
"format_version" VARCHAR
)
)
),
"enabled" BOOLEAN
),
"dynamic_partitioning_configuration" STRUCT(
"retry_options" STRUCT(
"duration_in_seconds" BIGINT
),
"enabled" BOOLEAN
),
"file_extension" VARCHAR,
"custom_time_zone" VARCHAR
),
"redshift_destination_description" STRUCT(
"role_arn" VARCHAR,
"cluster_jdbcurl" VARCHAR,
"copy_command" STRUCT(
"data_table_name" VARCHAR,
"data_table_columns" VARCHAR,
"copy_options" VARCHAR
),
"username" VARCHAR,
"retry_options" STRUCT(
"duration_in_seconds" BIGINT
),
"s3_destination_description" STRUCT(
"role_arn" VARCHAR,
"bucket_arn" VARCHAR,
"prefix" VARCHAR,
"error_output_prefix" VARCHAR,
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
),
"compression_format" VARCHAR,
"encryption_configuration" STRUCT(
"no_encryption_config" VARCHAR,
"kms_encryption_config" STRUCT(
"awskms_key_arn" VARCHAR
)
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
)
),
"processing_configuration" STRUCT(
"enabled" BOOLEAN,
"processors" STRUCT(
"type" VARCHAR,
"parameters" STRUCT(
"parameter_name" VARCHAR,
"parameter_value" VARCHAR
)[]
)[]
),
"s3_backup_mode" VARCHAR,
"s3_backup_description" STRUCT(
"role_arn" VARCHAR,
"bucket_arn" VARCHAR,
"prefix" VARCHAR,
"error_output_prefix" VARCHAR,
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
),
"compression_format" VARCHAR,
"encryption_configuration" STRUCT(
"no_encryption_config" VARCHAR,
"kms_encryption_config" STRUCT(
"awskms_key_arn" VARCHAR
)
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
)
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
),
"secrets_manager_configuration" STRUCT(
"secret_arn" VARCHAR,
"role_arn" VARCHAR,
"enabled" BOOLEAN
)
),
"elasticsearch_destination_description" STRUCT(
"role_arn" VARCHAR,
"domain_arn" VARCHAR,
"cluster_endpoint" VARCHAR,
"index_name" VARCHAR,
"type_name" VARCHAR,
"index_rotation_period" VARCHAR,
"buffering_hints" STRUCT(
"interval_in_seconds" BIGINT,
"size_in_m_bs" BIGINT
),
"retry_options" STRUCT(
"duration_in_seconds" BIGINT
),
"s3_backup_mode" VARCHAR,
"s3_destination_description" STRUCT(
"role_arn" VARCHAR,
"bucket_arn" VARCHAR,
"prefix" VARCHAR,
"error_output_prefix" VARCHAR,
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
),
"compression_format" VARCHAR,
"encryption_configuration" STRUCT(
"no_encryption_config" VARCHAR,
"kms_encryption_config" STRUCT(
"awskms_key_arn" VARCHAR
)
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
)
),
"processing_configuration" STRUCT(
"enabled" BOOLEAN,
"processors" STRUCT(
"type" VARCHAR,
"parameters" STRUCT(
"parameter_name" VARCHAR,
"parameter_value" VARCHAR
)[]
)[]
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
),
"vpc_configuration_description" STRUCT(
"subnet_ids" VARCHAR[],
"role_arn" VARCHAR,
"security_group_ids" VARCHAR[],
"vpc_id" VARCHAR
),
"document_id_options" STRUCT(
"default_document_id_format" VARCHAR
)
),
"amazonopensearchservice_destination_description" STRUCT(
"role_arn" VARCHAR,
"domain_arn" VARCHAR,
"cluster_endpoint" VARCHAR,
"index_name" VARCHAR,
"type_name" VARCHAR,
"index_rotation_period" VARCHAR,
"buffering_hints" STRUCT(
"interval_in_seconds" BIGINT,
"size_in_m_bs" BIGINT
),
"retry_options" STRUCT(
"duration_in_seconds" BIGINT
),
"s3_backup_mode" VARCHAR,
"s3_destination_description" STRUCT(
"role_arn" VARCHAR,
"bucket_arn" VARCHAR,
"prefix" VARCHAR,
"error_output_prefix" VARCHAR,
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
),
"compression_format" VARCHAR,
"encryption_configuration" STRUCT(
"no_encryption_config" VARCHAR,
"kms_encryption_config" STRUCT(
"awskms_key_arn" VARCHAR
)
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
)
),
"processing_configuration" STRUCT(
"enabled" BOOLEAN,
"processors" STRUCT(
"type" VARCHAR,
"parameters" STRUCT(
"parameter_name" VARCHAR,
"parameter_value" VARCHAR
)[]
)[]
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
),
"vpc_configuration_description" STRUCT(
"subnet_ids" VARCHAR[],
"role_arn" VARCHAR,
"security_group_ids" VARCHAR[],
"vpc_id" VARCHAR
),
"document_id_options" STRUCT(
"default_document_id_format" VARCHAR
)
),
"splunk_destination_description" STRUCT(
"hec_endpoint" VARCHAR,
"hec_endpoint_type" VARCHAR,
"hec_token" VARCHAR,
"hec_acknowledgment_timeout_in_seconds" BIGINT,
"retry_options" STRUCT(
"duration_in_seconds" BIGINT
),
"s3_backup_mode" VARCHAR,
"s3_destination_description" STRUCT(
"role_arn" VARCHAR,
"bucket_arn" VARCHAR,
"prefix" VARCHAR,
"error_output_prefix" VARCHAR,
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
),
"compression_format" VARCHAR,
"encryption_configuration" STRUCT(
"no_encryption_config" VARCHAR,
"kms_encryption_config" STRUCT(
"awskms_key_arn" VARCHAR
)
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
)
),
"processing_configuration" STRUCT(
"enabled" BOOLEAN,
"processors" STRUCT(
"type" VARCHAR,
"parameters" STRUCT(
"parameter_name" VARCHAR,
"parameter_value" VARCHAR
)[]
)[]
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
),
"buffering_hints" STRUCT(
"interval_in_seconds" BIGINT,
"size_in_m_bs" BIGINT
),
"secrets_manager_configuration" STRUCT(
"secret_arn" VARCHAR,
"role_arn" VARCHAR,
"enabled" BOOLEAN
)
),
"http_endpoint_destination_description" STRUCT(
"endpoint_configuration" STRUCT(
"url" VARCHAR,
"name" VARCHAR
),
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
),
"request_configuration" STRUCT(
"content_encoding" VARCHAR,
"common_attributes" STRUCT(
"attribute_name" VARCHAR,
"attribute_value" VARCHAR
)[]
),
"processing_configuration" STRUCT(
"enabled" BOOLEAN,
"processors" STRUCT(
"type" VARCHAR,
"parameters" STRUCT(
"parameter_name" VARCHAR,
"parameter_value" VARCHAR
)[]
)[]
),
"role_arn" VARCHAR,
"retry_options" STRUCT(
"duration_in_seconds" BIGINT
),
"s3_backup_mode" VARCHAR,
"s3_destination_description" STRUCT(
"role_arn" VARCHAR,
"bucket_arn" VARCHAR,
"prefix" VARCHAR,
"error_output_prefix" VARCHAR,
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
),
"compression_format" VARCHAR,
"encryption_configuration" STRUCT(
"no_encryption_config" VARCHAR,
"kms_encryption_config" STRUCT(
"awskms_key_arn" VARCHAR
)
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
)
),
"secrets_manager_configuration" STRUCT(
"secret_arn" VARCHAR,
"role_arn" VARCHAR,
"enabled" BOOLEAN
)
),
"snowflake_destination_description" STRUCT(
"account_url" VARCHAR,
"user" VARCHAR,
"database" VARCHAR,
"schema" VARCHAR,
"table" VARCHAR,
"snowflake_role_configuration" STRUCT(
"enabled" BOOLEAN,
"snowflake_role" VARCHAR
),
"data_loading_option" VARCHAR,
"meta_data_column_name" VARCHAR,
"content_column_name" VARCHAR,
"snowflake_vpc_configuration" STRUCT(
"private_link_vpce_id" VARCHAR
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
),
"processing_configuration" STRUCT(
"enabled" BOOLEAN,
"processors" STRUCT(
"type" VARCHAR,
"parameters" STRUCT(
"parameter_name" VARCHAR,
"parameter_value" VARCHAR
)[]
)[]
),
"role_arn" VARCHAR,
"retry_options" STRUCT(
"duration_in_seconds" BIGINT
),
"s3_backup_mode" VARCHAR,
"s3_destination_description" STRUCT(
"role_arn" VARCHAR,
"bucket_arn" VARCHAR,
"prefix" VARCHAR,
"error_output_prefix" VARCHAR,
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
),
"compression_format" VARCHAR,
"encryption_configuration" STRUCT(
"no_encryption_config" VARCHAR,
"kms_encryption_config" STRUCT(
"awskms_key_arn" VARCHAR
)
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
)
),
"secrets_manager_configuration" STRUCT(
"secret_arn" VARCHAR,
"role_arn" VARCHAR,
"enabled" BOOLEAN
),
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
)
),
"amazon_open_search_serverless_destination_description" STRUCT(
"role_arn" VARCHAR,
"collection_endpoint" VARCHAR,
"index_name" VARCHAR,
"buffering_hints" STRUCT(
"interval_in_seconds" BIGINT,
"size_in_m_bs" BIGINT
),
"retry_options" STRUCT(
"duration_in_seconds" BIGINT
),
"s3_backup_mode" VARCHAR,
"s3_destination_description" STRUCT(
"role_arn" VARCHAR,
"bucket_arn" VARCHAR,
"prefix" VARCHAR,
"error_output_prefix" VARCHAR,
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
),
"compression_format" VARCHAR,
"encryption_configuration" STRUCT(
"no_encryption_config" VARCHAR,
"kms_encryption_config" STRUCT(
"awskms_key_arn" VARCHAR
)
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
)
),
"processing_configuration" STRUCT(
"enabled" BOOLEAN,
"processors" STRUCT(
"type" VARCHAR,
"parameters" STRUCT(
"parameter_name" VARCHAR,
"parameter_value" VARCHAR
)[]
)[]
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
),
"vpc_configuration_description" STRUCT(
"subnet_ids" VARCHAR[],
"role_arn" VARCHAR,
"security_group_ids" VARCHAR[],
"vpc_id" VARCHAR
)
),
"iceberg_destination_description" STRUCT(
"destination_table_configuration_list" STRUCT(
"destination_table_name" VARCHAR,
"destination_database_name" VARCHAR,
"unique_keys" VARCHAR[],
"s3_error_output_prefix" VARCHAR
)[],
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
),
"processing_configuration" STRUCT(
"enabled" BOOLEAN,
"processors" STRUCT(
"type" VARCHAR,
"parameters" STRUCT(
"parameter_name" VARCHAR,
"parameter_value" VARCHAR
)[]
)[]
),
"s3_backup_mode" VARCHAR,
"retry_options" STRUCT(
"duration_in_seconds" BIGINT
),
"role_arn" VARCHAR,
"catalog_configuration" STRUCT(
"catalog_arn" VARCHAR
),
"s3_destination_description" STRUCT(
"role_arn" VARCHAR,
"bucket_arn" VARCHAR,
"prefix" VARCHAR,
"error_output_prefix" VARCHAR,
"buffering_hints" STRUCT(
"size_in_m_bs" BIGINT,
"interval_in_seconds" BIGINT
),
"compression_format" VARCHAR,
"encryption_configuration" STRUCT(
"no_encryption_config" VARCHAR,
"kms_encryption_config" STRUCT(
"awskms_key_arn" VARCHAR
)
),
"cloud_watch_logging_options" STRUCT(
"enabled" BOOLEAN,
"log_group_name" VARCHAR,
"log_stream_name" VARCHAR
)
)
)
)[],
"has_more_destinations" BOOLEAN
)
Show child fields
delivery_stream_description.create_timestamp

The date and time that the delivery stream was created.

delivery_stream_description.delivery_stream_arn

The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

delivery_stream_description.delivery_stream_encryption_configuration

Indicates the server-side encryption (SSE) status for the delivery stream.

Show child fields
delivery_stream_description.delivery_stream_encryption_configuration.failure_description

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

Show child fields
delivery_stream_description.delivery_stream_encryption_configuration.failure_description.details

A message providing details about the error that caused the failure.

delivery_stream_description.delivery_stream_encryption_configuration.failure_description.type

The type of error that caused the failure.

delivery_stream_description.delivery_stream_encryption_configuration.key_arn

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.

delivery_stream_description.delivery_stream_encryption_configuration.key_type

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).

delivery_stream_description.delivery_stream_encryption_configuration.status

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.

delivery_stream_description.delivery_stream_name

The name of the delivery stream.

delivery_stream_description.delivery_stream_status

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.

delivery_stream_description.delivery_stream_type

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.

delivery_stream_description.destinations[]
Show child fields
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description

The destination in the Serverless offering for Amazon OpenSearch Service.

Show child fields
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.buffering_hints

The buffering options.

Show child fields
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.buffering_hints.interval_in_seconds

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.cloud_watch_logging_options

Describes the Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.collection_endpoint

The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.index_name

The Serverless offering for Amazon OpenSearch Service index name.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.processing_configuration

Describes a data processing configuration.

Show child fields
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.processing_configuration.enabled

Enables or disables data processing.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.processing_configuration.processors[]
Show child fields
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.processing_configuration.processors[].parameters[]
Show child fields
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.processing_configuration.processors[].parameters[].parameter_name

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.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.processing_configuration.processors[].parameters[].parameter_value

The parameter value.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.processing_configuration.processors[].type

The type of processor.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.retry_options

The Serverless offering for Amazon OpenSearch Service retry options.

Show child fields
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.retry_options.duration_in_seconds

After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.role_arn

The Amazon Resource Name (ARN) of the Amazon Web Services credentials.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_backup_mode

The Amazon S3 backup mode.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description

Describes a destination in Amazon S3.

Show child fields
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.bucket_arn

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

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.buffering_hints

The buffering option. If no value is specified, BufferingHints object default values are used.

Show child fields
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.buffering_hints.interval_in_seconds

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.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.compression_format

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

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.encryption_configuration

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

Show child fields
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config

The encryption key.

Show child fields
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn

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.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.encryption_configuration.no_encryption_config

Specifically override existing encryption information to ensure that no encryption is used.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.error_output_prefix

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.prefix

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.s3_destination_description.role_arn

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.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.vpc_configuration_description

The details of the VPC of the Amazon ES destination.

Show child fields
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.vpc_configuration_description.role_arn

The ARN of the IAM role that the delivery stream uses to create endpoints in the destination VPC. You can use your existing Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:

  • ec2:DescribeVpcs

  • ec2:DescribeVpcAttribute

  • ec2:DescribeSubnets

  • ec2:DescribeSecurityGroups

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

  • ec2:CreateNetworkInterfacePermission

  • ec2:DeleteNetworkInterface

If you revoke these permissions after you create the delivery stream, Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.vpc_configuration_description.security_group_ids[]
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.vpc_configuration_description.subnet_ids[]
delivery_stream_description.destinations[].amazon_open_search_serverless_destination_description.vpc_configuration_description.vpc_id

The ID of the Amazon ES destination's VPC.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description

The destination in Amazon OpenSearch Service.

Show child fields
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.buffering_hints

The buffering options.

Show child fields
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.buffering_hints.interval_in_seconds

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.cloud_watch_logging_options

Describes the Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.cluster_endpoint

The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.document_id_options

Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

Show child fields
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.document_id_options.default_document_id_format

When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.

When the NO_DOCUMENT_ID option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.domain_arn

The ARN of the Amazon OpenSearch Service domain.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.index_name

The Amazon OpenSearch Service index name.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.index_rotation_period

The Amazon OpenSearch Service index rotation period

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.processing_configuration

Describes a data processing configuration.

Show child fields
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.processing_configuration.enabled

Enables or disables data processing.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.processing_configuration.processors[]
Show child fields
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.processing_configuration.processors[].parameters[]
Show child fields
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.processing_configuration.processors[].parameters[].parameter_name

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.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.processing_configuration.processors[].parameters[].parameter_value

The parameter value.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.processing_configuration.processors[].type

The type of processor.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.retry_options

The Amazon OpenSearch Service retry options.

Show child fields
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.retry_options.duration_in_seconds

After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.role_arn

The Amazon Resource Name (ARN) of the Amazon Web Services credentials.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_backup_mode

The Amazon S3 backup mode.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description

Describes a destination in Amazon S3.

Show child fields
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.bucket_arn

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

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.buffering_hints

The buffering option. If no value is specified, BufferingHints object default values are used.

Show child fields
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.buffering_hints.interval_in_seconds

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.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.compression_format

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

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.encryption_configuration

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

Show child fields
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config

The encryption key.

Show child fields
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn

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.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.encryption_configuration.no_encryption_config

Specifically override existing encryption information to ensure that no encryption is used.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.error_output_prefix

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.prefix

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.s3_destination_description.role_arn

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.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.type_name

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.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.vpc_configuration_description

The details of the VPC of the Amazon ES destination.

Show child fields
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.vpc_configuration_description.role_arn

The ARN of the IAM role that the delivery stream uses to create endpoints in the destination VPC. You can use your existing Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:

  • ec2:DescribeVpcs

  • ec2:DescribeVpcAttribute

  • ec2:DescribeSubnets

  • ec2:DescribeSecurityGroups

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

  • ec2:CreateNetworkInterfacePermission

  • ec2:DeleteNetworkInterface

If you revoke these permissions after you create the delivery stream, Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

delivery_stream_description.destinations[].amazonopensearchservice_destination_description.vpc_configuration_description.security_group_ids[]
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.vpc_configuration_description.subnet_ids[]
delivery_stream_description.destinations[].amazonopensearchservice_destination_description.vpc_configuration_description.vpc_id

The ID of the Amazon ES destination's VPC.

delivery_stream_description.destinations[].destination_id

The ID of the destination.

delivery_stream_description.destinations[].elasticsearch_destination_description

The destination in Amazon ES.

Show child fields
delivery_stream_description.destinations[].elasticsearch_destination_description.buffering_hints

The buffering options.

Show child fields
delivery_stream_description.destinations[].elasticsearch_destination_description.buffering_hints.interval_in_seconds

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).

delivery_stream_description.destinations[].elasticsearch_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].elasticsearch_destination_description.cloud_watch_logging_options

The Amazon CloudWatch logging options.

Show child fields
delivery_stream_description.destinations[].elasticsearch_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].elasticsearch_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].elasticsearch_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].elasticsearch_destination_description.cluster_endpoint

The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.

delivery_stream_description.destinations[].elasticsearch_destination_description.document_id_options

Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

Show child fields
delivery_stream_description.destinations[].elasticsearch_destination_description.document_id_options.default_document_id_format

When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.

When the NO_DOCUMENT_ID option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.

delivery_stream_description.destinations[].elasticsearch_destination_description.domain_arn

The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.

delivery_stream_description.destinations[].elasticsearch_destination_description.index_name

The Elasticsearch index name.

delivery_stream_description.destinations[].elasticsearch_destination_description.index_rotation_period

The Elasticsearch index rotation period

delivery_stream_description.destinations[].elasticsearch_destination_description.processing_configuration

The data processing configuration.

Show child fields
delivery_stream_description.destinations[].elasticsearch_destination_description.processing_configuration.enabled

Enables or disables data processing.

delivery_stream_description.destinations[].elasticsearch_destination_description.processing_configuration.processors[]
Show child fields
delivery_stream_description.destinations[].elasticsearch_destination_description.processing_configuration.processors[].parameters[]
Show child fields
delivery_stream_description.destinations[].elasticsearch_destination_description.processing_configuration.processors[].parameters[].parameter_name

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.

delivery_stream_description.destinations[].elasticsearch_destination_description.processing_configuration.processors[].parameters[].parameter_value

The parameter value.

delivery_stream_description.destinations[].elasticsearch_destination_description.processing_configuration.processors[].type

The type of processor.

delivery_stream_description.destinations[].elasticsearch_destination_description.retry_options

The Amazon ES retry options.

Show child fields
delivery_stream_description.destinations[].elasticsearch_destination_description.retry_options.duration_in_seconds

After an initial failure to deliver to Amazon ES, the total amount of time during which Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

delivery_stream_description.destinations[].elasticsearch_destination_description.role_arn

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.

delivery_stream_description.destinations[].elasticsearch_destination_description.s3_backup_mode

The Amazon S3 backup mode.

delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description

The Amazon S3 destination.

Show child fields
delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.bucket_arn

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

delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.buffering_hints

The buffering option. If no value is specified, BufferingHints object default values are used.

Show child fields
delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.buffering_hints.interval_in_seconds

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.

delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.compression_format

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

delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.encryption_configuration

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

Show child fields
delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config

The encryption key.

Show child fields
delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn

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.

delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.encryption_configuration.no_encryption_config

Specifically override existing encryption information to ensure that no encryption is used.

delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.error_output_prefix

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.prefix

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].elasticsearch_destination_description.s3_destination_description.role_arn

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.

delivery_stream_description.destinations[].elasticsearch_destination_description.type_name

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.

delivery_stream_description.destinations[].elasticsearch_destination_description.vpc_configuration_description

The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.

Show child fields
delivery_stream_description.destinations[].elasticsearch_destination_description.vpc_configuration_description.role_arn

The ARN of the IAM role that the delivery stream uses to create endpoints in the destination VPC. You can use your existing Firehose delivery role or you can specify a new role. In either case, make sure that the role trusts the Firehose service principal and that it grants the following permissions:

  • ec2:DescribeVpcs

  • ec2:DescribeVpcAttribute

  • ec2:DescribeSubnets

  • ec2:DescribeSecurityGroups

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

  • ec2:CreateNetworkInterfacePermission

  • ec2:DeleteNetworkInterface

If you revoke these permissions after you create the delivery stream, Firehose can't scale out by creating more ENIs when necessary. You might therefore see a degradation in performance.

delivery_stream_description.destinations[].elasticsearch_destination_description.vpc_configuration_description.security_group_ids[]
delivery_stream_description.destinations[].elasticsearch_destination_description.vpc_configuration_description.subnet_ids[]
delivery_stream_description.destinations[].elasticsearch_destination_description.vpc_configuration_description.vpc_id

The ID of the Amazon ES destination's VPC.

delivery_stream_description.destinations[].extended_s3_destination_description

The destination in Amazon S3.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.bucket_arn

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

delivery_stream_description.destinations[].extended_s3_destination_description.buffering_hints

The buffering option.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.buffering_hints.interval_in_seconds

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.

delivery_stream_description.destinations[].extended_s3_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].extended_s3_destination_description.cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].extended_s3_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].extended_s3_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].extended_s3_destination_description.compression_format

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

delivery_stream_description.destinations[].extended_s3_destination_description.custom_time_zone

The time zone you prefer. UTC is the default.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.enabled

Defaults to true. Set it to false if you want to disable format conversion while preserving the configuration details.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.input_format_configuration

Specifies the deserializer that you want Firehose to use to convert the format of your data from JSON. This parameter is required if Enabled is set to true.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.input_format_configuration.deserializer

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.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.input_format_configuration.deserializer.hive_json_ser_de

The native Hive/HCatalog JsonSerDe. Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.input_format_configuration.deserializer.hive_json_ser_de.timestamp_formats[]
delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.input_format_configuration.deserializer.open_x_json_ser_de

The OpenX SerDe. Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive/HCatalog JsonSerDe.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.input_format_configuration.deserializer.open_x_json_ser_de.case_insensitive

When set to true, which is the default, Firehose converts JSON keys to lowercase before deserializing them.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.input_format_configuration.deserializer.open_x_json_ser_de.column_to_json_key_mappings

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.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.input_format_configuration.deserializer.open_x_json_ser_de.convert_dots_in_json_keys_to_underscores

When set to true, specifies that the names of the keys include dots and that you want Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option.

The default is false.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration

Specifies the serializer that you want Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if Enabled is set to true.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer

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.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.orc_ser_de

A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.orc_ser_de.block_size_bytes

The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding calculations.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.orc_ser_de.bloom_filter_columns[]
delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.orc_ser_de.bloom_filter_false_positive_probability

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.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.orc_ser_de.compression

The compression code to use over data blocks. The default is SNAPPY.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.orc_ser_de.dictionary_key_threshold

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.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.orc_ser_de.enable_padding

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.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.orc_ser_de.format_version

The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.orc_ser_de.padding_tolerance

A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size.

For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.

Firehose ignores this parameter when OrcSerDe$EnablePadding is false.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.orc_ser_de.row_index_stride

The number of rows between index entries. The default is 10,000 and the minimum is 1,000.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.orc_ser_de.stripe_size_bytes

The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.parquet_ser_de

A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.parquet_ser_de.block_size_bytes

The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding calculations.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.parquet_ser_de.compression

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.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.parquet_ser_de.enable_dictionary_compression

Indicates whether to enable dictionary compression.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.parquet_ser_de.max_padding_bytes

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.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.parquet_ser_de.page_size_bytes

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.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.output_format_configuration.serializer.parquet_ser_de.writer_version

Indicates the version of row format to output. The possible values are V1 and V2. The default is V1.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.schema_configuration

Specifies the Amazon Web Services Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.schema_configuration.catalog_id

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.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.schema_configuration.database_name

Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.

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.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.schema_configuration.region

If you don't specify an Amazon Web Services Region, the default is the current Region.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.schema_configuration.role_arn

The role that Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.schema_configuration.table_name

Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.

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.

delivery_stream_description.destinations[].extended_s3_destination_description.data_format_conversion_configuration.schema_configuration.version_id

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

delivery_stream_description.destinations[].extended_s3_destination_description.dynamic_partitioning_configuration

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.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.dynamic_partitioning_configuration.enabled

Specifies that the dynamic partitioning is enabled for this Firehose delivery stream.

delivery_stream_description.destinations[].extended_s3_destination_description.dynamic_partitioning_configuration.retry_options

The retry behavior in case Firehose is unable to deliver data to an Amazon S3 prefix.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.dynamic_partitioning_configuration.retry_options.duration_in_seconds

The period of time during which Firehose retries to deliver data to the specified Amazon S3 prefix.

delivery_stream_description.destinations[].extended_s3_destination_description.encryption_configuration

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

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.encryption_configuration.kms_encryption_config

The encryption key.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn

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.

delivery_stream_description.destinations[].extended_s3_destination_description.encryption_configuration.no_encryption_config

Specifically override existing encryption information to ensure that no encryption is used.

delivery_stream_description.destinations[].extended_s3_destination_description.error_output_prefix

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].extended_s3_destination_description.file_extension

Specify a file extension. It will override the default file extension

delivery_stream_description.destinations[].extended_s3_destination_description.prefix

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].extended_s3_destination_description.processing_configuration

The data processing configuration.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.processing_configuration.enabled

Enables or disables data processing.

delivery_stream_description.destinations[].extended_s3_destination_description.processing_configuration.processors[]
Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.processing_configuration.processors[].parameters[]
Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.processing_configuration.processors[].parameters[].parameter_name

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.

delivery_stream_description.destinations[].extended_s3_destination_description.processing_configuration.processors[].parameters[].parameter_value

The parameter value.

delivery_stream_description.destinations[].extended_s3_destination_description.processing_configuration.processors[].type

The type of processor.

delivery_stream_description.destinations[].extended_s3_destination_description.role_arn

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.

delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description

The configuration for backup in Amazon S3.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.bucket_arn

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

delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.buffering_hints

The buffering option. If no value is specified, BufferingHints object default values are used.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.buffering_hints.interval_in_seconds

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.

delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.compression_format

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

delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.encryption_configuration

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

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.encryption_configuration.kms_encryption_config

The encryption key.

Show child fields
delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.encryption_configuration.kms_encryption_config.awskms_key_arn

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.

delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.encryption_configuration.no_encryption_config

Specifically override existing encryption information to ensure that no encryption is used.

delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.error_output_prefix

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.prefix

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_description.role_arn

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.

delivery_stream_description.destinations[].extended_s3_destination_description.s3_backup_mode

The Amazon S3 backup mode.

delivery_stream_description.destinations[].http_endpoint_destination_description

Describes the specified HTTP endpoint destination.

Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.buffering_hints

Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Firehose teats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.

Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.buffering_hints.interval_in_seconds

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).

delivery_stream_description.destinations[].http_endpoint_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].http_endpoint_destination_description.cloud_watch_logging_options

Describes the Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].http_endpoint_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].http_endpoint_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].http_endpoint_destination_description.endpoint_configuration

The configuration of the specified HTTP endpoint destination.

Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.endpoint_configuration.name

The name of the HTTP endpoint selected as the destination.

delivery_stream_description.destinations[].http_endpoint_destination_description.endpoint_configuration.url

The URL of the HTTP endpoint selected as the destination.

delivery_stream_description.destinations[].http_endpoint_destination_description.processing_configuration

Describes a data processing configuration.

Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.processing_configuration.enabled

Enables or disables data processing.

delivery_stream_description.destinations[].http_endpoint_destination_description.processing_configuration.processors[]
Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.processing_configuration.processors[].parameters[]
Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.processing_configuration.processors[].parameters[].parameter_name

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.

delivery_stream_description.destinations[].http_endpoint_destination_description.processing_configuration.processors[].parameters[].parameter_value

The parameter value.

delivery_stream_description.destinations[].http_endpoint_destination_description.processing_configuration.processors[].type

The type of processor.

delivery_stream_description.destinations[].http_endpoint_destination_description.request_configuration

The configuration of request sent to the HTTP endpoint specified as the destination.

Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.request_configuration.common_attributes[]
Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.request_configuration.common_attributes[].attribute_name

The name of the HTTP endpoint common attribute.

delivery_stream_description.destinations[].http_endpoint_destination_description.request_configuration.common_attributes[].attribute_value

The value of the HTTP endpoint common attribute.

delivery_stream_description.destinations[].http_endpoint_destination_description.request_configuration.content_encoding

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.

delivery_stream_description.destinations[].http_endpoint_destination_description.retry_options

Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.retry_options.duration_in_seconds

The total amount of time that Firehose spends on retries. This duration starts after the initial attempt to send data to the custom destination via HTTPS endpoint fails. It doesn't include the periods during which Firehose waits for acknowledgment from the specified destination after each attempt.

delivery_stream_description.destinations[].http_endpoint_destination_description.role_arn

Firehose uses this IAM role for all the permissions that the delivery stream needs.

delivery_stream_description.destinations[].http_endpoint_destination_description.s3_backup_mode

Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description

Describes a destination in Amazon S3.

Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.bucket_arn

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

delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.buffering_hints

The buffering option. If no value is specified, BufferingHints object default values are used.

Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.buffering_hints.interval_in_seconds

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.

delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.compression_format

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

delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.encryption_configuration

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

Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config

The encryption key.

Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn

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.

delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.encryption_configuration.no_encryption_config

Specifically override existing encryption information to ensure that no encryption is used.

delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.error_output_prefix

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.prefix

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].http_endpoint_destination_description.s3_destination_description.role_arn

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.

delivery_stream_description.destinations[].http_endpoint_destination_description.secrets_manager_configuration

The configuration that defines how you access secrets for HTTP Endpoint destination.

Show child fields
delivery_stream_description.destinations[].http_endpoint_destination_description.secrets_manager_configuration.enabled

Specifies whether you want to use the the secrets manager feature. When set as True the secrets manager configuration overwrites the existing secrets in the destination configuration. When it's set to False Firehose falls back to the credentials in the destination configuration.

delivery_stream_description.destinations[].http_endpoint_destination_description.secrets_manager_configuration.role_arn

Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk.

delivery_stream_description.destinations[].http_endpoint_destination_description.secrets_manager_configuration.secret_arn

The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream and the role. The secret ARN can reside in a different account than the delivery stream and role as Firehose supports cross-account secret access. This parameter is required when Enabled is set to True.

delivery_stream_description.destinations[].iceberg_destination_description

Describes a destination in Apache Iceberg Tables.

Amazon Data Firehose is in preview release and is subject to change.

Show child fields
delivery_stream_description.destinations[].iceberg_destination_description.buffering_hints

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Firehose might choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.

Show child fields
delivery_stream_description.destinations[].iceberg_destination_description.buffering_hints.interval_in_seconds

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.

delivery_stream_description.destinations[].iceberg_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].iceberg_destination_description.catalog_configuration

Configuration describing where the destination Iceberg tables are persisted.

Amazon Data Firehose is in preview release and is subject to change.

Show child fields
delivery_stream_description.destinations[].iceberg_destination_description.catalog_configuration.catalog_arn

Specifies the Glue catalog ARN indentifier of the destination Apache Iceberg Tables. You must specify the ARN in the format arn:aws:glue:region:account-id:catalog.

Amazon Data Firehose is in preview release and is subject to change.

delivery_stream_description.destinations[].iceberg_destination_description.cloud_watch_logging_options

Describes the Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].iceberg_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].iceberg_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].iceberg_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].iceberg_destination_description.destination_table_configuration_list[]
Show child fields
delivery_stream_description.destinations[].iceberg_destination_description.destination_table_configuration_list[].destination_database_name

The name of the Apache Iceberg database.

Amazon Data Firehose is in preview release and is subject to change.

delivery_stream_description.destinations[].iceberg_destination_description.destination_table_configuration_list[].destination_table_name

Specifies the name of the Apache Iceberg Table.

Amazon Data Firehose is in preview release and is subject to change.

delivery_stream_description.destinations[].iceberg_destination_description.destination_table_configuration_list[].s3_error_output_prefix

The table specific S3 error output prefix. All the errors that occurred while delivering to this table will be prefixed with this value in S3 destination.

Amazon Data Firehose is in preview release and is subject to change.

delivery_stream_description.destinations[].iceberg_destination_description.destination_table_configuration_list[].unique_keys[]
delivery_stream_description.destinations[].iceberg_destination_description.processing_configuration

Describes a data processing configuration.

Show child fields
delivery_stream_description.destinations[].iceberg_destination_description.processing_configuration.enabled

Enables or disables data processing.

delivery_stream_description.destinations[].iceberg_destination_description.processing_configuration.processors[]
Show child fields
delivery_stream_description.destinations[].iceberg_destination_description.processing_configuration.processors[].parameters[]
Show child fields
delivery_stream_description.destinations[].iceberg_destination_description.processing_configuration.processors[].parameters[].parameter_name

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.

delivery_stream_description.destinations[].iceberg_destination_description.processing_configuration.processors[].parameters[].parameter_value

The parameter value.

delivery_stream_description.destinations[].iceberg_destination_description.processing_configuration.processors[].type

The type of processor.

delivery_stream_description.destinations[].iceberg_destination_description.retry_options

The retry behavior in case Firehose is unable to deliver data to an Amazon S3 prefix.

Show child fields
delivery_stream_description.destinations[].iceberg_destination_description.retry_options.duration_in_seconds

The period of time during which Firehose retries to deliver data to the specified Amazon S3 prefix.

delivery_stream_description.destinations[].iceberg_destination_description.role_arn

The Amazon Resource Name (ARN) of the Apache Iceberg Tables role.

Amazon Data Firehose is in preview release and is subject to change.

delivery_stream_description.destinations[].iceberg_destination_description.s3_backup_mode

Describes how Firehose will backup records. Currently,Firehose only supports FailedDataOnly for preview.

Amazon Data Firehose is in preview release and is subject to change.

delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description

Describes a destination in Amazon S3.

Show child fields
delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.bucket_arn

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

delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.buffering_hints

The buffering option. If no value is specified, BufferingHints object default values are used.

Show child fields
delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.buffering_hints.interval_in_seconds

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.

delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.compression_format

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

delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.encryption_configuration

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

Show child fields
delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config

The encryption key.

Show child fields
delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn

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.

delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.encryption_configuration.no_encryption_config

Specifically override existing encryption information to ensure that no encryption is used.

delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.error_output_prefix

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.prefix

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].iceberg_destination_description.s3_destination_description.role_arn

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.

delivery_stream_description.destinations[].redshift_destination_description

The destination in Amazon Redshift.

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].redshift_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].redshift_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].redshift_destination_description.cluster_jdbcurl

The database connection string.

delivery_stream_description.destinations[].redshift_destination_description.copy_command

The COPY command.

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.copy_command.copy_options

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 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.

delivery_stream_description.destinations[].redshift_destination_description.copy_command.data_table_columns

A comma-separated list of column names.

delivery_stream_description.destinations[].redshift_destination_description.copy_command.data_table_name

The name of the target table. The table must already exist in the database.

delivery_stream_description.destinations[].redshift_destination_description.processing_configuration

The data processing configuration.

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.processing_configuration.enabled

Enables or disables data processing.

delivery_stream_description.destinations[].redshift_destination_description.processing_configuration.processors[]
Show child fields
delivery_stream_description.destinations[].redshift_destination_description.processing_configuration.processors[].parameters[]
Show child fields
delivery_stream_description.destinations[].redshift_destination_description.processing_configuration.processors[].parameters[].parameter_name

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.

delivery_stream_description.destinations[].redshift_destination_description.processing_configuration.processors[].parameters[].parameter_value

The parameter value.

delivery_stream_description.destinations[].redshift_destination_description.processing_configuration.processors[].type

The type of processor.

delivery_stream_description.destinations[].redshift_destination_description.retry_options

The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.retry_options.duration_in_seconds

The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.

delivery_stream_description.destinations[].redshift_destination_description.role_arn

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.

delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description

The configuration for backup in Amazon S3.

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.bucket_arn

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

delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.buffering_hints

The buffering option. If no value is specified, BufferingHints object default values are used.

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.buffering_hints.interval_in_seconds

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.

delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.compression_format

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

delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.encryption_configuration

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

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.encryption_configuration.kms_encryption_config

The encryption key.

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.encryption_configuration.kms_encryption_config.awskms_key_arn

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.

delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.encryption_configuration.no_encryption_config

Specifically override existing encryption information to ensure that no encryption is used.

delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.error_output_prefix

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.prefix

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].redshift_destination_description.s3_backup_description.role_arn

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.

delivery_stream_description.destinations[].redshift_destination_description.s3_backup_mode

The Amazon S3 backup mode.

delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description

The Amazon S3 destination.

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.bucket_arn

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

delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.buffering_hints

The buffering option. If no value is specified, BufferingHints object default values are used.

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.buffering_hints.interval_in_seconds

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.

delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.compression_format

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

delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.encryption_configuration

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

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config

The encryption key.

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn

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.

delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.encryption_configuration.no_encryption_config

Specifically override existing encryption information to ensure that no encryption is used.

delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.error_output_prefix

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.prefix

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].redshift_destination_description.s3_destination_description.role_arn

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.

delivery_stream_description.destinations[].redshift_destination_description.secrets_manager_configuration

The configuration that defines how you access secrets for Amazon Redshift.

Show child fields
delivery_stream_description.destinations[].redshift_destination_description.secrets_manager_configuration.enabled

Specifies whether you want to use the the secrets manager feature. When set as True the secrets manager configuration overwrites the existing secrets in the destination configuration. When it's set to False Firehose falls back to the credentials in the destination configuration.

delivery_stream_description.destinations[].redshift_destination_description.secrets_manager_configuration.role_arn

Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk.

delivery_stream_description.destinations[].redshift_destination_description.secrets_manager_configuration.secret_arn

The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream and the role. The secret ARN can reside in a different account than the delivery stream and role as Firehose supports cross-account secret access. This parameter is required when Enabled is set to True.

delivery_stream_description.destinations[].redshift_destination_description.username

The name of the user.

delivery_stream_description.destinations[].s3_destination_description

[Deprecated] The destination in Amazon S3.

Show child fields
delivery_stream_description.destinations[].s3_destination_description.bucket_arn

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

delivery_stream_description.destinations[].s3_destination_description.buffering_hints

The buffering option. If no value is specified, BufferingHints object default values are used.

Show child fields
delivery_stream_description.destinations[].s3_destination_description.buffering_hints.interval_in_seconds

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.

delivery_stream_description.destinations[].s3_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].s3_destination_description.cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].s3_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].s3_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].s3_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].s3_destination_description.compression_format

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

delivery_stream_description.destinations[].s3_destination_description.encryption_configuration

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

Show child fields
delivery_stream_description.destinations[].s3_destination_description.encryption_configuration.kms_encryption_config

The encryption key.

Show child fields
delivery_stream_description.destinations[].s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn

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.

delivery_stream_description.destinations[].s3_destination_description.encryption_configuration.no_encryption_config

Specifically override existing encryption information to ensure that no encryption is used.

delivery_stream_description.destinations[].s3_destination_description.error_output_prefix

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].s3_destination_description.prefix

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].s3_destination_description.role_arn

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.

delivery_stream_description.destinations[].snowflake_destination_description

Optional description for the destination

Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.account_url

URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (https://) and port number are optional.

delivery_stream_description.destinations[].snowflake_destination_description.buffering_hints

Describes the buffering to perform before delivering data to the Snowflake destination. If you do not specify any value, Firehose uses the default values.

Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.buffering_hints.interval_in_seconds

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 0.

delivery_stream_description.destinations[].snowflake_destination_description.buffering_hints.size_in_m_bs

Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 1.

delivery_stream_description.destinations[].snowflake_destination_description.cloud_watch_logging_options

Describes the Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].snowflake_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].snowflake_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].snowflake_destination_description.content_column_name

The name of the record content column

delivery_stream_description.destinations[].snowflake_destination_description.data_loading_option

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.

delivery_stream_description.destinations[].snowflake_destination_description.database

All data in Snowflake is maintained in databases.

delivery_stream_description.destinations[].snowflake_destination_description.meta_data_column_name

The name of the record metadata column

delivery_stream_description.destinations[].snowflake_destination_description.processing_configuration

Describes a data processing configuration.

Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.processing_configuration.enabled

Enables or disables data processing.

delivery_stream_description.destinations[].snowflake_destination_description.processing_configuration.processors[]
Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.processing_configuration.processors[].parameters[]
Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.processing_configuration.processors[].parameters[].parameter_name

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.

delivery_stream_description.destinations[].snowflake_destination_description.processing_configuration.processors[].parameters[].parameter_value

The parameter value.

delivery_stream_description.destinations[].snowflake_destination_description.processing_configuration.processors[].type

The type of processor.

delivery_stream_description.destinations[].snowflake_destination_description.retry_options

The time period where Firehose will retry sending data to the chosen HTTP endpoint.

Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.retry_options.duration_in_seconds

the time period where Firehose will retry sending data to the chosen HTTP endpoint.

delivery_stream_description.destinations[].snowflake_destination_description.role_arn

The Amazon Resource Name (ARN) of the Snowflake role

delivery_stream_description.destinations[].snowflake_destination_description.s3_backup_mode

Choose an S3 backup mode

delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description

Describes a destination in Amazon S3.

Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.bucket_arn

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

delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.buffering_hints

The buffering option. If no value is specified, BufferingHints object default values are used.

Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.buffering_hints.interval_in_seconds

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.

delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.compression_format

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

delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.encryption_configuration

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

Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config

The encryption key.

Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn

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.

delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.encryption_configuration.no_encryption_config

Specifically override existing encryption information to ensure that no encryption is used.

delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.error_output_prefix

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.prefix

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].snowflake_destination_description.s3_destination_description.role_arn

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.

delivery_stream_description.destinations[].snowflake_destination_description.schema

Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views

delivery_stream_description.destinations[].snowflake_destination_description.secrets_manager_configuration

The configuration that defines how you access secrets for Snowflake.

Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.secrets_manager_configuration.enabled

Specifies whether you want to use the the secrets manager feature. When set as True the secrets manager configuration overwrites the existing secrets in the destination configuration. When it's set to False Firehose falls back to the credentials in the destination configuration.

delivery_stream_description.destinations[].snowflake_destination_description.secrets_manager_configuration.role_arn

Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk.

delivery_stream_description.destinations[].snowflake_destination_description.secrets_manager_configuration.secret_arn

The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream and the role. The secret ARN can reside in a different account than the delivery stream and role as Firehose supports cross-account secret access. This parameter is required when Enabled is set to True.

delivery_stream_description.destinations[].snowflake_destination_description.snowflake_role_configuration

Optionally configure a Snowflake role. Otherwise the default user role will be used.

Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.snowflake_role_configuration.enabled

Enable Snowflake role

delivery_stream_description.destinations[].snowflake_destination_description.snowflake_role_configuration.snowflake_role

The Snowflake role you wish to configure

delivery_stream_description.destinations[].snowflake_destination_description.snowflake_vpc_configuration

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

Show child fields
delivery_stream_description.destinations[].snowflake_destination_description.snowflake_vpc_configuration.private_link_vpce_id

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

delivery_stream_description.destinations[].snowflake_destination_description.table

All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.

delivery_stream_description.destinations[].snowflake_destination_description.user

User login name for the Snowflake account.

delivery_stream_description.destinations[].splunk_destination_description

The destination in Splunk.

Show child fields
delivery_stream_description.destinations[].splunk_destination_description.buffering_hints

The buffering options. If no value is specified, the default values for Splunk are used.

Show child fields
delivery_stream_description.destinations[].splunk_destination_description.buffering_hints.interval_in_seconds

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 60 (1 minute).

delivery_stream_description.destinations[].splunk_destination_description.buffering_hints.size_in_m_bs

Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

delivery_stream_description.destinations[].splunk_destination_description.cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].splunk_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].splunk_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].splunk_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].splunk_destination_description.hec_acknowledgment_timeout_in_seconds

The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.

delivery_stream_description.destinations[].splunk_destination_description.hec_endpoint

The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.

delivery_stream_description.destinations[].splunk_destination_description.hec_endpoint_type

This type can be either "Raw" or "Event."

delivery_stream_description.destinations[].splunk_destination_description.hec_token

A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.

delivery_stream_description.destinations[].splunk_destination_description.processing_configuration

The data processing configuration.

Show child fields
delivery_stream_description.destinations[].splunk_destination_description.processing_configuration.enabled

Enables or disables data processing.

delivery_stream_description.destinations[].splunk_destination_description.processing_configuration.processors[]
Show child fields
delivery_stream_description.destinations[].splunk_destination_description.processing_configuration.processors[].parameters[]
Show child fields
delivery_stream_description.destinations[].splunk_destination_description.processing_configuration.processors[].parameters[].parameter_name

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.

delivery_stream_description.destinations[].splunk_destination_description.processing_configuration.processors[].parameters[].parameter_value

The parameter value.

delivery_stream_description.destinations[].splunk_destination_description.processing_configuration.processors[].type

The type of processor.

delivery_stream_description.destinations[].splunk_destination_description.retry_options

The retry behavior in case Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.

Show child fields
delivery_stream_description.destinations[].splunk_destination_description.retry_options.duration_in_seconds

The total amount of time that Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Firehose waits for acknowledgment from Splunk after each attempt.

delivery_stream_description.destinations[].splunk_destination_description.s3_backup_mode

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description

The Amazon S3 destination.>

Show child fields
delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.bucket_arn

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

delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.buffering_hints

The buffering option. If no value is specified, BufferingHints object default values are used.

Show child fields
delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.buffering_hints.interval_in_seconds

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.

delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.buffering_hints.size_in_m_bs

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.

delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.cloud_watch_logging_options

The Amazon CloudWatch logging options for your delivery stream.

Show child fields
delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.cloud_watch_logging_options.enabled

Enables or disables CloudWatch logging.

delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.cloud_watch_logging_options.log_group_name

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.cloud_watch_logging_options.log_stream_name

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.compression_format

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

delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.encryption_configuration

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

Show child fields
delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config

The encryption key.

Show child fields
delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.encryption_configuration.kms_encryption_config.awskms_key_arn

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.

delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.encryption_configuration.no_encryption_config

Specifically override existing encryption information to ensure that no encryption is used.

delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.error_output_prefix

A prefix that Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.prefix

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

delivery_stream_description.destinations[].splunk_destination_description.s3_destination_description.role_arn

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.

delivery_stream_description.destinations[].splunk_destination_description.secrets_manager_configuration

The configuration that defines how you access secrets for Splunk.

Show child fields
delivery_stream_description.destinations[].splunk_destination_description.secrets_manager_configuration.enabled

Specifies whether you want to use the the secrets manager feature. When set as True the secrets manager configuration overwrites the existing secrets in the destination configuration. When it's set to False Firehose falls back to the credentials in the destination configuration.

delivery_stream_description.destinations[].splunk_destination_description.secrets_manager_configuration.role_arn

Specifies the role that Firehose assumes when calling the Secrets Manager API operation. When you provide the role, it overrides any destination specific role defined in the destination configuration. If you do not provide the then we use the destination specific role. This parameter is required for Splunk.

delivery_stream_description.destinations[].splunk_destination_description.secrets_manager_configuration.secret_arn

The ARN of the secret that stores your credentials. It must be in the same region as the Firehose stream and the role. The secret ARN can reside in a different account than the delivery stream and role as Firehose supports cross-account secret access. This parameter is required when Enabled is set to True.

delivery_stream_description.failure_description

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

Show child fields
delivery_stream_description.failure_description.details

A message providing details about the error that caused the failure.

delivery_stream_description.failure_description.type

The type of error that caused the failure.

delivery_stream_description.has_more_destinations

Indicates whether there are more destinations available to list.

delivery_stream_description.last_update_timestamp

The date and time that the delivery stream was last updated.

delivery_stream_description.source

If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.

Show child fields
delivery_stream_description.source.kinesis_stream_source_description

The KinesisStreamSourceDescription value for the source Kinesis data stream.

Show child fields
delivery_stream_description.source.kinesis_stream_source_description.delivery_start_timestamp

Firehose starts retrieving records from the Kinesis data stream starting with this timestamp.

delivery_stream_description.source.kinesis_stream_source_description.kinesis_stream_arn

The Amazon Resource Name (ARN) of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.

delivery_stream_description.source.kinesis_stream_source_description.role_arn

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.

delivery_stream_description.source.msk_source_description

The configuration description for the Amazon MSK cluster to be used as the source for a delivery stream.

Show child fields
delivery_stream_description.source.msk_source_description.authentication_configuration

The authentication configuration of the Amazon MSK cluster.

Show child fields
delivery_stream_description.source.msk_source_description.authentication_configuration.connectivity

The type of connectivity used to access the Amazon MSK cluster.

delivery_stream_description.source.msk_source_description.authentication_configuration.role_arn

The ARN of the role used to access the Amazon MSK cluster.

delivery_stream_description.source.msk_source_description.delivery_start_timestamp

Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.

delivery_stream_description.source.msk_source_description.msk_cluster_arn

The ARN of the Amazon MSK cluster.

delivery_stream_description.source.msk_source_description.read_from_timestamp

The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestampUTC parameter to Epoch (1970-01-01T00:00:00Z).

delivery_stream_description.source.msk_source_description.topic_name

The topic name within the Amazon MSK cluster.

delivery_stream_description.version_id

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.