Package 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
@Mutable @NotThreadSafe public static interface DescribeCustomKeyStoresRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<DescribeCustomKeyStoresRequest.Builder,DescribeCustomKeyStoresRequest>

  • Method Details

    • 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, provide 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, provide 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, provide 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, provide 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, 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, 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)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder

    • overrideConfiguration

      DescribeCustomKeyStoresRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder