Adds a grant to a customer master key (CMK). The grant specifies who can use the CMK and under what conditions. When setting permissions, grants are an alternative to key policies.
kms_create_grant(KeyId, GranteePrincipal, RetiringPrincipal, Operations,
Constraints, GrantTokens, Name)[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 ListKeys or DescribeKey.
[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 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.
[required] A list of operations that the grant permits.
A structure that you can use to allow certain operations in the grant only when the desired encryption context is present. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide.
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
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.
svc$create_grant(
KeyId = "string",
GranteePrincipal = "string",
RetiringPrincipal = "string",
Operations = list(
"Decrypt"|"Encrypt"|"GenerateDataKey"|"GenerateDataKeyWithoutPlaintext"|"ReEncryptFrom"|"ReEncryptTo"|"CreateGrant"|"RetireGrant"|"DescribeKey"
),
Constraints = list(
EncryptionContextSubset = list(
"string"
),
EncryptionContextEquals = list(
"string"
)
),
GrantTokens = list(
"string"
),
Name = "string"
)
To perform this operation on a CMK in a different AWS account, specify
the key ARN in the value of the KeyId parameter. For more information
about grants, see
Grants
in the AWS Key Management Service Developer Guide.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
# NOT RUN {
# The following example creates a grant that allows the specified IAM role
# to encrypt data with the specified customer master key (CMK).
# }
# NOT RUN {
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"
)
)
# }
# NOT RUN {
# }
Run the code above in your browser using DataLab