public class CreateGrantRequest extends AmazonWebServiceRequest implements java.io.Serializable
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.
Constructor and Description |
---|
CreateGrantRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
GrantConstraints |
getConstraints()
The conditions under which the operations permitted by the grant are
allowed.
|
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 identifying 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)
The conditions under which the operations permitted by the grant are
allowed.
|
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 identifying 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)
The conditions under which the operations permitted by the grant are
allowed.
|
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 identifying 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.
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
Constraints:
Length: 1 - 256
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
public void setKeyId(java.lang.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
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:
Globally unique key ID: 12345678-1234-1234-1234-123456789012
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234 -1234-123456789012
public CreateGrantRequest withKeyId(java.lang.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
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:
Globally unique key ID: 12345678-1234-1234-1234-123456789012
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234 -1234-123456789012
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, 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
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 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, 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(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, 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 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
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
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
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()
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.
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 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.
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)
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 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 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 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.
Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$
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 void setName(java.lang.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 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(java.lang.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 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 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 © 2010 Amazon Web Services, Inc. All Rights Reserved.