298 lines
14 KiB
C++
298 lines
14 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/rds/RDS_EXPORTS.h>
|
|
#include <aws/rds/RDSRequest.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/rds/model/Filter.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace RDS
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class AWS_RDS_API DescribeGlobalClustersRequest : public RDSRequest
|
|
{
|
|
public:
|
|
DescribeGlobalClustersRequest();
|
|
|
|
// 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 "DescribeGlobalClusters"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
protected:
|
|
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
|
|
|
|
public:
|
|
|
|
/**
|
|
* <p> The user-supplied DB cluster identifier. If this parameter is specified,
|
|
* information from only the specific DB cluster is returned. This parameter isn't
|
|
* case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an
|
|
* existing DBClusterIdentifier.</p> </li> </ul>
|
|
*/
|
|
inline const Aws::String& GetGlobalClusterIdentifier() const{ return m_globalClusterIdentifier; }
|
|
|
|
/**
|
|
* <p> The user-supplied DB cluster identifier. If this parameter is specified,
|
|
* information from only the specific DB cluster is returned. This parameter isn't
|
|
* case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an
|
|
* existing DBClusterIdentifier.</p> </li> </ul>
|
|
*/
|
|
inline bool GlobalClusterIdentifierHasBeenSet() const { return m_globalClusterIdentifierHasBeenSet; }
|
|
|
|
/**
|
|
* <p> The user-supplied DB cluster identifier. If this parameter is specified,
|
|
* information from only the specific DB cluster is returned. This parameter isn't
|
|
* case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an
|
|
* existing DBClusterIdentifier.</p> </li> </ul>
|
|
*/
|
|
inline void SetGlobalClusterIdentifier(const Aws::String& value) { m_globalClusterIdentifierHasBeenSet = true; m_globalClusterIdentifier = value; }
|
|
|
|
/**
|
|
* <p> The user-supplied DB cluster identifier. If this parameter is specified,
|
|
* information from only the specific DB cluster is returned. This parameter isn't
|
|
* case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an
|
|
* existing DBClusterIdentifier.</p> </li> </ul>
|
|
*/
|
|
inline void SetGlobalClusterIdentifier(Aws::String&& value) { m_globalClusterIdentifierHasBeenSet = true; m_globalClusterIdentifier = std::move(value); }
|
|
|
|
/**
|
|
* <p> The user-supplied DB cluster identifier. If this parameter is specified,
|
|
* information from only the specific DB cluster is returned. This parameter isn't
|
|
* case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an
|
|
* existing DBClusterIdentifier.</p> </li> </ul>
|
|
*/
|
|
inline void SetGlobalClusterIdentifier(const char* value) { m_globalClusterIdentifierHasBeenSet = true; m_globalClusterIdentifier.assign(value); }
|
|
|
|
/**
|
|
* <p> The user-supplied DB cluster identifier. If this parameter is specified,
|
|
* information from only the specific DB cluster is returned. This parameter isn't
|
|
* case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an
|
|
* existing DBClusterIdentifier.</p> </li> </ul>
|
|
*/
|
|
inline DescribeGlobalClustersRequest& WithGlobalClusterIdentifier(const Aws::String& value) { SetGlobalClusterIdentifier(value); return *this;}
|
|
|
|
/**
|
|
* <p> The user-supplied DB cluster identifier. If this parameter is specified,
|
|
* information from only the specific DB cluster is returned. This parameter isn't
|
|
* case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an
|
|
* existing DBClusterIdentifier.</p> </li> </ul>
|
|
*/
|
|
inline DescribeGlobalClustersRequest& WithGlobalClusterIdentifier(Aws::String&& value) { SetGlobalClusterIdentifier(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p> The user-supplied DB cluster identifier. If this parameter is specified,
|
|
* information from only the specific DB cluster is returned. This parameter isn't
|
|
* case-sensitive. </p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an
|
|
* existing DBClusterIdentifier.</p> </li> </ul>
|
|
*/
|
|
inline DescribeGlobalClustersRequest& WithGlobalClusterIdentifier(const char* value) { SetGlobalClusterIdentifier(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>A filter that specifies one or more global DB clusters to describe.</p>
|
|
* <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB
|
|
* cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results
|
|
* list will only include information about the DB clusters identified by these
|
|
* ARNs.</p> </li> </ul>
|
|
*/
|
|
inline const Aws::Vector<Filter>& GetFilters() const{ return m_filters; }
|
|
|
|
/**
|
|
* <p>A filter that specifies one or more global DB clusters to describe.</p>
|
|
* <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB
|
|
* cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results
|
|
* list will only include information about the DB clusters identified by these
|
|
* ARNs.</p> </li> </ul>
|
|
*/
|
|
inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A filter that specifies one or more global DB clusters to describe.</p>
|
|
* <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB
|
|
* cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results
|
|
* list will only include information about the DB clusters identified by these
|
|
* ARNs.</p> </li> </ul>
|
|
*/
|
|
inline void SetFilters(const Aws::Vector<Filter>& value) { m_filtersHasBeenSet = true; m_filters = value; }
|
|
|
|
/**
|
|
* <p>A filter that specifies one or more global DB clusters to describe.</p>
|
|
* <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB
|
|
* cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results
|
|
* list will only include information about the DB clusters identified by these
|
|
* ARNs.</p> </li> </ul>
|
|
*/
|
|
inline void SetFilters(Aws::Vector<Filter>&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); }
|
|
|
|
/**
|
|
* <p>A filter that specifies one or more global DB clusters to describe.</p>
|
|
* <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB
|
|
* cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results
|
|
* list will only include information about the DB clusters identified by these
|
|
* ARNs.</p> </li> </ul>
|
|
*/
|
|
inline DescribeGlobalClustersRequest& WithFilters(const Aws::Vector<Filter>& value) { SetFilters(value); return *this;}
|
|
|
|
/**
|
|
* <p>A filter that specifies one or more global DB clusters to describe.</p>
|
|
* <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB
|
|
* cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results
|
|
* list will only include information about the DB clusters identified by these
|
|
* ARNs.</p> </li> </ul>
|
|
*/
|
|
inline DescribeGlobalClustersRequest& WithFilters(Aws::Vector<Filter>&& value) { SetFilters(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>A filter that specifies one or more global DB clusters to describe.</p>
|
|
* <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB
|
|
* cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results
|
|
* list will only include information about the DB clusters identified by these
|
|
* ARNs.</p> </li> </ul>
|
|
*/
|
|
inline DescribeGlobalClustersRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>A filter that specifies one or more global DB clusters to describe.</p>
|
|
* <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB
|
|
* cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results
|
|
* list will only include information about the DB clusters identified by these
|
|
* ARNs.</p> </li> </ul>
|
|
*/
|
|
inline DescribeGlobalClustersRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; }
|
|
|
|
|
|
/**
|
|
* <p> The maximum number of records to include in the response. If more records
|
|
* exist than the specified <code>MaxRecords</code> value, a pagination token
|
|
* called a marker is included in the response so that you can retrieve the
|
|
* remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum
|
|
* 100.</p>
|
|
*/
|
|
inline int GetMaxRecords() const{ return m_maxRecords; }
|
|
|
|
/**
|
|
* <p> The maximum number of records to include in the response. If more records
|
|
* exist than the specified <code>MaxRecords</code> value, a pagination token
|
|
* called a marker is included in the response so that you can retrieve the
|
|
* remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum
|
|
* 100.</p>
|
|
*/
|
|
inline bool MaxRecordsHasBeenSet() const { return m_maxRecordsHasBeenSet; }
|
|
|
|
/**
|
|
* <p> The maximum number of records to include in the response. If more records
|
|
* exist than the specified <code>MaxRecords</code> value, a pagination token
|
|
* called a marker is included in the response so that you can retrieve the
|
|
* remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum
|
|
* 100.</p>
|
|
*/
|
|
inline void SetMaxRecords(int value) { m_maxRecordsHasBeenSet = true; m_maxRecords = value; }
|
|
|
|
/**
|
|
* <p> The maximum number of records to include in the response. If more records
|
|
* exist than the specified <code>MaxRecords</code> value, a pagination token
|
|
* called a marker is included in the response so that you can retrieve the
|
|
* remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum
|
|
* 100.</p>
|
|
*/
|
|
inline DescribeGlobalClustersRequest& WithMaxRecords(int value) { SetMaxRecords(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p> An optional pagination token provided by a previous
|
|
* <code>DescribeGlobalClusters</code> request. If this parameter is specified, the
|
|
* response includes only records beyond the marker, up to the value specified by
|
|
* <code>MaxRecords</code>. </p>
|
|
*/
|
|
inline const Aws::String& GetMarker() const{ return m_marker; }
|
|
|
|
/**
|
|
* <p> An optional pagination token provided by a previous
|
|
* <code>DescribeGlobalClusters</code> request. If this parameter is specified, the
|
|
* response includes only records beyond the marker, up to the value specified by
|
|
* <code>MaxRecords</code>. </p>
|
|
*/
|
|
inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; }
|
|
|
|
/**
|
|
* <p> An optional pagination token provided by a previous
|
|
* <code>DescribeGlobalClusters</code> request. If this parameter is specified, the
|
|
* response includes only records beyond the marker, up to the value specified by
|
|
* <code>MaxRecords</code>. </p>
|
|
*/
|
|
inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; }
|
|
|
|
/**
|
|
* <p> An optional pagination token provided by a previous
|
|
* <code>DescribeGlobalClusters</code> request. If this parameter is specified, the
|
|
* response includes only records beyond the marker, up to the value specified by
|
|
* <code>MaxRecords</code>. </p>
|
|
*/
|
|
inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); }
|
|
|
|
/**
|
|
* <p> An optional pagination token provided by a previous
|
|
* <code>DescribeGlobalClusters</code> request. If this parameter is specified, the
|
|
* response includes only records beyond the marker, up to the value specified by
|
|
* <code>MaxRecords</code>. </p>
|
|
*/
|
|
inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); }
|
|
|
|
/**
|
|
* <p> An optional pagination token provided by a previous
|
|
* <code>DescribeGlobalClusters</code> request. If this parameter is specified, the
|
|
* response includes only records beyond the marker, up to the value specified by
|
|
* <code>MaxRecords</code>. </p>
|
|
*/
|
|
inline DescribeGlobalClustersRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;}
|
|
|
|
/**
|
|
* <p> An optional pagination token provided by a previous
|
|
* <code>DescribeGlobalClusters</code> request. If this parameter is specified, the
|
|
* response includes only records beyond the marker, up to the value specified by
|
|
* <code>MaxRecords</code>. </p>
|
|
*/
|
|
inline DescribeGlobalClustersRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p> An optional pagination token provided by a previous
|
|
* <code>DescribeGlobalClusters</code> request. If this parameter is specified, the
|
|
* response includes only records beyond the marker, up to the value specified by
|
|
* <code>MaxRecords</code>. </p>
|
|
*/
|
|
inline DescribeGlobalClustersRequest& WithMarker(const char* value) { SetMarker(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_globalClusterIdentifier;
|
|
bool m_globalClusterIdentifierHasBeenSet;
|
|
|
|
Aws::Vector<Filter> m_filters;
|
|
bool m_filtersHasBeenSet;
|
|
|
|
int m_maxRecords;
|
|
bool m_maxRecordsHasBeenSet;
|
|
|
|
Aws::String m_marker;
|
|
bool m_markerHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace RDS
|
|
} // namespace Aws
|