AWS SDK for C++  1.9.125
AWS SDK for C++
Public Member Functions | List of all members
Aws::WAFV2::Model::TimeWindow Class Reference

#include <TimeWindow.h>

Public Member Functions

 TimeWindow ()
 
 TimeWindow (Aws::Utils::Json::JsonView jsonValue)
 
TimeWindowoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
TimeWindowWithStartTime (const Aws::Utils::DateTime &value)
 
TimeWindowWithStartTime (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)
 
TimeWindowWithEndTime (const Aws::Utils::DateTime &value)
 
TimeWindowWithEndTime (Aws::Utils::DateTime &&value)
 

Detailed Description

In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want WAF to return a sample of web requests.

You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which WAF actually returned a sample of web requests. WAF gets the specified number of requests from among the first 5,000 requests that your Amazon Web Services resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, WAF stops sampling after the 5,000th request. In that case, EndTime is the time that WAF received the 5,000th request.

See Also:

AWS API Reference

Definition at line 44 of file TimeWindow.h.

Constructor & Destructor Documentation

◆ TimeWindow() [1/2]

Aws::WAFV2::Model::TimeWindow::TimeWindow ( )

◆ TimeWindow() [2/2]

Aws::WAFV2::Model::TimeWindow::TimeWindow ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ EndTimeHasBeenSet()

bool Aws::WAFV2::Model::TimeWindow::EndTimeHasBeenSet ( ) const
inline

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Definition at line 132 of file TimeWindow.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::WAFV2::Model::TimeWindow::GetEndTime ( ) const
inline

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Definition at line 122 of file TimeWindow.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::WAFV2::Model::TimeWindow::GetStartTime ( ) const
inline

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Definition at line 61 of file TimeWindow.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::WAFV2::Model::TimeWindow::Jsonize ( ) const

◆ operator=()

TimeWindow& Aws::WAFV2::Model::TimeWindow::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetEndTime() [1/2]

void Aws::WAFV2::Model::TimeWindow::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Definition at line 152 of file TimeWindow.h.

◆ SetEndTime() [2/2]

void Aws::WAFV2::Model::TimeWindow::SetEndTime ( const Aws::Utils::DateTime value)
inline

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Definition at line 142 of file TimeWindow.h.

◆ SetStartTime() [1/2]

void Aws::WAFV2::Model::TimeWindow::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Definition at line 91 of file TimeWindow.h.

◆ SetStartTime() [2/2]

void Aws::WAFV2::Model::TimeWindow::SetStartTime ( const Aws::Utils::DateTime value)
inline

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Definition at line 81 of file TimeWindow.h.

◆ StartTimeHasBeenSet()

bool Aws::WAFV2::Model::TimeWindow::StartTimeHasBeenSet ( ) const
inline

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Definition at line 71 of file TimeWindow.h.

◆ WithEndTime() [1/2]

TimeWindow& Aws::WAFV2::Model::TimeWindow::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Definition at line 172 of file TimeWindow.h.

◆ WithEndTime() [2/2]

TimeWindow& Aws::WAFV2::Model::TimeWindow::WithEndTime ( const Aws::Utils::DateTime value)
inline

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Definition at line 162 of file TimeWindow.h.

◆ WithStartTime() [1/2]

TimeWindow& Aws::WAFV2::Model::TimeWindow::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Definition at line 111 of file TimeWindow.h.

◆ WithStartTime() [2/2]

TimeWindow& Aws::WAFV2::Model::TimeWindow::WithStartTime ( const Aws::Utils::DateTime value)
inline

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

Definition at line 101 of file TimeWindow.h.


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