@Generated(value="software.amazon.awssdk:codegen") public class CreateGrantRequest extends KMSRequest implements ToCopyableBuilder<CreateGrantRequest.Builder,CreateGrantRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateGrantRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateGrantRequest.Builder |
builder() |
GrantConstraints |
constraints()
A structure that you can use to allow certain operations in the grant only when the desired encryption context is
present.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
String |
granteePrincipal()
The principal that is given permission to perform the operations that the grant permits.
|
List<String> |
grantTokens()
A list of grant tokens.
|
int |
hashCode() |
String |
keyId()
The unique identifier for the customer master key (CMK) that the grant applies to.
|
String |
name()
A friendly name for identifying the grant.
|
List<GrantOperation> |
operations()
A list of operations that the grant permits.
|
List<String> |
operationsStrings()
A list of operations that the grant permits.
|
String |
retiringPrincipal()
The principal that is given permission to retire the grant by using RetireGrant operation.
|
static Class<? extends CreateGrantRequest.Builder> |
serializableBuilderClass() |
CreateGrantRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public 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.
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.
public 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.
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.
public 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.
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<GrantOperation> operations()
A list of operations that the grant permits.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> operationsStrings()
A list of operations that the grant permits.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public GrantConstraints constraints()
A structure that you can use to allow certain operations in the grant only when the desired encryption context is present. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide.
public List<String> grantTokens()
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
public 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.
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.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateGrantRequest.Builder,CreateGrantRequest>
toBuilder
in class KMSRequest
public static CreateGrantRequest.Builder builder()
public static Class<? extends CreateGrantRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.