Network.AWS.KMS.PutKeyPolicy

Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

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 risk 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 that is making the request from making a subsequent PutKeyPolicy request on the CMK. The default value is false.
• pkpKeyId - A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey .
• pkpPolicyName - The name of the key policy. The only valid value is default .
• pkpPolicy - The key policy to attach to the CMK. The key policy must meet the following criteria: * If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide . * Each statement in the key policy must contain one or more principals. The principals 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 including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide . The key policy size limit is 32 kilobytes (32768 bytes).

data PutKeyPolicy

See: putKeyPolicy smart constructor.

Instances

Eq PutKeyPolicy

Defined in Network.AWS.KMS.PutKeyPolicy

Methods

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

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

Data PutKeyPolicy

Defined in Network.AWS.KMS.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

Defined in Network.AWS.KMS.PutKeyPolicy

Methods

readsPrec :: Int -> ReadS PutKeyPolicy

readList :: ReadS [PutKeyPolicy]

readPrec :: ReadPrec PutKeyPolicy

readListPrec :: ReadPrec [PutKeyPolicy]

Show PutKeyPolicy

Defined in Network.AWS.KMS.PutKeyPolicy

Methods

showsPrec :: Int -> PutKeyPolicy -> ShowS

show :: PutKeyPolicy -> String

showList :: [PutKeyPolicy] -> ShowS

Generic PutKeyPolicy

Defined in Network.AWS.KMS.PutKeyPolicy

Associated Types

type Rep PutKeyPolicy :: Type -> Type

Methods

from :: PutKeyPolicy -> Rep PutKeyPolicy x

to :: Rep PutKeyPolicy x -> PutKeyPolicy

Hashable PutKeyPolicy

Defined in Network.AWS.KMS.PutKeyPolicy

Methods

hashWithSalt :: Int -> PutKeyPolicy -> Int

hash :: PutKeyPolicy -> Int

ToJSON PutKeyPolicy

Defined in Network.AWS.KMS.PutKeyPolicy

Methods

toJSON :: PutKeyPolicy -> Value

toEncoding :: PutKeyPolicy -> Encoding

toJSONList :: [PutKeyPolicy] -> Value

toEncodingList :: [PutKeyPolicy] -> Encoding

AWSRequest PutKeyPolicy

Defined in Network.AWS.KMS.PutKeyPolicy

Associated Types

type Rs PutKeyPolicy :: Type

Methods

request :: PutKeyPolicy -> Request PutKeyPolicy

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

ToHeaders PutKeyPolicy

Defined in Network.AWS.KMS.PutKeyPolicy

Methods

toHeaders :: PutKeyPolicy -> [Header]

ToPath PutKeyPolicy

Defined in Network.AWS.KMS.PutKeyPolicy

Methods

toPath :: PutKeyPolicy -> ByteString

ToQuery PutKeyPolicy

Defined in Network.AWS.KMS.PutKeyPolicy

Methods

toQuery :: PutKeyPolicy -> QueryString

NFData PutKeyPolicy

Defined in Network.AWS.KMS.PutKeyPolicy

Methods

rnf :: PutKeyPolicy -> ()

type Rep PutKeyPolicy

Defined in Network.AWS.KMS.PutKeyPolicy

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

type Rs PutKeyPolicy

Defined in Network.AWS.KMS.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 risk 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 that is 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 customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey .

pkpPolicyName :: Lens' PutKeyPolicy Text

The name of the key policy. The only valid value is default .

pkpPolicy :: Lens' PutKeyPolicy Text

The key policy to attach to the CMK. The key policy must meet the following criteria: * If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide . * Each statement in the key policy must contain one or more principals. The principals 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 including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide . The key policy size limit is 32 kilobytes (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

Defined in Network.AWS.KMS.PutKeyPolicy

Methods

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

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

Data PutKeyPolicyResponse

Defined in Network.AWS.KMS.PutKeyPolicy

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

Defined in Network.AWS.KMS.PutKeyPolicy

Methods

readsPrec :: Int -> ReadS PutKeyPolicyResponse

readList :: ReadS [PutKeyPolicyResponse]

readPrec :: ReadPrec PutKeyPolicyResponse

readListPrec :: ReadPrec [PutKeyPolicyResponse]

Show PutKeyPolicyResponse

Defined in Network.AWS.KMS.PutKeyPolicy

Methods

showsPrec :: Int -> PutKeyPolicyResponse -> ShowS

show :: PutKeyPolicyResponse -> String

showList :: [PutKeyPolicyResponse] -> ShowS

Generic PutKeyPolicyResponse

Defined in Network.AWS.KMS.PutKeyPolicy

Associated Types

type Rep PutKeyPolicyResponse :: Type -> Type

Methods

from :: PutKeyPolicyResponse -> Rep PutKeyPolicyResponse x

to :: Rep PutKeyPolicyResponse x -> PutKeyPolicyResponse

NFData PutKeyPolicyResponse

Defined in Network.AWS.KMS.PutKeyPolicy

Methods

rnf :: PutKeyPolicyResponse -> ()

type Rep PutKeyPolicyResponse

Defined in Network.AWS.KMS.PutKeyPolicy

type Rep PutKeyPolicyResponse = D1 (MetaData "PutKeyPolicyResponse" "Network.AWS.KMS.PutKeyPolicy" "amazonka-kms-1.6.1-1UDljZYfeha1jjHbbMax4v" False) (C1 (MetaCons "PutKeyPolicyResponse'" PrefixI False) (U1 :: Type -> Type))