Package software.amazon.awssdk.services.kms.model

Interface CreateGrantRequest.Builder

All Superinterfaces:

CopyableBuilder<CreateGrantRequest.Builder,CreateGrantRequest>, SdkBuilder<CreateGrantRequest.Builder,CreateGrantRequest>

Enclosing class:

CreateGrantRequest

public static interface CreateGrantRequest.Builder
extends CopyableBuilder<CreateGrantRequest.Builder,CreateGrantRequest>

Method Summary

Modifier and Type	Method	Description
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(String... grantTokens)	A list of grant tokens.
CreateGrantRequest.Builder	grantTokens(Collection<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(String... operations)	A list of operations that the grant permits.
CreateGrantRequest.Builder	operations(Collection<String> operations)	A list of operations that the grant permits.
CreateGrantRequest.Builder	operations(GrantOperation... operations)	A list of operations that the grant permits.
CreateGrantRequest.Builder	retiringPrincipal(String retiringPrincipal)	The principal that is given permission to retire the grant by using RetireGrant operation.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

keyId

CreateGrantRequest.Builder keyId(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.

granteePrincipal

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.

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, 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

retiringPrincipal

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.

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.

operations

CreateGrantRequest.Builder operations(Collection<String> operations)

A list of operations that the grant permits.

Parameters:

operations - A list of operations that the grant permits.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GrantOperation

operations

CreateGrantRequest.Builder operations(String... operations)

A list of operations that the grant permits.

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.

Parameters:

operations - A list of operations that the grant permits.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GrantOperation

operations

CreateGrantRequest.Builder operations(GrantOperation... operations)

A list of operations that the grant permits.

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.

Parameters:

operations - A list of operations that the grant permits.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GrantOperation

constraints

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

grantTokens

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.

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.

grantTokens

CreateGrantRequest.Builder grantTokens(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) or #withGrantTokens(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.

name

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.

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 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:

Returns a reference to this object so that method calls can be chained together.