/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace WAFV2 { namespace Model { /** *

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

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

*/ class IPSet { public: AWS_WAFV2_API IPSet(); AWS_WAFV2_API IPSet(Aws::Utils::Json::JsonView jsonValue); AWS_WAFV2_API IPSet& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_WAFV2_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

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

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

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

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

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

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

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

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

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

*/ inline IPSet& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

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

*/ inline IPSet& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

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

*/ inline IPSet& WithName(const char* value) { SetName(value); return *this;} /** *

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.

*/ inline const Aws::String& GetId() const{ return m_id; } /** *

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.

*/ inline bool IdHasBeenSet() const { return m_idHasBeenSet; } /** *

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.

*/ inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; } /** *

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.

*/ inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); } /** *

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.

*/ inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); } /** *

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.

*/ inline IPSet& WithId(const Aws::String& value) { SetId(value); return *this;} /** *

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.

*/ inline IPSet& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} /** *

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.

*/ inline IPSet& WithId(const char* value) { SetId(value); return *this;} /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline const Aws::String& GetARN() const{ return m_aRN; } /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline bool ARNHasBeenSet() const { return m_aRNHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline void SetARN(const Aws::String& value) { m_aRNHasBeenSet = true; m_aRN = value; } /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline void SetARN(Aws::String&& value) { m_aRNHasBeenSet = true; m_aRN = std::move(value); } /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline void SetARN(const char* value) { m_aRNHasBeenSet = true; m_aRN.assign(value); } /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline IPSet& WithARN(const Aws::String& value) { SetARN(value); return *this;} /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline IPSet& WithARN(Aws::String&& value) { SetARN(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline IPSet& WithARN(const char* value) { SetARN(value); return *this;} /** *

A description of the IP set that helps with identification.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

A description of the IP set that helps with identification.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

A description of the IP set that helps with identification.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

A description of the IP set that helps with identification.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

A description of the IP set that helps with identification.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

A description of the IP set that helps with identification.

*/ inline IPSet& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

A description of the IP set that helps with identification.

*/ inline IPSet& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

A description of the IP set that helps with identification.

*/ inline IPSet& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

The version of the IP addresses, either IPV4 or * IPV6.

*/ inline const IPAddressVersion& GetIPAddressVersion() const{ return m_iPAddressVersion; } /** *

The version of the IP addresses, either IPV4 or * IPV6.

*/ inline bool IPAddressVersionHasBeenSet() const { return m_iPAddressVersionHasBeenSet; } /** *

The version of the IP addresses, either IPV4 or * IPV6.

*/ inline void SetIPAddressVersion(const IPAddressVersion& value) { m_iPAddressVersionHasBeenSet = true; m_iPAddressVersion = value; } /** *

The version of the IP addresses, either IPV4 or * IPV6.

*/ inline void SetIPAddressVersion(IPAddressVersion&& value) { m_iPAddressVersionHasBeenSet = true; m_iPAddressVersion = std::move(value); } /** *

The version of the IP addresses, either IPV4 or * IPV6.

*/ inline IPSet& WithIPAddressVersion(const IPAddressVersion& value) { SetIPAddressVersion(value); return *this;} /** *

The version of the IP addresses, either IPV4 or * IPV6.

*/ inline IPSet& WithIPAddressVersion(IPAddressVersion&& value) { SetIPAddressVersion(std::move(value)); return *this;} /** *

Contains an array of strings that specifies zero or more IP addresses or * blocks of IP addresses. All addresses must be specified using Classless * Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges * except for /0.

Example address strings:

  • *

    To configure 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 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 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 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.

Example JSON Addresses * specifications:

  • Empty array: "Addresses": []

    *
  • Array with one address: "Addresses": * ["192.0.2.44/32"]

  • Array with three addresses: * "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]

    *
  • INVALID specification: "Addresses": [""] INVALID

    *
*/ inline const Aws::Vector& GetAddresses() const{ return m_addresses; } /** *

Contains an array of strings that specifies zero or more IP addresses or * blocks of IP addresses. All addresses must be specified using Classless * Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges * except for /0.

Example address strings:

  • *

    To configure 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 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 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 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.

Example JSON Addresses * specifications:

  • Empty array: "Addresses": []

    *
  • Array with one address: "Addresses": * ["192.0.2.44/32"]

  • Array with three addresses: * "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]

    *
  • INVALID specification: "Addresses": [""] INVALID

    *
*/ inline bool AddressesHasBeenSet() const { return m_addressesHasBeenSet; } /** *

Contains an array of strings that specifies zero or more IP addresses or * blocks of IP addresses. All addresses must be specified using Classless * Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges * except for /0.

Example address strings:

  • *

    To configure 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 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 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 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.

Example JSON Addresses * specifications:

  • Empty array: "Addresses": []

    *
  • Array with one address: "Addresses": * ["192.0.2.44/32"]

  • Array with three addresses: * "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]

    *
  • INVALID specification: "Addresses": [""] INVALID

    *
*/ inline void SetAddresses(const Aws::Vector& value) { m_addressesHasBeenSet = true; m_addresses = value; } /** *

Contains an array of strings that specifies zero or more IP addresses or * blocks of IP addresses. All addresses must be specified using Classless * Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges * except for /0.

Example address strings:

  • *

    To configure 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 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 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 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.

Example JSON Addresses * specifications:

  • Empty array: "Addresses": []

    *
  • Array with one address: "Addresses": * ["192.0.2.44/32"]

  • Array with three addresses: * "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]

    *
  • INVALID specification: "Addresses": [""] INVALID

    *
*/ inline void SetAddresses(Aws::Vector&& value) { m_addressesHasBeenSet = true; m_addresses = std::move(value); } /** *

Contains an array of strings that specifies zero or more IP addresses or * blocks of IP addresses. All addresses must be specified using Classless * Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges * except for /0.

Example address strings:

  • *

    To configure 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 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 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 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.

Example JSON Addresses * specifications:

  • Empty array: "Addresses": []

    *
  • Array with one address: "Addresses": * ["192.0.2.44/32"]

  • Array with three addresses: * "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]

    *
  • INVALID specification: "Addresses": [""] INVALID

    *
*/ inline IPSet& WithAddresses(const Aws::Vector& value) { SetAddresses(value); return *this;} /** *

Contains an array of strings that specifies zero or more IP addresses or * blocks of IP addresses. All addresses must be specified using Classless * Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges * except for /0.

Example address strings:

  • *

    To configure 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 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 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 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.

Example JSON Addresses * specifications:

  • Empty array: "Addresses": []

    *
  • Array with one address: "Addresses": * ["192.0.2.44/32"]

  • Array with three addresses: * "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]

    *
  • INVALID specification: "Addresses": [""] INVALID

    *
*/ inline IPSet& WithAddresses(Aws::Vector&& value) { SetAddresses(std::move(value)); return *this;} /** *

Contains an array of strings that specifies zero or more IP addresses or * blocks of IP addresses. All addresses must be specified using Classless * Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges * except for /0.

Example address strings:

  • *

    To configure 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 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 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 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.

Example JSON Addresses * specifications:

  • Empty array: "Addresses": []

    *
  • Array with one address: "Addresses": * ["192.0.2.44/32"]

  • Array with three addresses: * "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]

    *
  • INVALID specification: "Addresses": [""] INVALID

    *
*/ inline IPSet& AddAddresses(const Aws::String& value) { m_addressesHasBeenSet = true; m_addresses.push_back(value); return *this; } /** *

Contains an array of strings that specifies zero or more IP addresses or * blocks of IP addresses. All addresses must be specified using Classless * Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges * except for /0.

Example address strings:

  • *

    To configure 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 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 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 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.

Example JSON Addresses * specifications:

  • Empty array: "Addresses": []

    *
  • Array with one address: "Addresses": * ["192.0.2.44/32"]

  • Array with three addresses: * "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]

    *
  • INVALID specification: "Addresses": [""] INVALID

    *
*/ inline IPSet& AddAddresses(Aws::String&& value) { m_addressesHasBeenSet = true; m_addresses.push_back(std::move(value)); return *this; } /** *

Contains an array of strings that specifies zero or more IP addresses or * blocks of IP addresses. All addresses must be specified using Classless * Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges * except for /0.

Example address strings:

  • *

    To configure 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 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 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 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.

Example JSON Addresses * specifications:

  • Empty array: "Addresses": []

    *
  • Array with one address: "Addresses": * ["192.0.2.44/32"]

  • Array with three addresses: * "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]

    *
  • INVALID specification: "Addresses": [""] INVALID

    *
*/ inline IPSet& AddAddresses(const char* value) { m_addressesHasBeenSet = true; m_addresses.push_back(value); return *this; } private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_id; bool m_idHasBeenSet = false; Aws::String m_aRN; bool m_aRNHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; IPAddressVersion m_iPAddressVersion; bool m_iPAddressVersionHasBeenSet = false; Aws::Vector m_addresses; bool m_addressesHasBeenSet = false; }; } // namespace Model } // namespace WAFV2 } // namespace Aws