AWS SDK for .NET Documentation
StreamDescription Class
Amazon ► Amazon.Kinesis.Model ► StreamDescription Did this page help you?   Yes   No    Tell us about it...

Represents the output of a DescribeStream operation.

Declaration Syntax
C#
public class StreamDescription
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
StreamDescription()()()()
Initializes a new instance of the StreamDescription class

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
HasMoreShards
If set to true there are more shards in the stream available to describe.

Shards
The shards that comprise the stream.

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

StreamName
The name of the stream being described.

Constraints:

Length
1 - 128
Pattern
[a-zA-Z0-9_.-]+


StreamStatus
The current status of the stream being described. The stream status is one of the following states:
  • CREATING - The stream is being created. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
  • DELETING - The stream is being deleted. After a DeleteStream request, the specified stream is in the DELETING state until Amazon Kinesis 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.

Constraints:

Allowed Values
CREATING, DELETING, ACTIVE, UPDATING


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithHasMoreShards(Boolean) Obsolete.
Sets the HasMoreShards property

WithShards(array<Shard>[]()[][]) Obsolete.
Adds elements to the Shards collection

WithShards(IEnumerable<(Of <<'(Shard>)>>)) Obsolete.
Adds elements to the Shards collection

WithStreamARN(String) Obsolete.
Sets the StreamARN property

WithStreamName(String) Obsolete.
Sets the StreamName property

WithStreamStatus(String) Obsolete.
Sets the StreamStatus property

Inheritance Hierarchy
Object
StreamDescription

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)