Struct aws_sdk_kinesis::model::stream_description_summary::Builder

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

A builder for StreamDescriptionSummary

Implementations

impl Builder

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

The name of the stream being described.

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

The name of the stream being described.

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

The Amazon Resource Name (ARN) for the stream being described.

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

The Amazon Resource Name (ARN) for the stream being described.

pub fn stream_status(self, input: StreamStatus) -> Self

The current status of the stream being described. The stream status is one of the following states:

• CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

• DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

• ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

• UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

pub fn set_stream_status(self, input: Option<StreamStatus>) -> Self

The current status of the stream being described. The stream status is one of the following states:

• CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

• DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

• ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

• UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

pub fn retention_period_hours(self, input: i32) -> Self

The current retention period, in hours.

pub fn set_retention_period_hours(self, input: Option<i32>) -> Self

The current retention period, in hours.

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

The approximate time that the stream was created.

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

The approximate time that the stream was created.

pub fn enhanced_monitoring(self, input: impl Into<EnhancedMetrics>) -> Self

Appends an item to enhanced_monitoring.

To override the contents of this collection use set_enhanced_monitoring.

Represents the current enhanced monitoring settings of the stream.

pub fn set_enhanced_monitoring(
    self,
    input: Option<Vec<EnhancedMetrics>>
) -> Self

Represents the current enhanced monitoring settings of the stream.

pub fn encryption_type(self, input: EncryptionType) -> Self

The encryption type used. This value is one of the following:

• KMS

• NONE

pub fn set_encryption_type(self, input: Option<EncryptionType>) -> Self

The encryption type used. This value is one of the following:

• KMS

• NONE

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

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

• Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

• Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

• Globally unique key ID example: 12345678-1234-1234-1234-123456789012

• Alias name example: alias/MyAliasName

• Master key owned by Kinesis Data Streams: alias/aws/kinesis

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

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

• Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

• Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

• Globally unique key ID example: 12345678-1234-1234-1234-123456789012

• Alias name example: alias/MyAliasName

• Master key owned by Kinesis Data Streams: alias/aws/kinesis

pub fn open_shard_count(self, input: i32) -> Self

The number of open shards in the stream.

pub fn set_open_shard_count(self, input: Option<i32>) -> Self

The number of open shards in the stream.

pub fn consumer_count(self, input: i32) -> Self

The number of enhanced fan-out consumers registered with the stream.

pub fn set_consumer_count(self, input: Option<i32>) -> Self

The number of enhanced fan-out consumers registered with the stream.

pub fn build(self) -> StreamDescriptionSummary

Consumes the builder and constructs a StreamDescriptionSummary

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