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

#include <CreateGrantRequest.h>

+ Inheritance diagram for Aws::KMS::Model::CreateGrantRequest:

Public Member Functions

 CreateGrantRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetKeyId () const
 
bool KeyIdHasBeenSet () const
 
void SetKeyId (const Aws::String &value)
 
void SetKeyId (Aws::String &&value)
 
void SetKeyId (const char *value)
 
CreateGrantRequestWithKeyId (const Aws::String &value)
 
CreateGrantRequestWithKeyId (Aws::String &&value)
 
CreateGrantRequestWithKeyId (const char *value)
 
const Aws::StringGetGranteePrincipal () const
 
bool GranteePrincipalHasBeenSet () const
 
void SetGranteePrincipal (const Aws::String &value)
 
void SetGranteePrincipal (Aws::String &&value)
 
void SetGranteePrincipal (const char *value)
 
CreateGrantRequestWithGranteePrincipal (const Aws::String &value)
 
CreateGrantRequestWithGranteePrincipal (Aws::String &&value)
 
CreateGrantRequestWithGranteePrincipal (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)
 
CreateGrantRequestWithRetiringPrincipal (const Aws::String &value)
 
CreateGrantRequestWithRetiringPrincipal (Aws::String &&value)
 
CreateGrantRequestWithRetiringPrincipal (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)
 
CreateGrantRequestWithOperations (const Aws::Vector< GrantOperation > &value)
 
CreateGrantRequestWithOperations (Aws::Vector< GrantOperation > &&value)
 
CreateGrantRequestAddOperations (const GrantOperation &value)
 
CreateGrantRequestAddOperations (GrantOperation &&value)
 
const GrantConstraintsGetConstraints () const
 
bool ConstraintsHasBeenSet () const
 
void SetConstraints (const GrantConstraints &value)
 
void SetConstraints (GrantConstraints &&value)
 
CreateGrantRequestWithConstraints (const GrantConstraints &value)
 
CreateGrantRequestWithConstraints (GrantConstraints &&value)
 
const Aws::Vector< Aws::String > & GetGrantTokens () const
 
bool GrantTokensHasBeenSet () const
 
void SetGrantTokens (const Aws::Vector< Aws::String > &value)
 
void SetGrantTokens (Aws::Vector< Aws::String > &&value)
 
CreateGrantRequestWithGrantTokens (const Aws::Vector< Aws::String > &value)
 
CreateGrantRequestWithGrantTokens (Aws::Vector< Aws::String > &&value)
 
CreateGrantRequestAddGrantTokens (const Aws::String &value)
 
CreateGrantRequestAddGrantTokens (Aws::String &&value)
 
CreateGrantRequestAddGrantTokens (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)
 
CreateGrantRequestWithName (const Aws::String &value)
 
CreateGrantRequestWithName (Aws::String &&value)
 
CreateGrantRequestWithName (const char *value)
 
- Public Member Functions inherited from Aws::KMS::KMSRequest
virtual ~KMSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file CreateGrantRequest.h.

Constructor & Destructor Documentation

◆ CreateGrantRequest()

Aws::KMS::Model::CreateGrantRequest::CreateGrantRequest ( )

Member Function Documentation

◆ AddGrantTokens() [1/3]

