AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 
Container for the parameters to the CreateGrant operation. Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.

For more information about grants, see Grants in the AWS Key Management Service Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
      Amazon.KeyManagementService.Model.CreateGrantRequest

Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class CreateGrantRequest : AmazonKeyManagementServiceRequest
         IRequestEvents

The CreateGrantRequest type exposes the following members

Constructors

NameDescription
Public Method CreateGrantRequest()

Properties

NameTypeDescription
Public Property Constraints Amazon.KeyManagementService.Model.GrantConstraints Gets and sets the property Constraints.

The conditions under which the operations permitted by the grant are allowed.

You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

Public Property GranteePrincipal System.String Gets and sets the property GranteePrincipal.

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, 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.

Public Property GrantTokens System.Collections.Generic.List<System.String> Gets and sets the property GrantTokens.

A list of grant tokens.

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

Public Property KeyId System.String Gets and sets the property KeyId.

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

To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:

  • Globally unique key ID: 12345678-1234-1234-1234-123456789012
  • Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012

Public Property Name System.String Gets and sets the property Name.

A friendly name for identifying the grant. Use this value to prevent 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.

Public Property Operations System.Collections.Generic.List<System.String> Gets and sets the property Operations.

A list of operations that the grant permits. The list can contain any combination of one or more of the following values:

  • Decrypt
  • Encrypt
  • GenerateDataKey
  • GenerateDataKeyWithoutPlaintext
  • ReEncryptFrom
  • ReEncryptTo
  • CreateGrant
  • RetireGrant

Public Property RetiringPrincipal System.String Gets and sets the property RetiringPrincipal.

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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8