DescribeDBInstancesRequest (AWS SDK for Java

Overview

Package

Class

Index

Help

Did this page help you?
Yes No Tell us about it...

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.rds.model
Class DescribeDBInstancesRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.rds.model.DescribeDBInstancesRequest

public class DescribeDBInstancesRequest
extends AmazonWebServiceRequest
extends AmazonWebServiceRequest

Container for the parameters to the DescribeDBInstances operation.

Returns information about provisioned RDS instances. This API supports pagination.

See Also:: AmazonRDS.describeDBInstances(DescribeDBInstancesRequest)

Constructor Summary
`DescribeDBInstancesRequest()` Default constructor for a new DescribeDBInstancesRequest object.

Method Summary
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDBInstanceIdentifier()` The user-supplied instance identifier.
`java.lang.String`	`getMarker()` An optional pagination token provided by a previous DescribeDBInstances request.
`java.lang.Integer`	`getMaxRecords()` The maximum number of records to include in the response.
`int`	`hashCode()`
`void`	`setDBInstanceIdentifier(java.lang.String dBInstanceIdentifier)` The user-supplied instance identifier.
`void`	`setMarker(java.lang.String marker)` An optional pagination token provided by a previous DescribeDBInstances request.
`void`	`setMaxRecords(java.lang.Integer maxRecords)` The maximum number of records to include in the response.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeDBInstancesRequest`	`withDBInstanceIdentifier(java.lang.String dBInstanceIdentifier)` The user-supplied instance identifier.
`DescribeDBInstancesRequest`	`withMarker(java.lang.String marker)` An optional pagination token provided by a previous DescribeDBInstances request.
`DescribeDBInstancesRequest`	`withMaxRecords(java.lang.Integer maxRecords)` The maximum number of records to include in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
`copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

DescribeDBInstancesRequest

public DescribeDBInstancesRequest()

Default constructor for a new DescribeDBInstancesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

Method Detail

getDBInstanceIdentifier

public java.lang.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

setDBInstanceIdentifier

public void setDBInstanceIdentifier(java.lang.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

withDBInstanceIdentifier

public DescribeDBInstancesRequest withDBInstanceIdentifier(java.lang.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

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

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:

A reference to this updated object so that method calls can be chained together.

getMaxRecords

public java.lang.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 may be retrieved.

Default: 100