AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateDeliveryStream operation. Creates a delivery stream.

By default, you can create up to 20 delivery streams per region.

This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream.

A Kinesis Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream ARN and role ARN in the KinesisStreamSourceConfiguration parameter.

A delivery stream is configured with a single destination: Amazon S3, Amazon ES, or Amazon Redshift. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, or RedshiftDestinationConfiguration.

When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. Note that BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly; for example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.

A few notes about Amazon Redshift as a destination:

Kinesis Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Amazon S3 Bucket Access in the Amazon Kinesis Firehose Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.KinesisFirehose.AmazonKinesisFirehoseRequest
      Amazon.KinesisFirehose.Model.CreateDeliveryStreamRequest

Namespace: Amazon.KinesisFirehose.Model
Assembly: AWSSDK.KinesisFirehose.dll
Version: 3.x.y.z

Syntax

C#
public class CreateDeliveryStreamRequest : AmazonKinesisFirehoseRequest
         IAmazonWebServiceRequest

The CreateDeliveryStreamRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property DeliveryStreamName System.String

Gets and sets the property DeliveryStreamName.

The name of the delivery stream. This name must be unique per AWS account in the same region. If the delivery streams are in different accounts or different regions, you can have multiple delivery streams with the same name.

Public Property DeliveryStreamType Amazon.KinesisFirehose.DeliveryStreamType

Gets and sets the property DeliveryStreamType.

The delivery stream type. This parameter can be one of the following values:

  • DirectPut: Provider applications access the delivery stream directly.

  • KinesisStreamAsSource: The delivery stream uses a Kinesis stream as a source.

Public Property ElasticsearchDestinationConfiguration Amazon.KinesisFirehose.Model.ElasticsearchDestinationConfiguration

Gets and sets the property ElasticsearchDestinationConfiguration.

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

Public Property ExtendedS3DestinationConfiguration Amazon.KinesisFirehose.Model.ExtendedS3DestinationConfiguration

Gets and sets the property ExtendedS3DestinationConfiguration.

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

Public Property KinesisStreamSourceConfiguration Amazon.KinesisFirehose.Model.KinesisStreamSourceConfiguration

Gets and sets the property KinesisStreamSourceConfiguration.

When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.

Public Property RedshiftDestinationConfiguration Amazon.KinesisFirehose.Model.RedshiftDestinationConfiguration

Gets and sets the property RedshiftDestinationConfiguration.

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

Public Property S3DestinationConfiguration Amazon.KinesisFirehose.Model.S3DestinationConfiguration

Gets and sets the property S3DestinationConfiguration.

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone