/** * 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 Neptune { namespace Model { /** */ class DescribeDBClusterEndpointsRequest : public NeptuneRequest { public: AWS_NEPTUNE_API DescribeDBClusterEndpointsRequest(); // 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 "DescribeDBClusterEndpoints"; } AWS_NEPTUNE_API Aws::String SerializePayload() const override; protected: AWS_NEPTUNE_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The DB cluster identifier of the DB cluster associated with the endpoint. * This parameter is stored as a lowercase string.

*/ inline const Aws::String& GetDBClusterIdentifier() const{ return m_dBClusterIdentifier; } /** *

The DB cluster identifier of the DB cluster associated with the endpoint. * This parameter is stored as a lowercase string.

*/ inline bool DBClusterIdentifierHasBeenSet() const { return m_dBClusterIdentifierHasBeenSet; } /** *

The DB cluster identifier of the DB cluster associated with the endpoint. * This parameter is stored as a lowercase string.

*/ inline void SetDBClusterIdentifier(const Aws::String& value) { m_dBClusterIdentifierHasBeenSet = true; m_dBClusterIdentifier = value; } /** *

The DB cluster identifier of the DB cluster associated with the endpoint. * This parameter is stored as a lowercase string.

*/ inline void SetDBClusterIdentifier(Aws::String&& value) { m_dBClusterIdentifierHasBeenSet = true; m_dBClusterIdentifier = std::move(value); } /** *

The DB cluster identifier of the DB cluster associated with the endpoint. * This parameter is stored as a lowercase string.

*/ inline void SetDBClusterIdentifier(const char* value) { m_dBClusterIdentifierHasBeenSet = true; m_dBClusterIdentifier.assign(value); } /** *

The DB cluster identifier of the DB cluster associated with the endpoint. * This parameter is stored as a lowercase string.

*/ inline DescribeDBClusterEndpointsRequest& WithDBClusterIdentifier(const Aws::String& value) { SetDBClusterIdentifier(value); return *this;} /** *

The DB cluster identifier of the DB cluster associated with the endpoint. * This parameter is stored as a lowercase string.

*/ inline DescribeDBClusterEndpointsRequest& WithDBClusterIdentifier(Aws::String&& value) { SetDBClusterIdentifier(std::move(value)); return *this;} /** *

The DB cluster identifier of the DB cluster associated with the endpoint. * This parameter is stored as a lowercase string.

*/ inline DescribeDBClusterEndpointsRequest& WithDBClusterIdentifier(const char* value) { SetDBClusterIdentifier(value); return *this;} /** *

The identifier of the endpoint to describe. This parameter is stored as a * lowercase string.

*/ inline const Aws::String& GetDBClusterEndpointIdentifier() const{ return m_dBClusterEndpointIdentifier; } /** *

The identifier of the endpoint to describe. This parameter is stored as a * lowercase string.

*/ inline bool DBClusterEndpointIdentifierHasBeenSet() const { return m_dBClusterEndpointIdentifierHasBeenSet; } /** *

The identifier of the endpoint to describe. This parameter is stored as a * lowercase string.

*/ inline void SetDBClusterEndpointIdentifier(const Aws::String& value) { m_dBClusterEndpointIdentifierHasBeenSet = true; m_dBClusterEndpointIdentifier = value; } /** *

The identifier of the endpoint to describe. This parameter is stored as a * lowercase string.

*/ inline void SetDBClusterEndpointIdentifier(Aws::String&& value) { m_dBClusterEndpointIdentifierHasBeenSet = true; m_dBClusterEndpointIdentifier = std::move(value); } /** *

The identifier of the endpoint to describe. This parameter is stored as a * lowercase string.

*/ inline void SetDBClusterEndpointIdentifier(const char* value) { m_dBClusterEndpointIdentifierHasBeenSet = true; m_dBClusterEndpointIdentifier.assign(value); } /** *

The identifier of the endpoint to describe. This parameter is stored as a * lowercase string.

*/ inline DescribeDBClusterEndpointsRequest& WithDBClusterEndpointIdentifier(const Aws::String& value) { SetDBClusterEndpointIdentifier(value); return *this;} /** *

The identifier of the endpoint to describe. This parameter is stored as a * lowercase string.

*/ inline DescribeDBClusterEndpointsRequest& WithDBClusterEndpointIdentifier(Aws::String&& value) { SetDBClusterEndpointIdentifier(std::move(value)); return *this;} /** *

The identifier of the endpoint to describe. This parameter is stored as a * lowercase string.

*/ inline DescribeDBClusterEndpointsRequest& WithDBClusterEndpointIdentifier(const char* value) { SetDBClusterEndpointIdentifier(value); return *this;} /** *

A set of name-value pairs that define which endpoints to include in the * output. The filters are specified as name-value pairs, in the format * Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... * Name can be one of: db-cluster-endpoint-type, * db-cluster-endpoint-custom-type, * db-cluster-endpoint-id, db-cluster-endpoint-status. * Values for the db-cluster-endpoint-type filter can be * one or more of: reader, writer, custom. * Values for the db-cluster-endpoint-custom-type filter * can be one or more of: reader, any. * Values for the db-cluster-endpoint-status filter can * be one or more of: available, creating, * deleting, inactive, modifying.

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

A set of name-value pairs that define which endpoints to include in the * output. The filters are specified as name-value pairs, in the format * Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... * Name can be one of: db-cluster-endpoint-type, * db-cluster-endpoint-custom-type, * db-cluster-endpoint-id, db-cluster-endpoint-status. * Values for the db-cluster-endpoint-type filter can be * one or more of: reader, writer, custom. * Values for the db-cluster-endpoint-custom-type filter * can be one or more of: reader, any. * Values for the db-cluster-endpoint-status filter can * be one or more of: available, creating, * deleting, inactive, modifying.

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

A set of name-value pairs that define which endpoints to include in the * output. The filters are specified as name-value pairs, in the format * Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... * Name can be one of: db-cluster-endpoint-type, * db-cluster-endpoint-custom-type, * db-cluster-endpoint-id, db-cluster-endpoint-status. * Values for the db-cluster-endpoint-type filter can be * one or more of: reader, writer, custom. * Values for the db-cluster-endpoint-custom-type filter * can be one or more of: reader, any. * Values for the db-cluster-endpoint-status filter can * be one or more of: available, creating, * deleting, inactive, modifying.

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

A set of name-value pairs that define which endpoints to include in the * output. The filters are specified as name-value pairs, in the format * Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... * Name can be one of: db-cluster-endpoint-type, * db-cluster-endpoint-custom-type, * db-cluster-endpoint-id, db-cluster-endpoint-status. * Values for the db-cluster-endpoint-type filter can be * one or more of: reader, writer, custom. * Values for the db-cluster-endpoint-custom-type filter * can be one or more of: reader, any. * Values for the db-cluster-endpoint-status filter can * be one or more of: available, creating, * deleting, inactive, modifying.

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

A set of name-value pairs that define which endpoints to include in the * output. The filters are specified as name-value pairs, in the format * Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... * Name can be one of: db-cluster-endpoint-type, * db-cluster-endpoint-custom-type, * db-cluster-endpoint-id, db-cluster-endpoint-status. * Values for the db-cluster-endpoint-type filter can be * one or more of: reader, writer, custom. * Values for the db-cluster-endpoint-custom-type filter * can be one or more of: reader, any. * Values for the db-cluster-endpoint-status filter can * be one or more of: available, creating, * deleting, inactive, modifying.

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

A set of name-value pairs that define which endpoints to include in the * output. The filters are specified as name-value pairs, in the format * Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... * Name can be one of: db-cluster-endpoint-type, * db-cluster-endpoint-custom-type, * db-cluster-endpoint-id, db-cluster-endpoint-status. * Values for the db-cluster-endpoint-type filter can be * one or more of: reader, writer, custom. * Values for the db-cluster-endpoint-custom-type filter * can be one or more of: reader, any. * Values for the db-cluster-endpoint-status filter can * be one or more of: available, creating, * deleting, inactive, modifying.

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

A set of name-value pairs that define which endpoints to include in the * output. The filters are specified as name-value pairs, in the format * Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... * Name can be one of: db-cluster-endpoint-type, * db-cluster-endpoint-custom-type, * db-cluster-endpoint-id, db-cluster-endpoint-status. * Values for the db-cluster-endpoint-type filter can be * one or more of: reader, writer, custom. * Values for the db-cluster-endpoint-custom-type filter * can be one or more of: reader, any. * Values for the db-cluster-endpoint-status filter can * be one or more of: available, creating, * deleting, inactive, modifying.

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

A set of name-value pairs that define which endpoints to include in the * output. The filters are specified as name-value pairs, in the format * Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... * Name can be one of: db-cluster-endpoint-type, * db-cluster-endpoint-custom-type, * db-cluster-endpoint-id, db-cluster-endpoint-status. * Values for the db-cluster-endpoint-type filter can be * one or more of: reader, writer, custom. * Values for the db-cluster-endpoint-custom-type filter * can be one or more of: reader, any. * Values for the db-cluster-endpoint-status filter can * be one or more of: available, creating, * deleting, inactive, modifying.

*/ inline DescribeDBClusterEndpointsRequest& 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 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 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 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 you can retrieve the remaining * results.

Default: 100

Constraints: Minimum 20, maximum 100.

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

An optional pagination token provided by a previous * DescribeDBClusterEndpoints 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 * DescribeDBClusterEndpoints 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 * DescribeDBClusterEndpoints 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 * DescribeDBClusterEndpoints 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 * DescribeDBClusterEndpoints 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 * DescribeDBClusterEndpoints request. If this parameter is specified, * the response includes only records beyond the marker, up to the value specified * by MaxRecords.

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

An optional pagination token provided by a previous * DescribeDBClusterEndpoints request. If this parameter is specified, * the response includes only records beyond the marker, up to the value specified * by MaxRecords.

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

An optional pagination token provided by a previous * DescribeDBClusterEndpoints request. If this parameter is specified, * the response includes only records beyond the marker, up to the value specified * by MaxRecords.

*/ inline DescribeDBClusterEndpointsRequest& WithMarker(const char* value) { SetMarker(value); return *this;} private: Aws::String m_dBClusterIdentifier; bool m_dBClusterIdentifierHasBeenSet = false; Aws::String m_dBClusterEndpointIdentifier; bool m_dBClusterEndpointIdentifierHasBeenSet = 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 Neptune } // namespace Aws