/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace RDS { namespace Model { /** *

Parameter input for DescribeDBInstanceAutomatedBackups.

See * Also:

AWS * API Reference

*/ class DescribeDBInstanceAutomatedBackupsRequest : public RDSRequest { public: AWS_RDS_API DescribeDBInstanceAutomatedBackupsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DescribeDBInstanceAutomatedBackups"; } AWS_RDS_API Aws::String SerializePayload() const override; protected: AWS_RDS_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

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

*/ inline const Aws::String& GetDbiResourceId() const{ return m_dbiResourceId; } /** *

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

*/ inline bool DbiResourceIdHasBeenSet() const { return m_dbiResourceIdHasBeenSet; } /** *

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

*/ inline void SetDbiResourceId(const Aws::String& value) { m_dbiResourceIdHasBeenSet = true; m_dbiResourceId = value; } /** *

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

*/ inline void SetDbiResourceId(Aws::String&& value) { m_dbiResourceIdHasBeenSet = true; m_dbiResourceId = std::move(value); } /** *

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

*/ inline void SetDbiResourceId(const char* value) { m_dbiResourceIdHasBeenSet = true; m_dbiResourceId.assign(value); } /** *

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

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithDbiResourceId(const Aws::String& value) { SetDbiResourceId(value); return *this;} /** *

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

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithDbiResourceId(Aws::String&& value) { SetDbiResourceId(std::move(value)); return *this;} /** *

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

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithDbiResourceId(const char* value) { SetDbiResourceId(value); return *this;} /** *

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

*/ inline const Aws::String& GetDBInstanceIdentifier() const{ return m_dBInstanceIdentifier; } /** *

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

*/ inline bool DBInstanceIdentifierHasBeenSet() const { return m_dBInstanceIdentifierHasBeenSet; } /** *

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

*/ inline void SetDBInstanceIdentifier(const Aws::String& value) { m_dBInstanceIdentifierHasBeenSet = true; m_dBInstanceIdentifier = value; } /** *

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

*/ inline void SetDBInstanceIdentifier(Aws::String&& value) { m_dBInstanceIdentifierHasBeenSet = true; m_dBInstanceIdentifier = std::move(value); } /** *

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

*/ inline void SetDBInstanceIdentifier(const char* value) { m_dBInstanceIdentifierHasBeenSet = true; m_dBInstanceIdentifier.assign(value); } /** *

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

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithDBInstanceIdentifier(const Aws::String& value) { SetDBInstanceIdentifier(value); return *this;} /** *

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

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithDBInstanceIdentifier(Aws::String&& value) { SetDBInstanceIdentifier(std::move(value)); return *this;} /** *

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

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithDBInstanceIdentifier(const char* value) { SetDBInstanceIdentifier(value); return *this;} /** *

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.

*/ inline const Aws::Vector& GetFilters() const{ return m_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.

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

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.

*/ inline void SetFilters(const Aws::Vector& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

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.

*/ inline void SetFilters(Aws::Vector&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

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.

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithFilters(const Aws::Vector& value) { SetFilters(value); return *this;} /** *

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.

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithFilters(Aws::Vector&& value) { SetFilters(std::move(value)); return *this;} /** *

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.

*/ inline DescribeDBInstanceAutomatedBackupsRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** *

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.

*/ inline DescribeDBInstanceAutomatedBackupsRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } /** *

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.

*/ inline int GetMaxRecords() const{ return m_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.

*/ inline bool MaxRecordsHasBeenSet() const { return m_maxRecordsHasBeenSet; } /** *

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.

*/ inline void SetMaxRecords(int value) { m_maxRecordsHasBeenSet = true; m_maxRecords = value; } /** *

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.

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithMaxRecords(int value) { SetMaxRecords(value); return *this;} /** *

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

*/ inline const Aws::String& GetMarker() const{ return m_marker; } /** *

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

*/ inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; } /** *

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

*/ inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; } /** *

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

*/ inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); } /** *

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

*/ inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); } /** *

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

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;} /** *

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

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;} /** *

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

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithMarker(const char* value) { SetMarker(value); return *this;} /** *

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.

*/ inline const Aws::String& GetDBInstanceAutomatedBackupsArn() const{ return m_dBInstanceAutomatedBackupsArn; } /** *

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.

*/ inline bool DBInstanceAutomatedBackupsArnHasBeenSet() const { return m_dBInstanceAutomatedBackupsArnHasBeenSet; } /** *

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.

*/ inline void SetDBInstanceAutomatedBackupsArn(const Aws::String& value) { m_dBInstanceAutomatedBackupsArnHasBeenSet = true; m_dBInstanceAutomatedBackupsArn = value; } /** *

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.

*/ inline void SetDBInstanceAutomatedBackupsArn(Aws::String&& value) { m_dBInstanceAutomatedBackupsArnHasBeenSet = true; m_dBInstanceAutomatedBackupsArn = std::move(value); } /** *

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.

*/ inline void SetDBInstanceAutomatedBackupsArn(const char* value) { m_dBInstanceAutomatedBackupsArnHasBeenSet = true; m_dBInstanceAutomatedBackupsArn.assign(value); } /** *

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.

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithDBInstanceAutomatedBackupsArn(const Aws::String& value) { SetDBInstanceAutomatedBackupsArn(value); return *this;} /** *

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.

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithDBInstanceAutomatedBackupsArn(Aws::String&& value) { SetDBInstanceAutomatedBackupsArn(std::move(value)); return *this;} /** *

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.

*/ inline DescribeDBInstanceAutomatedBackupsRequest& WithDBInstanceAutomatedBackupsArn(const char* value) { SetDBInstanceAutomatedBackupsArn(value); return *this;} private: Aws::String m_dbiResourceId; bool m_dbiResourceIdHasBeenSet = false; Aws::String m_dBInstanceIdentifier; bool m_dBInstanceIdentifierHasBeenSet = false; Aws::Vector m_filters; bool m_filtersHasBeenSet = false; int m_maxRecords; bool m_maxRecordsHasBeenSet = false; Aws::String m_marker; bool m_markerHasBeenSet = false; Aws::String m_dBInstanceAutomatedBackupsArn; bool m_dBInstanceAutomatedBackupsArnHasBeenSet = false; }; } // namespace Model } // namespace RDS } // namespace Aws