CreateDeliveryStreamInput
¶
Source code in docs_src/capo_firehose/types/create_delivery_stream_input.py
amazon_open_search_serverless_destination_configuration
instance-attribute
¶
amazon_open_search_serverless_destination_configuration: NotRequired[
AmazonOpenSearchServerlessDestinationConfiguration
]
The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.
amazonopensearchservice_destination_configuration
instance-attribute
¶
amazonopensearchservice_destination_configuration: NotRequired[
AmazonopensearchserviceDestinationConfiguration
]
The destination in Amazon OpenSearch Service. You can specify only one destination.
database_source_configuration
instance-attribute
¶
database_source_configuration: NotRequired[DatabaseSourceConfiguration]
The top level object for configuring streams with database as a source.
Amazon Data Firehose is in preview release and is subject to change.
delivery_stream_encryption_configuration_input
instance-attribute
¶
delivery_stream_encryption_configuration_input: NotRequired[
DeliveryStreamEncryptionConfigurationInput
]
Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
delivery_stream_name
instance-attribute
¶
delivery_stream_name: DeliveryStreamName
The name of the Firehose stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the Firehose streams are in different accounts or different Regions, you can have multiple Firehose streams with the same name.
delivery_stream_type
instance-attribute
¶
delivery_stream_type: NotRequired[DeliveryStreamType]
The Firehose stream type. This parameter can be one of the following values:
-
DirectPut: Provider applications access the Firehose stream directly. -
KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.
direct_put_source_configuration
instance-attribute
¶
direct_put_source_configuration: NotRequired[DirectPutSourceConfiguration]
The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.
elasticsearch_destination_configuration
instance-attribute
¶
elasticsearch_destination_configuration: NotRequired[
ElasticsearchDestinationConfiguration
]
The destination in Amazon OpenSearch Service. You can specify only one destination.
extended_s3_destination_configuration
instance-attribute
¶
extended_s3_destination_configuration: NotRequired[ExtendedS3DestinationConfiguration]
The destination in Amazon S3. You can specify only one destination.
http_endpoint_destination_configuration
instance-attribute
¶
http_endpoint_destination_configuration: NotRequired[
HttpEndpointDestinationConfiguration
]
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.
iceberg_destination_configuration
instance-attribute
¶
iceberg_destination_configuration: NotRequired[IcebergDestinationConfiguration]
Configure Apache Iceberg Tables destination.
kinesis_stream_source_configuration
instance-attribute
¶
kinesis_stream_source_configuration: NotRequired[KinesisStreamSourceConfiguration]
When a Kinesis data stream is used as the source for the Firehose stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.
msk_source_configuration
instance-attribute
¶
msk_source_configuration: NotRequired[MSKSourceConfiguration]
redshift_destination_configuration
instance-attribute
¶
redshift_destination_configuration: NotRequired[RedshiftDestinationConfiguration]
The destination in Amazon Redshift. You can specify only one destination.
s3_destination_configuration
instance-attribute
¶
s3_destination_configuration: NotRequired[S3DestinationConfiguration]
[Deprecated] The destination in Amazon S3. You can specify only one destination.
snowflake_destination_configuration
instance-attribute
¶
snowflake_destination_configuration: NotRequired[SnowflakeDestinationConfiguration]
Configure Snowflake destination
splunk_destination_configuration
instance-attribute
¶
splunk_destination_configuration: NotRequired[SplunkDestinationConfiguration]
The destination in Splunk. You can specify only one destination.
tags
instance-attribute
¶
tags: NotRequired[TagDeliveryStreamInputTagList]
A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
You can specify up to 50 tags when creating a Firehose stream.
If you specify tags in the CreateDeliveryStream action, Amazon Data Firehose performs an additional authorization on the firehose:TagDeliveryStream action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an AccessDeniedException such as following.
AccessDeniedException
User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.
For an example IAM policy, see Tag example.