@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeDBInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
DescribeDBInstancesRequest() |
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.
|
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.
|
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.
|
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.
|
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
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:
If supplied, must match the identifier of an existing DBInstance.
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.
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:
If supplied, must match the identifier of an existing DBInstance.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
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:
If supplied, must match the identifier of an existing DBInstance.
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.
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 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:
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:
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 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:
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:
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 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:
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.
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:
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 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:
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:
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.
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.
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.
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.
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.
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.
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
.
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
.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
.
DescribeDBInstances
request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified
by MaxRecords
.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
.
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
.public String toString()
toString
in class Object
Object.toString()
public DescribeDBInstancesRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()