Struct aws_sdk_kinesis::types::builders::StreamDescriptionBuilder

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

A builder for StreamDescription.

Implementations

impl StreamDescriptionBuilder

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 capacity 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 capacity 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 capacity mode and a provisioned capacity mode for your data streams.

pub fn shards(self, input: Shard) -> Self

Appends an item to shards.

To override the contents of this collection use set_shards.

The shards that comprise the stream.

pub fn set_shards(self, input: Option<Vec<Shard>>) -> Self

The shards that comprise the stream.

pub fn get_shards(&self) -> &Option<Vec<Shard>>

The shards that comprise the stream.

pub fn has_more_shards(self, input: bool) -> Self

If set to true, more shards in the stream are available to describe.

This field is required.

pub fn set_has_more_shards(self, input: Option<bool>) -> Self

If set to true, more shards in the stream are available to describe.

pub fn get_has_more_shards(&self) -> &Option<bool>

If set to true, more shards in the stream are available to describe.

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

The current retention period, in hours. Minimum value of 24. Maximum value of 168.

This field is required.

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

The current retention period, in hours. Minimum value of 24. Maximum value of 168.

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

The current retention period, in hours. Minimum value of 24. Maximum value of 168.

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 server-side encryption type used on the stream. This parameter can be one of the following values:

• NONE: Do not encrypt the records in the stream.

• KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.

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

The server-side encryption type used on the stream. This parameter can be one of the following values:

• NONE: Do not encrypt the records in the stream.

• KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.

pub fn get_encryption_type(&self) -> &Option<EncryptionType>

The server-side encryption type used on the stream. This parameter can be one of the following values:

• NONE: Do not encrypt the records in the stream.

• KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.

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 build(self) -> Result<StreamDescription, BuildError>

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

• stream_name
• stream_arn
• stream_status
• shards
• has_more_shards
• retention_period_hours
• stream_creation_timestamp
• enhanced_monitoring

Trait Implementations

impl Clone for StreamDescriptionBuilder

fn clone(&self) -> StreamDescriptionBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamDescriptionBuilder

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

Formats the value using the given formatter.

impl Default for StreamDescriptionBuilder

fn default() -> StreamDescriptionBuilder

Returns the “default value” for a type.

impl PartialEq for StreamDescriptionBuilder

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