public static interface CreateGrantRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<CreateGrantRequest.Builder,CreateGrantRequest>
| Modifier and Type | Method and Description |
|---|---|
default CreateGrantRequest.Builder |
constraints(Consumer<GrantConstraints.Builder> constraints)
A structure that you can use to allow certain operations in the grant only when the desired encryption
context is present.
|
CreateGrantRequest.Builder |
constraints(GrantConstraints constraints)
A structure that you can use to allow certain operations in the grant only when the desired encryption
context is present.
|
CreateGrantRequest.Builder |
granteePrincipal(String granteePrincipal)
The principal that is given permission to perform the operations that the grant permits.
|
CreateGrantRequest.Builder |
grantTokens(Collection<String> grantTokens)
A list of grant tokens.
|
CreateGrantRequest.Builder |
grantTokens(String... grantTokens)
A list of grant tokens.
|
CreateGrantRequest.Builder |
keyId(String keyId)
The unique identifier for the customer master key (CMK) that the grant applies to.
|
CreateGrantRequest.Builder |
name(String name)
A friendly name for identifying the grant.
|
CreateGrantRequest.Builder |
operations(Collection<GrantOperation> operations)
A list of operations that the grant permits.
|
CreateGrantRequest.Builder |
operations(GrantOperation... operations)
A list of operations that the grant permits.
|
CreateGrantRequest.Builder |
operationsWithStrings(Collection<String> operations)
A list of operations that the grant permits.
|
CreateGrantRequest.Builder |
operationsWithStrings(String... operations)
A list of operations that the grant permits.
|
CreateGrantRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateGrantRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateGrantRequest.Builder |
retiringPrincipal(String retiringPrincipal)
The principal that is given permission to retire the grant by using RetireGrant operation.
|
buildoverrideConfigurationcopyapplyMutation, buildCreateGrantRequest.Builder keyId(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.
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.
CreateGrantRequest.Builder granteePrincipal(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.
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.
CreateGrantRequest.Builder retiringPrincipal(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.
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.
CreateGrantRequest.Builder operationsWithStrings(Collection<String> operations)
A list of operations that the grant permits.
operations - A list of operations that the grant permits.CreateGrantRequest.Builder operationsWithStrings(String... operations)
A list of operations that the grant permits.
operations - A list of operations that the grant permits.CreateGrantRequest.Builder operations(Collection<GrantOperation> operations)
A list of operations that the grant permits.
operations - A list of operations that the grant permits.CreateGrantRequest.Builder operations(GrantOperation... operations)
A list of operations that the grant permits.
operations - A list of operations that the grant permits.CreateGrantRequest.Builder constraints(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.
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.default CreateGrantRequest.Builder constraints(Consumer<GrantConstraints.Builder> 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.
This is a convenience that creates an instance of theGrantConstraints.Builder avoiding the need to
create one manually via GrantConstraints.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to constraints(GrantConstraints).constraints - a consumer that will call methods on GrantConstraints.Builderconstraints(GrantConstraints)CreateGrantRequest.Builder grantTokens(Collection<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.
CreateGrantRequest.Builder grantTokens(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.
CreateGrantRequest.Builder name(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.
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.
CreateGrantRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateGrantRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2019. All rights reserved.