CreateGrantRequest& Aws::KMS::Model::CreateGrantRequest::AddGrantTokens ( const Aws::String value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 508 of file CreateGrantRequest.h.

◆ AddGrantTokens() [2/3]

CreateGrantRequest& Aws::KMS::Model::CreateGrantRequest::AddGrantTokens ( Aws::String &&  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 515 of file CreateGrantRequest.h.

◆ AddGrantTokens() [3/3]

CreateGrantRequest& Aws::KMS::Model::CreateGrantRequest::AddGrantTokens ( const char *  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 522 of file CreateGrantRequest.h.

◆ AddOperations() [1/2]

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

A list of operations that the grant permits.

Definition at line 380 of file CreateGrantRequest.h.

◆ AddOperations() [2/2]

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

A list of operations that the grant permits.

Definition at line 385 of file CreateGrantRequest.h.

◆ ConstraintsHasBeenSet()

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

Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .

Definition at line 410 of file CreateGrantRequest.h.

◆ GetConstraints()

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

Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .

Definition at line 398 of file CreateGrantRequest.h.

◆ GetGranteePrincipal()

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

The principal that is given permission to perform the operations that the grant permits.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 148 of file CreateGrantRequest.h.

◆ GetGrantTokens()

const Aws::Vector<Aws::String>& Aws::KMS::Model::CreateGrantRequest::GetGrantTokens ( ) const
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 466 of file CreateGrantRequest.h.

◆ GetKeyId()

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

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

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 50 of file CreateGrantRequest.h.

◆ GetName()

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

A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.

When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

Definition at line 538 of file CreateGrantRequest.h.

◆ GetOperations()

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

A list of operations that the grant permits.

Definition at line 350 of file CreateGrantRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::KMS::Model::CreateGrantRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::KMS::KMSRequest.

◆ GetRetiringPrincipal()

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

The principal that is given permission to retire the grant by using RetireGrant operation.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 253 of file CreateGrantRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::KMS::Model::CreateGrantRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CreateGrantRequest.h.

◆ GranteePrincipalHasBeenSet()

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

The principal that is given permission to perform the operations that the grant permits.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 161 of file CreateGrantRequest.h.

◆ GrantTokensHasBeenSet()

bool Aws::KMS::Model::CreateGrantRequest::GrantTokensHasBeenSet ( ) const
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 473 of file CreateGrantRequest.h.

◆ KeyIdHasBeenSet()

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

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

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 62 of file CreateGrantRequest.h.

◆ NameHasBeenSet()

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

A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.

When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

Definition at line 553 of file CreateGrantRequest.h.

◆ OperationsHasBeenSet()

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

A list of operations that the grant permits.

Definition at line 355 of file CreateGrantRequest.h.

◆ RetiringPrincipalHasBeenSet()

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

The principal that is given permission to retire the grant by using RetireGrant operation.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 266 of file CreateGrantRequest.h.

◆ SerializePayload()

Aws::String Aws::KMS::Model::CreateGrantRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetConstraints() [1/2]

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

Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .

Definition at line 422 of file CreateGrantRequest.h.

◆ SetConstraints() [2/2]

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

Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .

Definition at line 434 of file CreateGrantRequest.h.

◆ SetGranteePrincipal() [1/3]

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

The principal that is given permission to perform the operations that the grant permits.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 174 of file CreateGrantRequest.h.

◆ SetGranteePrincipal() [2/3]

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

The principal that is given permission to perform the operations that the grant permits.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 187 of file CreateGrantRequest.h.

◆ SetGranteePrincipal() [3/3]

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

The principal that is given permission to perform the operations that the grant permits.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 200 of file CreateGrantRequest.h.

◆ SetGrantTokens() [1/2]

void Aws::KMS::Model::CreateGrantRequest::SetGrantTokens ( const Aws::Vector< Aws::String > &  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 480 of file CreateGrantRequest.h.

◆ SetGrantTokens() [2/2]

void Aws::KMS::Model::CreateGrantRequest::SetGrantTokens ( Aws::Vector< Aws::String > &&  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 487 of file CreateGrantRequest.h.

◆ SetKeyId() [1/3]

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

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

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 74 of file CreateGrantRequest.h.

◆ SetKeyId() [2/3]

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

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

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 86 of file CreateGrantRequest.h.

◆ SetKeyId() [3/3]

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

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

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 98 of file CreateGrantRequest.h.

◆ SetName() [1/3]

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

A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.

When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

Definition at line 568 of file CreateGrantRequest.h.

◆ SetName() [2/3]

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

A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.

When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

Definition at line 583 of file CreateGrantRequest.h.

◆ SetName() [3/3]

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

A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.

When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

Definition at line 598 of file CreateGrantRequest.h.

◆ SetOperations() [1/2]

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

A list of operations that the grant permits.

Definition at line 360 of file CreateGrantRequest.h.

◆ SetOperations() [2/2]

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

A list of operations that the grant permits.

Definition at line 365 of file CreateGrantRequest.h.

◆ SetRetiringPrincipal() [1/3]

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

The principal that is given permission to retire the grant by using RetireGrant operation.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 279 of file CreateGrantRequest.h.

◆ SetRetiringPrincipal() [2/3]

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

The principal that is given permission to retire the grant by using RetireGrant operation.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 292 of file CreateGrantRequest.h.

◆ SetRetiringPrincipal() [3/3]

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

The principal that is given permission to retire the grant by using RetireGrant operation.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 305 of file CreateGrantRequest.h.

◆ WithConstraints() [1/2]

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

Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .

Definition at line 446 of file CreateGrantRequest.h.

◆ WithConstraints() [2/2]

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

Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .

Definition at line 458 of file CreateGrantRequest.h.

◆ WithGranteePrincipal() [1/3]

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

The principal that is given permission to perform the operations that the grant permits.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 213 of file CreateGrantRequest.h.

◆ WithGranteePrincipal() [2/3]

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

The principal that is given permission to perform the operations that the grant permits.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 226 of file CreateGrantRequest.h.

◆ WithGranteePrincipal() [3/3]

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

The principal that is given permission to perform the operations that the grant permits.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 239 of file CreateGrantRequest.h.

◆ WithGrantTokens() [1/2]

CreateGrantRequest& Aws::KMS::Model::CreateGrantRequest::WithGrantTokens ( const Aws::Vector< Aws::String > &  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 494 of file CreateGrantRequest.h.

◆ WithGrantTokens() [2/2]

CreateGrantRequest& Aws::KMS::Model::CreateGrantRequest::WithGrantTokens ( Aws::Vector< Aws::String > &&  value)
inline

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Definition at line 501 of file CreateGrantRequest.h.

◆ WithKeyId() [1/3]

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

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

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 110 of file CreateGrantRequest.h.

◆ WithKeyId() [2/3]

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

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

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 122 of file CreateGrantRequest.h.

◆ WithKeyId() [3/3]

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

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

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 134 of file CreateGrantRequest.h.

◆ WithName() [1/3]

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

A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.

When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

Definition at line 613 of file CreateGrantRequest.h.

◆ WithName() [2/3]

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

A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.

When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

Definition at line 628 of file CreateGrantRequest.h.

◆ WithName() [3/3]

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

A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.

When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

Definition at line 643 of file CreateGrantRequest.h.

◆ WithOperations() [1/2]

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

A list of operations that the grant permits.

Definition at line 370 of file CreateGrantRequest.h.

◆ WithOperations() [2/2]

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

A list of operations that the grant permits.

Definition at line 375 of file CreateGrantRequest.h.

◆ WithRetiringPrincipal() [1/3]

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

The principal that is given permission to retire the grant by using RetireGrant operation.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 318 of file CreateGrantRequest.h.

◆ WithRetiringPrincipal() [2/3]

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

The principal that is given permission to retire the grant by using RetireGrant operation.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 331 of file CreateGrantRequest.h.

◆ WithRetiringPrincipal() [3/3]

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

The principal that is given permission to retire the grant by using RetireGrant operation.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

Definition at line 344 of file CreateGrantRequest.h.


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