software.amazon.awssdk.services.kms.model

Interface GrantListEntry.Builder

All Superinterfaces:

CopyableBuilder<GrantListEntry.Builder,GrantListEntry>, SdkBuilder<GrantListEntry.Builder,GrantListEntry>

Enclosing class:

GrantListEntry

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

Method Summary

Modifier and Type	Method and Description
default GrantListEntry.Builder	constraints(Consumer<GrantConstraints.Builder> constraints) A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.
GrantListEntry.Builder	constraints(GrantConstraints constraints) A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.
GrantListEntry.Builder	creationDate(Instant creationDate) The date and time when the grant was created.
GrantListEntry.Builder	granteePrincipal(String granteePrincipal) The principal that receives the grant's permissions.
GrantListEntry.Builder	grantId(String grantId) The unique identifier for the grant.
GrantListEntry.Builder	issuingAccount(String issuingAccount) The AWS account under which the grant was issued.
GrantListEntry.Builder	keyId(String keyId) The unique identifier for the customer master key (CMK) to which the grant applies.
GrantListEntry.Builder	name(String name) The friendly name that identifies the grant.
GrantListEntry.Builder	operations(Collection<String> operations) The list of operations permitted by the grant.
GrantListEntry.Builder	operations(String... operations) The list of operations permitted by the grant.
GrantListEntry.Builder	retiringPrincipal(String retiringPrincipal) The principal that can retire the grant.

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

GrantListEntry.Builder keyId(String keyId)

The unique identifier for the customer master key (CMK) to which the grant applies.

Parameters:

keyId - The unique identifier for the customer master key (CMK) to which the grant applies.

Returns:

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

grantId

GrantListEntry.Builder grantId(String grantId)

The unique identifier for the grant.

Parameters:

grantId - The unique identifier for the grant.

Returns:

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

name

GrantListEntry.Builder name(String name)

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

Parameters:

name - The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

Returns:

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

creationDate

GrantListEntry.Builder creationDate(Instant creationDate)

The date and time when the grant was created.

Parameters:

creationDate - The date and time when the grant was created.

Returns:

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

granteePrincipal

GrantListEntry.Builder granteePrincipal(String granteePrincipal)

The principal that receives the grant's permissions.

Parameters:

granteePrincipal - The principal that receives the grant's permissions.

Returns:

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

retiringPrincipal

GrantListEntry.Builder retiringPrincipal(String retiringPrincipal)

The principal that can retire the grant.

Parameters:

retiringPrincipal - The principal that can retire the grant.

Returns:

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

issuingAccount

GrantListEntry.Builder issuingAccount(String issuingAccount)

The AWS account under which the grant was issued.

Parameters:

issuingAccount - The AWS account under which the grant was issued.

Returns:

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

operations

GrantListEntry.Builder operations(Collection<String> operations)

The list of operations permitted by the grant.

Parameters:

operations - The list of operations permitted by the grant.

Returns:

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

operations

GrantListEntry.Builder operations(String... operations)

The list of operations permitted by the grant.

Parameters:

operations - The list of operations permitted by the grant.

Returns:

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

constraints

GrantListEntry.Builder constraints(GrantConstraints constraints)

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

Parameters:

constraints - A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

Returns:

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

constraints

default GrantListEntry.Builder constraints(Consumer<GrantConstraints.Builder> constraints)

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

This is a convenience that creates an instance of the GrantConstraints.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).

Parameters:

constraints - a consumer that will call methods on GrantConstraints.Builder

Returns:

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

See Also:

constraints(GrantConstraints)