Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use the CMK when the conditions specified in the grant are met. When setting permissions, grants are an alternative to key policies.
To create a grant that allows a cryptographic operation
only when the request includes a particular encryption context,
use the Constraints parameter. For details, see GrantConstraints.
You can create grants on symmetric and asymmetric CMKs. However, if the
grant allows an operation that the CMK does not support,
create_grant fails with a ValidationException.
Grants for symmetric CMKs cannot allow operations that are not
supported for symmetric CMKs, including sign,
verify, and get_public_key.
(There are limited exceptions to this rule for legacy operations,
but you should not create a grant for an operation that AWS KMS does
not support.)
Grants for asymmetric CMKs cannot allow operations that are not supported for asymmetric CMKs, including operations that generate data keys or data key pairs, or operations related to automatic key rotation, imported key material, or CMKs in custom key stores.
Grants for asymmetric CMKs with a KeyUsage of ENCRYPT_DECRYPT
cannot allow the sign or verify
operations. Grants for asymmetric CMKs with a KeyUsage of
SIGN_VERIFY cannot allow the encrypt or
decrypt operations.
Grants for asymmetric CMKs cannot include an encryption context grant constraint. An encryption context is not supported on asymmetric CMKs.
For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide. For more information about grants, see Grants in the AWS Key Management Service Developer Guide .
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation on a CMK in a
different AWS account, specify the key ARN in the value of the KeyId
parameter.
Required permissions: kms:CreateGrant (key policy)
Related operations:
list_grants
list_retirable_grants
retire_grant
revoke_grant
kms_create_grant(KeyId, GranteePrincipal, RetiringPrincipal, Operations,
Constraints, GrantTokens, Name)A list with the following syntax:
list(
GrantToken = "string",
GrantId = "string"
)
[required] 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
list_keys or describe_key.
[required] 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.
The principal that is given permission to retire the grant by using
retire_grant 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.
[required] A list of operations that the grant permits.
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 .
Grant constraints are not applied to operations that do not support an
encryption context, such as cryptographic operations with asymmetric
CMKs and management operations, such as
describe_key or
retire_grant.
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
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 create_grant
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 create_grant
request.
When this value is present, you can retry a
create_grant 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 create_grant request, even when a duplicate
GrantId is returned. All grant tokens for the same grant ID can be
used interchangeably.
svc$create_grant(
KeyId = "string",
GranteePrincipal = "string",
RetiringPrincipal = "string",
Operations = list(
"Decrypt"|"Encrypt"|"GenerateDataKey"|"GenerateDataKeyWithoutPlaintext"|"ReEncryptFrom"|"ReEncryptTo"|"Sign"|"Verify"|"GetPublicKey"|"CreateGrant"|"RetireGrant"|"DescribeKey"|"GenerateDataKeyPair"|"GenerateDataKeyPairWithoutPlaintext"
),
Constraints = list(
EncryptionContextSubset = list(
"string"
),
EncryptionContextEquals = list(
"string"
)
),
GrantTokens = list(
"string"
),
Name = "string"
)
if (FALSE) {
# The following example creates a grant that allows the specified IAM role
# to encrypt data with the specified customer master key (CMK).
svc$create_grant(
GranteePrincipal = "arn:aws:iam::111122223333:role/ExampleRole",
KeyId = "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab",
Operations = list(
"Encrypt",
"Decrypt"
)
)
}
Run the code above in your browser using DataLab