@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:42.676Z") @Stability(value=Stable) public class CfnIPSet extends CfnResource implements IInspectable
This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Use an IPSet 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 IP set that lists those IP addresses.
You use an IP set by providing its Amazon Resource Name (ARN) to the rule statement IPSetReferenceStatement , when you add a rule to a rule group or web ACL.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.wafv2.*;
CfnIPSet cfnIPSet = CfnIPSet.Builder.create(this, "MyCfnIPSet")
.addresses(List.of("addresses"))
.ipAddressVersion("ipAddressVersion")
.scope("scope")
// the properties below are optional
.description("description")
.name("name")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnIPSet.Builder
A fluent builder for
CfnIPSet. |
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnIPSet(software.constructs.Construct scope,
String id,
CfnIPSetProps props)
Create a new `AWS::WAFv2::IPSet`.
|
protected |
CfnIPSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnIPSet(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
List<String> |
getAddresses()
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
|
String |
getAttrArn()
The Amazon Resource Name (ARN) of the IP set.
|
String |
getAttrId()
The ID of the IP set.
|
protected Map<String,Object> |
getCfnProperties() |
String |
getDescription()
A description of the IP set that helps with identification.
|
String |
getIpAddressVersion()
The version of the IP addresses, either `IPV4` or `IPV6` .
|
String |
getName()
The name of the IP set.
|
String |
getScope()
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
|
TagManager |
getTags()
Key:value pairs associated with an AWS resource.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setAddresses(List<String> value)
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
|
void |
setDescription(String value)
A description of the IP set that helps with identification.
|
void |
setIpAddressVersion(String value)
The version of the IP addresses, either `IPV4` or `IPV6` .
|
void |
setName(String value)
The name of the IP set.
|
void |
setScope(String value)
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnIPSet(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnIPSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnIPSet(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnIPSetProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties. This parameter is required.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrArn()
@Stability(value=Stable) @NotNull public String getAttrId()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.
@Stability(value=Stable) @NotNull public List<String> getAddresses()
AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
192.0.2.44/32 .192.0.2.0/24 .1111:0000:0000:0000:0000:0000:0000:0111/128 .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:
"Addresses": []"Addresses": ["192.0.2.44/32"]"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]"Addresses": [""] INVALID@Stability(value=Stable)
public void setAddresses(@NotNull
List<String> value)
AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
192.0.2.44/32 .192.0.2.0/24 .1111:0000:0000:0000:0000:0000:0000:0111/128 .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:
"Addresses": []"Addresses": ["192.0.2.44/32"]"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]"Addresses": [""] INVALID@Stability(value=Stable) @NotNull public String getIpAddressVersion()
@Stability(value=Stable)
public void setIpAddressVersion(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getScope()
A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API. Valid Values are CLOUDFRONT and REGIONAL .
For
CLOUDFRONT, you must create your WAFv2 resources in the US East (N. Virginia) Region,us-east-1.
@Stability(value=Stable)
public void setScope(@NotNull
String value)
A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API. Valid Values are CLOUDFRONT and REGIONAL .
For
CLOUDFRONT, you must create your WAFv2 resources in the US East (N. Virginia) Region,us-east-1.
@Stability(value=Stable) @Nullable public String getDescription()
@Stability(value=Stable)
public void setDescription(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getName()
You cannot change the name of an IPSet after you create it.
@Stability(value=Stable)
public void setName(@Nullable
String value)
You cannot change the name of an IPSet after you create it.
Copyright © 2022. All rights reserved.