software.amazon.awssdk.services.kms.model

Interface ScheduleKeyDeletionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<ScheduleKeyDeletionRequest.Builder,ScheduleKeyDeletionRequest>, KmsRequest.Builder, SdkBuilder<ScheduleKeyDeletionRequest.Builder,ScheduleKeyDeletionRequest>, SdkRequest.Builder

Enclosing class:

ScheduleKeyDeletionRequest

public static interface ScheduleKeyDeletionRequest.Builder
extends KmsRequest.Builder, CopyableBuilder<ScheduleKeyDeletionRequest.Builder,ScheduleKeyDeletionRequest>

Method Summary

Modifier and Type	Method and Description
ScheduleKeyDeletionRequest.Builder	keyId(String keyId) The unique identifier of the customer master key (CMK) to delete.
ScheduleKeyDeletionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ScheduleKeyDeletionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ScheduleKeyDeletionRequest.Builder	pendingWindowInDays(Integer pendingWindowInDays) The waiting period, specified in number of days.

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

build

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

overrideConfiguration

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

copy

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

applyMutation, build

Method Detail

keyId

ScheduleKeyDeletionRequest.Builder keyId(String keyId)

The unique identifier of the customer master key (CMK) to delete.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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.

Parameters:

keyId - The unique identifier of the customer master key (CMK) to delete.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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.

Returns:

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

pendingWindowInDays

ScheduleKeyDeletionRequest.Builder pendingWindowInDays(Integer pendingWindowInDays)

The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.

Parameters:

pendingWindowInDays - The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.

Returns:

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

overrideConfiguration

ScheduleKeyDeletionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ScheduleKeyDeletionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.