AWS SDK for C++  1.8.79
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::DocDB::Model::DescribeEventsRequest Class Reference

#include <DescribeEventsRequest.h>

+ Inheritance diagram for Aws::DocDB::Model::DescribeEventsRequest:

Public Member Functions

 DescribeEventsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetSourceIdentifier () const
 
bool SourceIdentifierHasBeenSet () const
 
void SetSourceIdentifier (const Aws::String &value)
 
void SetSourceIdentifier (Aws::String &&value)
 
void SetSourceIdentifier (const char *value)
 
DescribeEventsRequestWithSourceIdentifier (const Aws::String &value)
 
DescribeEventsRequestWithSourceIdentifier (Aws::String &&value)
 
DescribeEventsRequestWithSourceIdentifier (const char *value)
 
const SourceTypeGetSourceType () const
 
bool SourceTypeHasBeenSet () const
 
void SetSourceType (const SourceType &value)
 
void SetSourceType (SourceType &&value)
 
DescribeEventsRequestWithSourceType (const SourceType &value)
 
DescribeEventsRequestWithSourceType (SourceType &&value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
DescribeEventsRequestWithStartTime (const Aws::Utils::DateTime &value)
 
DescribeEventsRequestWithStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (const Aws::Utils::DateTime &value)
 
void SetEndTime (Aws::Utils::DateTime &&value)
 
DescribeEventsRequestWithEndTime (const Aws::Utils::DateTime &value)
 
DescribeEventsRequestWithEndTime (Aws::Utils::DateTime &&value)
 
int GetDuration () const
 
bool DurationHasBeenSet () const
 
void SetDuration (int value)
 
DescribeEventsRequestWithDuration (int value)
 
const Aws::Vector< Aws::String > & GetEventCategories () const
 
bool EventCategoriesHasBeenSet () const
 
void SetEventCategories (const Aws::Vector< Aws::String > &value)
 
void SetEventCategories (Aws::Vector< Aws::String > &&value)
 
DescribeEventsRequestWithEventCategories (const Aws::Vector< Aws::String > &value)
 
DescribeEventsRequestWithEventCategories (Aws::Vector< Aws::String > &&value)
 
DescribeEventsRequestAddEventCategories (const Aws::String &value)
 
DescribeEventsRequestAddEventCategories (Aws::String &&value)
 
DescribeEventsRequestAddEventCategories (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)
 
DescribeEventsRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeEventsRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeEventsRequestAddFilters (const Filter &value)
 
DescribeEventsRequestAddFilters (Filter &&value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeEventsRequestWithMaxRecords (int value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
DescribeEventsRequestWithMarker (const Aws::String &value)
 
DescribeEventsRequestWithMarker (Aws::String &&value)
 
DescribeEventsRequestWithMarker (const char *value)
 
- Public Member Functions inherited from Aws::DocDB::DocDBRequest
virtual ~DocDBRequest ()
 
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::IOStreamGetBody () 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 RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () 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::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

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

Detailed Description

Represents the input to DescribeEvents.

See Also:

AWS API Reference

Definition at line 28 of file DescribeEventsRequest.h.

Constructor & Destructor Documentation

◆ DescribeEventsRequest()

Aws::DocDB::Model::DescribeEventsRequest::DescribeEventsRequest ( )

Member Function Documentation

◆ AddEventCategories() [1/3]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::AddEventCategories ( const Aws::String value)
inline

A list of event categories that trigger notifications for an event notification subscription.

Definition at line 347 of file DescribeEventsRequest.h.

◆ AddEventCategories() [2/3]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::AddEventCategories ( Aws::String &&  value)
inline

A list of event categories that trigger notifications for an event notification subscription.

Definition at line 353 of file DescribeEventsRequest.h.

◆ AddEventCategories() [3/3]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::AddEventCategories ( const char *  value)
inline

A list of event categories that trigger notifications for an event notification subscription.

Definition at line 359 of file DescribeEventsRequest.h.

◆ AddFilters() [1/2]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::AddFilters ( const Filter value)
inline

This parameter is not currently supported.

Definition at line 395 of file DescribeEventsRequest.h.

◆ AddFilters() [2/2]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::AddFilters ( Filter &&  value)
inline

This parameter is not currently supported.

Definition at line 400 of file DescribeEventsRequest.h.

◆ DumpBodyToUrl()

void Aws::DocDB::Model::DescribeEventsRequest::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.

◆ DurationHasBeenSet()

bool Aws::DocDB::Model::DescribeEventsRequest::DurationHasBeenSet ( ) const
inline

The number of minutes to retrieve events for.

Default: 60

Definition at line 294 of file DescribeEventsRequest.h.

◆ EndTimeHasBeenSet()

bool Aws::DocDB::Model::DescribeEventsRequest::EndTimeHasBeenSet ( ) const
inline

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Definition at line 259 of file DescribeEventsRequest.h.

◆ EventCategoriesHasBeenSet()

bool Aws::DocDB::Model::DescribeEventsRequest::EventCategoriesHasBeenSet ( ) const
inline

A list of event categories that trigger notifications for an event notification subscription.

Definition at line 317 of file DescribeEventsRequest.h.

◆ FiltersHasBeenSet()

bool Aws::DocDB::Model::DescribeEventsRequest::FiltersHasBeenSet ( ) const
inline

This parameter is not currently supported.

Definition at line 370 of file DescribeEventsRequest.h.

◆ GetDuration()

int Aws::DocDB::Model::DescribeEventsRequest::GetDuration ( ) const
inline

The number of minutes to retrieve events for.

Default: 60

Definition at line 289 of file DescribeEventsRequest.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::DocDB::Model::DescribeEventsRequest::GetEndTime ( ) const
inline

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Definition at line 253 of file DescribeEventsRequest.h.

◆ GetEventCategories()

const Aws::Vector<Aws::String>& Aws::DocDB::Model::DescribeEventsRequest::GetEventCategories ( ) const
inline

A list of event categories that trigger notifications for an event notification subscription.

Definition at line 311 of file DescribeEventsRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::DocDB::Model::DescribeEventsRequest::GetFilters ( ) const
inline

This parameter is not currently supported.

Definition at line 365 of file DescribeEventsRequest.h.

◆ GetMarker()

const Aws::String& Aws::DocDB::Model::DescribeEventsRequest::GetMarker ( ) const
inline

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.

Definition at line 441 of file DescribeEventsRequest.h.

◆ GetMaxRecords()

int Aws::DocDB::Model::DescribeEventsRequest::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 (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 409 of file DescribeEventsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::DocDB::Model::DescribeEventsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file DescribeEventsRequest.h.

◆ GetSourceIdentifier()

const Aws::String& Aws::DocDB::Model::DescribeEventsRequest::GetSourceIdentifier ( ) const
inline

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 60 of file DescribeEventsRequest.h.

◆ GetSourceType()

const SourceType& Aws::DocDB::Model::DescribeEventsRequest::GetSourceType ( ) const
inline

The event source to retrieve events for. If no value is specified, all events are returned.

Definition at line 179 of file DescribeEventsRequest.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::DocDB::Model::DescribeEventsRequest::GetStartTime ( ) const
inline

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Definition at line 216 of file DescribeEventsRequest.h.

◆ MarkerHasBeenSet()

bool Aws::DocDB::Model::DescribeEventsRequest::MarkerHasBeenSet ( ) const
inline

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.

Definition at line 448 of file DescribeEventsRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::DocDB::Model::DescribeEventsRequest::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 (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 417 of file DescribeEventsRequest.h.

◆ SerializePayload()

Aws::String Aws::DocDB::Model::DescribeEventsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDuration()

void Aws::DocDB::Model::DescribeEventsRequest::SetDuration ( int  value)
inline

The number of minutes to retrieve events for.

Default: 60

Definition at line 299 of file DescribeEventsRequest.h.

◆ SetEndTime() [1/2]

void Aws::DocDB::Model::DescribeEventsRequest::SetEndTime ( const Aws::Utils::DateTime value)
inline

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Definition at line 265 of file DescribeEventsRequest.h.

◆ SetEndTime() [2/2]

void Aws::DocDB::Model::DescribeEventsRequest::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Definition at line 271 of file DescribeEventsRequest.h.

◆ SetEventCategories() [1/2]

void Aws::DocDB::Model::DescribeEventsRequest::SetEventCategories ( const Aws::Vector< Aws::String > &  value)
inline

A list of event categories that trigger notifications for an event notification subscription.

Definition at line 323 of file DescribeEventsRequest.h.

◆ SetEventCategories() [2/2]

void Aws::DocDB::Model::DescribeEventsRequest::SetEventCategories ( Aws::Vector< Aws::String > &&  value)
inline

A list of event categories that trigger notifications for an event notification subscription.

Definition at line 329 of file DescribeEventsRequest.h.

◆ SetFilters() [1/2]

void Aws::DocDB::Model::DescribeEventsRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

This parameter is not currently supported.

Definition at line 375 of file DescribeEventsRequest.h.

◆ SetFilters() [2/2]

void Aws::DocDB::Model::DescribeEventsRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

This parameter is not currently supported.

Definition at line 380 of file DescribeEventsRequest.h.

◆ SetMarker() [1/3]

void Aws::DocDB::Model::DescribeEventsRequest::SetMarker ( const Aws::String value)
inline

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.

Definition at line 455 of file DescribeEventsRequest.h.

◆ SetMarker() [2/3]

void Aws::DocDB::Model::DescribeEventsRequest::SetMarker ( Aws::String &&  value)
inline

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.

Definition at line 462 of file DescribeEventsRequest.h.

◆ SetMarker() [3/3]

void Aws::DocDB::Model::DescribeEventsRequest::SetMarker ( const char *  value)
inline

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.

Definition at line 469 of file DescribeEventsRequest.h.

◆ SetMaxRecords()

void Aws::DocDB::Model::DescribeEventsRequest::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 (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 425 of file DescribeEventsRequest.h.

◆ SetSourceIdentifier() [1/3]

void Aws::DocDB::Model::DescribeEventsRequest::SetSourceIdentifier ( const Aws::String value)
inline

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 92 of file DescribeEventsRequest.h.

◆ SetSourceIdentifier() [2/3]

void Aws::DocDB::Model::DescribeEventsRequest::SetSourceIdentifier ( Aws::String &&  value)
inline

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 108 of file DescribeEventsRequest.h.

◆ SetSourceIdentifier() [3/3]

void Aws::DocDB::Model::DescribeEventsRequest::SetSourceIdentifier ( const char *  value)
inline

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 124 of file DescribeEventsRequest.h.

◆ SetSourceType() [1/2]

void Aws::DocDB::Model::DescribeEventsRequest::SetSourceType ( const SourceType value)
inline

The event source to retrieve events for. If no value is specified, all events are returned.

Definition at line 191 of file DescribeEventsRequest.h.

◆ SetSourceType() [2/2]

void Aws::DocDB::Model::DescribeEventsRequest::SetSourceType ( SourceType &&  value)
inline

The event source to retrieve events for. If no value is specified, all events are returned.

Definition at line 197 of file DescribeEventsRequest.h.

◆ SetStartTime() [1/2]

void Aws::DocDB::Model::DescribeEventsRequest::SetStartTime ( const Aws::Utils::DateTime value)
inline

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Definition at line 228 of file DescribeEventsRequest.h.

◆ SetStartTime() [2/2]

void Aws::DocDB::Model::DescribeEventsRequest::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Definition at line 234 of file DescribeEventsRequest.h.

◆ SourceIdentifierHasBeenSet()

bool Aws::DocDB::Model::DescribeEventsRequest::SourceIdentifierHasBeenSet ( ) const
inline

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 76 of file DescribeEventsRequest.h.

◆ SourceTypeHasBeenSet()

bool Aws::DocDB::Model::DescribeEventsRequest::SourceTypeHasBeenSet ( ) const
inline

The event source to retrieve events for. If no value is specified, all events are returned.

Definition at line 185 of file DescribeEventsRequest.h.

◆ StartTimeHasBeenSet()

bool Aws::DocDB::Model::DescribeEventsRequest::StartTimeHasBeenSet ( ) const
inline

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Definition at line 222 of file DescribeEventsRequest.h.

◆ WithDuration()

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithDuration ( int  value)
inline

The number of minutes to retrieve events for.

Default: 60

Definition at line 304 of file DescribeEventsRequest.h.

◆ WithEndTime() [1/2]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithEndTime ( const Aws::Utils::DateTime value)
inline

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Definition at line 277 of file DescribeEventsRequest.h.

◆ WithEndTime() [2/2]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Definition at line 283 of file DescribeEventsRequest.h.

◆ WithEventCategories() [1/2]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithEventCategories ( const Aws::Vector< Aws::String > &  value)
inline

A list of event categories that trigger notifications for an event notification subscription.

Definition at line 335 of file DescribeEventsRequest.h.

◆ WithEventCategories() [2/2]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithEventCategories ( Aws::Vector< Aws::String > &&  value)
inline

A list of event categories that trigger notifications for an event notification subscription.

Definition at line 341 of file DescribeEventsRequest.h.

◆ WithFilters() [1/2]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

This parameter is not currently supported.

Definition at line 385 of file DescribeEventsRequest.h.

◆ WithFilters() [2/2]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

This parameter is not currently supported.

Definition at line 390 of file DescribeEventsRequest.h.

◆ WithMarker() [1/3]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithMarker ( const Aws::String value)
inline

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.

Definition at line 476 of file DescribeEventsRequest.h.

◆ WithMarker() [2/3]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithMarker ( Aws::String &&  value)
inline

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.

Definition at line 483 of file DescribeEventsRequest.h.

◆ WithMarker() [3/3]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithMarker ( const char *  value)
inline

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.

Definition at line 490 of file DescribeEventsRequest.h.

◆ WithMaxRecords()

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::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 (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 433 of file DescribeEventsRequest.h.

◆ WithSourceIdentifier() [1/3]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithSourceIdentifier ( const Aws::String value)
inline

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 140 of file DescribeEventsRequest.h.

◆ WithSourceIdentifier() [2/3]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithSourceIdentifier ( Aws::String &&  value)
inline

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 156 of file DescribeEventsRequest.h.

◆ WithSourceIdentifier() [3/3]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithSourceIdentifier ( const char *  value)
inline

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Definition at line 172 of file DescribeEventsRequest.h.

◆ WithSourceType() [1/2]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithSourceType ( const SourceType value)
inline

The event source to retrieve events for. If no value is specified, all events are returned.

Definition at line 203 of file DescribeEventsRequest.h.

◆ WithSourceType() [2/2]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithSourceType ( SourceType &&  value)
inline

The event source to retrieve events for. If no value is specified, all events are returned.

Definition at line 209 of file DescribeEventsRequest.h.

◆ WithStartTime() [1/2]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithStartTime ( const Aws::Utils::DateTime value)
inline

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Definition at line 240 of file DescribeEventsRequest.h.

◆ WithStartTime() [2/2]

DescribeEventsRequest& Aws::DocDB::Model::DescribeEventsRequest::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

Definition at line 246 of file DescribeEventsRequest.h.


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