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

Amazonka.Kinesis.StartStreamEncryption

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Enables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream.

Starting 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. Updating or applying 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, encryption begins for records written to the stream.

API Limits: You can successfully apply a new Amazon Web Services KMS key for 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 encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from PutRecord or PutRecords.

When invoking this API, it is recommended you use the StreamARN input parameter rather than the StreamName input parameter.

Creating a Request

data StartStreamEncryption Source #

See: newStartStreamEncryption smart constructor.

Constructors

StartStreamEncryption'

Fields

streamARN :: Maybe Text
The ARN of the stream.
streamName :: Maybe Text
The name of the stream for which to start encrypting records.
encryptionType :: EncryptionType
The encryption type to use. The only valid value is KMS.
keyId :: Text
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

Instances

Instances details

ToJSON StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods toJSON :: StartStreamEncryption -> Value # toEncoding :: StartStreamEncryption -> Encoding # toJSONList :: [StartStreamEncryption] -> Value # toEncodingList :: [StartStreamEncryption] -> Encoding #
ToHeaders StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods toHeaders :: StartStreamEncryption -> [Header] #
ToPath StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods toPath :: StartStreamEncryption -> ByteString #
ToQuery StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods toQuery :: StartStreamEncryption -> QueryString #
AWSRequest StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Associated Types type AWSResponse StartStreamEncryption # Methods request :: (Service -> Service) -> StartStreamEncryption -> Request StartStreamEncryption # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartStreamEncryption -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartStreamEncryption))) #
Generic StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Associated Types type Rep StartStreamEncryption :: Type -> Type # Methods from :: StartStreamEncryption -> Rep StartStreamEncryption x # to :: Rep StartStreamEncryption x -> StartStreamEncryption #
Read StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods readsPrec :: Int -> ReadS StartStreamEncryption # readList :: ReadS [StartStreamEncryption] # readPrec :: ReadPrec StartStreamEncryption # readListPrec :: ReadPrec [StartStreamEncryption] #
Show StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods showsPrec :: Int -> StartStreamEncryption -> ShowS # show :: StartStreamEncryption -> String # showList :: [StartStreamEncryption] -> ShowS #
NFData StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods rnf :: StartStreamEncryption -> () #
Eq StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods (==) :: StartStreamEncryption -> StartStreamEncryption -> Bool # (/=) :: StartStreamEncryption -> StartStreamEncryption -> Bool #
Hashable StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods hashWithSalt :: Int -> StartStreamEncryption -> Int # hash :: StartStreamEncryption -> Int #
type AWSResponse StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption type AWSResponse StartStreamEncryption = StartStreamEncryptionResponse
type Rep StartStreamEncryption Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption type Rep StartStreamEncryption = D1 ('MetaData "StartStreamEncryption" "Amazonka.Kinesis.StartStreamEncryption" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "StartStreamEncryption'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "streamARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "encryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncryptionType) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStartStreamEncryption Source #

Arguments

:: EncryptionType	`StartStreamEncryption`
-> Text	`StartStreamEncryption`
-> StartStreamEncryption

Create a value of StartStreamEncryption 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:

StartStreamEncryption, startStreamEncryption_streamARN - The ARN of the stream.

StartStreamEncryption, startStreamEncryption_streamName - The name of the stream for which to start encrypting records.

StartStreamEncryption, startStreamEncryption_encryptionType - The encryption type to use. The only valid value is KMS.

StartStreamEncryption, startStreamEncryption_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

startStreamEncryption_streamARN :: Lens' StartStreamEncryption (Maybe Text) Source #

The ARN of the stream.

startStreamEncryption_streamName :: Lens' StartStreamEncryption (Maybe Text) Source #

The name of the stream for which to start encrypting records.

startStreamEncryption_encryptionType :: Lens' StartStreamEncryption EncryptionType Source #

The encryption type to use. The only valid value is KMS.

startStreamEncryption_keyId :: Lens' StartStreamEncryption 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 StartStreamEncryptionResponse Source #

See: newStartStreamEncryptionResponse smart constructor.

Constructors

StartStreamEncryptionResponse'

Instances

Instances details

Generic StartStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Associated Types type Rep StartStreamEncryptionResponse :: Type -> Type # Methods from :: StartStreamEncryptionResponse -> Rep StartStreamEncryptionResponse x # to :: Rep StartStreamEncryptionResponse x -> StartStreamEncryptionResponse #
Read StartStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods readsPrec :: Int -> ReadS StartStreamEncryptionResponse # readList :: ReadS [StartStreamEncryptionResponse] # readPrec :: ReadPrec StartStreamEncryptionResponse # readListPrec :: ReadPrec [StartStreamEncryptionResponse] #
Show StartStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods showsPrec :: Int -> StartStreamEncryptionResponse -> ShowS # show :: StartStreamEncryptionResponse -> String # showList :: [StartStreamEncryptionResponse] -> ShowS #
NFData StartStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods rnf :: StartStreamEncryptionResponse -> () #
Eq StartStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption Methods (==) :: StartStreamEncryptionResponse -> StartStreamEncryptionResponse -> Bool # (/=) :: StartStreamEncryptionResponse -> StartStreamEncryptionResponse -> Bool #
type Rep StartStreamEncryptionResponse Source #
Instance details Defined in Amazonka.Kinesis.StartStreamEncryption type Rep StartStreamEncryptionResponse = D1 ('MetaData "StartStreamEncryptionResponse" "Amazonka.Kinesis.StartStreamEncryption" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "StartStreamEncryptionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newStartStreamEncryptionResponse :: StartStreamEncryptionResponse Source #

Create a value of StartStreamEncryptionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.