Struct aws_sdk_rds::client::fluent_builders::DescribeDBInstanceAutomatedBackups

pub struct DescribeDBInstanceAutomatedBackups { /* private fields */ }

Fluent builder constructing a request to DescribeDBInstanceAutomatedBackups.

Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

All parameters are optional.

Implementations

impl DescribeDBInstanceAutomatedBackups

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeDBInstanceAutomatedBackups, AwsResponseRetryClassifier>, SdkError<DescribeDBInstanceAutomatedBackupsError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<DescribeDbInstanceAutomatedBackupsOutput, SdkError<DescribeDBInstanceAutomatedBackupsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeDbInstanceAutomatedBackupsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn dbi_resource_id(self, input: impl Into<String>) -> Self

The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

pub fn set_dbi_resource_id(self, input: Option<String>) -> Self

The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

pub fn db_instance_identifier(self, input: impl Into<String>) -> Self

(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter isn't case-sensitive.

pub fn set_db_instance_identifier(self, input: Option<String>) -> Self

(Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter isn't case-sensitive.

pub fn filters(self, input: Filter) -> Self

Appends an item to Filters.

To override the contents of this collection use set_filters.

A filter that specifies which resources to return based on status.

Supported filters are the following:

• status

  • active - automated backups for current instances

  • retained - automated backups for deleted instances and after backup replication is stopped

  • creating - automated backups that are waiting for the first automated snapshot to be available

• db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self

A filter that specifies which resources to return based on status.

Supported filters are the following:

• status

  • active - automated backups for current instances

  • retained - automated backups for deleted instances and after backup replication is stopped

  • creating - automated backups that are waiting for the first automated snapshot to be available

• db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.

• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

pub fn max_records(self, input: i32) -> Self

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.

pub fn set_max_records(self, input: Option<i32>) -> Self

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.

pub fn marker(self, input: impl Into<String>) -> Self

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

pub fn set_marker(self, input: Option<String>) -> Self

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

pub fn db_instance_automated_backups_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

pub fn set_db_instance_automated_backups_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

Trait Implementations

impl Clone for DescribeDBInstanceAutomatedBackups

fn clone(&self) -> DescribeDBInstanceAutomatedBackups

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeDBInstanceAutomatedBackups

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

Formats the value using the given formatter.