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

#include <GrantListEntry.h>

Public Member Functions

 GrantListEntry ()
 
 GrantListEntry (Aws::Utils::Json::JsonView jsonValue)
 
GrantListEntryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetKeyId () const
 
bool KeyIdHasBeenSet () const
 
void SetKeyId (const Aws::String &value)
 
void SetKeyId (Aws::String &&value)
 
void SetKeyId (const char *value)
 
GrantListEntryWithKeyId (const Aws::String &value)
 
GrantListEntryWithKeyId (Aws::String &&value)
 
GrantListEntryWithKeyId (const char *value)
 
const Aws::StringGetGrantId () const
 
bool GrantIdHasBeenSet () const
 
void SetGrantId (const Aws::String &value)
 
void SetGrantId (Aws::String &&value)
 
void SetGrantId (const char *value)
 
GrantListEntryWithGrantId (const Aws::String &value)
 
GrantListEntryWithGrantId (Aws::String &&value)
 
GrantListEntryWithGrantId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
GrantListEntryWithName (const Aws::String &value)
 
GrantListEntryWithName (Aws::String &&value)
 
GrantListEntryWithName (const char *value)
 
const Aws::Utils::DateTimeGetCreationDate () const
 
bool CreationDateHasBeenSet () const
 
void SetCreationDate (const Aws::Utils::DateTime &value)
 
void SetCreationDate (Aws::Utils::DateTime &&value)
 
GrantListEntryWithCreationDate (const Aws::Utils::DateTime &value)
 
GrantListEntryWithCreationDate (Aws::Utils::DateTime &&value)
 
const Aws::StringGetGranteePrincipal () const
 
bool GranteePrincipalHasBeenSet () const
 
void SetGranteePrincipal (const Aws::String &value)
 
void SetGranteePrincipal (Aws::String &&value)
 
void SetGranteePrincipal (const char *value)
 
GrantListEntryWithGranteePrincipal (const Aws::String &value)
 
GrantListEntryWithGranteePrincipal (Aws::String &&value)
 
GrantListEntryWithGranteePrincipal (const char *value)
 
const Aws::StringGetRetiringPrincipal () const
 
bool RetiringPrincipalHasBeenSet () const
 
void SetRetiringPrincipal (const Aws::String &value)
 
void SetRetiringPrincipal (Aws::String &&value)
 
void SetRetiringPrincipal (const char *value)
 
GrantListEntryWithRetiringPrincipal (const Aws::String &value)
 
GrantListEntryWithRetiringPrincipal (Aws::String &&value)
 
GrantListEntryWithRetiringPrincipal (const char *value)
 
const Aws::StringGetIssuingAccount () const
 
bool IssuingAccountHasBeenSet () const
 
void SetIssuingAccount (const Aws::String &value)
 
void SetIssuingAccount (Aws::String &&value)
 
void SetIssuingAccount (const char *value)
 
GrantListEntryWithIssuingAccount (const Aws::String &value)
 
GrantListEntryWithIssuingAccount (Aws::String &&value)
 
GrantListEntryWithIssuingAccount (const char *value)
 
const Aws::Vector< GrantOperation > & GetOperations () const
 
bool OperationsHasBeenSet () const
 
void SetOperations (const Aws::Vector< GrantOperation > &value)
 
void SetOperations (Aws::Vector< GrantOperation > &&value)
 
GrantListEntryWithOperations (const Aws::Vector< GrantOperation > &value)
 
GrantListEntryWithOperations (Aws::Vector< GrantOperation > &&value)
 
GrantListEntryAddOperations (const GrantOperation &value)
 
GrantListEntryAddOperations (GrantOperation &&value)
 
const GrantConstraintsGetConstraints () const
 
bool ConstraintsHasBeenSet () const
 
void SetConstraints (const GrantConstraints &value)
 
void SetConstraints (GrantConstraints &&value)
 
GrantListEntryWithConstraints (const GrantConstraints &value)
 
GrantListEntryWithConstraints (GrantConstraints &&value)
 

Detailed Description

Contains information about a grant.

See Also:

AWS API Reference

Definition at line 35 of file GrantListEntry.h.

Constructor & Destructor Documentation

◆ GrantListEntry() [1/2]

Aws::KMS::Model::GrantListEntry::GrantListEntry ( )

◆ GrantListEntry() [2/2]

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

Member Function Documentation

◆ AddOperations() [1/2]

GrantListEntry& Aws::KMS::Model::GrantListEntry::AddOperations ( const GrantOperation value)
inline

The list of operations permitted by the grant.

Definition at line 426 of file GrantListEntry.h.

◆ AddOperations() [2/2]

GrantListEntry& Aws::KMS::Model::GrantListEntry::AddOperations ( GrantOperation &&  value)
inline

The list of operations permitted by the grant.

