You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Kinesis::Types::ConsumerDescription
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kinesis::Types::ConsumerDescription
- Defined in:
- (unknown)
Overview
An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.
Returned by:
Instance Attribute Summary collapse
-
#consumer_arn ⇒ String
When you register a consumer, Kinesis Data Streams generates an ARN for it.
-
#consumer_creation_timestamp ⇒ Time
-
#consumer_name ⇒ String
The name of the consumer is something you choose when you register the consumer.
-
#consumer_status ⇒ String
A consumer can\'t read data while in the
CREATING
orDELETING
states. -
#stream_arn ⇒ String
The ARN of the stream with which you registered the consumer.
Instance Attribute Details
#consumer_arn ⇒ String
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.
#consumer_creation_timestamp ⇒ Time
#consumer_name ⇒ String
The name of the consumer is something you choose when you register the consumer.
#consumer_status ⇒ String
A consumer can\'t read data while in the CREATING
or DELETING
states.
Possible values:
- CREATING
- DELETING
- ACTIVE
#stream_arn ⇒ String
The ARN of the stream with which you registered the consumer.