You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WAFV2::Types::CreateIPSetRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateIPSetRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "EntityName", # required
  scope: "CLOUDFRONT", # required, accepts CLOUDFRONT, REGIONAL
  description: "EntityDescription",
  ip_address_version: "IPV4", # required, accepts IPV4, IPV6
  addresses: ["IPAddress"], # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#addresses ⇒ Array<String>

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.

Returns:

  • (Array<String>) —

    Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.

#description ⇒ String

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

Returns:

  • (String) —

    A description of the IP set that helps with identification.

#ip_address_version ⇒ String

Specify IPV4 or IPV6.

Possible values:

  • IPV4
  • IPV6

Returns:

  • (String) —

    Specify IPV4 or IPV6.

#name ⇒ String

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

Returns:

  • (String) —

    The name of the IP set.

#scope ⇒ String

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.

    Possible values:

    • CLOUDFRONT
    • REGIONAL

Returns:

  • (String) —

    Specifies whether this is for an AWS CloudFront distribution or for a regional application.

#tags ⇒ Array<Types::Tag>

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

Returns:

  • (Array<Types::Tag>) —

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