Struct aws_sdk_kinesis::model::Consumer

#[non_exhaustive]
pub struct Consumer {
    pub consumer_name: Option<String>,
    pub consumer_arn: Option<String>,
    pub consumer_status: Option<ConsumerStatus>,
    pub consumer_creation_timestamp: Option<DateTime>,
}

An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer.

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: Option<String>

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

consumer_arn: Option<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: Option<ConsumerStatus>

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

consumer_creation_timestamp: Option<DateTime>

Implementations

impl Consumer

pub fn consumer_name(&self) -> Option<&str>

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

pub fn consumer_arn(&self) -> Option<&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) -> Option<&ConsumerStatus>

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

pub fn consumer_creation_timestamp(&self) -> Option<&DateTime>

impl Consumer

pub fn builder() -> Builder

Creates a new builder-style object to manufacture Consumer

Trait Implementations

impl Clone for Consumer

fn clone(&self) -> Consumer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Consumer

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

Formats the value using the given formatter.

impl PartialEq<Consumer> for Consumer

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Consumer