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

The reserved DB instance identifier filter value. Specify this parameter to * show only the reservation that matches the specified reservation ID.

*/ inline const Aws::String& GetReservedDBInstanceId() const{ return m_reservedDBInstanceId; } /** *

The reserved DB instance identifier filter value. Specify this parameter to * show only the reservation that matches the specified reservation ID.

*/ inline bool ReservedDBInstanceIdHasBeenSet() const { return m_reservedDBInstanceIdHasBeenSet; } /** *

The reserved DB instance identifier filter value. Specify this parameter to * show only the reservation that matches the specified reservation ID.

*/ inline void SetReservedDBInstanceId(const Aws::String& value) { m_reservedDBInstanceIdHasBeenSet = true; m_reservedDBInstanceId = value; } /** *

The reserved DB instance identifier filter value. Specify this parameter to * show only the reservation that matches the specified reservation ID.

*/ inline void SetReservedDBInstanceId(Aws::String&& value) { m_reservedDBInstanceIdHasBeenSet = true; m_reservedDBInstanceId = std::move(value); } /** *

The reserved DB instance identifier filter value. Specify this parameter to * show only the reservation that matches the specified reservation ID.

*/ inline void SetReservedDBInstanceId(const char* value) { m_reservedDBInstanceIdHasBeenSet = true; m_reservedDBInstanceId.assign(value); } /** *

The reserved DB instance identifier filter value. Specify this parameter to * show only the reservation that matches the specified reservation ID.

*/ inline DescribeReservedDBInstancesRequest& WithReservedDBInstanceId(const Aws::String& value) { SetReservedDBInstanceId(value); return *this;} /** *

The reserved DB instance identifier filter value. Specify this parameter to * show only the reservation that matches the specified reservation ID.

*/ inline DescribeReservedDBInstancesRequest& WithReservedDBInstanceId(Aws::String&& value) { SetReservedDBInstanceId(std::move(value)); return *this;} /** *

The reserved DB instance identifier filter value. Specify this parameter to * show only the reservation that matches the specified reservation ID.

*/ inline DescribeReservedDBInstancesRequest& WithReservedDBInstanceId(const char* value) { SetReservedDBInstanceId(value); return *this;} /** *

The offering identifier filter value. Specify this parameter to show only * purchased reservations matching the specified offering identifier.

*/ inline const Aws::String& GetReservedDBInstancesOfferingId() const{ return m_reservedDBInstancesOfferingId; } /** *

The offering identifier filter value. Specify this parameter to show only * purchased reservations matching the specified offering identifier.

*/ inline bool ReservedDBInstancesOfferingIdHasBeenSet() const { return m_reservedDBInstancesOfferingIdHasBeenSet; } /** *

The offering identifier filter value. Specify this parameter to show only * purchased reservations matching the specified offering identifier.

*/ inline void SetReservedDBInstancesOfferingId(const Aws::String& value) { m_reservedDBInstancesOfferingIdHasBeenSet = true; m_reservedDBInstancesOfferingId = value; } /** *

The offering identifier filter value. Specify this parameter to show only * purchased reservations matching the specified offering identifier.

*/ inline void SetReservedDBInstancesOfferingId(Aws::String&& value) { m_reservedDBInstancesOfferingIdHasBeenSet = true; m_reservedDBInstancesOfferingId = std::move(value); } /** *

The offering identifier filter value. Specify this parameter to show only * purchased reservations matching the specified offering identifier.

*/ inline void SetReservedDBInstancesOfferingId(const char* value) { m_reservedDBInstancesOfferingIdHasBeenSet = true; m_reservedDBInstancesOfferingId.assign(value); } /** *

The offering identifier filter value. Specify this parameter to show only * purchased reservations matching the specified offering identifier.

*/ inline DescribeReservedDBInstancesRequest& WithReservedDBInstancesOfferingId(const Aws::String& value) { SetReservedDBInstancesOfferingId(value); return *this;} /** *

The offering identifier filter value. Specify this parameter to show only * purchased reservations matching the specified offering identifier.

*/ inline DescribeReservedDBInstancesRequest& WithReservedDBInstancesOfferingId(Aws::String&& value) { SetReservedDBInstancesOfferingId(std::move(value)); return *this;} /** *

The offering identifier filter value. Specify this parameter to show only * purchased reservations matching the specified offering identifier.

*/ inline DescribeReservedDBInstancesRequest& WithReservedDBInstancesOfferingId(const char* value) { SetReservedDBInstancesOfferingId(value); return *this;} /** *

The DB instance class filter value. Specify this parameter to show only those * reservations matching the specified DB instances class.

*/ inline const Aws::String& GetDBInstanceClass() const{ return m_dBInstanceClass; } /** *

The DB instance class filter value. Specify this parameter to show only those * reservations matching the specified DB instances class.

*/ inline bool DBInstanceClassHasBeenSet() const { return m_dBInstanceClassHasBeenSet; } /** *

The DB instance class filter value. Specify this parameter to show only those * reservations matching the specified DB instances class.

*/ inline void SetDBInstanceClass(const Aws::String& value) { m_dBInstanceClassHasBeenSet = true; m_dBInstanceClass = value; } /** *

The DB instance class filter value. Specify this parameter to show only those * reservations matching the specified DB instances class.

*/ inline void SetDBInstanceClass(Aws::String&& value) { m_dBInstanceClassHasBeenSet = true; m_dBInstanceClass = std::move(value); } /** *

The DB instance class filter value. Specify this parameter to show only those * reservations matching the specified DB instances class.

*/ inline void SetDBInstanceClass(const char* value) { m_dBInstanceClassHasBeenSet = true; m_dBInstanceClass.assign(value); } /** *

The DB instance class filter value. Specify this parameter to show only those * reservations matching the specified DB instances class.

*/ inline DescribeReservedDBInstancesRequest& WithDBInstanceClass(const Aws::String& value) { SetDBInstanceClass(value); return *this;} /** *

The DB instance class filter value. Specify this parameter to show only those * reservations matching the specified DB instances class.

*/ inline DescribeReservedDBInstancesRequest& WithDBInstanceClass(Aws::String&& value) { SetDBInstanceClass(std::move(value)); return *this;} /** *

The DB instance class filter value. Specify this parameter to show only those * reservations matching the specified DB instances class.

*/ inline DescribeReservedDBInstancesRequest& WithDBInstanceClass(const char* value) { SetDBInstanceClass(value); return *this;} /** *

The duration filter value, specified in years or seconds. Specify this * parameter to show only reservations for this duration.

Valid Values: * 1 | 3 | 31536000 | 94608000

*/ inline const Aws::String& GetDuration() const{ return m_duration; } /** *

The duration filter value, specified in years or seconds. Specify this * parameter to show only reservations for this duration.

Valid Values: * 1 | 3 | 31536000 | 94608000

*/ inline bool DurationHasBeenSet() const { return m_durationHasBeenSet; } /** *

The duration filter value, specified in years or seconds. Specify this * parameter to show only reservations for this duration.

Valid Values: * 1 | 3 | 31536000 | 94608000

*/ inline void SetDuration(const Aws::String& value) { m_durationHasBeenSet = true; m_duration = value; } /** *

The duration filter value, specified in years or seconds. Specify this * parameter to show only reservations for this duration.

Valid Values: * 1 | 3 | 31536000 | 94608000

*/ inline void SetDuration(Aws::String&& value) { m_durationHasBeenSet = true; m_duration = std::move(value); } /** *

The duration filter value, specified in years or seconds. Specify this * parameter to show only reservations for this duration.

Valid Values: * 1 | 3 | 31536000 | 94608000

*/ inline void SetDuration(const char* value) { m_durationHasBeenSet = true; m_duration.assign(value); } /** *

The duration filter value, specified in years or seconds. Specify this * parameter to show only reservations for this duration.

Valid Values: * 1 | 3 | 31536000 | 94608000

*/ inline DescribeReservedDBInstancesRequest& WithDuration(const Aws::String& value) { SetDuration(value); return *this;} /** *

The duration filter value, specified in years or seconds. Specify this * parameter to show only reservations for this duration.

Valid Values: * 1 | 3 | 31536000 | 94608000

*/ inline DescribeReservedDBInstancesRequest& WithDuration(Aws::String&& value) { SetDuration(std::move(value)); return *this;} /** *

The duration filter value, specified in years or seconds. Specify this * parameter to show only reservations for this duration.

Valid Values: * 1 | 3 | 31536000 | 94608000

*/ inline DescribeReservedDBInstancesRequest& WithDuration(const char* value) { SetDuration(value); return *this;} /** *

The product description filter value. Specify this parameter to show only * those reservations matching the specified product description.

*/ inline const Aws::String& GetProductDescription() const{ return m_productDescription; } /** *

The product description filter value. Specify this parameter to show only * those reservations matching the specified product description.

*/ inline bool ProductDescriptionHasBeenSet() const { return m_productDescriptionHasBeenSet; } /** *

The product description filter value. Specify this parameter to show only * those reservations matching the specified product description.

*/ inline void SetProductDescription(const Aws::String& value) { m_productDescriptionHasBeenSet = true; m_productDescription = value; } /** *

The product description filter value. Specify this parameter to show only * those reservations matching the specified product description.

*/ inline void SetProductDescription(Aws::String&& value) { m_productDescriptionHasBeenSet = true; m_productDescription = std::move(value); } /** *

The product description filter value. Specify this parameter to show only * those reservations matching the specified product description.

*/ inline void SetProductDescription(const char* value) { m_productDescriptionHasBeenSet = true; m_productDescription.assign(value); } /** *

The product description filter value. Specify this parameter to show only * those reservations matching the specified product description.

*/ inline DescribeReservedDBInstancesRequest& WithProductDescription(const Aws::String& value) { SetProductDescription(value); return *this;} /** *

The product description filter value. Specify this parameter to show only * those reservations matching the specified product description.

*/ inline DescribeReservedDBInstancesRequest& WithProductDescription(Aws::String&& value) { SetProductDescription(std::move(value)); return *this;} /** *

The product description filter value. Specify this parameter to show only * those reservations matching the specified product description.

*/ inline DescribeReservedDBInstancesRequest& WithProductDescription(const char* value) { SetProductDescription(value); return *this;} /** *

The offering type filter value. Specify this parameter to show only the * available offerings matching the specified offering type.

Valid Values: * "Partial Upfront" | "All Upfront" | "No Upfront"

*/ inline const Aws::String& GetOfferingType() const{ return m_offeringType; } /** *

The offering type filter value. Specify this parameter to show only the * available offerings matching the specified offering type.

Valid Values: * "Partial Upfront" | "All Upfront" | "No Upfront"

*/ inline bool OfferingTypeHasBeenSet() const { return m_offeringTypeHasBeenSet; } /** *

The offering type filter value. Specify this parameter to show only the * available offerings matching the specified offering type.

Valid Values: * "Partial Upfront" | "All Upfront" | "No Upfront"

*/ inline void SetOfferingType(const Aws::String& value) { m_offeringTypeHasBeenSet = true; m_offeringType = value; } /** *

The offering type filter value. Specify this parameter to show only the * available offerings matching the specified offering type.

Valid Values: * "Partial Upfront" | "All Upfront" | "No Upfront"

*/ inline void SetOfferingType(Aws::String&& value) { m_offeringTypeHasBeenSet = true; m_offeringType = std::move(value); } /** *

The offering type filter value. Specify this parameter to show only the * available offerings matching the specified offering type.

Valid Values: * "Partial Upfront" | "All Upfront" | "No Upfront"

*/ inline void SetOfferingType(const char* value) { m_offeringTypeHasBeenSet = true; m_offeringType.assign(value); } /** *

The offering type filter value. Specify this parameter to show only the * available offerings matching the specified offering type.

Valid Values: * "Partial Upfront" | "All Upfront" | "No Upfront"

*/ inline DescribeReservedDBInstancesRequest& WithOfferingType(const Aws::String& value) { SetOfferingType(value); return *this;} /** *

The offering type filter value. Specify this parameter to show only the * available offerings matching the specified offering type.

Valid Values: * "Partial Upfront" | "All Upfront" | "No Upfront"

*/ inline DescribeReservedDBInstancesRequest& WithOfferingType(Aws::String&& value) { SetOfferingType(std::move(value)); return *this;} /** *

The offering type filter value. Specify this parameter to show only the * available offerings matching the specified offering type.

Valid Values: * "Partial Upfront" | "All Upfront" | "No Upfront"

*/ inline DescribeReservedDBInstancesRequest& WithOfferingType(const char* value) { SetOfferingType(value); return *this;} /** *

A value that indicates whether to show only those reservations that support * Multi-AZ.

*/ inline bool GetMultiAZ() const{ return m_multiAZ; } /** *

A value that indicates whether to show only those reservations that support * Multi-AZ.

*/ inline bool MultiAZHasBeenSet() const { return m_multiAZHasBeenSet; } /** *

A value that indicates whether to show only those reservations that support * Multi-AZ.

*/ inline void SetMultiAZ(bool value) { m_multiAZHasBeenSet = true; m_multiAZ = value; } /** *

A value that indicates whether to show only those reservations that support * Multi-AZ.

*/ inline DescribeReservedDBInstancesRequest& WithMultiAZ(bool value) { SetMultiAZ(value); return *this;} /** *

The lease identifier filter value. Specify this parameter to show only the * reservation that matches the specified lease ID.

Amazon Web * Services Support might request the lease ID for an issue related to a reserved * DB instance.

*/ inline const Aws::String& GetLeaseId() const{ return m_leaseId; } /** *

The lease identifier filter value. Specify this parameter to show only the * reservation that matches the specified lease ID.

Amazon Web * Services Support might request the lease ID for an issue related to a reserved * DB instance.

*/ inline bool LeaseIdHasBeenSet() const { return m_leaseIdHasBeenSet; } /** *

The lease identifier filter value. Specify this parameter to show only the * reservation that matches the specified lease ID.

Amazon Web * Services Support might request the lease ID for an issue related to a reserved * DB instance.

*/ inline void SetLeaseId(const Aws::String& value) { m_leaseIdHasBeenSet = true; m_leaseId = value; } /** *

The lease identifier filter value. Specify this parameter to show only the * reservation that matches the specified lease ID.

Amazon Web * Services Support might request the lease ID for an issue related to a reserved * DB instance.

*/ inline void SetLeaseId(Aws::String&& value) { m_leaseIdHasBeenSet = true; m_leaseId = std::move(value); } /** *

The lease identifier filter value. Specify this parameter to show only the * reservation that matches the specified lease ID.

Amazon Web * Services Support might request the lease ID for an issue related to a reserved * DB instance.

*/ inline void SetLeaseId(const char* value) { m_leaseIdHasBeenSet = true; m_leaseId.assign(value); } /** *

The lease identifier filter value. Specify this parameter to show only the * reservation that matches the specified lease ID.

Amazon Web * Services Support might request the lease ID for an issue related to a reserved * DB instance.

*/ inline DescribeReservedDBInstancesRequest& WithLeaseId(const Aws::String& value) { SetLeaseId(value); return *this;} /** *

The lease identifier filter value. Specify this parameter to show only the * reservation that matches the specified lease ID.

Amazon Web * Services Support might request the lease ID for an issue related to a reserved * DB instance.

*/ inline DescribeReservedDBInstancesRequest& WithLeaseId(Aws::String&& value) { SetLeaseId(std::move(value)); return *this;} /** *

The lease identifier filter value. Specify this parameter to show only the * reservation that matches the specified lease ID.

Amazon Web * Services Support might request the lease ID for an issue related to a reserved * DB instance.

*/ inline DescribeReservedDBInstancesRequest& WithLeaseId(const char* value) { SetLeaseId(value); return *this;} /** *

This parameter isn't currently supported.

*/ inline const Aws::Vector& GetFilters() const{ return m_filters; } /** *

This parameter isn't currently supported.

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

This parameter isn't currently supported.

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

This parameter isn't currently supported.

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

This parameter isn't currently supported.

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

This parameter isn't currently supported.

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

This parameter isn't currently supported.

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

This parameter isn't currently supported.

*/ inline DescribeReservedDBInstancesRequest& 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 than the * MaxRecords value is available, a pagination token called a marker * is included in the response so 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 than the * MaxRecords value is available, a pagination token called a marker * is included in the response so 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 than the * MaxRecords value is available, a pagination token called a marker * is included in the response so 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 than the * MaxRecords value is available, a pagination token called a marker * is included in the response so you can retrieve the remaining results.

*

Default: 100

Constraints: Minimum 20, maximum 100.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

*/ inline DescribeReservedDBInstancesRequest& WithMarker(const char* value) { SetMarker(value); return *this;} private: Aws::String m_reservedDBInstanceId; bool m_reservedDBInstanceIdHasBeenSet = false; Aws::String m_reservedDBInstancesOfferingId; bool m_reservedDBInstancesOfferingIdHasBeenSet = false; Aws::String m_dBInstanceClass; bool m_dBInstanceClassHasBeenSet = false; Aws::String m_duration; bool m_durationHasBeenSet = false; Aws::String m_productDescription; bool m_productDescriptionHasBeenSet = false; Aws::String m_offeringType; bool m_offeringTypeHasBeenSet = false; bool m_multiAZ; bool m_multiAZHasBeenSet = false; Aws::String m_leaseId; bool m_leaseIdHasBeenSet = 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