/** * 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 { /** *

See Also:

AWS * API Reference

*/ class DescribeDBInstancesRequest : public RDSRequest { public: AWS_RDS_API DescribeDBInstancesRequest(); // 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 "DescribeDBInstances"; } AWS_RDS_API Aws::String SerializePayload() const override; protected: AWS_RDS_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

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.

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

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

*/ inline DescribeDBInstancesRequest& 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.

Default: 100

Constraints: Minimum 20, maximum * 100.

*/ 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.

Default: 100

Constraints: Minimum 20, maximum * 100.

*/ 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.

Default: 100

Constraints: Minimum 20, maximum * 100.

*/ 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.

Default: 100

Constraints: Minimum 20, maximum * 100.

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

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.

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

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

*/ inline DescribeDBInstancesRequest& WithMarker(const char* value) { SetMarker(value); return *this;} private: 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; }; } // namespace Model } // namespace RDS } // namespace Aws