class Amazonite::Kms::GrantConstraints

• Amazonite::Kms::GrantConstraints
• Reference
• Object

Overview

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.

Included Modules

• JSON::Serializable

Defined in:

kms/grant_constraints.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(encryption_context_subset : Hash(String, String) | Nil = nil, encryption_context_equals : Hash(String, String) | Nil = nil, source_arn : String | Nil = nil)
• .new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #encryption_context_equals : Hash(String, String) | Nil

  A list of key-value pairs that must match the encryption context in the cryptographic operation request.

• #encryption_context_equals=(encryption_context_equals : Hash(String, String) | Nil)

  A list of key-value pairs that must match the encryption context in the cryptographic operation request.

• #encryption_context_subset : Hash(String, String) | Nil

  A list of key-value pairs that must be included in the encryption context of the cryptographic operation request.

• #encryption_context_subset=(encryption_context_subset : Hash(String, String) | Nil)

  A list of key-value pairs that must be included in the encryption context of the cryptographic operation request.

• #hash(hasher)

  See Object#hash(hasher)

• #source_arn : String | Nil

  The Amazon Resource Name (ARN) of an Amazon Web Services resource on behalf of which the request is made.

• #source_arn=(source_arn : String | Nil)

  The Amazon Resource Name (ARN) of an Amazon Web Services resource on behalf of which the request is made.

• #validate! : Nil

Constructor Detail

Instance Method Detail