public class CreateGrantRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
CreateGrant operation.
Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.
For more information about grants, see Grants in the AWS Key Management Service Developer Guide .
NOOP| Constructor and Description |
|---|
CreateGrantRequest() |
| Modifier and Type | Method and Description |
|---|---|
CreateGrantRequest |
clone() |
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(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(GrantOperation... 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.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic String getKeyId()
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
Constraints:
Length: 1 - 256
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
public void setKeyId(String keyId)
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
Constraints:
Length: 1 - 256
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:
public CreateGrantRequest withKeyId(String keyId)
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
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:
public String getGranteePrincipal()
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
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 setGranteePrincipal(String granteePrincipal)
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
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.
public CreateGrantRequest withGranteePrincipal(String granteePrincipal)
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
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.
public String getRetiringPrincipal()
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
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(String retiringPrincipal)
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
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(String retiringPrincipal)
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
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 List<String> getOperations()
public void setOperations(Collection<String> operations)
operations - A list of operations that the grant permits. The list can contain any
combination of one or more of the following values: public CreateGrantRequest withOperations(String... operations)
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.
operations - A list of operations that the grant permits. The list can contain any
combination of one or more of the following values: public CreateGrantRequest withOperations(Collection<String> operations)
Returns a reference to this object so that method calls can be chained together.
operations - A list of operations that the grant permits. The list can contain any
combination of one or more of the following values: public CreateGrantRequest withOperations(GrantOperation... operations)
Returns a reference to this object so that method calls can be chained together.
operations - A list of operations that the grant permits. The list can contain any
combination of one or more of the following values: public GrantConstraints getConstraints()
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.
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.
public void setConstraints(GrantConstraints constraints)
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.
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.
public CreateGrantRequest withConstraints(GrantConstraints constraints)
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 a reference to this object so that method calls can be chained together.
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.
public List<String> getGrantTokens()
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
Constraints:
Length: 0 - 10
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
public void setGrantTokens(Collection<String> grantTokens)
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
Constraints:
Length: 0 - 10
grantTokens - A list of grant tokens. For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
public CreateGrantRequest withGrantTokens(String... grantTokens)
For more information, go to 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) 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
grantTokens - A list of grant tokens. For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
public CreateGrantRequest withGrantTokens(Collection<String> grantTokens)
For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 10
grantTokens - A list of grant tokens. For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.
public String getName()
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:/_-]+$
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.
public void setName(String name)
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:/_-]+$
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 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.
public CreateGrantRequest withName(String name)
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:/_-]+$
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 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.
public String toString()
toString in class ObjectObject.toString()public CreateGrantRequest clone()
clone in class AmazonWebServiceRequestCopyright © 2015. All rights reserved.