/AWS1/CL_KMSGRANTCONSTRAINTS

Use this structure to allow cryptographic operations in the grant only when the operation request meets the specified constraints.

KMS supports the following grant constraints:

• EncryptionContextEquals and EncryptionContextSubset — These encryption context constraints apply only to cryptographic operations that support an encryption context, that is, all cryptographic operations with a symmetric KMS key. Encryption context grant constraints are not applied to operations that do not support an encryption context, such as cryptographic operations with asymmetric KMS keys and management operations, such as DescribeKey or RetireGrant.

  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:context-key in the Key Management Service Developer Guide .

• SourceArn — This grant constraint allows the permissions in the grant only when the request is made on behalf of a specific Amazon Web Services resource, identified by its Amazon Resource Name (ARN). This is effectively the same as having the aws:SourceArn global condition key in the grant. The SourceArn constraint is supported on grants for all types of KMS keys and can also be applied to the DescribeKey operation when specified in the request. However, it does not apply to RetireGrant operation.

CONSTRUCTOR

IMPORTING

Optional arguments:

it_encryptioncontextsubset TYPE /AWS1/CL_KMSENCCONTEXTTYPE_W=>TT_ENCRYPTIONCONTEXTTYPE TT_ENCRYPTIONCONTEXTTYPE

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.

it_encryptioncontextequals TYPE /AWS1/CL_KMSENCCONTEXTTYPE_W=>TT_ENCRYPTIONCONTEXTTYPE TT_ENCRYPTIONCONTEXTTYPE

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.

iv_sourcearn TYPE /AWS1/KMSGRANTCNSTRNTSRCARNTYP /AWS1/KMSGRANTCNSTRNTSRCARNTYP

The Amazon Resource Name (ARN) of an Amazon Web Services resource on behalf of which the request is made. This is effectively the same as having the aws:SourceArn global condition key in the grant. The SourceArn constraint ensures that the principal can use the KMS key only when the request is made on behalf of the specified resource.

---

Queryable Attributes

EncryptionContextSubset

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.

Accessible with the following methods

Method	Description
GET_ENCRYPTIONCONTEXTSUBSET()	Getter for ENCRYPTIONCONTEXTSUBSET, with configurable defaul
ASK_ENCRYPTIONCONTEXTSUBSET()	Getter for ENCRYPTIONCONTEXTSUBSET w/ exceptions if field ha
HAS_ENCRYPTIONCONTEXTSUBSET()	Determine if ENCRYPTIONCONTEXTSUBSET has a value

EncryptionContextEquals

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.

Accessible with the following methods

Method	Description
GET_ENCRYPTIONCONTEXTEQUALS()	Getter for ENCRYPTIONCONTEXTEQUALS, with configurable defaul
ASK_ENCRYPTIONCONTEXTEQUALS()	Getter for ENCRYPTIONCONTEXTEQUALS w/ exceptions if field ha
HAS_ENCRYPTIONCONTEXTEQUALS()	Determine if ENCRYPTIONCONTEXTEQUALS has a value

SourceArn

The Amazon Resource Name (ARN) of an Amazon Web Services resource on behalf of which the request is made. This is effectively the same as having the aws:SourceArn global condition key in the grant. The SourceArn constraint ensures that the principal can use the KMS key only when the request is made on behalf of the specified resource.

Accessible with the following methods

Method	Description
GET_SOURCEARN()	Getter for SOURCEARN, with configurable default
ASK_SOURCEARN()	Getter for SOURCEARN w/ exceptions if field has no value
HAS_SOURCEARN()	Determine if SOURCEARN has a value