Struct rusoto_kinesis::StreamDescription

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 AWS 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 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

retention_period_hours: i64

The current retention period, in hours.

shards: Vec<Shard>

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

Trait Implementations

impl PartialEq<StreamDescription> 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: &StreamDescription) -> bool

This method tests for !=.

impl Default for StreamDescription

fn default() -> StreamDescription

Returns the "default value" for a type.

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<'de> Deserialize<'de> for StreamDescription

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.