AWS SDK for C++  1.9.109
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 ( Aws::String &&  value)
inline

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 711 of file CreateGrantRequest.h.

◆ AddGrantTokens() [2/3]

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 700 of file CreateGrantRequest.h.

◆ AddGrantTokens() [3/3]

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 722 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.

The operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

Definition at line 478 of file CreateGrantRequest.h.

◆ AddOperations() [2/2]

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

A list of operations that the grant permits.

The operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

Definition at line 489 of file CreateGrantRequest.h.

◆ ConstraintsHasBeenSet()

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

Specifies a grant constraint.

KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters.

These grant constraints allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in this structure. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption Context in the Key Management Service Developer Guide .

The encryption context grant constraints are supported only on operations that include an encryption context. You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or for management operations, such as DescribeKey or RetireGrant.

Definition at line 534 of file CreateGrantRequest.h.

◆ GetConstraints()

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

Specifies a grant constraint.

KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters.

These grant constraints allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in this structure. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption Context in the Key Management Service Developer Guide .

The encryption context grant constraints are supported only on operations that include an encryption context. You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or for management operations, such as DescribeKey or RetireGrant.

Definition at line 512 of file CreateGrantRequest.h.

◆ GetGranteePrincipal()

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

The identity that gets the permissions specified in the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services 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 Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 149 of file CreateGrantRequest.h.

◆ GetGrantTokens()

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 634 of file CreateGrantRequest.h.

◆ GetKeyId()

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

Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, 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 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 for the same grant ID can be used interchangeably.

Definition at line 739 of file CreateGrantRequest.h.

◆ GetOperations()

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

A list of operations that the grant permits.

The operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

Definition at line 412 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 has permission to use the RetireGrant operation to retire the grant.

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

The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

Definition at line 267 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 identity that gets the permissions specified in the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services 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 Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 163 of file CreateGrantRequest.h.

◆ GrantTokensHasBeenSet()

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 645 of file CreateGrantRequest.h.

◆ KeyIdHasBeenSet()

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

Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, 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 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 for the same grant ID can be used interchangeably.

Definition at line 755 of file CreateGrantRequest.h.

◆ OperationsHasBeenSet()

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

A list of operations that the grant permits.

The operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

Definition at line 423 of file CreateGrantRequest.h.

◆ RetiringPrincipalHasBeenSet()

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

The principal that has permission to use the RetireGrant operation to retire the grant.

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

The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

Definition at line 286 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

Specifies a grant constraint.

KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters.

These grant constraints allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in this structure. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption Context in the Key Management Service Developer Guide .

The encryption context grant constraints are supported only on operations that include an encryption context. You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or for management operations, such as DescribeKey or RetireGrant.

Definition at line 556 of file CreateGrantRequest.h.

◆ SetConstraints() [2/2]

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

Specifies a grant constraint.

KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters.

These grant constraints allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in this structure. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption Context in the Key Management Service Developer Guide .

The encryption context grant constraints are supported only on operations that include an encryption context. You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or for management operations, such as DescribeKey or RetireGrant.

Definition at line 578 of file CreateGrantRequest.h.

◆ SetGranteePrincipal() [1/3]

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

The identity that gets the permissions specified in the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services 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 Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 191 of file CreateGrantRequest.h.

◆ SetGranteePrincipal() [2/3]

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

The identity that gets the permissions specified in the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services 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 Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 177 of file CreateGrantRequest.h.

◆ SetGranteePrincipal() [3/3]

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

The identity that gets the permissions specified in the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services 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 Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 205 of file CreateGrantRequest.h.

◆ SetGrantTokens() [1/2]

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 667 of file CreateGrantRequest.h.

◆ SetGrantTokens() [2/2]

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 656 of file CreateGrantRequest.h.

◆ SetKeyId() [1/3]

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

Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

Definition at line 86 of file CreateGrantRequest.h.

◆ SetKeyId() [2/3]

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

Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

Definition at line 74 of file CreateGrantRequest.h.

◆ SetKeyId() [3/3]

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

Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

Definition at line 98 of file CreateGrantRequest.h.

◆ SetName() [1/3]

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

A friendly name for 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 for the same grant ID can be used interchangeably.

Definition at line 787 of file CreateGrantRequest.h.

◆ SetName() [2/3]

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

