Struct aws_sdk_kinesis::model::consumer_description::Builder

#[non_exhaustive]
pub struct Builder { /* fields omitted */ }

A builder for ConsumerDescription

Implementations

impl Builder

pub fn consumer_name(self, input: impl Into<String>) -> Self

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

pub fn set_consumer_name(self, input: Option<String>) -> Self

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

pub fn consumer_arn(self, input: impl Into<String>) -> Self

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 set_consumer_arn(self, input: Option<String>) -> Self

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, input: ConsumerStatus) -> Self

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

pub fn set_consumer_status(self, input: Option<ConsumerStatus>) -> Self

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

pub fn consumer_creation_timestamp(self, input: Instant) -> Self

pub fn set_consumer_creation_timestamp(self, input: Option<Instant>) -> Self

pub fn stream_arn(self, input: impl Into<String>) -> Self

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

pub fn set_stream_arn(self, input: Option<String>) -> Self

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

pub fn build(self) -> ConsumerDescription

Consumes the builder and constructs a ConsumerDescription

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

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

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

This method tests for !=.

impl StructuralPartialEq for Builder