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.

An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.

Inheritance Hierarchy

System.Object
  Amazon.Kinesis.Model.ConsumerDescription

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

Syntax

C#
public class ConsumerDescription

The ConsumerDescription type exposes the following members

Constructors

NameDescription
Public Method ConsumerDescription()

Properties

NameTypeDescription
Public Property ConsumerARN System.String

Gets and sets the property ConsumerARN.

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

Public Property ConsumerCreationTimestamp System.DateTime

Gets and sets the property ConsumerCreationTimestamp.

Public Property ConsumerName System.String

Gets and sets the property ConsumerName.

The name of the consumer is something you choose when you register the consumer.

Public Property ConsumerStatus Amazon.Kinesis.ConsumerStatus

Gets and sets the property ConsumerStatus.

A consumer can't read data while in the CREATING or DELETING states.

Public Property StreamARN System.String

Gets and sets the property StreamARN.

The ARN of the stream with which you registered the consumer.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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