Package software.amazon.awssdk.services.kms.model

Interface ListKeyPoliciesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListKeyPoliciesRequest.Builder,ListKeyPoliciesRequest>, KmsRequest.Builder, SdkBuilder<ListKeyPoliciesRequest.Builder,ListKeyPoliciesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListKeyPoliciesRequest
public static interface ListKeyPoliciesRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<ListKeyPoliciesRequest.Builder,ListKeyPoliciesRequest>

  • Method Details

    • keyId

      ListKeyPoliciesRequest.Builder keyId(String keyId)

      Gets the names of key policies for the specified KMS key.

      Specify the key ID or key ARN of the KMS key.

      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 KMS key, use ListKeys or DescribeKey.

      Parameters:
      keyId - Gets the names of key policies for the specified KMS key.

      Specify the key ID or key ARN of the KMS key.

      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 KMS key, use ListKeys or DescribeKey.

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

    • limit

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

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

      Only one policy can be attached to a key.

      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.

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

      Only one policy can be attached to a key.

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

    • marker

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

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

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