You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::KMS::Types::GrantConstraints

Inherits:

Struct

Object
Struct
Aws::KMS::Types::GrantConstraints

show all

Defined in:: (unknown)

Overview

Note:

When passing GrantConstraints as input to an Aws::Client method, you can use a vanilla Hash:

{
  encryption_context_subset: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  encryption_context_equals: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
}

Use this structure to allow cryptographic operations in the grant only when the operation request includes the specified encryption context.

AWS KMS applies the grant constraints only to cryptographic operations that support an encryption context, that is, all cryptographic operations with a symmetric CMK. Grant constraints are not applied to operations that do not support an encryption context, such as cryptographic operations with asymmetric CMKs and management operations, such as DescribeKey or ScheduleKeyDeletion.

In a cryptographic operation, the encryption context in the decryption operation must be an exact, case-sensitive match for the keys and values in the encryption context of the encryption operation. Only the order of the pairs can vary.

However, in a grant constraint, the key in each key-value pair is not case sensitive, but the value is case sensitive.

To avoid confusion, do not use multiple encryption context pairs that differ only by case. To require a fully case-sensitive encryption context, use the kms:EncryptionContext: and kms:EncryptionContextKeys conditions in an IAM or key policy. For details, see kms:EncryptionContext: in the AWS Key Management Service Developer Guide .

Returned by:

Instance Attribute Summary collapse

#encryption_context_equals ⇒ Hash<String,String>
A list of key-value pairs that must match the encryption context in the [cryptographic operation][1] request.
#encryption_context_subset ⇒ Hash<String,String>
A list of key-value pairs that must be included in the encryption context of the [cryptographic operation][1] request.

Instance Attribute Details

#encryption_context_equals ⇒ `Hash<String,String>`

A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.

Returns:

(Hash<String,String>) —
A list of key-value pairs that must match the encryption context in the [cryptographic operation][1] request.

#encryption_context_subset ⇒ `Hash<String,String>`

A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.