A friendly name for 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 for the same grant ID can be used interchangeably.

Definition at line 771 of file CreateGrantRequest.h.

◆ SetName() [3/3]

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

A friendly name for 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 for the same grant ID can be used interchangeably.

Definition at line 803 of file CreateGrantRequest.h.

◆ SetOperations() [1/2]

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

A list of operations that the grant permits.

The operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

Definition at line 445 of file CreateGrantRequest.h.

◆ SetOperations() [2/2]

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

A list of operations that the grant permits.

The operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

Definition at line 434 of file CreateGrantRequest.h.

◆ SetRetiringPrincipal() [1/3]

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

The principal that has permission to use the RetireGrant operation to retire the grant.

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

The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

Definition at line 324 of file CreateGrantRequest.h.

◆ SetRetiringPrincipal() [2/3]

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

The principal that has permission to use the RetireGrant operation to retire the grant.

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

The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

Definition at line 305 of file CreateGrantRequest.h.

◆ SetRetiringPrincipal() [3/3]

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

The principal that has permission to use the RetireGrant operation to retire the grant.

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

The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

Definition at line 343 of file CreateGrantRequest.h.

◆ WithConstraints() [1/2]

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

Specifies a grant constraint.

KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters.

These grant constraints allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in this structure. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption Context in the Key Management Service Developer Guide .

The encryption context grant constraints are supported only on operations that include an encryption context. You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or for management operations, such as DescribeKey or RetireGrant.

Definition at line 600 of file CreateGrantRequest.h.

◆ WithConstraints() [2/2]

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

Specifies a grant constraint.

KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints. Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters.

These grant constraints allow the permissions in the grant only when the encryption context in the request matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption context specified in this structure. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption Context in the Key Management Service Developer Guide .

The encryption context grant constraints are supported only on operations that include an encryption context. You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or for management operations, such as DescribeKey or RetireGrant.

Definition at line 622 of file CreateGrantRequest.h.

◆ WithGranteePrincipal() [1/3]

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

The identity that gets the permissions specified in the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services 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 Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 233 of file CreateGrantRequest.h.

◆ WithGranteePrincipal() [2/3]

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

The identity that gets the permissions specified in the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services 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 Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 219 of file CreateGrantRequest.h.

◆ WithGranteePrincipal() [3/3]

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

The identity that gets the permissions specified in the grant.

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services 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 Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

Definition at line 247 of file CreateGrantRequest.h.

◆ WithGrantTokens() [1/2]

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 689 of file CreateGrantRequest.h.

◆ WithGrantTokens() [2/2]

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

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Definition at line 678 of file CreateGrantRequest.h.

◆ WithKeyId() [1/3]

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

Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

Definition at line 122 of file CreateGrantRequest.h.

◆ WithKeyId() [2/3]

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

Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

Definition at line 110 of file CreateGrantRequest.h.

◆ WithKeyId() [3/3]

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

Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

Definition at line 134 of file CreateGrantRequest.h.

◆ WithName() [1/3]

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

A friendly name for 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 for the same grant ID can be used interchangeably.

Definition at line 835 of file CreateGrantRequest.h.

◆ WithName() [2/3]

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

A friendly name for 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 for the same grant ID can be used interchangeably.

Definition at line 819 of file CreateGrantRequest.h.

◆ WithName() [3/3]

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

A friendly name for 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 for the same grant ID can be used interchangeably.

Definition at line 851 of file CreateGrantRequest.h.

◆ WithOperations() [1/2]

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

A list of operations that the grant permits.

The operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

Definition at line 467 of file CreateGrantRequest.h.

◆ WithOperations() [2/2]

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

A list of operations that the grant permits.

The operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

Definition at line 456 of file CreateGrantRequest.h.

◆ WithRetiringPrincipal() [1/3]

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

The principal that has permission to use the RetireGrant operation to retire the grant.

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

The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

Definition at line 381 of file CreateGrantRequest.h.

◆ WithRetiringPrincipal() [2/3]

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

The principal that has permission to use the RetireGrant operation to retire the grant.

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

The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

Definition at line 362 of file CreateGrantRequest.h.

◆ WithRetiringPrincipal() [3/3]

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

The principal that has permission to use the RetireGrant operation to retire the grant.

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

The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

Definition at line 400 of file CreateGrantRequest.h.


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