Interface DescribeDbCapacityReservationsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeDbCapacityReservationsRequest.Builder,DescribeDbCapacityReservationsRequest>, RdsRequest.Builder, SdkBuilder<DescribeDbCapacityReservationsRequest.Builder,DescribeDbCapacityReservationsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeDbCapacityReservationsRequest
@Mutable @NotThreadSafe public static interface DescribeDbCapacityReservationsRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<DescribeDbCapacityReservationsRequest.Builder,DescribeDbCapacityReservationsRequest>

  • Method Details

    • dbCapacityReservationIdentifier

      DescribeDbCapacityReservationsRequest.Builder dbCapacityReservationIdentifier(String dbCapacityReservationIdentifier)

      The identifier or the name of the DB capacity reservation to describe. You can specify the identifier, which has the prefix dbcr-, or the reservation name.

      Parameters:
      dbCapacityReservationIdentifier - The identifier or the name of the DB capacity reservation to describe. You can specify the identifier, which has the prefix dbcr-, or the reservation name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • marker

      DescribeDbCapacityReservationsRequest.Builder marker(String marker)

      An optional pagination token provided by a previous DescribeDBCapacityReservations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      Parameters:
      marker - An optional pagination token provided by a previous DescribeDBCapacityReservations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxRecords

      DescribeDbCapacityReservationsRequest.Builder maxRecords(Integer maxRecords)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

      Default: 100

      Constraints:

      • Must be a minimum of 20.

      • Can't exceed 100.

      Parameters:
      maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

      Default: 100

      Constraints:

      • Must be a minimum of 20.

      • Can't exceed 100.

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

    • filters

      DescribeDbCapacityReservationsRequest.Builder filters(Collection<Filter> filters)

      A filter that specifies which DB capacity reservations to describe.

      Supported filters:

      • db-capacity-reservation-name - Accepts DB capacity reservation names. The response includes only the reservations that these names identify. Use this filter to describe several reservations by name in one request.

      • state - Accepts reservation states. The response includes only the reservations in these states.

      • engine - Accepts database engine names. The response includes only the reservations that reserve capacity for these engines.

      • db-instance-class - Accepts DB instance classes. The response includes only the reservations that reserve capacity for these DB instance classes.

      • availability-zone - Accepts Availability Zone names. The response includes only the reservations that cover these Availability Zones.

      When you specify more than one value for a filter, the response includes the reservations that match any of those values. When you specify more than one filter, the response includes only the reservations that match every filter.

      Amazon RDS rejects the request when a filter name isn't in this list, or when a filter specifies no values.

      The state filter doesn't accept expired. To find an expired reservation, compare EndDate against the current date and time.

      Parameters:
      filters - A filter that specifies which DB capacity reservations to describe.

      Supported filters:

      • db-capacity-reservation-name - Accepts DB capacity reservation names. The response includes only the reservations that these names identify. Use this filter to describe several reservations by name in one request.

      • state - Accepts reservation states. The response includes only the reservations in these states.

      • engine - Accepts database engine names. The response includes only the reservations that reserve capacity for these engines.

      • db-instance-class - Accepts DB instance classes. The response includes only the reservations that reserve capacity for these DB instance classes.

      • availability-zone - Accepts Availability Zone names. The response includes only the reservations that cover these Availability Zones.

      When you specify more than one value for a filter, the response includes the reservations that match any of those values. When you specify more than one filter, the response includes only the reservations that match every filter.

      Amazon RDS rejects the request when a filter name isn't in this list, or when a filter specifies no values.

      The state filter doesn't accept expired. To find an expired reservation, compare EndDate against the current date and time.

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

    • filters

      DescribeDbCapacityReservationsRequest.Builder filters(Filter... filters)

      A filter that specifies which DB capacity reservations to describe.

      Supported filters:

      • db-capacity-reservation-name - Accepts DB capacity reservation names. The response includes only the reservations that these names identify. Use this filter to describe several reservations by name in one request.

      • state - Accepts reservation states. The response includes only the reservations in these states.

      • engine - Accepts database engine names. The response includes only the reservations that reserve capacity for these engines.

      • db-instance-class - Accepts DB instance classes. The response includes only the reservations that reserve capacity for these DB instance classes.

      • availability-zone - Accepts Availability Zone names. The response includes only the reservations that cover these Availability Zones.

      When you specify more than one value for a filter, the response includes the reservations that match any of those values. When you specify more than one filter, the response includes only the reservations that match every filter.

      Amazon RDS rejects the request when a filter name isn't in this list, or when a filter specifies no values.

      The state filter doesn't accept expired. To find an expired reservation, compare EndDate against the current date and time.

      Parameters:
      filters - A filter that specifies which DB capacity reservations to describe.

      Supported filters:

      • db-capacity-reservation-name - Accepts DB capacity reservation names. The response includes only the reservations that these names identify. Use this filter to describe several reservations by name in one request.

      • state - Accepts reservation states. The response includes only the reservations in these states.

      • engine - Accepts database engine names. The response includes only the reservations that reserve capacity for these engines.

      • db-instance-class - Accepts DB instance classes. The response includes only the reservations that reserve capacity for these DB instance classes.

      • availability-zone - Accepts Availability Zone names. The response includes only the reservations that cover these Availability Zones.

      When you specify more than one value for a filter, the response includes the reservations that match any of those values. When you specify more than one filter, the response includes only the reservations that match every filter.

      Amazon RDS rejects the request when a filter name isn't in this list, or when a filter specifies no values.

      The state filter doesn't accept expired. To find an expired reservation, compare EndDate against the current date and time.

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

    • filters

      DescribeDbCapacityReservationsRequest.Builder filters(Consumer<Filter.Builder>... filters)

      A filter that specifies which DB capacity reservations to describe.

      Supported filters:

      • db-capacity-reservation-name - Accepts DB capacity reservation names. The response includes only the reservations that these names identify. Use this filter to describe several reservations by name in one request.

      • state - Accepts reservation states. The response includes only the reservations in these states.

      • engine - Accepts database engine names. The response includes only the reservations that reserve capacity for these engines.

      • db-instance-class - Accepts DB instance classes. The response includes only the reservations that reserve capacity for these DB instance classes.

      • availability-zone - Accepts Availability Zone names. The response includes only the reservations that cover these Availability Zones.

      When you specify more than one value for a filter, the response includes the reservations that match any of those values. When you specify more than one filter, the response includes only the reservations that match every filter.

      Amazon RDS rejects the request when a filter name isn't in this list, or when a filter specifies no values.

      The state filter doesn't accept expired. To find an expired reservation, compare EndDate against the current date and time.

      This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<Filter>).

      Parameters:
      filters - a consumer that will call methods on Filter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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