Struct aws_sdk_kinesis::model::stream_description::Builder [−][src]
#[non_exhaustive]pub struct Builder { /* fields omitted */ }
Expand description
A builder for StreamDescription
Implementations
The name of the stream being described.
The name of the stream being described.
The Amazon Resource Name (ARN) for 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 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.
Appends an item to shards
.
To override the contents of this collection use set_shards
.
The shards that comprise the stream.
The shards that comprise the stream.
If set to true
, more shards in the stream are available to
describe.
If set to true
, more shards in the stream are available to
describe.
The current retention period, in hours. Minimum value of 24. Maximum value of 168.
The current retention period, in hours. Minimum value of 24. Maximum value of 168.
The approximate time that the stream was created.
The approximate time that the stream was created.
Appends an item to enhanced_monitoring
.
To override the contents of this collection use set_enhanced_monitoring
.
Represents the current enhanced monitoring settings of the stream.
Represents the current enhanced monitoring settings of the stream.
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.
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.
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 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
Consumes the builder and constructs a StreamDescription
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Builder
impl UnwindSafe for Builder
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