Struct rusoto_kinesis::StreamDescription
[−]
[src]
pub struct StreamDescription { pub encryption_type: Option<String>, pub enhanced_monitoring: Vec<EnhancedMetrics>, pub has_more_shards: bool, pub key_id: Option<String>, pub retention_period_hours: i64, pub shards: Vec<Shard>, pub stream_arn: String, pub stream_creation_timestamp: f64, pub stream_name: String, pub stream_status: String, }
Represents the output for DescribeStream.
Fields
encryption_type: Option<String>
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 KMS key.
enhanced_monitoring: Vec<EnhancedMetrics>
Represents the current enhanced monitoring settings of the stream.
has_more_shards: bool
If set to true
, more shards in the stream are available to describe.
key_id: Option<String>
The GUID for the customer-managed 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 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 Streams:
alias/aws/kinesis
retention_period_hours: i64
The current retention period, in hours.
The shards that comprise the stream.
stream_arn: String
The Amazon Resource Name (ARN) for the stream being described.
stream_creation_timestamp: f64
The approximate time that the stream was created.
stream_name: String
The name of the stream being described.
stream_status: String
The current status of the stream being described. The stream status is one of the following states:
-
CREATING
- The stream is being created. Kinesis Streams immediately returns and setsStreamStatus
toCREATING
. -
DELETING
- The stream is being deleted. The specified stream is in theDELETING
state until Kinesis 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.
Trait Implementations
impl Default for StreamDescription
[src]
fn default() -> StreamDescription
[src]
Returns the "default value" for a type. Read more
impl Debug for StreamDescription
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Clone for StreamDescription
[src]
fn clone(&self) -> StreamDescription
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more