Class CfnIPSet
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.wafv2.CfnIPSet
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-22T02:24:10.718Z")
@Stability(Stable)
public class CfnIPSet
extends CfnResource
implements IInspectable, ITaggable
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();
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnIPSet
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnIPSet
(software.amazon.jsii.JsiiObjectRef objRef) CfnIPSet
(software.constructs.Construct scope, String id, CfnIPSetProps props) -
Method Summary
Modifier and TypeMethodDescriptionContains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want AWS WAF to inspect for in incoming requests.The Amazon Resource Name (ARN) of the IP set.The ID of the IP set.A description of the IP set that helps with identification.The version of the IP addresses, eitherIPV4
orIPV6
.getName()
The name of the IP set.getScope()
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.getTags()
Tag Manager which manages the tags for this resource.Key:value pairs associated with an AWS resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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 that you want AWS WAF to inspect for in incoming requests.void
setDescription
(String value) A description of the IP set that helps with identification.void
setIpAddressVersion
(String value) The version of the IP addresses, eitherIPV4
orIPV6
.void
The name of the IP set.void
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.void
setTagsRaw
(List<CfnTag> value) Key:value pairs associated with an AWS resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnIPSet
protected CfnIPSet(software.amazon.jsii.JsiiObjectRef objRef) -
CfnIPSet
protected CfnIPSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnIPSet
@Stability(Stable) public CfnIPSet(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIPSetProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the IP set. -
getAttrId
The ID of the IP set. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getAddresses
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want AWS WAF to inspect for in incoming requests. -
setAddresses
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want AWS WAF to inspect for in incoming requests. -
getIpAddressVersion
The version of the IP addresses, eitherIPV4
orIPV6
. -
setIpAddressVersion
The version of the IP addresses, eitherIPV4
orIPV6
. -
getScope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. -
setScope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. -
getDescription
A description of the IP set that helps with identification. -
setDescription
A description of the IP set that helps with identification. -
getName
The name of the IP set. -
setName
The name of the IP set. -
getTagsRaw
Key:value pairs associated with an AWS resource. -
setTagsRaw
Key:value pairs associated with an AWS resource.
-