Class CfnIPSet

This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnIPSet
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnIPSet : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnIPSet
    Inherits CfnResource
    Implements IInspectable, ITaggable
Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html

CloudformationResource: AWS::WAFv2::IPSet

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WAFv2;

var cfnIPSet = new CfnIPSet(this, "MyCfnIPSet", new CfnIPSetProps {
    Addresses = new [] { "addresses" },
    IpAddressVersion = "ipAddressVersion",
    Scope = "scope",

    // the properties below are optional
    Description = "description",
    Name = "name",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnIPSet(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnIPSet(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnIPSet(Construct, String, ICfnIPSetProps)

Properties

Addresses

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.
AttrArn

The Amazon Resource Name (ARN) of the IP set.
AttrId

The ID of the IP set.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
Description

A description of the IP set that helps with identification.
IpAddressVersion

The version of the IP addresses, either IPV4 or IPV6 .
Name

The name of the IP set.
Scope

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

Tag Manager which manages the tags for this resource.
TagsRaw

Key:value pairs associated with an AWS resource.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnIPSet(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnIPSet(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnIPSet(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnIPSet(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnIPSet(Construct, String, ICfnIPSetProps)

public CfnIPSet(Construct scope, string id, ICfnIPSetProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnIPSetProps

Resource properties.

Properties

Addresses

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.

public virtual string[] Addresses { get; set; }
Property Value

System.String[]

AttrArn

The Amazon Resource Name (ARN) of the IP set.

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrId

The ID of the IP set.

public virtual string AttrId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Description

A description of the IP set that helps with identification.

public virtual string Description { get; set; }
Property Value

System.String

IpAddressVersion

The version of the IP addresses, either IPV4 or IPV6 .

public virtual string IpAddressVersion { get; set; }
Property Value

System.String

Name

The name of the IP set.

public virtual string Name { get; set; }
Property Value

System.String

Scope

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

public virtual string Scope { get; set; }
Property Value

System.String

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

Key:value pairs associated with an AWS resource.

public virtual ICfnTag[] TagsRaw { get; set; }
Property Value

ICfnTag[]

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements