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

#include <IPSet.h>

Public Member Functions

 IPSet ()
 
 IPSet (Aws::Utils::Json::JsonView jsonValue)
 
IPSetoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
IPSetWithName (const Aws::String &value)
 
IPSetWithName (Aws::String &&value)
 
IPSetWithName (const char *value)
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
IPSetWithId (const Aws::String &value)
 
IPSetWithId (Aws::String &&value)
 
IPSetWithId (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)
 
IPSetWithARN (const Aws::String &value)
 
IPSetWithARN (Aws::String &&value)
 
IPSetWithARN (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
IPSetWithDescription (const Aws::String &value)
 
IPSetWithDescription (Aws::String &&value)
 
IPSetWithDescription (const char *value)
 
const IPAddressVersionGetIPAddressVersion () const
 
bool IPAddressVersionHasBeenSet () const
 
void SetIPAddressVersion (const IPAddressVersion &value)
 
void SetIPAddressVersion (IPAddressVersion &&value)
 
IPSetWithIPAddressVersion (const IPAddressVersion &value)
 
IPSetWithIPAddressVersion (IPAddressVersion &&value)
 
const Aws::Vector< Aws::String > & GetAddresses () const
 
bool AddressesHasBeenSet () const
 
void SetAddresses (const Aws::Vector< Aws::String > &value)
 
void SetAddresses (Aws::Vector< Aws::String > &&value)
 
IPSetWithAddresses (const Aws::Vector< Aws::String > &value)
 
IPSetWithAddresses (Aws::Vector< Aws::String > &&value)
 
IPSetAddAddresses (const Aws::String &value)
 
IPSetAddAddresses (Aws::String &&value)
 
IPSetAddAddresses (const char *value)
 

Detailed Description

Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

AWS WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.

See Also:

AWS API Reference

Definition at line 41 of file IPSet.h.

Constructor & Destructor Documentation

◆ IPSet() [1/2]

Aws::WAFV2::Model::IPSet::IPSet ( )

◆ IPSet() [2/2]

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

Member Function Documentation

◆ AddAddresses() [1/3]

IPSet& Aws::WAFV2::Model::IPSet::AddAddresses ( Aws::String &&  value)
inline

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Examples:

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Definition at line 443 of file IPSet.h.

◆ AddAddresses() [2/3]

IPSet& Aws::WAFV2::Model::IPSet::AddAddresses ( const Aws::String value)
inline

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Examples:

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Definition at line 421 of file IPSet.h.

◆ AddAddresses() [3/3]

IPSet& Aws::WAFV2::Model::IPSet::AddAddresses ( const char *  value)
inline

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Examples:

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Definition at line 465 of file IPSet.h.

◆ AddressesHasBeenSet()

bool Aws::WAFV2::Model::IPSet::AddressesHasBeenSet ( ) const
inline

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Examples:

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Definition at line 311 of file IPSet.h.

◆ ARNHasBeenSet()

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

The Amazon Resource Name (ARN) of the entity.

Definition at line 164 of file IPSet.h.

◆ DescriptionHasBeenSet()

bool Aws::WAFV2::Model::IPSet::DescriptionHasBeenSet ( ) const
inline

A description of the IP set that helps with identification.

Definition at line 205 of file IPSet.h.

◆ GetAddresses()

const Aws::Vector<Aws::String>& Aws::WAFV2::Model::IPSet::GetAddresses ( ) const
inline

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Examples:

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Definition at line 289 of file IPSet.h.

◆ GetARN()

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

The Amazon Resource Name (ARN) of the entity.

Definition at line 159 of file IPSet.h.

◆ GetDescription()

const Aws::String& Aws::WAFV2::Model::IPSet::GetDescription ( ) const
inline

A description of the IP set that helps with identification.

Definition at line 200 of file IPSet.h.

◆ GetId()

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

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

Definition at line 104 of file IPSet.h.

◆ GetIPAddressVersion()

const IPAddressVersion& Aws::WAFV2::Model::IPSet::GetIPAddressVersion ( ) const
inline

Specify IPV4 or IPV6.

Definition at line 241 of file IPSet.h.

◆ GetName()

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

The name of the IP set. You cannot change the name of an IPSet after you create it.

Definition at line 54 of file IPSet.h.

◆ IdHasBeenSet()

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

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

Definition at line 111 of file IPSet.h.

◆ IPAddressVersionHasBeenSet()

bool Aws::WAFV2::Model::IPSet::IPAddressVersionHasBeenSet ( ) const
inline

Specify IPV4 or IPV6.

Definition at line 246 of file IPSet.h.

◆ Jsonize()

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

◆ NameHasBeenSet()

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

The name of the IP set. You cannot change the name of an IPSet after you create it.

Definition at line 60 of file IPSet.h.

◆ operator=()

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

◆ SetAddresses() [1/2]

void Aws::WAFV2::Model::IPSet::SetAddresses ( Aws::Vector< Aws::String > &&  value)
inline

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Examples:

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Definition at line 355 of file IPSet.h.

◆ SetAddresses() [2/2]

void Aws::WAFV2::Model::IPSet::SetAddresses ( const Aws::Vector< Aws::String > &  value)
inline

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Examples:

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Definition at line 333 of file IPSet.h.

◆ SetARN() [1/3]

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

The Amazon Resource Name (ARN) of the entity.

Definition at line 174 of file IPSet.h.

◆ SetARN() [2/3]

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

The Amazon Resource Name (ARN) of the entity.

Definition at line 169 of file IPSet.h.

◆ SetARN() [3/3]

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

The Amazon Resource Name (ARN) of the entity.

Definition at line 179 of file IPSet.h.

◆ SetDescription() [1/3]

void Aws::WAFV2::Model::IPSet::SetDescription ( Aws::String &&  value)
inline

A description of the IP set that helps with identification.

Definition at line 215 of file IPSet.h.

◆ SetDescription() [2/3]

void Aws::WAFV2::Model::IPSet::SetDescription ( const Aws::String value)
inline

A description of the IP set that helps with identification.

Definition at line 210 of file IPSet.h.

◆ SetDescription() [3/3]

void Aws::WAFV2::Model::IPSet::SetDescription ( const char *  value)
inline

A description of the IP set that helps with identification.

Definition at line 220 of file IPSet.h.

◆ SetId() [1/3]

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

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

Definition at line 125 of file IPSet.h.

◆ SetId() [2/3]

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

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

Definition at line 118 of file IPSet.h.

◆ SetId() [3/3]

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

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

Definition at line 132 of file IPSet.h.

◆ SetIPAddressVersion() [1/2]

void Aws::WAFV2::Model::IPSet::SetIPAddressVersion ( const IPAddressVersion value)
inline

Specify IPV4 or IPV6.

Definition at line 251 of file IPSet.h.

◆ SetIPAddressVersion() [2/2]

void Aws::WAFV2::Model::IPSet::SetIPAddressVersion ( IPAddressVersion &&  value)
inline

Specify IPV4 or IPV6.

Definition at line 256 of file IPSet.h.

◆ SetName() [1/3]

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

The name of the IP set. You cannot change the name of an IPSet after you create it.

Definition at line 72 of file IPSet.h.

◆ SetName() [2/3]

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

The name of the IP set. You cannot change the name of an IPSet after you create it.

Definition at line 66 of file IPSet.h.

◆ SetName() [3/3]

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

The name of the IP set. You cannot change the name of an IPSet after you create it.

Definition at line 78 of file IPSet.h.

◆ WithAddresses() [1/2]

IPSet& Aws::WAFV2::Model::IPSet::WithAddresses ( Aws::Vector< Aws::String > &&  value)
inline

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Examples:

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Definition at line 399 of file IPSet.h.

◆ WithAddresses() [2/2]

IPSet& Aws::WAFV2::Model::IPSet::WithAddresses ( const Aws::Vector< Aws::String > &  value)
inline

Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Examples:

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Definition at line 377 of file IPSet.h.

◆ WithARN() [1/3]

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

The Amazon Resource Name (ARN) of the entity.

Definition at line 189 of file IPSet.h.

◆ WithARN() [2/3]

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

The Amazon Resource Name (ARN) of the entity.

Definition at line 184 of file IPSet.h.

◆ WithARN() [3/3]

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

The Amazon Resource Name (ARN) of the entity.

Definition at line 194 of file IPSet.h.

◆ WithDescription() [1/3]

IPSet& Aws::WAFV2::Model::IPSet::WithDescription ( Aws::String &&  value)
inline

A description of the IP set that helps with identification.

Definition at line 230 of file IPSet.h.

◆ WithDescription() [2/3]

IPSet& Aws::WAFV2::Model::IPSet::WithDescription ( const Aws::String value)
inline

A description of the IP set that helps with identification.

Definition at line 225 of file IPSet.h.

◆ WithDescription() [3/3]

IPSet& Aws::WAFV2::Model::IPSet::WithDescription ( const char *  value)
inline

A description of the IP set that helps with identification.

Definition at line 235 of file IPSet.h.

◆ WithId() [1/3]

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

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

Definition at line 146 of file IPSet.h.

◆ WithId() [2/3]

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

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

Definition at line 139 of file IPSet.h.

◆ WithId() [3/3]

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

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

Definition at line 153 of file IPSet.h.

◆ WithIPAddressVersion() [1/2]

IPSet& Aws::WAFV2::Model::IPSet::WithIPAddressVersion ( const IPAddressVersion value)
inline

Specify IPV4 or IPV6.

Definition at line 261 of file IPSet.h.

◆ WithIPAddressVersion() [2/2]

IPSet& Aws::WAFV2::Model::IPSet::WithIPAddressVersion ( IPAddressVersion &&  value)
inline

Specify IPV4 or IPV6.

Definition at line 266 of file IPSet.h.

◆ WithName() [1/3]

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

The name of the IP set. You cannot change the name of an IPSet after you create it.

Definition at line 90 of file IPSet.h.

◆ WithName() [2/3]

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

The name of the IP set. You cannot change the name of an IPSet after you create it.

Definition at line 84 of file IPSet.h.

◆ WithName() [3/3]

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

The name of the IP set. You cannot change the name of an IPSet after you create it.

Definition at line 96 of file IPSet.h.


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