Struct aws_sdk_kinesis::model::stream_description::Builder
source · pub struct Builder { /* private fields */ }
Expand description
A builder for StreamDescription
.
Implementations§
source§impl Builder
impl Builder
sourcepub fn stream_name(self, input: impl Into<String>) -> Self
pub fn stream_name(self, input: impl Into<String>) -> Self
The name of the stream being described.
sourcepub fn set_stream_name(self, input: Option<String>) -> Self
pub fn set_stream_name(self, input: Option<String>) -> Self
The name of the stream being described.
sourcepub fn stream_arn(self, input: impl Into<String>) -> Self
pub fn stream_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the stream being described.
sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
pub fn set_stream_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the stream being described.
sourcepub fn stream_status(self, input: StreamStatus) -> Self
pub fn stream_status(self, input: StreamStatus) -> Self
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 set_stream_status(self, input: Option<StreamStatus>) -> Self
pub fn set_stream_status(self, input: Option<StreamStatus>) -> Self
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, input: StreamModeDetails) -> Self
pub fn stream_mode_details(self, input: StreamModeDetails) -> Self
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 set_stream_mode_details(self, input: Option<StreamModeDetails>) -> Self
pub fn set_stream_mode_details(self, input: Option<StreamModeDetails>) -> Self
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 shards(self, input: Shard) -> Self
pub fn shards(self, input: Shard) -> Self
Appends an item to shards
.
To override the contents of this collection use set_shards
.
The shards that comprise the stream.
sourcepub fn set_shards(self, input: Option<Vec<Shard>>) -> Self
pub fn set_shards(self, input: Option<Vec<Shard>>) -> Self
The shards that comprise the stream.
sourcepub fn has_more_shards(self, input: bool) -> Self
pub fn has_more_shards(self, input: bool) -> Self
If set to true
, more shards in the stream are available to describe.
sourcepub fn set_has_more_shards(self, input: Option<bool>) -> Self
pub fn set_has_more_shards(self, input: Option<bool>) -> Self
If set to true
, more shards in the stream are available to describe.
sourcepub fn retention_period_hours(self, input: i32) -> Self
pub fn retention_period_hours(self, input: i32) -> Self
The current retention period, in hours. Minimum value of 24. Maximum value of 168.
sourcepub fn set_retention_period_hours(self, input: Option<i32>) -> Self
pub fn set_retention_period_hours(self, input: Option<i32>) -> Self
The current retention period, in hours. Minimum value of 24. Maximum value of 168.
sourcepub fn stream_creation_timestamp(self, input: DateTime) -> Self
pub fn stream_creation_timestamp(self, input: DateTime) -> Self
The approximate time that the stream was created.
sourcepub fn set_stream_creation_timestamp(self, input: Option<DateTime>) -> Self
pub fn set_stream_creation_timestamp(self, input: Option<DateTime>) -> Self
The approximate time that the stream was created.
sourcepub fn enhanced_monitoring(self, input: EnhancedMetrics) -> Self
pub fn enhanced_monitoring(self, input: EnhancedMetrics) -> Self
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.
sourcepub fn set_enhanced_monitoring(self, input: Option<Vec<EnhancedMetrics>>) -> Self
pub fn set_enhanced_monitoring(self, input: Option<Vec<EnhancedMetrics>>) -> Self
Represents the current enhanced monitoring settings of the stream.
sourcepub fn encryption_type(self, input: EncryptionType) -> Self
pub fn encryption_type(self, input: EncryptionType) -> Self
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 set_encryption_type(self, input: Option<EncryptionType>) -> Self
pub fn set_encryption_type(self, input: Option<EncryptionType>) -> Self
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, input: impl Into<String>) -> Self
pub fn key_id(self, input: impl Into<String>) -> Self
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
sourcepub fn set_key_id(self, input: Option<String>) -> Self
pub fn set_key_id(self, input: Option<String>) -> Self
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
sourcepub fn build(self) -> StreamDescription
pub fn build(self) -> StreamDescription
Consumes the builder and constructs a StreamDescription
.