Struct aws_sdk_kinesis::model::StreamDescription
source · #[non_exhaustive]pub struct StreamDescription { /* private fields */ }
Expand description
Represents the output for DescribeStream
.
Implementations§
source§impl StreamDescription
impl StreamDescription
sourcepub fn stream_name(&self) -> Option<&str>
pub fn stream_name(&self) -> Option<&str>
The name of the stream being described.
sourcepub fn stream_arn(&self) -> Option<&str>
pub fn stream_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the stream being described.
sourcepub fn stream_status(&self) -> Option<&StreamStatus>
pub fn 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 setsStreamStatus
toCREATING
. -
DELETING
- The stream is being deleted. The specified stream is in theDELETING
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 anACTIVE
stream. -
UPDATING
- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATING
state.
sourcepub fn stream_mode_details(&self) -> Option<&StreamModeDetails>
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.
sourcepub fn has_more_shards(&self) -> Option<bool>
pub fn has_more_shards(&self) -> Option<bool>
If set to true
, more shards in the stream are available to describe.
sourcepub fn retention_period_hours(&self) -> Option<i32>
pub fn retention_period_hours(&self) -> Option<i32>
The current retention period, in hours. Minimum value of 24. Maximum value of 168.
sourcepub fn stream_creation_timestamp(&self) -> Option<&DateTime>
pub fn stream_creation_timestamp(&self) -> Option<&DateTime>
The approximate time that the stream was created.
sourcepub fn enhanced_monitoring(&self) -> Option<&[EnhancedMetrics]>
pub fn enhanced_monitoring(&self) -> Option<&[EnhancedMetrics]>
Represents the current enhanced monitoring settings of the stream.
sourcepub fn encryption_type(&self) -> Option<&EncryptionType>
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.
sourcepub fn key_id(&self) -> Option<&str>
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
source§impl StreamDescription
impl StreamDescription
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture StreamDescription
.
Trait Implementations§
source§impl Clone for StreamDescription
impl Clone for StreamDescription
source§fn clone(&self) -> StreamDescription
fn clone(&self) -> StreamDescription
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for StreamDescription
impl Debug for StreamDescription
source§impl PartialEq<StreamDescription> for StreamDescription
impl PartialEq<StreamDescription> for StreamDescription
source§fn eq(&self, other: &StreamDescription) -> bool
fn eq(&self, other: &StreamDescription) -> bool
self
and other
values to be equal, and is used
by ==
.