Aws::RDS::Model::DescribeOptionGroupsRequest Class Reference

#include <DescribeOptionGroupsRequest.h>

Inheritance diagram for Aws::RDS::Model::DescribeOptionGroupsRequest:

Public Member Functions
	DescribeOptionGroupsRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
const Aws::String &	GetOptionGroupName () const
bool	OptionGroupNameHasBeenSet () const
void	SetOptionGroupName (const Aws::String &value)
void	SetOptionGroupName (Aws::String &&value)
void	SetOptionGroupName (const char *value)
DescribeOptionGroupsRequest &	WithOptionGroupName (const Aws::String &value)
DescribeOptionGroupsRequest &	WithOptionGroupName (Aws::String &&value)
DescribeOptionGroupsRequest &	WithOptionGroupName (const char *value)
const Aws::Vector< Filter > &	GetFilters () const
bool	FiltersHasBeenSet () const
void	SetFilters (const Aws::Vector< Filter > &value)
void	SetFilters (Aws::Vector< Filter > &&value)
DescribeOptionGroupsRequest &	WithFilters (const Aws::Vector< Filter > &value)
DescribeOptionGroupsRequest &	WithFilters (Aws::Vector< Filter > &&value)
DescribeOptionGroupsRequest &	AddFilters (const Filter &value)
DescribeOptionGroupsRequest &	AddFilters (Filter &&value)
const Aws::String &	GetMarker () const
bool	MarkerHasBeenSet () const
void	SetMarker (const Aws::String &value)
void	SetMarker (Aws::String &&value)
void	SetMarker (const char *value)
DescribeOptionGroupsRequest &	WithMarker (const Aws::String &value)
DescribeOptionGroupsRequest &	WithMarker (Aws::String &&value)
DescribeOptionGroupsRequest &	WithMarker (const char *value)
int	GetMaxRecords () const
bool	MaxRecordsHasBeenSet () const
void	SetMaxRecords (int value)
DescribeOptionGroupsRequest &	WithMaxRecords (int value)
const Aws::String &	GetEngineName () const
bool	EngineNameHasBeenSet () const
void	SetEngineName (const Aws::String &value)
void	SetEngineName (Aws::String &&value)
void	SetEngineName (const char *value)
DescribeOptionGroupsRequest &	WithEngineName (const Aws::String &value)
DescribeOptionGroupsRequest &	WithEngineName (Aws::String &&value)
DescribeOptionGroupsRequest &	WithEngineName (const char *value)
const Aws::String &	GetMajorEngineVersion () const
bool	MajorEngineVersionHasBeenSet () const
void	SetMajorEngineVersion (const Aws::String &value)
void	SetMajorEngineVersion (Aws::String &&value)
void	SetMajorEngineVersion (const char *value)
DescribeOptionGroupsRequest &	WithMajorEngineVersion (const Aws::String &value)
DescribeOptionGroupsRequest &	WithMajorEngineVersion (Aws::String &&value)
DescribeOptionGroupsRequest &	WithMajorEngineVersion (const char *value)
Public Member Functions inherited from Aws::RDS::RDSRequest
virtual	~RDSRequest ()
void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
Aws::Http::HeaderValueCollection	GetHeaders () const override
Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()
virtual	~AmazonSerializableWebServiceRequest ()
std::shared_ptr< Aws::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const
virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () const
virtual bool	SignBody () const
virtual bool	IsChunked () const
virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)
virtual const RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () const
void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)
virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)
virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () const
virtual bool	ShouldComputeContentMd5 () const

Protected Member Functions
void	DumpBodyToUrl (Aws::Http::URI &uri) const override
Protected Member Functions inherited from Aws::RDS::RDSRequest
virtual Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const

Detailed Description

See Also:

AWS API Reference

Definition at line 26 of file DescribeOptionGroupsRequest.h.

Constructor & Destructor Documentation

DescribeOptionGroupsRequest()

Aws::RDS::Model::DescribeOptionGroupsRequest::DescribeOptionGroupsRequest

(

)

Member Function Documentation

AddFilters() [1/2]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::AddFilters ( const Filter &  value )

inline

This parameter isn't currently supported.

Definition at line 126 of file DescribeOptionGroupsRequest.h.

AddFilters() [2/2]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::AddFilters ( Filter &&  value )

inline

This parameter isn't currently supported.

Definition at line 131 of file DescribeOptionGroupsRequest.h.

DumpBodyToUrl()

void Aws::RDS::Model::DescribeOptionGroupsRequest::DumpBodyToUrl ( Aws::Http::URI &  uri ) const

overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

