com.amazonaws.services.kms.model

Class CreateGrantRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.CreateGrantRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateGrantRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateGrant operation.

Adds a grant to a key to specify who can access the key and under what conditions. Grants are alternate permission mechanisms to key policies. For more information about grants, see Grants in the developer guide. If a grant is absent, access to the key is evaluated based on IAM policies attached to the user.

1. ListGrants
2. RetireGrant
3. RevokeGrant

See Also:

AWSKMS.createGrant(CreateGrantRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateGrantRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateGrantRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
GrantConstraints	getConstraints() Specifies the conditions under which the actions specified by the Operations parameter are allowed.
String	getGranteePrincipal() Principal given permission by the grant to use the key identified by the keyId parameter.
List<String>	getGrantTokens() For more information, see Grant Tokens.
String	getKeyId() A unique identifier for the customer master key.
List<String>	getOperations() List of operations permitted by the grant.
String	getRetiringPrincipal() Principal given permission to retire the grant.
int	hashCode()
void	setConstraints(GrantConstraints constraints) Specifies the conditions under which the actions specified by the Operations parameter are allowed.
void	setGranteePrincipal(String granteePrincipal) Principal given permission by the grant to use the key identified by the keyId parameter.
void	setGrantTokens(Collection<String> grantTokens) For more information, see Grant Tokens.
void	setKeyId(String keyId) A unique identifier for the customer master key.
void	setOperations(Collection<String> operations) List of operations permitted by the grant.
void	setRetiringPrincipal(String retiringPrincipal) Principal given permission to retire the grant.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateGrantRequest	withConstraints(GrantConstraints constraints) Specifies the conditions under which the actions specified by the Operations parameter are allowed.
CreateGrantRequest	withGranteePrincipal(String granteePrincipal) Principal given permission by the grant to use the key identified by the keyId parameter.
CreateGrantRequest	withGrantTokens(Collection<String> grantTokens) For more information, see Grant Tokens.
CreateGrantRequest	withGrantTokens(String... grantTokens) For more information, see Grant Tokens.
CreateGrantRequest	withKeyId(String keyId) A unique identifier for the customer master key.
CreateGrantRequest	withOperations(Collection<String> operations) List of operations permitted by the grant.
CreateGrantRequest	withOperations(GrantOperation... operations) List of operations permitted by the grant.
CreateGrantRequest	withOperations(String... operations) List of operations permitted by the grant.
CreateGrantRequest	withRetiringPrincipal(String retiringPrincipal) Principal given permission to retire the grant.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, 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()

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Constraints:
Length: 1 - 256

Returns:

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

setKeyId

public void setKeyId(String keyId)

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Constraints:
Length: 1 - 256

Parameters:

keyId - A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

withKeyId

public CreateGrantRequest withKeyId(String keyId)

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:

keyId - A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Returns:

A reference to this updated object so that method calls can be chained together.

getGranteePrincipal

public String getGranteePrincipal()

Principal given permission by the grant to use the key identified by the keyId parameter.

Constraints:
Length: 1 - 256

Returns:

Principal given permission by the grant to use the key identified by the keyId parameter.

setGranteePrincipal

public void setGranteePrincipal(String granteePrincipal)

Principal given permission by the grant to use the key identified by the keyId parameter.

Constraints:
Length: 1 - 256

Parameters:

granteePrincipal - Principal given permission by the grant to use the key identified by the keyId parameter.

withGranteePrincipal

public CreateGrantRequest withGranteePrincipal(String granteePrincipal)

Principal given permission by the grant to use the key identified by the keyId parameter.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:

granteePrincipal - Principal given permission by the grant to use the key identified by the keyId parameter.

Returns:

A reference to this updated object so that method calls can be chained together.

getRetiringPrincipal

public String getRetiringPrincipal()

Principal given permission to retire the grant. For more information, see RetireGrant.

Constraints:
Length: 1 - 256

Returns:

Principal given permission to retire the grant. For more information, see RetireGrant.

setRetiringPrincipal

public void setRetiringPrincipal(String retiringPrincipal)

Principal given permission to retire the grant. For more information, see RetireGrant.

Constraints:
Length: 1 - 256

Parameters:

retiringPrincipal - Principal given permission to retire the grant. For more information, see RetireGrant.

withRetiringPrincipal

public CreateGrantRequest withRetiringPrincipal(String retiringPrincipal)

Principal given permission to retire the grant. For more information, see RetireGrant.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:

retiringPrincipal - Principal given permission to retire the grant. For more information, see RetireGrant.

Returns:

A reference to this updated object so that method calls can be chained together.

getOperations

public List<String> getOperations()

List of operations permitted by the grant. This can be any combination of one or more of the following values:

1. Decrypt
2. Encrypt
3. GenerateDataKey
4. GenerateDataKeyWithoutPlaintext
5. ReEncryptFrom
6. ReEncryptTo
7. CreateGrant
8. RetireGrant

Returns:

List of operations permitted by the grant. This can be any combination of one or more of the following values:

1. Decrypt
2. Encrypt
3. GenerateDataKey
4. GenerateDataKeyWithoutPlaintext
5. ReEncryptFrom
6. ReEncryptTo
7. CreateGrant
8. RetireGrant

setOperations

public void setOperations(Collection<String> operations)

List of operations permitted by the grant. This can be any combination of one or more of the following values:

1. Decrypt
2. Encrypt
3. GenerateDataKey
4. GenerateDataKeyWithoutPlaintext
5. ReEncryptFrom
6. ReEncryptTo
7. CreateGrant
8. RetireGrant

Parameters:

operations - List of operations permitted by the grant. This can be any combination of one or more of the following values:

1. Decrypt
2. Encrypt
3. GenerateDataKey
4. GenerateDataKeyWithoutPlaintext
5. ReEncryptFrom
6. ReEncryptTo
7. CreateGrant
8. RetireGrant

withOperations

public CreateGrantRequest withOperations(String... operations)

List of operations permitted by the grant. This can be any combination of one or more of the following values:

1. Decrypt
2. Encrypt
3. GenerateDataKey
4. GenerateDataKeyWithoutPlaintext
5. ReEncryptFrom
6. ReEncryptTo
7. CreateGrant
8. RetireGrant

NOTE: This method appends the values to the existing list (if any). Use setOperations(java.util.Collection) or withOperations(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

operations - List of operations permitted by the grant. This can be any combination of one or more of the following values:

1. Decrypt
2. Encrypt
3. GenerateDataKey
4. GenerateDataKeyWithoutPlaintext
5. ReEncryptFrom
6. ReEncryptTo
7. CreateGrant
8. RetireGrant

Returns:

A reference to this updated object so that method calls can be chained together.

withOperations

public CreateGrantRequest withOperations(Collection<String> operations)

List of operations permitted by the grant. This can be any combination of one or more of the following values:

1. Decrypt
2. Encrypt
3. GenerateDataKey
4. GenerateDataKeyWithoutPlaintext
5. ReEncryptFrom
6. ReEncryptTo
7. CreateGrant
8. RetireGrant

Returns a reference to this object so that method calls can be chained together.

Parameters:

operations - List of operations permitted by the grant. This can be any combination of one or more of the following values:

1. Decrypt
2. Encrypt
3. GenerateDataKey
4. GenerateDataKeyWithoutPlaintext
5. ReEncryptFrom
6. ReEncryptTo
7. CreateGrant
8. RetireGrant

Returns:

A reference to this updated object so that method calls can be chained together.

withOperations

public CreateGrantRequest withOperations(GrantOperation... operations)

List of operations permitted by the grant. This can be any combination of one or more of the following values:

1. Decrypt
2. Encrypt
3. GenerateDataKey
4. GenerateDataKeyWithoutPlaintext
5. ReEncryptFrom
6. ReEncryptTo
7. CreateGrant
8. RetireGrant

Returns a reference to this object so that method calls can be chained together.

Parameters:

operations - List of operations permitted by the grant. This can be any combination of one or more of the following values:

1. Decrypt
2. Encrypt
3. GenerateDataKey
4. GenerateDataKeyWithoutPlaintext
5. ReEncryptFrom
6. ReEncryptTo
7. CreateGrant
8. RetireGrant

Returns:

A reference to this updated object so that method calls can be chained together.

getConstraints

public GrantConstraints getConstraints()

Specifies the conditions under which the actions specified by the Operations parameter are allowed.

Returns:

Specifies the conditions under which the actions specified by the Operations parameter are allowed.

setConstraints

public void setConstraints(GrantConstraints constraints)

Specifies the conditions under which the actions specified by the Operations parameter are allowed.

Parameters:

constraints - Specifies the conditions under which the actions specified by the Operations parameter are allowed.

withConstraints

public CreateGrantRequest withConstraints(GrantConstraints constraints)

Specifies the conditions under which the actions specified by the Operations parameter are allowed.

Returns a reference to this object so that method calls can be chained together.

Parameters:

constraints - Specifies the conditions under which the actions specified by the Operations parameter are allowed.

Returns:

A reference to this updated object so that method calls can be chained together.

getGrantTokens

public List<String> getGrantTokens()

For more information, see Grant Tokens.

Constraints:
Length: 0 - 10

Returns:

For more information, see Grant Tokens.

setGrantTokens

public void setGrantTokens(Collection<String> grantTokens)

For more information, see Grant Tokens.

Constraints:
Length: 0 - 10

Parameters:

grantTokens - For more information, see Grant Tokens.

withGrantTokens

public CreateGrantRequest withGrantTokens(String... grantTokens)

For more information, see Grant Tokens.

NOTE: This method appends the values to the existing list (if any). Use setGrantTokens(java.util.Collection) or withGrantTokens(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 10

Parameters:

grantTokens - For more information, see Grant Tokens.

Returns:

A reference to this updated object so that method calls can be chained together.

withGrantTokens

public CreateGrantRequest withGrantTokens(Collection<String> grantTokens)

For more information, see Grant Tokens.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 10

Parameters:

grantTokens - For more information, see Grant Tokens.

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

clone

public CreateGrantRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()