Network.AWS.KMS.CreateKey

Creates a customer master key. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see GenerateDataKey and GenerateDataKeyWithoutPlaintext.

Creating a Request

createKey :: CreateKey

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

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

• ckKeyUsage
• ckPolicy
• ckDescription

data CreateKey

See: createKey smart constructor.

Instances

Eq CreateKey

Methods

(==) :: CreateKey -> CreateKey -> Bool

(/=) :: CreateKey -> CreateKey -> Bool

Data CreateKey

Methods

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

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

toConstr :: CreateKey -> Constr

dataTypeOf :: CreateKey -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> CreateKey -> CreateKey

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

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

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

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

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

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

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

Read CreateKey

Methods

readsPrec :: Int -> ReadS CreateKey

readList :: ReadS [CreateKey]

readPrec :: ReadPrec CreateKey

readListPrec :: ReadPrec [CreateKey]

Show CreateKey

Methods

showsPrec :: Int -> CreateKey -> ShowS

show :: CreateKey -> String

showList :: [CreateKey] -> ShowS

Generic CreateKey

Associated Types

type Rep CreateKey :: * -> *

Methods

from :: CreateKey -> Rep CreateKey x

to :: Rep CreateKey x -> CreateKey

Hashable CreateKey

Methods

hashWithSalt :: Int -> CreateKey -> Int

hash :: CreateKey -> Int

ToJSON CreateKey

Methods

toJSON :: CreateKey -> Value

toEncoding :: CreateKey -> Encoding

toJSONList :: [CreateKey] -> Value

toEncodingList :: [CreateKey] -> Encoding

NFData CreateKey

Methods

rnf :: CreateKey -> ()

AWSRequest CreateKey

Associated Types

type Rs CreateKey :: *

Methods

request :: CreateKey -> Request CreateKey

response :: MonadResource m => Logger -> Service -> Proxy * CreateKey -> ClientResponse -> m (Response CreateKey)

ToQuery CreateKey

Methods

toQuery :: CreateKey -> QueryString

ToPath CreateKey

Methods

toPath :: CreateKey -> ByteString

ToHeaders CreateKey

Methods

toHeaders :: CreateKey -> [Header]

type Rep CreateKey

type Rep CreateKey = D1 (MetaData "CreateKey" "Network.AWS.KMS.CreateKey" "amazonka-kms-1.4.1-GF628EecSPSCenC7tCeKjK" False) (C1 (MetaCons "CreateKey'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ckKeyUsage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe KeyUsageType))) ((:*:) (S1 (MetaSel (Just Symbol "_ckPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ckDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Rs CreateKey

type Rs CreateKey = CreateKeyResponse

Request Lenses

ckKeyUsage :: Lens' CreateKey (Maybe KeyUsageType)

Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.

ckPolicy :: Lens' CreateKey (Maybe Text)

Policy to attach to the key. This is required and delegates back to the account. The key is the root of trust. The policy size limit is 32 KiB (32768 bytes).

ckDescription :: Lens' CreateKey (Maybe Text)

Description of the key. We recommend that you choose a description that helps your customer decide whether the key is appropriate for a task.

Destructuring the Response

createKeyResponse

Arguments

:: Int

ckrsResponseStatus

-> CreateKeyResponse

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

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

• ckrsKeyMetadata
• ckrsResponseStatus

data CreateKeyResponse

See: createKeyResponse smart constructor.

Instances

Eq CreateKeyResponse

Methods

(==) :: CreateKeyResponse -> CreateKeyResponse -> Bool

(/=) :: CreateKeyResponse -> CreateKeyResponse -> Bool

Data CreateKeyResponse

Methods

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

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

toConstr :: CreateKeyResponse -> Constr

dataTypeOf :: CreateKeyResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> CreateKeyResponse -> CreateKeyResponse

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

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

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

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

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

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

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

Read CreateKeyResponse

Methods

readsPrec :: Int -> ReadS CreateKeyResponse

readList :: ReadS [CreateKeyResponse]

readPrec :: ReadPrec CreateKeyResponse

readListPrec :: ReadPrec [CreateKeyResponse]

Show CreateKeyResponse

Methods

showsPrec :: Int -> CreateKeyResponse -> ShowS

show :: CreateKeyResponse -> String

showList :: [CreateKeyResponse] -> ShowS

Generic CreateKeyResponse

Associated Types

type Rep CreateKeyResponse :: * -> *

Methods

from :: CreateKeyResponse -> Rep CreateKeyResponse x

to :: Rep CreateKeyResponse x -> CreateKeyResponse

NFData CreateKeyResponse

Methods

rnf :: CreateKeyResponse -> ()

type Rep CreateKeyResponse

type Rep CreateKeyResponse = D1 (MetaData "CreateKeyResponse" "Network.AWS.KMS.CreateKey" "amazonka-kms-1.4.1-GF628EecSPSCenC7tCeKjK" False) (C1 (MetaCons "CreateKeyResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ckrsKeyMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe KeyMetadata))) (S1 (MetaSel (Just Symbol "_ckrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

ckrsKeyMetadata :: Lens' CreateKeyResponse (Maybe KeyMetadata)

Metadata associated with the key.

ckrsResponseStatus :: Lens' CreateKeyResponse Int

The response status code.