EngineNameHasBeenSet()

bool Aws::RDS::Model::DescribeOptionGroupsRequest::EngineNameHasBeenSet ( ) const

inline

Filters the list of option groups to only include groups associated with a specific database engine.

Valid Values:

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Definition at line 252 of file DescribeOptionGroupsRequest.h.

FiltersHasBeenSet()

bool Aws::RDS::Model::DescribeOptionGroupsRequest::FiltersHasBeenSet ( ) const

inline

This parameter isn't currently supported.

Definition at line 101 of file DescribeOptionGroupsRequest.h.

GetEngineName()

const Aws::String& Aws::RDS::Model::DescribeOptionGroupsRequest::GetEngineName ( ) const

inline

Filters the list of option groups to only include groups associated with a specific database engine.

Valid Values:

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Definition at line 239 of file DescribeOptionGroupsRequest.h.

GetFilters()

const Aws::Vector<Filter>& Aws::RDS::Model::DescribeOptionGroupsRequest::GetFilters ( ) const

inline

This parameter isn't currently supported.

Definition at line 96 of file DescribeOptionGroupsRequest.h.

GetMajorEngineVersion()

const Aws::String& Aws::RDS::Model::DescribeOptionGroupsRequest::GetMajorEngineVersion ( ) const

inline

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Definition at line 338 of file DescribeOptionGroupsRequest.h.

GetMarker()

const Aws::String& Aws::RDS::Model::DescribeOptionGroupsRequest::GetMarker ( ) const

inline

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

Definition at line 139 of file DescribeOptionGroupsRequest.h.

GetMaxRecords()

int Aws::RDS::Model::DescribeOptionGroupsRequest::GetMaxRecords ( ) const

inline

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.

Definition at line 198 of file DescribeOptionGroupsRequest.h.

GetOptionGroupName()

const Aws::String& Aws::RDS::Model::DescribeOptionGroupsRequest::GetOptionGroupName ( ) const

inline

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Definition at line 48 of file DescribeOptionGroupsRequest.h.

GetServiceRequestName()

virtual const char* Aws::RDS::Model::DescribeOptionGroupsRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file DescribeOptionGroupsRequest.h.

MajorEngineVersionHasBeenSet()

bool Aws::RDS::Model::DescribeOptionGroupsRequest::MajorEngineVersionHasBeenSet ( ) const

inline

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Definition at line 345 of file DescribeOptionGroupsRequest.h.

MarkerHasBeenSet()

bool Aws::RDS::Model::DescribeOptionGroupsRequest::MarkerHasBeenSet ( ) const

inline

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

Definition at line 146 of file DescribeOptionGroupsRequest.h.

MaxRecordsHasBeenSet()

bool Aws::RDS::Model::DescribeOptionGroupsRequest::MaxRecordsHasBeenSet ( ) const

inline

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.

Definition at line 207 of file DescribeOptionGroupsRequest.h.

OptionGroupNameHasBeenSet()

bool Aws::RDS::Model::DescribeOptionGroupsRequest::OptionGroupNameHasBeenSet ( ) const

inline

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Definition at line 54 of file DescribeOptionGroupsRequest.h.

SerializePayload()

Aws::String Aws::RDS::Model::DescribeOptionGroupsRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetEngineName() [1/3]

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetEngineName ( Aws::String &&  value )

inline

Filters the list of option groups to only include groups associated with a specific database engine.

Valid Values:

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Definition at line 278 of file DescribeOptionGroupsRequest.h.

SetEngineName() [2/3]

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetEngineName ( const Aws::String &  value )

inline

Filters the list of option groups to only include groups associated with a specific database engine.

Valid Values:

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Definition at line 265 of file DescribeOptionGroupsRequest.h.

SetEngineName() [3/3]

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetEngineName ( const char *  value )

inline

Filters the list of option groups to only include groups associated with a specific database engine.

Valid Values:

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Definition at line 291 of file DescribeOptionGroupsRequest.h.

SetFilters() [1/2]

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetFilters ( Aws::Vector< Filter > &&  value )

inline

This parameter isn't currently supported.

Definition at line 111 of file DescribeOptionGroupsRequest.h.

SetFilters() [2/2]

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetFilters ( const Aws::Vector< Filter > &  value )

inline

This parameter isn't currently supported.

Definition at line 106 of file DescribeOptionGroupsRequest.h.

SetMajorEngineVersion() [1/3]

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetMajorEngineVersion ( Aws::String &&  value )

inline

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Definition at line 359 of file DescribeOptionGroupsRequest.h.

