software.amazon.awssdk.services.kms.model

Interface DescribeCustomKeyStoresRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeCustomKeyStoresRequest.Builder,DescribeCustomKeyStoresRequest>, KmsRequest.Builder, SdkBuilder<DescribeCustomKeyStoresRequest.Builder,DescribeCustomKeyStoresRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeCustomKeyStoresRequest

public static interface DescribeCustomKeyStoresRequest.Builder
extends KmsRequest.Builder, SdkPojo, CopyableBuilder<DescribeCustomKeyStoresRequest.Builder,DescribeCustomKeyStoresRequest>

Method Summary

Modifier and Type	Method and Description
DescribeCustomKeyStoresRequest.Builder	customKeyStoreId(String customKeyStoreId) Gets only information about the specified custom key store.
DescribeCustomKeyStoresRequest.Builder	customKeyStoreName(String customKeyStoreName) Gets only information about the specified custom key store.
DescribeCustomKeyStoresRequest.Builder	limit(Integer limit) Use this parameter to specify the maximum number of items to return.
DescribeCustomKeyStoresRequest.Builder	marker(String marker) Use this parameter in a subsequent request after you receive a response with truncated results.
DescribeCustomKeyStoresRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DescribeCustomKeyStoresRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

customKeyStoreId

DescribeCustomKeyStoresRequest.Builder customKeyStoreId(String customKeyStoreId)

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Parameters:

customKeyStoreId - Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Returns:

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

customKeyStoreName

DescribeCustomKeyStoresRequest.Builder customKeyStoreName(String customKeyStoreName)

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Parameters:

customKeyStoreName - Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

Returns:

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

limit

DescribeCustomKeyStoresRequest.Builder limit(Integer limit)

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

Parameters:

limit - Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

Returns:

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

marker

DescribeCustomKeyStoresRequest.Builder marker(String marker)

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Parameters:

marker - Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Returns:

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

overrideConfiguration

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

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