DescribeDBInstancesRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

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

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDBInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

DescribeDBInstancesRequest ()

Constructors
Constructor and Description
`DescribeDBInstancesRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`DescribeDBInstancesRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getDBInstanceIdentifier ()` The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance.
`List<Filter>`	`getFilters ()` A filter that specifies one or more DB instances to describe.
`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 or the Amazon Resource Name (ARN) of the DB instance.
`void`	`setFilters (Collection<Filter> filters)` A filter that specifies one or more DB instances to describe.
`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.
`DescribeDBInstancesRequest`	`withDBInstanceIdentifier (String dBInstanceIdentifier)` The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance.
`DescribeDBInstancesRequest`	`withFilters (Collection<Filter> filters)` A filter that specifies one or more DB instances to describe.
`DescribeDBInstancesRequest`	`withFilters (Filter... filters)` A filter that specifies one or more DB instances to describe.
`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
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

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

- Constructor Detail
  - DescribeDBInstancesRequest
```
public DescribeDBInstancesRequest()
```
- Method Detail
  - setDBInstanceIdentifier
```
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
```
    The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. 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 DB instance.
    Parameters:
    dBInstanceIdentifier - The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. 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 DB instance.
  - getDBInstanceIdentifier
```
public String getDBInstanceIdentifier()
```
    The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. 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 DB instance.
    Returns:
    The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. 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 DB instance.
  - withDBInstanceIdentifier
```
public DescribeDBInstancesRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
```
    The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. 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 DB instance.
    Parameters:
    dBInstanceIdentifier - The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. 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 DB instance.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFilters
```
public List<Filter> getFilters()
```
    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 only includes 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 only includes information about the DB instances identified by these ARNs.
    - dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.
    - domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.
    - engine - Accepts engine names. The results list only includes information about the DB instances for these engines.
    Returns:
    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 only includes 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 only includes information about the DB instances identified by these ARNs.
    
    dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.
    
    domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.
    
    engine - Accepts engine names. The results list only includes information about the DB instances for these engines.
  - setFilters
```
public void setFilters(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 only includes 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 only includes information about the DB instances identified by these ARNs.
    - dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.
    - domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.
    - engine - Accepts engine names. The results list only includes information about the DB instances for these engines.
    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 only includes 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 only includes information about the DB instances identified by these ARNs.
    
    dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.
    
    domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.
    
    engine - Accepts engine names. The results list only includes information about the DB instances for these engines.
  - withFilters
```
public DescribeDBInstancesRequest withFilters(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 only includes 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 only includes information about the DB instances identified by these ARNs.
    - dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.
    - domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.
    - engine - Accepts engine names. The results list only includes information about the DB instances for these engines.
    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 only includes 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 only includes information about the DB instances identified by these ARNs.
    
    dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.
    
    domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.
    
    engine - Accepts engine names. The results list only includes information about the DB instances for these engines.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFilters
```
public DescribeDBInstancesRequest withFilters(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 only includes 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 only includes information about the DB instances identified by these ARNs.
    - dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.
    - domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.
    - engine - Accepts engine names. The results list only includes information about the DB instances for these engines.
    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 only includes 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 only includes information about the DB instances identified by these ARNs.
    
    dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.
    
    domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.
    
    engine - Accepts engine names. The results list only includes information about the DB instances for these engines.
    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 you can retrieve the remaining results.
    
    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 you can retrieve the remaining results.
    
    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 you can retrieve the remaining results.
    
    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 you can retrieve the remaining results.
    
    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 you can retrieve the remaining results.
    
    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 you can retrieve the remaining results.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeDBInstancesRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class DescribeDBInstancesRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeDBInstancesRequest

Method Detail

setDBInstanceIdentifier

getDBInstanceIdentifier

withDBInstanceIdentifier

getFilters

setFilters

withFilters

withFilters

setMaxRecords

getMaxRecords

withMaxRecords

setMarker

getMarker

withMarker

toString

equals

hashCode

clone