Class CfnIPSet

A CloudFormation AWS::WAFv2::IPSet.

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

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.

CloudformationResource: AWS::WAFv2::IPSet

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

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;

CfnIPSet 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(Construct, String, ICfnIPSetProps)

Create a new AWS::WAFv2::IPSet.
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

Properties

Addresses

Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation.
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

Key:value pairs associated with an AWS resource.

Methods

Inspect(TreeInspector)

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

Constructors

CfnIPSet(Construct, String, ICfnIPSetProps)

Create a new AWS::WAFv2::IPSet.

public CfnIPSet(Construct scope, string id, ICfnIPSetProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnIPSetProps
  • resource properties.

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

Properties

Addresses

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

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

System.String[]

Remarks

AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0.

Example address strings:

    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing .

    Example JSON Addresses specifications:

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-addresses

      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

      Remarks

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-description

      IpAddressVersion

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

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

      System.String

      Remarks

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-ipaddressversion

      Name

      The name of the IP set.

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

      System.String

      Remarks

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

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-name

      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

      Remarks

      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 .

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-scope

      Tags

      Key:value pairs associated with an AWS resource.

      public virtual TagManager Tags { get; }
      Property Value

      TagManager

      Remarks

      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.

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-ipset.html#cfn-wafv2-ipset-tags

      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

      Constructs.IConstruct