Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.Kinesis.StopStreamEncryption

Contents

Creating a Request
Request Lenses
Destructuring the Response

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 .

Creating a Request

stopStreamEncryption #

Arguments

:: Text	`sseStreamName`
-> EncryptionType	`sseEncryptionType`
-> Text	`sseKeyId`
-> 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 #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Methods (==) :: StopStreamEncryption -> StopStreamEncryption -> Bool # (/=) :: StopStreamEncryption -> StopStreamEncryption -> Bool #
Data StopStreamEncryption #
Instance details Defined in Network.AWS.Kinesis.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 #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Methods readsPrec :: Int -> ReadS StopStreamEncryption # readList :: ReadS [StopStreamEncryption] # readPrec :: ReadPrec StopStreamEncryption # readListPrec :: ReadPrec [StopStreamEncryption] #
Show StopStreamEncryption #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Methods showsPrec :: Int -> StopStreamEncryption -> ShowS # show :: StopStreamEncryption -> String # showList :: [StopStreamEncryption] -> ShowS #
Generic StopStreamEncryption #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Associated Types type Rep StopStreamEncryption :: * -> * # Methods from :: StopStreamEncryption -> Rep StopStreamEncryption x # to :: Rep StopStreamEncryption x -> StopStreamEncryption #
Hashable StopStreamEncryption #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Methods hashWithSalt :: Int -> StopStreamEncryption -> Int # hash :: StopStreamEncryption -> Int #
ToJSON StopStreamEncryption #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Methods toJSON :: StopStreamEncryption -> Value # toEncoding :: StopStreamEncryption -> Encoding # toJSONList :: [StopStreamEncryption] -> Value # toEncodingList :: [StopStreamEncryption] -> Encoding #
AWSRequest StopStreamEncryption #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Associated Types type Rs StopStreamEncryption :: * # Methods request :: StopStreamEncryption -> Request StopStreamEncryption # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy StopStreamEncryption -> ClientResponse -> m (Response StopStreamEncryption) #
ToHeaders StopStreamEncryption #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Methods toHeaders :: StopStreamEncryption -> [Header] #
ToPath StopStreamEncryption #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Methods toPath :: StopStreamEncryption -> ByteString #
ToQuery StopStreamEncryption #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Methods toQuery :: StopStreamEncryption -> QueryString #
NFData StopStreamEncryption #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Methods rnf :: StopStreamEncryption -> () #
type Rep StopStreamEncryption #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption type Rep StopStreamEncryption = D1 (MetaData "StopStreamEncryption" "Network.AWS.Kinesis.StopStreamEncryption" "amazonka-kinesis-1.6.0-7CHFApk9twZE5kY7quU0Eh" False) (C1 (MetaCons "StopStreamEncryption'" PrefixI True) (S1 (MetaSel (Just "_sseStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_sseEncryptionType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 EncryptionType) :: S1 (MetaSel (Just "_sseKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs StopStreamEncryption #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption type Rs StopStreamEncryption = StopStreamEncryptionResponse

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 #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Methods (==) :: StopStreamEncryptionResponse -> StopStreamEncryptionResponse -> Bool # (/=) :: StopStreamEncryptionResponse -> StopStreamEncryptionResponse -> Bool #
Data StopStreamEncryptionResponse #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption 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 #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Methods readsPrec :: Int -> ReadS StopStreamEncryptionResponse # readList :: ReadS [StopStreamEncryptionResponse] # readPrec :: ReadPrec StopStreamEncryptionResponse # readListPrec :: ReadPrec [StopStreamEncryptionResponse] #
Show StopStreamEncryptionResponse #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Methods showsPrec :: Int -> StopStreamEncryptionResponse -> ShowS # show :: StopStreamEncryptionResponse -> String # showList :: [StopStreamEncryptionResponse] -> ShowS #
Generic StopStreamEncryptionResponse #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Associated Types type Rep StopStreamEncryptionResponse :: * -> * # Methods from :: StopStreamEncryptionResponse -> Rep StopStreamEncryptionResponse x # to :: Rep StopStreamEncryptionResponse x -> StopStreamEncryptionResponse #
NFData StopStreamEncryptionResponse #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption Methods rnf :: StopStreamEncryptionResponse -> () #
type Rep StopStreamEncryptionResponse #
Instance details Defined in Network.AWS.Kinesis.StopStreamEncryption type Rep StopStreamEncryptionResponse = D1 (MetaData "StopStreamEncryptionResponse" "Network.AWS.Kinesis.StopStreamEncryption" "amazonka-kinesis-1.6.0-7CHFApk9twZE5kY7quU0Eh" False) (C1 (MetaCons "StopStreamEncryptionResponse'" PrefixI False) (U1 :: * -> *))