SetMajorEngineVersion() [2/3]

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetMajorEngineVersion ( const Aws::String &  value )

inline

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Definition at line 352 of file DescribeOptionGroupsRequest.h.

SetMajorEngineVersion() [3/3]

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetMajorEngineVersion ( const char *  value )

inline

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Definition at line 366 of file DescribeOptionGroupsRequest.h.

SetMarker() [1/3]

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetMarker ( Aws::String &&  value )

inline

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

Definition at line 160 of file DescribeOptionGroupsRequest.h.

SetMarker() [2/3]

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetMarker ( const Aws::String &  value )

inline

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

Definition at line 153 of file DescribeOptionGroupsRequest.h.

SetMarker() [3/3]

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetMarker ( const char *  value )

inline

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

Definition at line 167 of file DescribeOptionGroupsRequest.h.

SetMaxRecords()

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetMaxRecords ( int  value )

inline

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.

Definition at line 216 of file DescribeOptionGroupsRequest.h.

SetOptionGroupName() [1/3]

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetOptionGroupName ( Aws::String &&  value )

inline

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Definition at line 66 of file DescribeOptionGroupsRequest.h.

SetOptionGroupName() [2/3]

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetOptionGroupName ( const Aws::String &  value )

inline

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Definition at line 60 of file DescribeOptionGroupsRequest.h.

SetOptionGroupName() [3/3]

void Aws::RDS::Model::DescribeOptionGroupsRequest::SetOptionGroupName ( const char *  value )

inline

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Definition at line 72 of file DescribeOptionGroupsRequest.h.

WithEngineName() [1/3]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithEngineName ( Aws::String &&  value )

inline

Filters the list of option groups to only include groups associated with a specific database engine.

Valid Values:

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Definition at line 317 of file DescribeOptionGroupsRequest.h.

WithEngineName() [2/3]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithEngineName ( const Aws::String &  value )

inline

Filters the list of option groups to only include groups associated with a specific database engine.

Valid Values:

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Definition at line 304 of file DescribeOptionGroupsRequest.h.

WithEngineName() [3/3]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithEngineName ( const char *  value )

inline

Filters the list of option groups to only include groups associated with a specific database engine.

Valid Values:

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Definition at line 330 of file DescribeOptionGroupsRequest.h.

WithFilters() [1/2]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithFilters ( Aws::Vector< Filter > &&  value )

inline

This parameter isn't currently supported.

Definition at line 121 of file DescribeOptionGroupsRequest.h.

WithFilters() [2/2]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithFilters ( const Aws::Vector< Filter > &  value )

inline

This parameter isn't currently supported.

Definition at line 116 of file DescribeOptionGroupsRequest.h.

WithMajorEngineVersion() [1/3]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithMajorEngineVersion ( Aws::String &&  value )

inline

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Definition at line 380 of file DescribeOptionGroupsRequest.h.

WithMajorEngineVersion() [2/3]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithMajorEngineVersion ( const Aws::String &  value )

inline

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Definition at line 373 of file DescribeOptionGroupsRequest.h.

WithMajorEngineVersion() [3/3]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithMajorEngineVersion ( const char *  value )

inline

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Definition at line 387 of file DescribeOptionGroupsRequest.h.

WithMarker() [1/3]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithMarker ( Aws::String &&  value )

inline

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

Definition at line 181 of file DescribeOptionGroupsRequest.h.

WithMarker() [2/3]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithMarker ( const Aws::String &  value )

inline

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

Definition at line 174 of file DescribeOptionGroupsRequest.h.

WithMarker() [3/3]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithMarker ( const char *  value )

inline

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

Definition at line 188 of file DescribeOptionGroupsRequest.h.

WithMaxRecords()

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithMaxRecords ( int  value )

inline

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.

Definition at line 225 of file DescribeOptionGroupsRequest.h.

WithOptionGroupName() [1/3]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithOptionGroupName ( Aws::String &&  value )

inline

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Definition at line 84 of file DescribeOptionGroupsRequest.h.

WithOptionGroupName() [2/3]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithOptionGroupName ( const Aws::String &  value )

inline

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Definition at line 78 of file DescribeOptionGroupsRequest.h.

WithOptionGroupName() [3/3]

DescribeOptionGroupsRequest& Aws::RDS::Model::DescribeOptionGroupsRequest::WithOptionGroupName ( const char *  value )

inline

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Definition at line 90 of file DescribeOptionGroupsRequest.h.

---

The documentation for this class was generated from the following file:

• aws-cpp-sdk-rds/include/aws/rds/model/DescribeOptionGroupsRequest.h