createIPSet method

Future<CreateIPSetResponse> createIPSet({ required List<String> addresses, required IPAddressVersion iPAddressVersion, required String name, required Scope scope, String? description, List<Tag>? tags, })

Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IPSet that lists those IP addresses.

May throw WAFInternalErrorException. May throw WAFInvalidParameterException. May throw WAFDuplicateItemException. May throw WAFOptimisticLockException. May throw WAFLimitsExceededException. May throw WAFTagOperationException. May throw WAFTagOperationInternalErrorException. May throw WAFInvalidOperationException.

Parameter addresses : 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 address ranges for IP versions IPv4 and IPv6.

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.

Parameter iPAddressVersion : Specify IPV4 or IPV6.

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

Parameter scope : Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an 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.

Parameter description : A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

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

Implementation

Future<CreateIPSetResponse> createIPSet({
  required List<String> addresses,
  required IPAddressVersion iPAddressVersion,
  required String name,
  required Scope scope,
  String? description,
  List<Tag>? tags,
}) async {
  ArgumentError.checkNotNull(addresses, 'addresses');
  ArgumentError.checkNotNull(iPAddressVersion, 'iPAddressVersion');
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    1,
    128,
    isRequired: true,
  );
  ArgumentError.checkNotNull(scope, 'scope');
  _s.validateStringLength(
    'description',
    description,
    1,
    256,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSWAF_20190729.CreateIPSet'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Addresses': addresses,
      'IPAddressVersion': iPAddressVersion.toValue(),
      'Name': name,
      'Scope': scope.toValue(),
      if (description != null) 'Description': description,
      if (tags != null) 'Tags': tags,
    },
  );

  return CreateIPSetResponse.fromJson(jsonResponse.body);
}