class Aws::KMS::Types::CreateGrantRequest

@note When making an API call, you may pass CreateGrantRequest

data as a hash:

    {
      key_id: "KeyIdType", # required
      grantee_principal: "PrincipalIdType", # required
      retiring_principal: "PrincipalIdType",
      operations: ["Decrypt"], # required, accepts Decrypt, Encrypt, GenerateDataKey, GenerateDataKeyWithoutPlaintext, ReEncryptFrom, ReEncryptTo, Sign, Verify, GetPublicKey, CreateGrant, RetireGrant, DescribeKey, GenerateDataKeyPair, GenerateDataKeyPairWithoutPlaintext
      constraints: {
        encryption_context_subset: {
          "EncryptionContextKey" => "EncryptionContextValue",
        },
        encryption_context_equals: {
          "EncryptionContextKey" => "EncryptionContextValue",
        },
      },
      grant_tokens: ["GrantTokenType"],
      name: "GrantNameType",
    }

@!attribute [rw] key_id

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.
@return [String]

@!attribute [rw] grantee_principal

The identity that gets the permissions specified in the grant.

To specify the principal, use the [Amazon Resource Name (ARN)][1] 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)][2] in the Example
ARNs section of the *Amazon Web Services General Reference*.

[1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
[2]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam
@return [String]

@!attribute [rw] retiring_principal

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

To specify the principal, use the [Amazon Resource Name (ARN)][1] 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)][2] 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][3] in
the *Key Management Service Developer Guide*.

[1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
[2]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam
[3]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete
@return [String]

@!attribute [rw] operations

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][1]
in the *Key Management Service Developer Guide*.

[1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations
@return [Array<String>]

@!attribute [rw] constraints

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][1] in the
*Key Management Service Developer Guide*. For more information about
encryption context, see [Encryption Context][2] in the <i> <i>Key
Management Service Developer Guide</i> </i>.

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.

[1]: https://docs.aws.amazon.com/kms/latest/developerguide/create-grant-overview.html#grant-constraints
[2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
@return [Types::GrantConstraints]

@!attribute [rw] grant_tokens

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][1] and [Using a grant
token][2] in the *Key Management Service Developer Guide*.

[1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
[2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
@return [Array<String>]

@!attribute [rw] name

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.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateGrantRequest AWS API Documentation

Constants

SENSITIVE