Struct aws_sdk_kinesis::types::builders::StreamDescriptionSummaryBuilder

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

A builder for StreamDescriptionSummary.

Implementations

impl StreamDescriptionSummaryBuilder

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

The name of the stream being described.

This field is required.

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

The name of the stream being described.

pub fn get_stream_name(&self) -> &Option<String>

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.

This field is required.

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

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

pub fn get_stream_arn(&self) -> &Option<String>

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.

This field is required.

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 get_stream_status(&self) -> &Option<StreamStatus>

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 stream_mode_details(self, input: StreamModeDetails) -> Self

Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.

pub fn set_stream_mode_details(self, input: Option<StreamModeDetails>) -> Self

Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.

pub fn get_stream_mode_details(&self) -> &Option<StreamModeDetails>

Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.

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

The current retention period, in hours.

This field is required.

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

The current retention period, in hours.

pub fn get_retention_period_hours(&self) -> &Option<i32>

The current retention period, in hours.

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

The approximate time that the stream was created.

This field is required.

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

The approximate time that the stream was created.

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

The approximate time that the stream was created.

pub fn enhanced_monitoring(self, input: 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 get_enhanced_monitoring(&self) -> &Option<Vec<EnhancedMetrics>>

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 get_encryption_type(&self) -> &Option<EncryptionType>

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 Amazon Web Services 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 Amazon Web Services 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 get_key_id(&self) -> &Option<String>

The GUID for the customer-managed Amazon Web Services 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.

This field is required.

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

The number of open shards in the stream.

pub fn get_open_shard_count(&self) -> &Option<i32>

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 get_consumer_count(&self) -> &Option<i32>

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

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

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

• stream_name
• stream_arn
• stream_status
• retention_period_hours
• stream_creation_timestamp
• enhanced_monitoring
• open_shard_count

Trait Implementations

impl Clone for StreamDescriptionSummaryBuilder

fn clone(&self) -> StreamDescriptionSummaryBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamDescriptionSummaryBuilder

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

Formats the value using the given formatter.

impl Default for StreamDescriptionSummaryBuilder

fn default() -> StreamDescriptionSummaryBuilder

Returns the “default value” for a type.

impl PartialEq for StreamDescriptionSummaryBuilder

fn eq(&self, other: &StreamDescriptionSummaryBuilder) -> 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 StreamDescriptionSummaryBuilder