Struct StartStreamEncryptionFluentBuilder

pub struct StartStreamEncryptionFluentBuilder { /* private fields */ }

Fluent builder constructing a request to StartStreamEncryption.

Enables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream.

When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.

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 Amazon Web Services 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 StartStreamEncryptionFluentBuilder

pub fn as_input(&self) -> &StartStreamEncryptionInputBuilder

Access the StartStreamEncryption as a reference.

pub async fn send( self, ) -> Result<StartStreamEncryptionOutput, SdkError<StartStreamEncryptionError, HttpResponse>>

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.

pub fn customize( self, ) -> CustomizableOperation<StartStreamEncryptionOutput, StartStreamEncryptionError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn stream_name(self, input: impl Into<String>) -> Self

The name of the stream for which to start encrypting records.

pub fn set_stream_name(self, input: Option<String>) -> Self

The name of the stream for which to start encrypting records.

pub fn get_stream_name(&self) -> &Option<String>

The name of the stream for which to start encrypting records.

pub fn encryption_type(self, input: EncryptionType) -> Self

The encryption type to use. The only valid value is KMS.

pub fn set_encryption_type(self, input: Option<EncryptionType>) -> Self

The encryption type to use. The only valid value is KMS.

pub fn get_encryption_type(&self) -> &Option<EncryptionType>

The encryption type to use. The only valid value is KMS.

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

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

pub fn get_key_id(&self) -> &Option<String>

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

pub fn stream_arn(self, input: impl Into<String>) -> Self

The ARN of the stream.

pub fn set_stream_arn(self, input: Option<String>) -> Self

The ARN of the stream.

pub fn get_stream_arn(&self) -> &Option<String>

The ARN of the stream.

Trait Implementations

impl Clone for StartStreamEncryptionFluentBuilder

fn clone(&self) -> StartStreamEncryptionFluentBuilder

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartStreamEncryptionFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.