Network.AWS.KMS.PutKeyPolicy

Attaches a key policy to the specified customer master key (CMK).

For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide .

Creating a Request

putKeyPolicy

Arguments

:: Text

pkpKeyId

-> Text

pkpPolicyName

-> Text

pkpPolicy

-> PutKeyPolicy

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

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

• pkpBypassPolicyLockoutSafetyCheck - A flag to indicate whether to bypass the key policy lockout safety check. Important: Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide . Use this parameter only when you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK. The default value is false.
• pkpKeyId - A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example: * Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab * ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
• pkpPolicyName - The name of the key policy. This value must be default .
• pkpPolicy - The key policy to attach to the CMK. If you do not set BypassPolicyLockoutSafetyCheck to true, the policy must meet the following criteria: * It must allow the principal making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide . * The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide . The policy size limit is 32 KiB (32768 bytes).

data PutKeyPolicy

See: putKeyPolicy smart constructor.

Instances

Eq PutKeyPolicy

Methods

(==) :: PutKeyPolicy -> PutKeyPolicy -> Bool

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

Data PutKeyPolicy

Methods

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

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

toConstr :: PutKeyPolicy -> Constr

dataTypeOf :: PutKeyPolicy -> DataType

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

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

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

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

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

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

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

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

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

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

Read PutKeyPolicy

Methods

readsPrec :: Int -> ReadS PutKeyPolicy

readList :: ReadS [PutKeyPolicy]

readPrec :: ReadPrec PutKeyPolicy

readListPrec :: ReadPrec [PutKeyPolicy]

Show PutKeyPolicy

Methods

showsPrec :: Int -> PutKeyPolicy -> ShowS

show :: PutKeyPolicy -> String

showList :: [PutKeyPolicy] -> ShowS

Generic PutKeyPolicy

Associated Types

type Rep PutKeyPolicy :: * -> *

Methods

from :: PutKeyPolicy -> Rep PutKeyPolicy x

to :: Rep PutKeyPolicy x -> PutKeyPolicy

Hashable PutKeyPolicy

Methods

hashWithSalt :: Int -> PutKeyPolicy -> Int

hash :: PutKeyPolicy -> Int

ToJSON PutKeyPolicy

Methods

toJSON :: PutKeyPolicy -> Value

toEncoding :: PutKeyPolicy -> Encoding

toJSONList :: [PutKeyPolicy] -> Value

toEncodingList :: [PutKeyPolicy] -> Encoding

NFData PutKeyPolicy

Methods

rnf :: PutKeyPolicy -> ()

AWSRequest PutKeyPolicy

Associated Types

type Rs PutKeyPolicy :: *

Methods

request :: PutKeyPolicy -> Request PutKeyPolicy

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

ToPath PutKeyPolicy

Methods

toPath :: PutKeyPolicy -> ByteString

ToHeaders PutKeyPolicy

Methods

toHeaders :: PutKeyPolicy -> [Header]

ToQuery PutKeyPolicy

Methods

toQuery :: PutKeyPolicy -> QueryString

type Rep PutKeyPolicy

type Rep PutKeyPolicy = D1 (MetaData "PutKeyPolicy" "Network.AWS.KMS.PutKeyPolicy" "amazonka-kms-1.4.5-2CcuwPQYK1JBjEgZ8528Xg" False) (C1 (MetaCons "PutKeyPolicy'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pkpBypassPolicyLockoutSafetyCheck") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_pkpKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_pkpPolicyName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_pkpPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs PutKeyPolicy

type Rs PutKeyPolicy = PutKeyPolicyResponse

Request Lenses

pkpBypassPolicyLockoutSafetyCheck :: Lens' PutKeyPolicy (Maybe Bool)

A flag to indicate whether to bypass the key policy lockout safety check. Important: Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide . Use this parameter only when you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK. The default value is false.

pkpKeyId :: Lens' PutKeyPolicy Text

A unique identifier for the CMK. Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example: * Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab * ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

pkpPolicyName :: Lens' PutKeyPolicy Text

The name of the key policy. This value must be default .

pkpPolicy :: Lens' PutKeyPolicy Text

The key policy to attach to the CMK. If you do not set BypassPolicyLockoutSafetyCheck to true, the policy must meet the following criteria: * It must allow the principal making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide . * The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide . The policy size limit is 32 KiB (32768 bytes).

Destructuring the Response

putKeyPolicyResponse :: PutKeyPolicyResponse

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

data PutKeyPolicyResponse

See: putKeyPolicyResponse smart constructor.

Instances

Eq PutKeyPolicyResponse

Methods

(==) :: PutKeyPolicyResponse -> PutKeyPolicyResponse -> Bool

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

Data PutKeyPolicyResponse

Methods

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

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

toConstr :: PutKeyPolicyResponse -> Constr

dataTypeOf :: PutKeyPolicyResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read PutKeyPolicyResponse

Methods

readsPrec :: Int -> ReadS PutKeyPolicyResponse

readList :: ReadS [PutKeyPolicyResponse]

readPrec :: ReadPrec PutKeyPolicyResponse

readListPrec :: ReadPrec [PutKeyPolicyResponse]

Show PutKeyPolicyResponse

Methods

showsPrec :: Int -> PutKeyPolicyResponse -> ShowS

show :: PutKeyPolicyResponse -> String

showList :: [PutKeyPolicyResponse] -> ShowS

Generic PutKeyPolicyResponse

Associated Types

type Rep PutKeyPolicyResponse :: * -> *

Methods

from :: PutKeyPolicyResponse -> Rep PutKeyPolicyResponse x

to :: Rep PutKeyPolicyResponse x -> PutKeyPolicyResponse

NFData PutKeyPolicyResponse

Methods

rnf :: PutKeyPolicyResponse -> ()

type Rep PutKeyPolicyResponse

type Rep PutKeyPolicyResponse = D1 (MetaData "PutKeyPolicyResponse" "Network.AWS.KMS.PutKeyPolicy" "amazonka-kms-1.4.5-2CcuwPQYK1JBjEgZ8528Xg" False) (C1 (MetaCons "PutKeyPolicyResponse'" PrefixI False) U1)