CreateGrantRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kms.model.CreateGrantRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class CreateGrantRequest
extends AmazonWebServiceRequest
implements 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.

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 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.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateGrantRequest()

Constructors
Constructor and Description
`CreateGrantRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`GrantConstraints`	`getConstraints()` Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure.
`String`	`getGranteePrincipal()` The principal that is given permission to perform the operations that the grant permits.
`List<String>`	`getGrantTokens()` A list of grant tokens.
`String`	`getKeyId()` The unique identifier for the customer master key (CMK) that the grant applies to.
`String`	`getName()` A friendly name for identifying the grant.
`List<String>`	`getOperations()` A list of operations that the grant permits.
`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(String granteePrincipal)` The principal that is given permission to perform the operations that the grant permits.
`void`	`setGrantTokens(Collection<String> grantTokens)` A list of grant tokens.
`void`	`setKeyId(String keyId)` The unique identifier for the customer master key (CMK) that the grant applies to.
`void`	`setName(String name)` A friendly name for identifying the grant.
`void`	`setOperations(Collection<String> operations)` A list of operations that the grant permits.
`void`	`setRetiringPrincipal(String retiringPrincipal)` The principal that is given permission to retire the grant by using RetireGrant operation.
`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(String granteePrincipal)` The principal that is given permission to perform the operations that the grant permits.
`CreateGrantRequest`	`withGrantTokens(Collection<String> grantTokens)` A list of grant tokens.
`CreateGrantRequest`	`withGrantTokens(String... grantTokens)` A list of grant tokens.
`CreateGrantRequest`	`withKeyId(String keyId)` The unique identifier for the customer master key (CMK) that the grant applies to.
`CreateGrantRequest`	`withName(String name)` A friendly name for identifying the grant.
`CreateGrantRequest`	`withOperations(Collection<String> operations)` A list of operations that the grant permits.
`CreateGrantRequest`	`withOperations(String... operations)` A list of operations that the grant permits.
`CreateGrantRequest`	`withRetiringPrincipal(String retiringPrincipal)` The principal that is given permission to retire the grant by using RetireGrant operation.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateGrantRequest
```
public CreateGrantRequest()
```
- Method Detail
  - getKeyId
```
public 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
    Returns:
    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.
  - setKeyId
```
public void setKeyId(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
    Parameters:
    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.
  - withKeyId
```
public CreateGrantRequest withKeyId(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
    Parameters:
    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 updated object so that method calls can be chained together.
  - getGranteePrincipal
```
public 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+=,.@:/-]+$
    
    Returns:
    
    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.
  - setGranteePrincipal
```
public void setGranteePrincipal(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+=,.@:/-]+$
    
    Parameters:
    
    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.
  - withGranteePrincipal
```
public CreateGrantRequest withGranteePrincipal(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+=,.@:/-]+$
    
    Parameters:
    
    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 updated object so that method calls can be chained together.
  - getRetiringPrincipal
```
public 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+=,.@:/-]+$
    
    Returns:
    
    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.
  - setRetiringPrincipal
```
public void setRetiringPrincipal(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+=,.@:/-]+$
    
    Parameters:
    
    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.
  - withRetiringPrincipal
```
public CreateGrantRequest withRetiringPrincipal(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+=,.@:/-]+$
    
    Parameters:
    
    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 updated object so that method calls can be chained together.
  - getOperations
```
public List<String> getOperations()
```
    A list of operations that the grant permits.
    
    Returns:
    
    A list of operations that the grant permits.
  - setOperations
```
public void setOperations(Collection<String> operations)
```
    A list of operations that the grant permits.
    
    Parameters:
    
    operations -
    A list of operations that the grant permits.
  - withOperations
```
public CreateGrantRequest withOperations(String... operations)
```
    A list of operations that the grant permits.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    operations -
    A list of operations that the grant permits.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withOperations
```
public CreateGrantRequest withOperations(Collection<String> operations)
```
    A list of operations that the grant permits.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    operations -
    A list of operations that the grant permits.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getConstraints
```
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 .
    
    Returns:
    
    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 .
  - setConstraints
```
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 .
    
    Parameters:
    
    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 .
  - withConstraints
```
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 .
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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 .
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getGrantTokens
```
public List<String> getGrantTokens()
```
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
  - setGrantTokens
```
public void setGrantTokens(Collection<String> grantTokens)
```
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Parameters:
    
    grantTokens -
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
  - withGrantTokens
```
public CreateGrantRequest withGrantTokens(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.
    
    Parameters:
    
    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 updated object so that method calls can be chained together.
  - withGrantTokens
```
public CreateGrantRequest withGrantTokens(Collection<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.
    
    Parameters:
    
    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 updated object so that method calls can be chained together.
  - getName
```
public String getName()
```
    A friendly name for identifying 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 obtained in this way can be used interchangeably.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^[a-zA-Z0-9:/_-]+$
    
    Returns:
    
    A friendly name for identifying 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 obtained in this way can be used interchangeably.
  - setName
```
public void setName(String name)
```
    A friendly name for identifying 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 obtained in this way can be used interchangeably.
    
    Constraints:
    Length: 1 - 256
    Pattern: ^[a-zA-Z0-9:/_-]+$
    
    Parameters:
    
    name -
    A friendly name for identifying 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 obtained in this way can be used interchangeably.
  - withName
```
public CreateGrantRequest withName(String name)
```
    A friendly name for identifying 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 obtained in this way 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:/_-]+$
    
    Parameters:
    
    name -
    A friendly name for identifying 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 obtained in this way can be used interchangeably.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class CreateGrantRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateGrantRequest

Method Detail

getKeyId

setKeyId

withKeyId

getGranteePrincipal

setGranteePrincipal

withGranteePrincipal

getRetiringPrincipal

setRetiringPrincipal

withRetiringPrincipal

getOperations

setOperations

withOperations

withOperations

getConstraints

setConstraints

withConstraints

getGrantTokens

setGrantTokens

withGrantTokens

withGrantTokens

getName

setName

withName

toString

hashCode

equals