AWSKMSCreateGrantRequest Class Reference

Inherits from AWSRequest : AWSModel : AWSMTLModel
Declared in AWSKMSModel.h
AWSKMSModel.m

  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.

@property (nonatomic, strong) AWSKMSGrantConstraints *constraints

Declared In

AWSKMSModel.h

  grantTokens

A list of grant tokens.

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

@property (nonatomic, strong) NSArray<NSString*> *grantTokens

Declared In

AWSKMSModel.h

  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.

@property (nonatomic, strong) NSString *granteePrincipal

Declared In

AWSKMSModel.h

  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

@property (nonatomic, strong) NSString *keyId

Declared In

AWSKMSModel.h

  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.

@property (nonatomic, strong) NSString *name

Declared In

AWSKMSModel.h

  operations

A list of operations that the grant permits.

@property (nonatomic, strong) NSArray<NSString*> *operations

Declared In

AWSKMSModel.h

  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.

@property (nonatomic, strong) NSString *retiringPrincipal

Declared In

AWSKMSModel.h