Package software.amazon.awssdk.services.rds.model

Interface DescribeDBInstancesRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeDBInstancesRequest.Builder,DescribeDBInstancesRequest>, SdkBuilder<DescribeDBInstancesRequest.Builder,DescribeDBInstancesRequest>

Enclosing class:

DescribeDBInstancesRequest

public static interface DescribeDBInstancesRequest.Builder
extends CopyableBuilder<DescribeDBInstancesRequest.Builder,DescribeDBInstancesRequest>

Method Summary

Modifier and Type	Method	Description
DescribeDBInstancesRequest.Builder	dbInstanceIdentifier(String dbInstanceIdentifier)	The user-supplied instance identifier.
DescribeDBInstancesRequest.Builder	filters(Collection<Filter> filters)	A filter that specifies one or more DB instances to describe.
DescribeDBInstancesRequest.Builder	filters(Filter... filters)	A filter that specifies one or more DB instances to describe.
DescribeDBInstancesRequest.Builder	marker(String marker)	An optional pagination token provided by a previous DescribeDBInstances request.
DescribeDBInstancesRequest.Builder	maxRecords(Integer maxRecords)	The maximum number of records to include in the response.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

dbInstanceIdentifier

DescribeDBInstancesRequest.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Parameters:

dbInstanceIdentifier - The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Returns:

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

filters

DescribeDBInstancesRequest.Builder filters(Collection<Filter> filters)

A filter that specifies one or more DB instances to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB Clusters identified by these ARNs.

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

Parameters:

filters - A filter that specifies one or more DB instances to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB Clusters identified by these ARNs.

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

Returns:

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

filters

DescribeDBInstancesRequest.Builder filters(Filter... filters)

A filter that specifies one or more DB instances to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB Clusters identified by these ARNs.

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

NOTE: This method appends the values to the existing list (if any). Use #setFilters(java.util.Collection) or #withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - A filter that specifies one or more DB instances to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB Clusters identified by these ARNs.

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

Returns:

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

maxRecords

DescribeDBInstancesRequest.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 the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 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 the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

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

marker

DescribeDBInstancesRequest.Builder marker(String marker)

An optional pagination token provided by a previous DescribeDBInstances 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 DescribeDBInstances 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.