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

Interface ListRetirableGrantsRequest.Builder

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

  • Method Details

    • limit

      ListRetirableGrantsRequest.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 100, inclusive. If you do not include a value, it defaults to 50.

      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 100, inclusive. If you do not include a value, it defaults to 50.

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

    • marker

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

    • retiringPrincipal

      ListRetirableGrantsRequest.Builder retiringPrincipal(String retiringPrincipal)

      The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.

      To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .

      Parameters:
      retiringPrincipal - The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.

      To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid principals include Amazon Web Services accounts, IAM users, IAM roles, federated users, and assumed role users. For help with the ARN syntax for a principal, see IAM ARNs in the Identity and Access Management User Guide .

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

    • overrideConfiguration

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

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