Struct aws_sdk_kinesis::types::StreamDescription

#[non_exhaustive]
pub struct StreamDescription {
    pub stream_name: String,
    pub stream_arn: String,
    pub stream_status: StreamStatus,
    pub stream_mode_details: Option<StreamModeDetails>,
    pub shards: Vec<Shard>,
    pub has_more_shards: bool,
    pub retention_period_hours: i32,
    pub stream_creation_timestamp: DateTime,
    pub enhanced_monitoring: Vec<EnhancedMetrics>,
    pub encryption_type: Option<EncryptionType>,
    pub key_id: Option<String>,
}

Represents the output for DescribeStream.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

stream_name: String

The name of the stream being described.

stream_arn: String

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

stream_status: 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.

stream_mode_details: 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.

shards: Vec<Shard>

The shards that comprise the stream.

has_more_shards: bool

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

retention_period_hours: i32

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

stream_creation_timestamp: DateTime

The approximate time that the stream was created.

enhanced_monitoring: Vec<EnhancedMetrics>

Represents the current enhanced monitoring settings of the stream.

encryption_type: 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.

key_id: 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

Implementations

impl StreamDescription

pub fn stream_name(&self) -> &str

The name of the stream being described.

pub fn stream_arn(&self) -> &str

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

pub fn stream_status(&self) -> &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) -> 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) -> &[Shard]

The shards that comprise the stream.

pub fn has_more_shards(&self) -> bool

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

pub fn retention_period_hours(&self) -> i32

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

pub fn stream_creation_timestamp(&self) -> &DateTime

The approximate time that the stream was created.

pub fn enhanced_monitoring(&self) -> &[EnhancedMetrics]

Represents the current enhanced monitoring settings of the stream.

pub fn 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) -> Option<&str>

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

impl StreamDescription

pub fn builder() -> StreamDescriptionBuilder

Creates a new builder-style object to manufacture StreamDescription.

Trait Implementations

impl Clone for StreamDescription

fn clone(&self) -> StreamDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamDescription

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

Formats the value using the given formatter.

impl PartialEq for StreamDescription

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