com.amazonaws.services.rds.model

Class DescribeDBInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.DescribeDBInstancesRequest

All Implemented Interfaces:

Serializable, Cloneable

public class DescribeDBInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeDBInstances operation.

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

See Also:

AmazonRDS.describeDBInstances(DescribeDBInstancesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeDBInstancesRequest() Default constructor for a new DescribeDBInstancesRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
DescribeDBInstancesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDBInstanceIdentifier() The user-supplied instance identifier.
List<Filter>	getFilters() This parameter is not currently supported.
String	getMarker() An optional pagination token provided by a previous DescribeDBInstances request.
Integer	getMaxRecords() The maximum number of records to include in the response.
int	hashCode()
void	setDBInstanceIdentifier(String dBInstanceIdentifier) The user-supplied instance identifier.
void	setFilters(Collection<Filter> filters) This parameter is not currently supported.
void	setMarker(String marker) An optional pagination token provided by a previous DescribeDBInstances request.
void	setMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeDBInstancesRequest	withDBInstanceIdentifier(String dBInstanceIdentifier) The user-supplied instance identifier.
DescribeDBInstancesRequest	withFilters(Collection<Filter> filters) This parameter is not currently supported.
DescribeDBInstancesRequest	withFilters(Filter... filters) This parameter is not currently supported.
DescribeDBInstancesRequest	withMarker(String marker) An optional pagination token provided by a previous DescribeDBInstances request.
DescribeDBInstancesRequest	withMaxRecords(Integer maxRecords) The maximum number of records to include in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, 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 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(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(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.

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.

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

Parameters:

filters - This parameter is not currently supported.

Returns:

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

withFilters

public DescribeDBInstancesRequest withFilters(Collection<Filter> filters)

This parameter is not currently supported.

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

Parameters:

filters - This parameter is not currently supported.

Returns:

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

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

Default: 100

Constraints: minimum 20, maximum 100

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

Default: 100

Constraints: minimum 20, maximum 100

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

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

Default: 100

Constraints: minimum 20, maximum 100

Returns:

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

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 .

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 .

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 .

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

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:

A reference to this updated 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:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeDBInstancesRequest 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:

Object.clone()