AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the StopStreamEncryption operation.
Disables server-side encryption 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.
Stopping 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
. Stopping 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
, records
written to the stream are no longer encrypted by Kinesis Data Streams.
API Limits: You can successfully disable 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 no longer subject to encryption. After you disabled
encryption, you can verify that encryption is not applied by inspecting the API response
from PutRecord
or PutRecords
.
Namespace: Amazon.Kinesis.Model
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
public class StopStreamEncryptionRequest : AmazonKinesisRequest IAmazonWebServiceRequest
The StopStreamEncryptionRequest type exposes the following members
Name | Description | |
---|---|---|
StopStreamEncryptionRequest() |
Name | Type | Description | |
---|---|---|---|
EncryptionType | Amazon.Kinesis.EncryptionType |
Gets and sets the property EncryptionType.
The encryption type. The only valid value is |
|
KeyId | System.String |
Gets and sets the property KeyId.
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
|
|
StreamARN | System.String |
Gets and sets the property StreamARN. The ARN of the stream. |
|
StreamName | System.String |
Gets and sets the property StreamName. The name of the stream on which to stop encrypting records. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5