public class CreateGrantRequest extends AmazonWebServiceRequest implements java.io.Serializable
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, CreateGrant
fails with a ValidationException
.
Grants for symmetric CMKs cannot allow operations that are not supported for symmetric CMKs, including Sign, Verify, and GetPublicKey. (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:
Constructor and Description |
---|
CreateGrantRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
GrantConstraints |
getConstraints()
Allows a cryptographic operation only when the encryption context matches or
includes the encryption context specified in this structure.
|
java.lang.String |
getGranteePrincipal()
The principal that is given permission to perform the operations that the
grant permits.
|
java.util.List<java.lang.String> |
getGrantTokens()
A list of grant tokens.
|
java.lang.String |
getKeyId()
The unique identifier for the customer master key (CMK) that the grant
applies to.
|
java.lang.String |
getName()
A friendly name for the grant.
|
java.util.List<java.lang.String> |
getOperations()
A list of operations that the grant permits.
|
java.lang.String |
getRetiringPrincipal()
The principal that is given permission to retire the grant by using
RetireGrant operation.
|
int |
hashCode() |
void |
setConstraints(GrantConstraints constraints)
Allows a cryptographic operation only when the encryption context matches or
includes the encryption context specified in this structure.
|
void |
setGranteePrincipal(java.lang.String granteePrincipal)
The principal that is given permission to perform the operations that the
grant permits.
|
void |
setGrantTokens(java.util.Collection<java.lang.String> grantTokens)
A list of grant tokens.
|
void |
setKeyId(java.lang.String keyId)
The unique identifier for the customer master key (CMK) that the grant
applies to.
|
void |
setName(java.lang.String name)
A friendly name for the grant.
|
void |
setOperations(java.util.Collection<java.lang.String> operations)
A list of operations that the grant permits.
|
void |
setRetiringPrincipal(java.lang.String retiringPrincipal)
The principal that is given permission to retire the grant by using
RetireGrant operation.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateGrantRequest |
withConstraints(GrantConstraints constraints)
Allows a cryptographic operation only when the encryption context matches or
includes the encryption context specified in this structure.
|
CreateGrantRequest |
withGranteePrincipal(java.lang.String granteePrincipal)
The principal that is given permission to perform the operations that the
grant permits.
|
CreateGrantRequest |
withGrantTokens(java.util.Collection<java.lang.String> grantTokens)
A list of grant tokens.
|
CreateGrantRequest |
withGrantTokens(java.lang.String... grantTokens)
A list of grant tokens.
|
CreateGrantRequest |
withKeyId(java.lang.String keyId)
The unique identifier for the customer master key (CMK) that the grant
applies to.
|
CreateGrantRequest |
withName(java.lang.String name)
A friendly name for the grant.
|
CreateGrantRequest |
withOperations(java.util.Collection<java.lang.String> operations)
A list of operations that the grant permits.
|
CreateGrantRequest |
withOperations(java.lang.String... operations)
A list of operations that the grant permits.
|
CreateGrantRequest |
withRetiringPrincipal(java.lang.String retiringPrincipal)
The principal that is given permission to retire the grant by using
RetireGrant operation.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String getKeyId()
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.
Constraints:
Length: 1 - 2048
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.
public void setKeyId(java.lang.String keyId)
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.
Constraints:
Length: 1 - 2048
keyId
- 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.
public CreateGrantRequest withKeyId(java.lang.String keyId)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 2048
keyId
- 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.
public java.lang.String getGranteePrincipal()
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.
Constraints:
Length: 1 - 256
Pattern: ^[\w+=,.@:/-]+$
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.
public void setGranteePrincipal(java.lang.String 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, 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.
Constraints:
Length: 1 - 256
Pattern: ^[\w+=,.@:/-]+$
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, 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.
public CreateGrantRequest withGranteePrincipal(java.lang.String 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, 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
Pattern: ^[\w+=,.@:/-]+$
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, 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.
public java.lang.String getRetiringPrincipal()
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.
Constraints:
Length: 1 - 256
Pattern: ^[\w+=,.@:/-]+$
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.
public void setRetiringPrincipal(java.lang.String 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.
Constraints:
Length: 1 - 256
Pattern: ^[\w+=,.@:/-]+$
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.
public CreateGrantRequest withRetiringPrincipal(java.lang.String 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
Pattern: ^[\w+=,.@:/-]+$
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.
public java.util.List<java.lang.String> getOperations()
A list of operations that the grant permits.
A list of operations that the grant permits.
public void setOperations(java.util.Collection<java.lang.String> operations)
A list of operations that the grant permits.
operations
- A list of operations that the grant permits.
public CreateGrantRequest withOperations(java.lang.String... operations)
A list of operations that the grant permits.
Returns a reference to this object so that method calls can be chained together.
operations
- A list of operations that the grant permits.
public CreateGrantRequest withOperations(java.util.Collection<java.lang.String> operations)
A list of operations that the grant permits.
Returns a reference to this object so that method calls can be chained together.
operations
- A list of operations that the grant permits.
public GrantConstraints getConstraints()
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 DescribeKey or RetireGrant.
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 DescribeKey or RetireGrant.
public void setConstraints(GrantConstraints constraints)
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 DescribeKey or RetireGrant.
constraints
- 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 DescribeKey or RetireGrant.
public CreateGrantRequest withConstraints(GrantConstraints constraints)
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 DescribeKey or RetireGrant.
Returns a reference to this object so that method calls can be chained together.
constraints
- 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 DescribeKey or RetireGrant.
public java.util.List<java.lang.String> getGrantTokens()
A list of grant tokens.
For more information, see Grant Tokens 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.
public void setGrantTokens(java.util.Collection<java.lang.String> grantTokens)
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
grantTokens
- A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
public CreateGrantRequest withGrantTokens(java.lang.String... grantTokens)
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
Returns a reference to this object so that method calls can be chained together.
grantTokens
- A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
public CreateGrantRequest withGrantTokens(java.util.Collection<java.lang.String> grantTokens)
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
Returns a reference to this object so that method calls can be chained together.
grantTokens
- A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
public java.lang.String getName()
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.
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
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.
public void setName(java.lang.String 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.
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
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.
public CreateGrantRequest withName(java.lang.String 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
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.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.