Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Disables server-side encryption for a specified stream.
When invoking this API, it is recommended you use the StreamARN
input
parameter rather than the StreamName
input parameter.
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
.
Synopsis
- data StopStreamEncryption = StopStreamEncryption' {}
- newStopStreamEncryption :: EncryptionType -> Text -> StopStreamEncryption
- stopStreamEncryption_streamARN :: Lens' StopStreamEncryption (Maybe Text)
- stopStreamEncryption_streamName :: Lens' StopStreamEncryption (Maybe Text)
- stopStreamEncryption_encryptionType :: Lens' StopStreamEncryption EncryptionType
- stopStreamEncryption_keyId :: Lens' StopStreamEncryption Text
- data StopStreamEncryptionResponse = StopStreamEncryptionResponse' {
- newStopStreamEncryptionResponse :: StopStreamEncryptionResponse
Creating a Request
data StopStreamEncryption Source #
See: newStopStreamEncryption
smart constructor.
StopStreamEncryption' | |
|
Instances
newStopStreamEncryption Source #
Create a value of StopStreamEncryption
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopStreamEncryption
, stopStreamEncryption_streamARN
- The ARN of the stream.
StopStreamEncryption
, stopStreamEncryption_streamName
- The name of the stream on which to stop encrypting records.
StopStreamEncryption
, stopStreamEncryption_encryptionType
- The encryption type. The only valid value is KMS
.
StopStreamEncryption
, stopStreamEncryption_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 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
Request Lenses
stopStreamEncryption_streamARN :: Lens' StopStreamEncryption (Maybe Text) Source #
The ARN of the stream.
stopStreamEncryption_streamName :: Lens' StopStreamEncryption (Maybe Text) Source #
The name of the stream on which to stop encrypting records.
stopStreamEncryption_encryptionType :: Lens' StopStreamEncryption EncryptionType Source #
The encryption type. The only valid value is KMS
.
stopStreamEncryption_keyId :: Lens' StopStreamEncryption Text Source #
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
Destructuring the Response
data StopStreamEncryptionResponse Source #
See: newStopStreamEncryptionResponse
smart constructor.
Instances
newStopStreamEncryptionResponse :: StopStreamEncryptionResponse Source #
Create a value of StopStreamEncryptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.