Definition at line 431 of file GrantListEntry.h.

◆ ConstraintsHasBeenSet()

bool Aws::KMS::Model::GrantListEntry::ConstraintsHasBeenSet ( ) const
inline

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

Definition at line 444 of file GrantListEntry.h.

◆ CreationDateHasBeenSet()

bool Aws::KMS::Model::GrantListEntry::CreationDateHasBeenSet ( ) const
inline

The date and time when the grant was created.

Definition at line 199 of file GrantListEntry.h.

◆ GetConstraints()

const GrantConstraints& Aws::KMS::Model::GrantListEntry::GetConstraints ( ) const
inline

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

Definition at line 438 of file GrantListEntry.h.

◆ GetCreationDate()

const Aws::Utils::DateTime& Aws::KMS::Model::GrantListEntry::GetCreationDate ( ) const
inline

The date and time when the grant was created.

Definition at line 194 of file GrantListEntry.h.

◆ GetGranteePrincipal()

const Aws::String& Aws::KMS::Model::GrantListEntry::GetGranteePrincipal ( ) const
inline

The identity that gets the permissions in the grant.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

Definition at line 231 of file GrantListEntry.h.

◆ GetGrantId()

const Aws::String& Aws::KMS::Model::GrantListEntry::GetGrantId ( ) const
inline

The unique identifier for the grant.

Definition at line 96 of file GrantListEntry.h.

◆ GetIssuingAccount()

const Aws::String& Aws::KMS::Model::GrantListEntry::GetIssuingAccount ( ) const
inline

The AWS account under which the grant was issued.

Definition at line 355 of file GrantListEntry.h.

◆ GetKeyId()

const Aws::String& Aws::KMS::Model::GrantListEntry::GetKeyId ( ) const
inline

The unique identifier for the customer master key (CMK) to which the grant applies.

Definition at line 48 of file GrantListEntry.h.

◆ GetName()

const Aws::String& Aws::KMS::Model::GrantListEntry::GetName ( ) const
inline

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

Definition at line 139 of file GrantListEntry.h.

◆ GetOperations()

const Aws::Vector<GrantOperation>& Aws::KMS::Model::GrantListEntry::GetOperations ( ) const
inline

The list of operations permitted by the grant.

Definition at line 396 of file GrantListEntry.h.

◆ GetRetiringPrincipal()

const Aws::String& Aws::KMS::Model::GrantListEntry::GetRetiringPrincipal ( ) const
inline

The principal that can retire the grant.

Definition at line 314 of file GrantListEntry.h.

◆ GranteePrincipalHasBeenSet()

bool Aws::KMS::Model::GrantListEntry::GranteePrincipalHasBeenSet ( ) const
inline

The identity that gets the permissions in the grant.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

Definition at line 242 of file GrantListEntry.h.

◆ GrantIdHasBeenSet()

bool Aws::KMS::Model::GrantListEntry::GrantIdHasBeenSet ( ) const
inline

The unique identifier for the grant.

Definition at line 101 of file GrantListEntry.h.

◆ IssuingAccountHasBeenSet()

bool Aws::KMS::Model::GrantListEntry::IssuingAccountHasBeenSet ( ) const
inline

The AWS account under which the grant was issued.

Definition at line 360 of file GrantListEntry.h.

◆ Jsonize()

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

◆ KeyIdHasBeenSet()

bool Aws::KMS::Model::GrantListEntry::KeyIdHasBeenSet ( ) const
inline

The unique identifier for the customer master key (CMK) to which the grant applies.

Definition at line 54 of file GrantListEntry.h.

◆ NameHasBeenSet()

bool Aws::KMS::Model::GrantListEntry::NameHasBeenSet ( ) const
inline

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

Definition at line 146 of file GrantListEntry.h.

◆ OperationsHasBeenSet()

bool Aws::KMS::Model::GrantListEntry::OperationsHasBeenSet ( ) const
inline

The list of operations permitted by the grant.

Definition at line 401 of file GrantListEntry.h.

◆ operator=()

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

◆ RetiringPrincipalHasBeenSet()

bool Aws::KMS::Model::GrantListEntry::RetiringPrincipalHasBeenSet ( ) const
inline

The principal that can retire the grant.

Definition at line 319 of file GrantListEntry.h.

◆ SetConstraints() [1/2]

void Aws::KMS::Model::GrantListEntry::SetConstraints ( const GrantConstraints value)
inline

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

Definition at line 450 of file GrantListEntry.h.

◆ SetConstraints() [2/2]

void Aws::KMS::Model::GrantListEntry::SetConstraints ( GrantConstraints &&  value)
inline

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

Definition at line 456 of file GrantListEntry.h.

◆ SetCreationDate() [1/2]

void Aws::KMS::Model::GrantListEntry::SetCreationDate ( const Aws::Utils::DateTime value)
inline

