/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { namespace WAFV2 { namespace Model { /** */ class CreateIPSetRequest : public WAFV2Request { public: AWS_WAFV2_API CreateIPSetRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "CreateIPSet"; } AWS_WAFV2_API Aws::String SerializePayload() const override; AWS_WAFV2_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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 CreateIPSetRequest& 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 CreateIPSetRequest& 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 CreateIPSetRequest& WithName(const char* value) { SetName(value); return *this;} /** *

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, an AppSync GraphQL API, an Amazon Cognito * user pool, an App Runner service, or an Amazon Web Services Verified Access * instance.

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.

*/ inline const Scope& GetScope() const{ return m_scope; } /** *

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, an AppSync GraphQL API, an Amazon Cognito * user pool, an App Runner service, or an Amazon Web Services Verified Access * instance.

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.

*/ inline bool ScopeHasBeenSet() const { return m_scopeHasBeenSet; } /** *

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, an AppSync GraphQL API, an Amazon Cognito * user pool, an App Runner service, or an Amazon Web Services Verified Access * instance.

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.

*/ inline void SetScope(const Scope& value) { m_scopeHasBeenSet = true; m_scope = value; } /** *

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, an AppSync GraphQL API, an Amazon Cognito * user pool, an App Runner service, or an Amazon Web Services Verified Access * instance.

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.

*/ inline void SetScope(Scope&& value) { m_scopeHasBeenSet = true; m_scope = std::move(value); } /** *

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, an AppSync GraphQL API, an Amazon Cognito * user pool, an App Runner service, or an Amazon Web Services Verified Access * instance.

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.

*/ inline CreateIPSetRequest& WithScope(const Scope& value) { SetScope(value); return *this;} /** *

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, an AppSync GraphQL API, an Amazon Cognito * user pool, an App Runner service, or an Amazon Web Services Verified Access * instance.

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.

*/ inline CreateIPSetRequest& WithScope(Scope&& value) { SetScope(std::move(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 CreateIPSetRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

A description of the IP set that helps with identification.

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

A description of the IP set that helps with identification.

*/ inline CreateIPSetRequest& 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 CreateIPSetRequest& WithIPAddressVersion(const IPAddressVersion& value) { SetIPAddressVersion(value); return *this;} /** *

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

*/ inline CreateIPSetRequest& 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 CreateIPSetRequest& 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 CreateIPSetRequest& 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 CreateIPSetRequest& 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 CreateIPSetRequest& 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 CreateIPSetRequest& AddAddresses(const char* value) { m_addressesHasBeenSet = true; m_addresses.push_back(value); return *this; } /** *

An array of key:value pairs to associate with the resource.

*/ inline const Aws::Vector& GetTags() const{ return m_tags; } /** *

An array of key:value pairs to associate with the resource.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

An array of key:value pairs to associate with the resource.

*/ inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

An array of key:value pairs to associate with the resource.

*/ inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

An array of key:value pairs to associate with the resource.

*/ inline CreateIPSetRequest& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} /** *

An array of key:value pairs to associate with the resource.

*/ inline CreateIPSetRequest& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} /** *

An array of key:value pairs to associate with the resource.

*/ inline CreateIPSetRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *

An array of key:value pairs to associate with the resource.

*/ inline CreateIPSetRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } private: Aws::String m_name; bool m_nameHasBeenSet = false; Scope m_scope; bool m_scopeHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; IPAddressVersion m_iPAddressVersion; bool m_iPAddressVersionHasBeenSet = false; Aws::Vector m_addresses; bool m_addressesHasBeenSet = false; Aws::Vector m_tags; bool m_tagsHasBeenSet = false; }; } // namespace Model } // namespace WAFV2 } // namespace Aws