| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Kinesis.StopStreamEncryption
Description
Disables server-side encryption for a specified stream.
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 :: Text -> EncryptionType -> Text -> StopStreamEncryption
- stopStreamEncryption_streamName :: Lens' StopStreamEncryption 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.
Constructors
| StopStreamEncryption' | |
Fields
| |
Instances
newStopStreamEncryption Source #
Arguments
| :: Text | |
| -> EncryptionType | |
| -> Text | |
| -> StopStreamEncryption |
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:
$sel:streamName:StopStreamEncryption', stopStreamEncryption_streamName - The name of the stream on which to stop encrypting records.
$sel:encryptionType:StopStreamEncryption', stopStreamEncryption_encryptionType - The encryption type. The only valid value is KMS.
$sel:keyId:StopStreamEncryption', stopStreamEncryption_keyId - 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
Request Lenses
stopStreamEncryption_streamName :: Lens' StopStreamEncryption 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 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
Destructuring the Response
data StopStreamEncryptionResponse Source #
See: newStopStreamEncryptionResponse smart constructor.
Constructors
| StopStreamEncryptionResponse' | |
Instances
| Eq StopStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StopStreamEncryption Methods (==) :: StopStreamEncryptionResponse -> StopStreamEncryptionResponse -> Bool # (/=) :: StopStreamEncryptionResponse -> StopStreamEncryptionResponse -> Bool # | |
| Read StopStreamEncryptionResponse Source # | |
| Show StopStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StopStreamEncryption Methods showsPrec :: Int -> StopStreamEncryptionResponse -> ShowS # show :: StopStreamEncryptionResponse -> String # showList :: [StopStreamEncryptionResponse] -> ShowS # | |
| Generic StopStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StopStreamEncryption Associated Types type Rep StopStreamEncryptionResponse :: Type -> Type # | |
| NFData StopStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StopStreamEncryption Methods rnf :: StopStreamEncryptionResponse -> () # | |
| type Rep StopStreamEncryptionResponse Source # | |
Defined in Amazonka.Kinesis.StopStreamEncryption | |
newStopStreamEncryptionResponse :: StopStreamEncryptionResponse Source #
Create a value of StopStreamEncryptionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.