Class DescribeDBInstancesRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.rds.model.DescribeDBInstancesRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class DescribeDBInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

See Also:
  • Constructor Details

    • DescribeDBInstancesRequest

      public DescribeDBInstancesRequest()
  • Method Details

    • setDBInstanceIdentifier

      public void setDBInstanceIdentifier(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
    • getDBInstanceIdentifier

      public String getDBInstanceIdentifier()

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

      public DescribeDBInstancesRequest withDBInstanceIdentifier(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.
    • getFilters

      public List<Filter> getFilters()

      This parameter is not currently supported.

      Returns:
      This parameter is not currently supported.
    • setFilters

      public void setFilters(Collection<Filter> filters)

      This parameter is not currently supported.

      Parameters:
      filters - This parameter is not currently supported.
    • withFilters

      public DescribeDBInstancesRequest withFilters(Filter... filters)

      This parameter is not currently supported.

      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 - This parameter is not currently supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withFilters

      public DescribeDBInstancesRequest withFilters(Collection<Filter> filters)

      This parameter is not currently supported.

      Parameters:
      filters - This parameter is not currently supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMaxRecords

      public void setMaxRecords(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.

    • getMaxRecords

      public Integer getMaxRecords()

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

    • withMaxRecords

      public DescribeDBInstancesRequest withMaxRecords(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.
    • setMarker

      public void setMarker(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.
    • getMarker

      public String getMarker()

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

      public DescribeDBInstancesRequest withMarker(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.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: