Struct aws_sdk_kinesis::types::builders::ConsumerBuilder

#[non_exhaustive]
pub struct ConsumerBuilder { /* private fields */ }

A builder for Consumer.

Implementations

impl ConsumerBuilder

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

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

This field is required.

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 get_consumer_name(&self) -> &Option<String>

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.

This field is required.

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 get_consumer_arn(&self) -> &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.

pub fn consumer_status(self, input: ConsumerStatus) -> Self

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

This field is required.

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 get_consumer_status(&self) -> &Option<ConsumerStatus>

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

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

This field is required.

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

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

pub fn build(self) -> Result<Consumer, BuildError>

Consumes the builder and constructs a Consumer. This method will fail if any of the following fields are not set:

• consumer_name
• consumer_arn
• consumer_status
• consumer_creation_timestamp

Trait Implementations

impl Clone for ConsumerBuilder

fn clone(&self) -> ConsumerBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConsumerBuilder

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

Formats the value using the given formatter.

impl Default for ConsumerBuilder

fn default() -> ConsumerBuilder

Returns the “default value” for a type.

impl PartialEq for ConsumerBuilder

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

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

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

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

impl StructuralPartialEq for ConsumerBuilder