Struct aws_sdk_docdb::input::DescribeDbInstancesInput

#[non_exhaustive]
pub struct DescribeDbInstancesInput {
    pub db_instance_identifier: Option<String>,
    pub filters: Option<Vec<Filter>>,
    pub max_records: Option<i32>,
    pub marker: Option<String>,
}

Represents the input to DescribeDBInstances.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

db_instance_identifier: Option<String>

The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.

Constraints:

• If provided, must match the identifier of an existing DBInstance.

filters: Option<Vec<Filter>>

A filter that specifies one or more instances to describe.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.

• db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

max_records: Option<i32>

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

marker: Option<String>

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Implementations

impl DescribeDbInstancesInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<DescribeDBInstances, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<DescribeDBInstances>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeDbInstancesInput

impl DescribeDbInstancesInput

pub fn db_instance_identifier(&self) -> Option<&str>

The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.

Constraints:

• If provided, must match the identifier of an existing DBInstance.

pub fn filters(&self) -> Option<&[Filter]>

A filter that specifies one or more instances to describe.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.

• db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

pub fn max_records(&self) -> Option<i32>

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

pub fn marker(&self) -> Option<&str>

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Trait Implementations

impl Clone for DescribeDbInstancesInput

fn clone(&self) -> DescribeDbInstancesInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeDbInstancesInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<DescribeDbInstancesInput> for DescribeDbInstancesInput

fn eq(&self, other: &DescribeDbInstancesInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DescribeDbInstancesInput) -> bool

This method tests for !=.

impl StructuralPartialEq for DescribeDbInstancesInput