Struct aws_sdk_kinesis::client::fluent_builders::StartStreamEncryption [−][src]
pub struct StartStreamEncryption<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to StartStreamEncryption
.
Enables or updates server-side encryption using an AWS KMS key for a specified stream.
Starting encryption is an asynchronous operation. Upon receiving the request,
Kinesis Data Streams returns immediately and sets the status of the stream to
UPDATING
. After the update is complete, Kinesis Data Streams sets the
status of the stream back to ACTIVE
. Updating or applying encryption
normally takes a few seconds to complete, but it can take minutes. You can continue to
read and write data to your stream while its status is UPDATING
. Once the
status of the stream is ACTIVE
, encryption begins for records written to
the stream.
API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period.
Note: It can take up to 5 seconds after the stream is in an ACTIVE
status before all records written to the stream are encrypted. After you enable
encryption, you can verify that encryption is applied by inspecting the API response
from PutRecord
or PutRecords
.
Implementations
impl<C, M, R> StartStreamEncryption<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> StartStreamEncryption<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<StartStreamEncryptionOutput, SdkError<StartStreamEncryptionError>> where
R::Policy: SmithyRetryPolicy<StartStreamEncryptionInputOperationOutputAlias, StartStreamEncryptionOutput, StartStreamEncryptionError, StartStreamEncryptionInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<StartStreamEncryptionOutput, SdkError<StartStreamEncryptionError>> where
R::Policy: SmithyRetryPolicy<StartStreamEncryptionInputOperationOutputAlias, StartStreamEncryptionOutput, StartStreamEncryptionError, StartStreamEncryptionInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
The name of the stream for which to start encrypting records.
The name of the stream for which to start encrypting records.
The encryption type to use. The only valid value is KMS
.
The encryption type to use. The only valid value is KMS
.
The GUID for the customer-managed AWS KMS key to use for encryption. This value can
be a globally unique identifier, a fully specified Amazon Resource Name (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 Amazon Resource Name (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
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for StartStreamEncryption<C, M, R>
impl<C, M, R> Send for StartStreamEncryption<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for StartStreamEncryption<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for StartStreamEncryption<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for StartStreamEncryption<C, M, R>
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