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.

Represents the output for DescribeStream.

Inheritance Hierarchy


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


public class StreamDescription

The StreamDescription type exposes the following members


Public Method StreamDescription()


Public Property EncryptionType Amazon.Kinesis.EncryptionType

Gets and sets the property EncryptionType.

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Public Property EnhancedMonitoring System.Collections.Generic.List<Amazon.Kinesis.Model.EnhancedMetrics>

Gets and sets the property EnhancedMonitoring.

Represents the current enhanced monitoring settings of the stream.

Public Property HasMoreShards System.Boolean

Gets and sets the property HasMoreShards.

If set to true, more shards in the stream are available to describe.

Public Property KeyId System.String

Gets and sets the property KeyId.

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

Public Property RetentionPeriodHours System.Int32

Gets and sets the property RetentionPeriodHours.

The current retention period, in hours.

Public Property Shards System.Collections.Generic.List<Amazon.Kinesis.Model.Shard>

Gets and sets the property Shards.

The shards that comprise the stream.

Public Property StreamARN System.String

Gets and sets the property StreamARN.

The Amazon Resource Name (ARN) for the stream being described.

Public Property StreamCreationTimestamp System.DateTime

Gets and sets the property StreamCreationTimestamp.

The approximate time that the stream was created.

Public Property StreamName System.String

Gets and sets the property StreamName.

The name of the stream being described.

Public Property StreamStatus Amazon.Kinesis.StreamStatus

Gets and sets the property StreamStatus.

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

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

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