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

#include <GetRuleGroupRequest.h>

+ Inheritance diagram for Aws::WAFV2::Model::GetRuleGroupRequest:

Public Member Functions

 GetRuleGroupRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
GetRuleGroupRequestWithName (const Aws::String &value)
 
GetRuleGroupRequestWithName (Aws::String &&value)
 
GetRuleGroupRequestWithName (const char *value)
 
const ScopeGetScope () const
 
bool ScopeHasBeenSet () const
 
void SetScope (const Scope &value)
 
void SetScope (Scope &&value)
 
GetRuleGroupRequestWithScope (const Scope &value)
 
GetRuleGroupRequestWithScope (Scope &&value)
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
GetRuleGroupRequestWithId (const Aws::String &value)
 
GetRuleGroupRequestWithId (Aws::String &&value)
 
GetRuleGroupRequestWithId (const char *value)
 
const Aws::StringGetARN () const
 
bool ARNHasBeenSet () const
 
void SetARN (const Aws::String &value)
 
void SetARN (Aws::String &&value)
 
void SetARN (const char *value)
 
GetRuleGroupRequestWithARN (const Aws::String &value)
 
GetRuleGroupRequestWithARN (Aws::String &&value)
 
GetRuleGroupRequestWithARN (const char *value)
 
- Public Member Functions inherited from Aws::WAFV2::WAFV2Request
virtual ~WAFV2Request ()
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file GetRuleGroupRequest.h.

Constructor & Destructor Documentation

◆ GetRuleGroupRequest()

Aws::WAFV2::Model::GetRuleGroupRequest::GetRuleGroupRequest ( )

Member Function Documentation

◆ ARNHasBeenSet()

bool Aws::WAFV2::Model::GetRuleGroupRequest::ARNHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 225 of file GetRuleGroupRequest.h.

◆ GetARN()

const Aws::String& Aws::WAFV2::Model::GetRuleGroupRequest::GetARN ( ) const
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 220 of file GetRuleGroupRequest.h.

◆ GetId()

const Aws::String& Aws::WAFV2::Model::GetRuleGroupRequest::GetId ( ) const
inline

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 165 of file GetRuleGroupRequest.h.

◆ GetName()

const Aws::String& Aws::WAFV2::Model::GetRuleGroupRequest::GetName ( ) const
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 42 of file GetRuleGroupRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::WAFV2::Model::GetRuleGroupRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::WAFV2::WAFV2Request.

◆ GetScope()

const Scope& Aws::WAFV2::Model::GetRuleGroupRequest::GetScope ( ) const
inline

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 97 of file GetRuleGroupRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::WAFV2::Model::GetRuleGroupRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file GetRuleGroupRequest.h.

◆ IdHasBeenSet()

bool Aws::WAFV2::Model::GetRuleGroupRequest::IdHasBeenSet ( ) const
inline

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 172 of file GetRuleGroupRequest.h.

◆ NameHasBeenSet()

bool Aws::WAFV2::Model::GetRuleGroupRequest::NameHasBeenSet ( ) const
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 48 of file GetRuleGroupRequest.h.

◆ ScopeHasBeenSet()

bool Aws::WAFV2::Model::GetRuleGroupRequest::ScopeHasBeenSet ( ) const
inline

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 109 of file GetRuleGroupRequest.h.

◆ SerializePayload()

Aws::String Aws::WAFV2::Model::GetRuleGroupRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetARN() [1/3]

void Aws::WAFV2::Model::GetRuleGroupRequest::SetARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 235 of file GetRuleGroupRequest.h.

◆ SetARN() [2/3]

void Aws::WAFV2::Model::GetRuleGroupRequest::SetARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 230 of file GetRuleGroupRequest.h.

◆ SetARN() [3/3]

void Aws::WAFV2::Model::GetRuleGroupRequest::SetARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 240 of file GetRuleGroupRequest.h.

