software.amazon.awssdk.services.kms.model

Interface RetireGrantRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<RetireGrantRequest.Builder,RetireGrantRequest>, KMSRequest.Builder, SdkBuilder<RetireGrantRequest.Builder,RetireGrantRequest>, SdkRequest.Builder

Enclosing class:

RetireGrantRequest

public static interface RetireGrantRequest.Builder
extends KMSRequest.Builder, CopyableBuilder<RetireGrantRequest.Builder,RetireGrantRequest>

Method Summary

Modifier and Type	Method and Description
RetireGrantRequest.Builder	grantId(String grantId) Unique identifier of the grant to retire.
RetireGrantRequest.Builder	grantToken(String grantToken) Token that identifies the grant to be retired.
RetireGrantRequest.Builder	keyId(String keyId) The Amazon Resource Name (ARN) of the CMK associated with the grant.
RetireGrantRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
RetireGrantRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.kms.model.KMSRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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

grantToken

RetireGrantRequest.Builder grantToken(String grantToken)

Token that identifies the grant to be retired.

Parameters:

grantToken - Token that identifies the grant to be retired.

Returns:

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

keyId

RetireGrantRequest.Builder keyId(String keyId)

The Amazon Resource Name (ARN) of the CMK associated with the grant.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Parameters:

keyId - The Amazon Resource Name (ARN) of the CMK associated with the grant.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Returns:

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

grantId

RetireGrantRequest.Builder grantId(String grantId)

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Parameters:

grantId - Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Returns:

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

requestOverrideConfig

RetireGrantRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

RetireGrantRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.