The date and time when the grant was created.

Definition at line 204 of file GrantListEntry.h.

◆ SetCreationDate() [2/2]

void Aws::KMS::Model::GrantListEntry::SetCreationDate ( Aws::Utils::DateTime &&  value)
inline

The date and time when the grant was created.

Definition at line 209 of file GrantListEntry.h.

◆ SetGranteePrincipal() [1/3]

void Aws::KMS::Model::GrantListEntry::SetGranteePrincipal ( const Aws::String value)
inline

The identity that gets the permissions in the grant.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

Definition at line 253 of file GrantListEntry.h.

◆ SetGranteePrincipal() [2/3]

void Aws::KMS::Model::GrantListEntry::SetGranteePrincipal ( Aws::String &&  value)
inline

The identity that gets the permissions in the grant.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

Definition at line 264 of file GrantListEntry.h.

◆ SetGranteePrincipal() [3/3]

void Aws::KMS::Model::GrantListEntry::SetGranteePrincipal ( const char *  value)
inline

The identity that gets the permissions in the grant.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

Definition at line 275 of file GrantListEntry.h.

◆ SetGrantId() [1/3]

void Aws::KMS::Model::GrantListEntry::SetGrantId ( const Aws::String value)
inline

The unique identifier for the grant.

Definition at line 106 of file GrantListEntry.h.

◆ SetGrantId() [2/3]

void Aws::KMS::Model::GrantListEntry::SetGrantId ( Aws::String &&  value)
inline

The unique identifier for the grant.

Definition at line 111 of file GrantListEntry.h.

◆ SetGrantId() [3/3]

void Aws::KMS::Model::GrantListEntry::SetGrantId ( const char *  value)
inline

The unique identifier for the grant.

Definition at line 116 of file GrantListEntry.h.

◆ SetIssuingAccount() [1/3]

void Aws::KMS::Model::GrantListEntry::SetIssuingAccount ( const Aws::String value)
inline

The AWS account under which the grant was issued.

Definition at line 365 of file GrantListEntry.h.

◆ SetIssuingAccount() [2/3]

void Aws::KMS::Model::GrantListEntry::SetIssuingAccount ( Aws::String &&  value)
inline

The AWS account under which the grant was issued.

Definition at line 370 of file GrantListEntry.h.

◆ SetIssuingAccount() [3/3]

void Aws::KMS::Model::GrantListEntry::SetIssuingAccount ( const char *  value)
inline

The AWS account under which the grant was issued.

Definition at line 375 of file GrantListEntry.h.

◆ SetKeyId() [1/3]

void Aws::KMS::Model::GrantListEntry::SetKeyId ( const Aws::String value)
inline

The unique identifier for the customer master key (CMK) to which the grant applies.

Definition at line 60 of file GrantListEntry.h.

◆ SetKeyId() [2/3]

void Aws::KMS::Model::GrantListEntry::SetKeyId ( Aws::String &&  value)
inline

The unique identifier for the customer master key (CMK) to which the grant applies.

Definition at line 66 of file GrantListEntry.h.

◆ SetKeyId() [3/3]

void Aws::KMS::Model::GrantListEntry::SetKeyId ( const char *  value)
inline

The unique identifier for the customer master key (CMK) to which the grant applies.

Definition at line 72 of file GrantListEntry.h.

◆ SetName() [1/3]

void Aws::KMS::Model::GrantListEntry::SetName ( const Aws::String value)
inline

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

Definition at line 153 of file GrantListEntry.h.

◆ SetName() [2/3]

void Aws::KMS::Model::GrantListEntry::SetName ( Aws::String &&  value)
inline

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

Definition at line 160 of file GrantListEntry.h.

◆ SetName() [3/3]

void Aws::KMS::Model::GrantListEntry::SetName ( const char *  value)
inline

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

Definition at line 167 of file GrantListEntry.h.

◆ SetOperations() [1/2]

void Aws::KMS::Model::GrantListEntry::SetOperations ( const Aws::Vector< GrantOperation > &  value)
inline

The list of operations permitted by the grant.

Definition at line 406 of file GrantListEntry.h.

◆ SetOperations() [2/2]

void Aws::KMS::Model::GrantListEntry::SetOperations ( Aws::Vector< GrantOperation > &&  value)
inline

The list of operations permitted by the grant.

Definition at line 411 of file GrantListEntry.h.

◆ SetRetiringPrincipal() [1/3]

void Aws::KMS::Model::GrantListEntry::SetRetiringPrincipal ( const Aws::String value)
inline

The principal that can retire the grant.

Definition at line 324 of file GrantListEntry.h.

◆ SetRetiringPrincipal() [2/3]

void Aws::KMS::Model::GrantListEntry::SetRetiringPrincipal ( Aws::String &&  value)
inline