◆ SetId() [1/3]

void Aws::WAFV2::Model::GetRuleGroupRequest::SetId ( Aws::String &&  value)
inline

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 186 of file GetRuleGroupRequest.h.

◆ SetId() [2/3]

void Aws::WAFV2::Model::GetRuleGroupRequest::SetId ( const Aws::String value)
inline

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 179 of file GetRuleGroupRequest.h.

◆ SetId() [3/3]

void Aws::WAFV2::Model::GetRuleGroupRequest::SetId ( const char *  value)
inline

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 193 of file GetRuleGroupRequest.h.

◆ SetName() [1/3]

void Aws::WAFV2::Model::GetRuleGroupRequest::SetName ( Aws::String &&  value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 60 of file GetRuleGroupRequest.h.

◆ SetName() [2/3]

void Aws::WAFV2::Model::GetRuleGroupRequest::SetName ( const Aws::String value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 54 of file GetRuleGroupRequest.h.

◆ SetName() [3/3]

void Aws::WAFV2::Model::GetRuleGroupRequest::SetName ( const char *  value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 66 of file GetRuleGroupRequest.h.

◆ SetScope() [1/2]

void Aws::WAFV2::Model::GetRuleGroupRequest::SetScope ( const Scope value)
inline

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 121 of file GetRuleGroupRequest.h.

◆ SetScope() [2/2]

void Aws::WAFV2::Model::GetRuleGroupRequest::SetScope ( Scope &&  value)
inline

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 133 of file GetRuleGroupRequest.h.

◆ WithARN() [1/3]

GetRuleGroupRequest& Aws::WAFV2::Model::GetRuleGroupRequest::WithARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 250 of file GetRuleGroupRequest.h.

◆ WithARN() [2/3]

GetRuleGroupRequest& Aws::WAFV2::Model::GetRuleGroupRequest::WithARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 245 of file GetRuleGroupRequest.h.

◆ WithARN() [3/3]

GetRuleGroupRequest& Aws::WAFV2::Model::GetRuleGroupRequest::WithARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of the entity.

Definition at line 255 of file GetRuleGroupRequest.h.

◆ WithId() [1/3]

GetRuleGroupRequest& Aws::WAFV2::Model::GetRuleGroupRequest::WithId ( Aws::String &&  value)
inline

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 207 of file GetRuleGroupRequest.h.

◆ WithId() [2/3]

GetRuleGroupRequest& Aws::WAFV2::Model::GetRuleGroupRequest::WithId ( const Aws::String value)
inline

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 200 of file GetRuleGroupRequest.h.

◆ WithId() [3/3]

GetRuleGroupRequest& Aws::WAFV2::Model::GetRuleGroupRequest::WithId ( const char *  value)
inline

A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Definition at line 214 of file GetRuleGroupRequest.h.

◆ WithName() [1/3]

GetRuleGroupRequest& Aws::WAFV2::Model::GetRuleGroupRequest::WithName ( Aws::String &&  value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 78 of file GetRuleGroupRequest.h.

◆ WithName() [2/3]

GetRuleGroupRequest& Aws::WAFV2::Model::GetRuleGroupRequest::WithName ( const Aws::String value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 72 of file GetRuleGroupRequest.h.

◆ WithName() [3/3]

GetRuleGroupRequest& Aws::WAFV2::Model::GetRuleGroupRequest::WithName ( const char *  value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 84 of file GetRuleGroupRequest.h.

◆ WithScope() [1/2]

GetRuleGroupRequest& Aws::WAFV2::Model::GetRuleGroupRequest::WithScope ( const Scope value)
inline

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 145 of file GetRuleGroupRequest.h.

◆ WithScope() [2/2]

GetRuleGroupRequest& Aws::WAFV2::Model::GetRuleGroupRequest::WithScope ( Scope &&  value)
inline

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 157 of file GetRuleGroupRequest.h.


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