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 DescribeStreamSummary

Inheritance Hierarchy

System.Object
  Amazon.Kinesis.Model.StreamDescriptionSummary

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

Syntax

C#
public class StreamDescriptionSummary

The StreamDescriptionSummary type exposes the following members

Constructors

NameDescription
Public Method StreamDescriptionSummary()

Properties

NameTypeDescription
Public Property ConsumerCount System.Int32

Gets and sets the property ConsumerCount.

The number of enhanced fan-out consumers registered with the stream.

Public Property EncryptionType Amazon.Kinesis.EncryptionType

Gets and sets the property EncryptionType.

The encryption type used. This value is one of the following:

  • KMS

  • NONE

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 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 OpenShardCount System.Int32

Gets and sets the property OpenShardCount.

The number of open shards in the stream.

Public Property RetentionPeriodHours System.Int32

Gets and sets the property RetentionPeriodHours.

The current retention period, in hours.

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

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