The principal that can retire the grant.

Definition at line 329 of file GrantListEntry.h.

◆ SetRetiringPrincipal() [3/3]

void Aws::KMS::Model::GrantListEntry::SetRetiringPrincipal ( const char *  value)
inline

The principal that can retire the grant.

Definition at line 334 of file GrantListEntry.h.

◆ WithConstraints() [1/2]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithConstraints ( const GrantConstraints value)
inline

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

Definition at line 462 of file GrantListEntry.h.

◆ WithConstraints() [2/2]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithConstraints ( GrantConstraints &&  value)
inline

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

Definition at line 468 of file GrantListEntry.h.

◆ WithCreationDate() [1/2]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithCreationDate ( const Aws::Utils::DateTime value)
inline

The date and time when the grant was created.

Definition at line 214 of file GrantListEntry.h.

◆ WithCreationDate() [2/2]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithCreationDate ( Aws::Utils::DateTime &&  value)
inline

The date and time when the grant was created.

Definition at line 219 of file GrantListEntry.h.

◆ WithGranteePrincipal() [1/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithGranteePrincipal ( const Aws::String value)
inline

The identity that gets the permissions in the grant.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

Definition at line 286 of file GrantListEntry.h.

◆ WithGranteePrincipal() [2/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithGranteePrincipal ( Aws::String &&  value)
inline

The identity that gets the permissions in the grant.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

Definition at line 297 of file GrantListEntry.h.

◆ WithGranteePrincipal() [3/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithGranteePrincipal ( const char *  value)
inline

The identity that gets the permissions in the grant.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

Definition at line 308 of file GrantListEntry.h.

◆ WithGrantId() [1/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithGrantId ( const Aws::String value)
inline

The unique identifier for the grant.

Definition at line 121 of file GrantListEntry.h.

◆ WithGrantId() [2/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithGrantId ( Aws::String &&  value)
inline

The unique identifier for the grant.

Definition at line 126 of file GrantListEntry.h.

◆ WithGrantId() [3/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithGrantId ( const char *  value)
inline

The unique identifier for the grant.

Definition at line 131 of file GrantListEntry.h.

◆ WithIssuingAccount() [1/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithIssuingAccount ( const Aws::String value)
inline

The AWS account under which the grant was issued.

Definition at line 380 of file GrantListEntry.h.

◆ WithIssuingAccount() [2/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithIssuingAccount ( Aws::String &&  value)
inline

The AWS account under which the grant was issued.

Definition at line 385 of file GrantListEntry.h.

◆ WithIssuingAccount() [3/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithIssuingAccount ( const char *  value)
inline

The AWS account under which the grant was issued.

Definition at line 390 of file GrantListEntry.h.

◆ WithKeyId() [1/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithKeyId ( const Aws::String value)
inline

The unique identifier for the customer master key (CMK) to which the grant applies.

Definition at line 78 of file GrantListEntry.h.

◆ WithKeyId() [2/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithKeyId ( Aws::String &&  value)
inline

The unique identifier for the customer master key (CMK) to which the grant applies.

Definition at line 84 of file GrantListEntry.h.

◆ WithKeyId() [3/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithKeyId ( const char *  value)
inline

The unique identifier for the customer master key (CMK) to which the grant applies.

Definition at line 90 of file GrantListEntry.h.

◆ WithName() [1/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithName ( const Aws::String value)
inline

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

Definition at line 174 of file GrantListEntry.h.

◆ WithName() [2/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithName ( Aws::String &&  value)
inline

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

Definition at line 181 of file GrantListEntry.h.

◆ WithName() [3/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithName ( const char *  value)
inline

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

Definition at line 188 of file GrantListEntry.h.

◆ WithOperations() [1/2]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithOperations ( const Aws::Vector< GrantOperation > &  value)
inline

The list of operations permitted by the grant.

Definition at line 416 of file GrantListEntry.h.

◆ WithOperations() [2/2]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithOperations ( Aws::Vector< GrantOperation > &&  value)
inline

The list of operations permitted by the grant.

Definition at line 421 of file GrantListEntry.h.

◆ WithRetiringPrincipal() [1/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithRetiringPrincipal ( const Aws::String value)
inline

The principal that can retire the grant.

Definition at line 339 of file GrantListEntry.h.

◆ WithRetiringPrincipal() [2/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithRetiringPrincipal ( Aws::String &&  value)
inline

The principal that can retire the grant.

Definition at line 344 of file GrantListEntry.h.

◆ WithRetiringPrincipal() [3/3]

GrantListEntry& Aws::KMS::Model::GrantListEntry::WithRetiringPrincipal ( const char *  value)
inline

The principal that can retire the grant.

Definition at line 349 of file GrantListEntry.h.


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