amazonka-kinesis-1.6.0: Amazon Kinesis SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Kinesis.StopStreamEncryption

Contents

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

Creating a Request

stopStreamEncryption #

Creates a value of StopStreamEncryption with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • sseStreamName - The name of the stream on which to stop encrypting records.
  • sseEncryptionType - The encryption type. The only valid value is KMS .
  • sseKeyId - 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 @awskinesis . * Key ARN example: arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012 * Alias ARN example: arn:aws:kms:us-east-1:123456789012:aliasMyAliasName * Globally unique key ID example: 12345678-1234-1234-1234-123456789012 * Alias name example: aliasMyAliasName * Master key owned by Kinesis Data Streams: aliasaws/kinesis@

data StopStreamEncryption #

See: stopStreamEncryption smart constructor.

Instances

Eq StopStreamEncryption # 
Data StopStreamEncryption # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StopStreamEncryption -> c StopStreamEncryption #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StopStreamEncryption #

toConstr :: StopStreamEncryption -> Constr #

dataTypeOf :: StopStreamEncryption -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StopStreamEncryption) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StopStreamEncryption) #

gmapT :: (forall b. Data b => b -> b) -> StopStreamEncryption -> StopStreamEncryption #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StopStreamEncryption -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StopStreamEncryption -> r #

gmapQ :: (forall d. Data d => d -> u) -> StopStreamEncryption -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> StopStreamEncryption -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StopStreamEncryption -> m StopStreamEncryption #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StopStreamEncryption -> m StopStreamEncryption #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StopStreamEncryption -> m StopStreamEncryption #

Read StopStreamEncryption # 
Show StopStreamEncryption # 
Generic StopStreamEncryption # 
Hashable StopStreamEncryption # 
ToJSON StopStreamEncryption # 
NFData StopStreamEncryption # 

Methods

rnf :: StopStreamEncryption -> () #

AWSRequest StopStreamEncryption # 
ToHeaders StopStreamEncryption # 
ToPath StopStreamEncryption # 
ToQuery StopStreamEncryption # 
type Rep StopStreamEncryption # 
type Rep StopStreamEncryption = D1 * (MetaData "StopStreamEncryption" "Network.AWS.Kinesis.StopStreamEncryption" "amazonka-kinesis-1.6.0-AMlDcsmqKN4oWDRc0mjTF" False) (C1 * (MetaCons "StopStreamEncryption'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sseStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_sseEncryptionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * EncryptionType)) (S1 * (MetaSel (Just Symbol "_sseKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))
type Rs StopStreamEncryption # 

Request Lenses

sseStreamName :: Lens' StopStreamEncryption Text #

The name of the stream on which to stop encrypting records.

sseEncryptionType :: Lens' StopStreamEncryption EncryptionType #

The encryption type. The only valid value is KMS .

sseKeyId :: Lens' StopStreamEncryption Text #

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 @awskinesis . * Key ARN example: arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012 * Alias ARN example: arn:aws:kms:us-east-1:123456789012:aliasMyAliasName * Globally unique key ID example: 12345678-1234-1234-1234-123456789012 * Alias name example: aliasMyAliasName * Master key owned by Kinesis Data Streams: aliasaws/kinesis@

Destructuring the Response

stopStreamEncryptionResponse :: StopStreamEncryptionResponse #

Creates a value of StopStreamEncryptionResponse with the minimum fields required to make a request.

data StopStreamEncryptionResponse #

See: stopStreamEncryptionResponse smart constructor.

Instances

Eq StopStreamEncryptionResponse # 
Data StopStreamEncryptionResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StopStreamEncryptionResponse -> c StopStreamEncryptionResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StopStreamEncryptionResponse #

toConstr :: StopStreamEncryptionResponse -> Constr #

dataTypeOf :: StopStreamEncryptionResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StopStreamEncryptionResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StopStreamEncryptionResponse) #

gmapT :: (forall b. Data b => b -> b) -> StopStreamEncryptionResponse -> StopStreamEncryptionResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StopStreamEncryptionResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StopStreamEncryptionResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> StopStreamEncryptionResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> StopStreamEncryptionResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StopStreamEncryptionResponse -> m StopStreamEncryptionResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StopStreamEncryptionResponse -> m StopStreamEncryptionResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StopStreamEncryptionResponse -> m StopStreamEncryptionResponse #

Read StopStreamEncryptionResponse # 
Show StopStreamEncryptionResponse # 
Generic StopStreamEncryptionResponse # 
NFData StopStreamEncryptionResponse # 
type Rep StopStreamEncryptionResponse # 
type Rep StopStreamEncryptionResponse = D1 * (MetaData "StopStreamEncryptionResponse" "Network.AWS.Kinesis.StopStreamEncryption" "amazonka-kinesis-1.6.0-AMlDcsmqKN4oWDRc0mjTF" False) (C1 * (MetaCons "StopStreamEncryptionResponse'" PrefixI False) (U1 *))