Struct ConsumerDescription 

#[non_exhaustive]
pub struct ConsumerDescription {
    pub consumer_name: String,
    pub consumer_arn: String,
    pub consumer_status: ConsumerStatus,
    pub consumer_creation_timestamp: DateTime,
    pub stream_arn: String,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

consumer_name: String

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

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_status: ConsumerStatus

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

consumer_creation_timestamp: DateTime

stream_arn: String

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

Implementations

impl ConsumerDescription

pub fn consumer_name(&self) -> &str

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

pub fn consumer_arn(&self) -> &str

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.

pub fn consumer_status(&self) -> &ConsumerStatus

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

pub fn consumer_creation_timestamp(&self) -> &DateTime

pub fn stream_arn(&self) -> &str

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

impl ConsumerDescription

pub fn builder() -> ConsumerDescriptionBuilder

Creates a new builder-style object to manufacture ConsumerDescription.

Trait Implementations

impl Clone for ConsumerDescription

fn clone(&self) -> ConsumerDescription

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConsumerDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ConsumerDescription

fn eq(&self, other: &ConsumerDescription) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConsumerDescription