Class: Aws::WAFV2::Types::UpdateIPSetRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::WAFV2::Types::UpdateIPSetRequest
- Defined in:
- gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb
Overview
When making an API call, you may pass UpdateIPSetRequest data as a hash:
{
name: "EntityName", # required
scope: "CLOUDFRONT", # required, accepts CLOUDFRONT, REGIONAL
id: "EntityId", # required
description: "EntityDescription",
addresses: ["IPAddress"], # required
lock_token: "LockToken", # required
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#addresses ⇒ Array<String>
Contains an array of strings that specifies zero 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.
-
#id ⇒ String
A unique identifier for the set.
-
#lock_token ⇒ String
A token used for optimistic locking.
-
#name ⇒ String
The name of the IP set.
-
#scope ⇒ String
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
Instance Attribute Details
#addresses ⇒ Array<String>
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in 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
14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 14493 class UpdateIPSetRequest < Struct.new( :name, :scope, :id, :description, :addresses, :lock_token) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description of the IP set that helps with identification.
14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 14493 class UpdateIPSetRequest < Struct.new( :name, :scope, :id, :description, :addresses, :lock_token) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
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.
14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 14493 class UpdateIPSetRequest < Struct.new( :name, :scope, :id, :description, :addresses, :lock_token) SENSITIVE = [] include Aws::Structure end |
#lock_token ⇒ String
A token used for optimistic locking. WAF returns a token to your
get
and list
requests, to mark the state of the entity at the
time of the request. To make changes to the entity associated with
the token, you provide the token to operations like update
and
delete
. WAF uses the token to ensure that no changes have been
made to the entity since you last retrieved it. If a change has been
made, the update fails with a WAFOptimisticLockException
. If this
happens, perform another get
, and use the new token returned by
that operation.
14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 14493 class UpdateIPSetRequest < Struct.new( :name, :scope, :id, :description, :addresses, :lock_token) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the IP set. You cannot change the name of an IPSet
after you create it.
14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 14493 class UpdateIPSetRequest < Struct.new( :name, :scope, :id, :description, :addresses, :lock_token) SENSITIVE = [] include Aws::Structure end |
#scope ⇒ String
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, or an Amazon Cognito user pool.
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.
14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 14493 class UpdateIPSetRequest < Struct.new( :name, :scope, :id, :description, :addresses, :lock_token) SENSITIVE = [] include Aws::Structure end |