Skip to contents

Creates a Firehose stream

Source: R/firehose_operations.R
firehose_create_delivery_stream.Rd

Creates a Firehose stream.

See https://www.paws-r-sdk.com/docs/firehose_create_delivery_stream/ for full documentation.

Usage

firehose_create_delivery_stream(
  DeliveryStreamName,
  DeliveryStreamType = NULL,
  DirectPutSourceConfiguration = NULL,
  KinesisStreamSourceConfiguration = NULL,
  DeliveryStreamEncryptionConfigurationInput = NULL,
  S3DestinationConfiguration = NULL,
  ExtendedS3DestinationConfiguration = NULL,
  RedshiftDestinationConfiguration = NULL,
  ElasticsearchDestinationConfiguration = NULL,
  AmazonopensearchserviceDestinationConfiguration = NULL,
  SplunkDestinationConfiguration = NULL,
  HttpEndpointDestinationConfiguration = NULL,
  Tags = NULL,
  AmazonOpenSearchServerlessDestinationConfiguration = NULL,
  MSKSourceConfiguration = NULL,
  SnowflakeDestinationConfiguration = NULL,
  IcebergDestinationConfiguration = NULL,
  DatabaseSourceConfiguration = NULL
)

Arguments

DeliveryStreamName

[required] The name of the Firehose stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the Firehose streams are in different accounts or different Regions, you can have multiple Firehose streams with the same name.

DeliveryStreamType

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.

DirectPutSourceConfiguration

The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.

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.

DeliveryStreamEncryptionConfigurationInput

Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).

S3DestinationConfiguration

[Deprecated] The destination in Amazon S3. You can specify only one destination.

ExtendedS3DestinationConfiguration

The destination in Amazon S3. You can specify only one destination.

RedshiftDestinationConfiguration

The destination in Amazon Redshift. You can specify only one destination.

ElasticsearchDestinationConfiguration

The destination in Amazon OpenSearch Service. You can specify only one destination.

AmazonopensearchserviceDestinationConfiguration

The destination in Amazon OpenSearch Service. You can specify only one destination.

SplunkDestinationConfiguration

The destination in Splunk. You can specify only one destination.

HttpEndpointDestinationConfiguration

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

Tags

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

AmazonOpenSearchServerlessDestinationConfiguration

The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.

MSKSourceConfiguration

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

SnowflakeDestinationConfiguration

Configure Snowflake destination

IcebergDestinationConfiguration

Configure Apache Iceberg Tables destination.

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.