Package software.amazon.awssdk.services.neptune.model

Interface DescribeDbInstancesRequest.Builder

    • 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:

        • If supplied, must match the identifier of an existing DBInstance.

        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:

        • If supplied, must match the identifier of an existing DBInstance.

        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.

        • engine - Accepts an engine name (such as neptune), and restricts the results list to DB instances created by that engine.

        For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB instances are returned, you could use the following command:

        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.

        • engine - Accepts an engine name (such as neptune), and restricts the results list to DB instances created by that engine.

        For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB instances are returned, you could use the following command:

        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.

        • engine - Accepts an engine name (such as neptune), and restricts the results list to DB instances created by that engine.

        For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB instances are returned, you could use the following command:

        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.

        • engine - Accepts an engine name (such as neptune), and restricts the results list to DB instances created by that engine.

        For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB instances are returned, you could use the following command:

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

      • filters

        DescribeDbInstancesRequest.Builder filters​(Consumer<Filter.Builder>... 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.

        • engine - Accepts an engine name (such as neptune), and restricts the results list to DB instances created by that engine.

        For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB instances are returned, you could use the following command:

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

        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:
        #filters(java.util.Collection)

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