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
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description CreateGrantRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateGrantRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
GrantConstraints
getConstraints()
The conditions under which the operations permitted by the grant are allowed.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)
The conditions under which the operations permitted by the grant are allowed.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)
The conditions under which the operations permitted by the grant are allowed.CreateGrantRequest
withGranteePrincipal(String granteePrincipal)
The principal that is given permission to perform the operations that the grant permits.CreateGrantRequest
withGrantTokens(String... grantTokens)
A list of grant tokens.CreateGrantRequest
withGrantTokens(Collection<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(GrantOperation... operations)
A list of operations that the grant permits.CreateGrantRequest
withOperations(String... operations)
A list of operations that the grant permits.CreateGrantRequest
withOperations(Collection<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
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setKeyId
public void setKeyId(String keyId)
The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234- 123456789012
- Parameters:
keyId
- The unique identifier for the customer master key (CMK) that the grant applies to.To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234- 1234-123456789012
-
-
-
getKeyId
public String getKeyId()
The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234- 123456789012
- Returns:
- The unique identifier for the customer master key (CMK) that the
grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234 -1234-123456789012
-
-
-
withKeyId
public CreateGrantRequest withKeyId(String keyId)
The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234- 123456789012
- Parameters:
keyId
- The unique identifier for the customer master key (CMK) that the grant applies to.To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
-
Globally unique key ID: 12345678-1234-1234-1234-123456789012
-
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234- 1234-123456789012
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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, 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.
- 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, 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.
-
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, 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:
- 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, 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, 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.
- 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, 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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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.
-
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.
- 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.
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
getOperations
public List<String> getOperations()
A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
- Returns:
- A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
- See Also:
GrantOperation
-
setOperations
public void setOperations(Collection<String> operations)
A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
- Parameters:
operations
- A list of operations that the grant permits. The list can contain any combination of one or more of the following values:- See Also:
GrantOperation
-
withOperations
public CreateGrantRequest withOperations(String... operations)
A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
NOTE: This method appends the values to the existing list (if any). Use
setOperations(java.util.Collection)
orwithOperations(java.util.Collection)
if you want to override the existing values.- Parameters:
operations
- A list of operations that the grant permits. The list can contain any combination of one or more of the following values:- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
GrantOperation
-
withOperations
public CreateGrantRequest withOperations(Collection<String> operations)
A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
- Parameters:
operations
- A list of operations that the grant permits. The list can contain any combination of one or more of the following values:- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
GrantOperation
-
withOperations
public CreateGrantRequest withOperations(GrantOperation... operations)
A list of operations that the grant permits. The list can contain any combination of one or more of the following values:
- Parameters:
operations
- A list of operations that the grant permits. The list can contain any combination of one or more of the following values:- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
GrantOperation
-
setConstraints
public void setConstraints(GrantConstraints constraints)
The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
- Parameters:
constraints
- The conditions under which the operations permitted by the grant are allowed.You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
-
getConstraints
public GrantConstraints getConstraints()
The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
- Returns:
- The conditions under which the operations permitted by the grant
are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
-
withConstraints
public CreateGrantRequest withConstraints(GrantConstraints constraints)
The conditions under which the operations permitted by the grant are allowed.
You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
- Parameters:
constraints
- The conditions under which the operations permitted by the grant are allowed.You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
- Returns:
- Returns a reference to this 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.
NOTE: This method appends the values to the existing list (if any). Use
setGrantTokens(java.util.Collection)
orwithGrantTokens(java.util.Collection)
if you want to override the existing values.- Parameters:
grantTokens
- A list of grant tokens.For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
- Returns:
- Returns a reference to this 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.
- Parameters:
grantTokens
- A list of grant tokens.For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setName
public void setName(String name)
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 uniqueGrantId
even if all the supplied parameters are identical. This can result in unintended duplicates when you retry theCreateGrant
request.When this value is present, you can retry a
CreateGrant
request with identical parameters; if the grant already exists, the originalGrantId
is returned without creating a new grant. Note that the returned grant token is unique with everyCreateGrant
request, even when a duplicateGrantId
is returned. All grant tokens obtained in this way can be used interchangeably.- Parameters:
name
- 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 uniqueGrantId
even if all the supplied parameters are identical. This can result in unintended duplicates when you retry theCreateGrant
request.When this value is present, you can retry a
CreateGrant
request with identical parameters; if the grant already exists, the originalGrantId
is returned without creating a new grant. Note that the returned grant token is unique with everyCreateGrant
request, even when a duplicateGrantId
is returned. All grant tokens obtained in this way can be used interchangeably.
-
getName
public String getName()
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 uniqueGrantId
even if all the supplied parameters are identical. This can result in unintended duplicates when you retry theCreateGrant
request.When this value is present, you can retry a
CreateGrant
request with identical parameters; if the grant already exists, the originalGrantId
is returned without creating a new grant. Note that the returned grant token is unique with everyCreateGrant
request, even when a duplicateGrantId
is returned. All grant tokens obtained in this way can be used interchangeably.- Returns:
- 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 uniqueGrantId
even if all the supplied parameters are identical. This can result in unintended duplicates when you retry theCreateGrant
request.When this value is present, you can retry a
CreateGrant
request with identical parameters; if the grant already exists, the originalGrantId
is returned without creating a new grant. Note that the returned grant token is unique with everyCreateGrant
request, even when a duplicateGrantId
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 unintended creation of duplicate grants when retrying this request.
When this value is absent, all
CreateGrant
requests result in a new grant with a uniqueGrantId
even if all the supplied parameters are identical. This can result in unintended duplicates when you retry theCreateGrant
request.When this value is present, you can retry a
CreateGrant
request with identical parameters; if the grant already exists, the originalGrantId
is returned without creating a new grant. Note that the returned grant token is unique with everyCreateGrant
request, even when a duplicateGrantId
is returned. All grant tokens obtained in this way can be used interchangeably.- Parameters:
name
- 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 uniqueGrantId
even if all the supplied parameters are identical. This can result in unintended duplicates when you retry theCreateGrant
request.When this value is present, you can retry a
CreateGrant
request with identical parameters; if the grant already exists, the originalGrantId
is returned without creating a new grant. Note that the returned grant token is unique with everyCreateGrant
request, even when a duplicateGrantId
is returned. All grant tokens obtained in this way can be used interchangeably.- Returns:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
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 classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-