class
Amazonite::Kinesis::ConsumerDescription
- Amazonite::Kinesis::ConsumerDescription
- Reference
- Object
Overview
An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.
Included Modules
- JSON::Serializable
Defined in:
kinesis/consumer_description.crConstructors
- .new(consumer_name : String, consumer_arn : String, consumer_status : ConsumerStatus, consumer_creation_timestamp : Time, stream_arn : String)
- .new(pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#consumer_arn : String
When you register a consumer, Kinesis Data Streams generates an ARN for it.
-
#consumer_arn=(consumer_arn : String)
When you register a consumer, Kinesis Data Streams generates an ARN for it.
- #consumer_creation_timestamp : Time
- #consumer_creation_timestamp=(consumer_creation_timestamp : Time)
-
#consumer_name : String
The name of the consumer is something you choose when you register the consumer.
-
#consumer_name=(consumer_name : String)
The name of the consumer is something you choose when you register the consumer.
-
#consumer_status : ConsumerStatus
A consumer can't read data while in the
CREATINGorDELETINGstates. -
#consumer_status=(consumer_status : ConsumerStatus)
A consumer can't read data while in the
CREATINGorDELETINGstates. -
#hash(hasher)
See
Object#hash(hasher) -
#stream_arn : String
The ARN of the stream with which you registered the consumer.
-
#stream_arn=(stream_arn : String)
The ARN of the stream with which you registered the consumer.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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.
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.
The name of the consumer is something you choose when you register the consumer.
The name of the consumer is something you choose when you register the consumer.
A consumer can't read data while in the CREATING or DELETING states.
A consumer can't read data while in the CREATING or DELETING states.
The ARN of the stream with which you registered the consumer.