Struct aws_sdk_kinesis::model::StreamDescriptionSummary [−][src]
#[non_exhaustive]pub struct StreamDescriptionSummary {
pub stream_name: Option<String>,
pub stream_arn: Option<String>,
pub stream_status: Option<StreamStatus>,
pub retention_period_hours: Option<i32>,
pub stream_creation_timestamp: Option<Instant>,
pub enhanced_monitoring: Option<Vec<EnhancedMetrics>>,
pub encryption_type: Option<EncryptionType>,
pub key_id: Option<String>,
pub open_shard_count: Option<i32>,
pub consumer_count: Option<i32>,
}
Expand description
Represents the output for DescribeStreamSummary
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.stream_name: Option<String>
The name of the stream being described.
stream_arn: Option<String>
The Amazon Resource Name (ARN) for the stream being described.
stream_status: 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.
retention_period_hours: Option<i32>
The current retention period, in hours.
stream_creation_timestamp: Option<Instant>
The approximate time that the stream was created.
enhanced_monitoring: Option<Vec<EnhancedMetrics>>
Represents the current enhanced monitoring settings of the stream.
encryption_type: Option<EncryptionType>
The encryption type used. This value is one of the following:
-
KMS
-
NONE
key_id: Option<String>
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
open_shard_count: Option<i32>
The number of open shards in the stream.
consumer_count: Option<i32>
The number of enhanced fan-out consumers registered with the stream.
Implementations
The name of the stream being described.
The Amazon Resource Name (ARN) for the stream being described.
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.
The current retention period, in hours.
The approximate time that the stream was created.
Represents the current enhanced monitoring settings of the stream.
The encryption type used. This value is one of the following:
-
KMS
-
NONE
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
The number of open shards in the stream.
The number of enhanced fan-out consumers registered with the stream.
Creates a new builder-style object to manufacture StreamDescriptionSummary
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for StreamDescriptionSummary
impl Send for StreamDescriptionSummary
impl Sync for StreamDescriptionSummary
impl Unpin for StreamDescriptionSummary
impl UnwindSafe for StreamDescriptionSummary
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more