AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::KMS::Model::GrantConstraints Class Reference

#include <GrantConstraints.h>

Public Member Functions

 GrantConstraints ()
 
 GrantConstraints (Aws::Utils::Json::JsonView jsonValue)
 
GrantConstraintsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Map< Aws::String, Aws::String > & GetEncryptionContextSubset () const
 
bool EncryptionContextSubsetHasBeenSet () const
 
void SetEncryptionContextSubset (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetEncryptionContextSubset (Aws::Map< Aws::String, Aws::String > &&value)
 
GrantConstraintsWithEncryptionContextSubset (const Aws::Map< Aws::String, Aws::String > &value)
 
GrantConstraintsWithEncryptionContextSubset (Aws::Map< Aws::String, Aws::String > &&value)
 
GrantConstraintsAddEncryptionContextSubset (const Aws::String &key, const Aws::String &value)
 
GrantConstraintsAddEncryptionContextSubset (Aws::String &&key, const Aws::String &value)
 
GrantConstraintsAddEncryptionContextSubset (const Aws::String &key, Aws::String &&value)
 
GrantConstraintsAddEncryptionContextSubset (Aws::String &&key, Aws::String &&value)
 
GrantConstraintsAddEncryptionContextSubset (const char *key, Aws::String &&value)
 
GrantConstraintsAddEncryptionContextSubset (Aws::String &&key, const char *value)
 
GrantConstraintsAddEncryptionContextSubset (const char *key, const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetEncryptionContextEquals () const
 
bool EncryptionContextEqualsHasBeenSet () const
 
void SetEncryptionContextEquals (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetEncryptionContextEquals (Aws::Map< Aws::String, Aws::String > &&value)
 
GrantConstraintsWithEncryptionContextEquals (const Aws::Map< Aws::String, Aws::String > &value)
 
GrantConstraintsWithEncryptionContextEquals (Aws::Map< Aws::String, Aws::String > &&value)
 
GrantConstraintsAddEncryptionContextEquals (const Aws::String &key, const Aws::String &value)
 
GrantConstraintsAddEncryptionContextEquals (Aws::String &&key, const Aws::String &value)
 
GrantConstraintsAddEncryptionContextEquals (const Aws::String &key, Aws::String &&value)
 
GrantConstraintsAddEncryptionContextEquals (Aws::String &&key, Aws::String &&value)
 
GrantConstraintsAddEncryptionContextEquals (const char *key, Aws::String &&value)
 
GrantConstraintsAddEncryptionContextEquals (Aws::String &&key, const char *value)
 
GrantConstraintsAddEncryptionContextEquals (const char *key, const char *value)
 

Detailed Description

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 .

See Also:

AWS API Reference

Definition at line 56 of file GrantConstraints.h.

Constructor & Destructor Documentation

◆ GrantConstraints() [1/2]

Aws::KMS::Model::GrantConstraints::GrantConstraints ( )

◆ GrantConstraints() [2/2]

Aws::KMS::Model::GrantConstraints::GrantConstraints ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddEncryptionContextEquals() [1/7]

GrantConstraints& Aws::KMS::Model::GrantConstraints::AddEncryptionContextEquals ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 257 of file GrantConstraints.h.

◆ AddEncryptionContextEquals() [2/7]

GrantConstraints& Aws::KMS::Model::GrantConstraints::AddEncryptionContextEquals ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 266 of file GrantConstraints.h.

◆ AddEncryptionContextEquals() [3/7]

GrantConstraints& Aws::KMS::Model::GrantConstraints::AddEncryptionContextEquals ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 275 of file GrantConstraints.h.

◆ AddEncryptionContextEquals() [4/7]

GrantConstraints& Aws::KMS::Model::GrantConstraints::AddEncryptionContextEquals ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 284 of file GrantConstraints.h.

◆ AddEncryptionContextEquals() [5/7]

GrantConstraints& Aws::KMS::Model::GrantConstraints::AddEncryptionContextEquals ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 293 of file GrantConstraints.h.

◆ AddEncryptionContextEquals() [6/7]

GrantConstraints& Aws::KMS::Model::GrantConstraints::AddEncryptionContextEquals ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 302 of file GrantConstraints.h.

◆ AddEncryptionContextEquals() [7/7]

GrantConstraints& Aws::KMS::Model::GrantConstraints::AddEncryptionContextEquals ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 311 of file GrantConstraints.h.

◆ AddEncryptionContextSubset() [1/7]

GrantConstraints& Aws::KMS::Model::GrantConstraints::AddEncryptionContextSubset ( const Aws::String key,
const Aws::String value 
)
inline

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.

Definition at line 133 of file GrantConstraints.h.

◆ AddEncryptionContextSubset() [2/7]

GrantConstraints& Aws::KMS::Model::GrantConstraints::AddEncryptionContextSubset ( Aws::String &&  key,
const Aws::String value 
)
inline

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.

Definition at line 143 of file GrantConstraints.h.

◆ AddEncryptionContextSubset() [3/7]

GrantConstraints& Aws::KMS::Model::GrantConstraints::AddEncryptionContextSubset ( const Aws::String key,
Aws::String &&  value 
)
inline

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.

Definition at line 153 of file GrantConstraints.h.

◆ AddEncryptionContextSubset() [4/7]

GrantConstraints& Aws::KMS::Model::GrantConstraints::AddEncryptionContextSubset ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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.

Definition at line 163 of file GrantConstraints.h.

◆ AddEncryptionContextSubset() [5/7]

GrantConstraints& Aws::KMS::Model::GrantConstraints::AddEncryptionContextSubset ( const char *  key,
Aws::String &&  value 
)
inline

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.

Definition at line 173 of file GrantConstraints.h.

◆ AddEncryptionContextSubset() [6/7]

GrantConstraints& Aws::KMS::Model::GrantConstraints::AddEncryptionContextSubset ( Aws::String &&  key,
const char *  value 
)
inline

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.

Definition at line 183 of file GrantConstraints.h.

◆ AddEncryptionContextSubset() [7/7]

GrantConstraints& Aws::KMS::Model::GrantConstraints::AddEncryptionContextSubset ( const char *  key,
const char *  value 
)
inline

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.

Definition at line 193 of file GrantConstraints.h.

◆ EncryptionContextEqualsHasBeenSet()

bool Aws::KMS::Model::GrantConstraints::EncryptionContextEqualsHasBeenSet ( ) const
inline

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.

Definition at line 212 of file GrantConstraints.h.

◆ EncryptionContextSubsetHasBeenSet()

bool Aws::KMS::Model::GrantConstraints::EncryptionContextSubsetHasBeenSet ( ) const
inline

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.

Definition at line 83 of file GrantConstraints.h.

◆ GetEncryptionContextEquals()

const Aws::Map<Aws::String, Aws::String>& Aws::KMS::Model::GrantConstraints::GetEncryptionContextEquals ( ) const
inline

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.

Definition at line 203 of file GrantConstraints.h.

◆ GetEncryptionContextSubset()

const Aws::Map<Aws::String, Aws::String>& Aws::KMS::Model::GrantConstraints::GetEncryptionContextSubset ( ) const
inline

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.

Definition at line 73 of file GrantConstraints.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::KMS::Model::GrantConstraints::Jsonize ( ) const

◆ operator=()

GrantConstraints& Aws::KMS::Model::GrantConstraints::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetEncryptionContextEquals() [1/2]

void Aws::KMS::Model::GrantConstraints::SetEncryptionContextEquals ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 221 of file GrantConstraints.h.

◆ SetEncryptionContextEquals() [2/2]

void Aws::KMS::Model::GrantConstraints::SetEncryptionContextEquals ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 230 of file GrantConstraints.h.

◆ SetEncryptionContextSubset() [1/2]

void Aws::KMS::Model::GrantConstraints::SetEncryptionContextSubset ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 93 of file GrantConstraints.h.

◆ SetEncryptionContextSubset() [2/2]

void Aws::KMS::Model::GrantConstraints::SetEncryptionContextSubset ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 103 of file GrantConstraints.h.

◆ WithEncryptionContextEquals() [1/2]

GrantConstraints& Aws::KMS::Model::GrantConstraints::WithEncryptionContextEquals ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 239 of file GrantConstraints.h.

◆ WithEncryptionContextEquals() [2/2]

GrantConstraints& Aws::KMS::Model::GrantConstraints::WithEncryptionContextEquals ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 248 of file GrantConstraints.h.

◆ WithEncryptionContextSubset() [1/2]

GrantConstraints& Aws::KMS::Model::GrantConstraints::WithEncryptionContextSubset ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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.

Definition at line 113 of file GrantConstraints.h.

◆ WithEncryptionContextSubset() [2/2]

GrantConstraints& Aws::KMS::Model::GrantConstraints::WithEncryptionContextSubset ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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.

Definition at line 123 of file GrantConstraints.h.


The documentation for this class was generated from the following file: