Class CfnIPSetProps

Properties for defining a CfnIPSet.

Inheritance

object

CfnIPSetProps

Implements

ICfnIPSetProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.WAFv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnIPSetProps : ICfnIPSetProps

Syntax (vb)

Public Class CfnIPSetProps Implements ICfnIPSetProps

Remarks

See: 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;

             var cfnIPSetProps = 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

CfnIPSetProps()

Properties for defining a CfnIPSet.

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

Constructors

CfnIPSetProps()

Properties for defining a CfnIPSet.

public CfnIPSetProps()

Remarks

See: 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;

             var cfnIPSetProps = 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"
                 } }
             };

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 string[] Addresses { get; set; }

Property Value

string[]

Remarks

All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. 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:

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

Description

A description of the IP set that helps with identification.

public string? Description { get; set; }

Property Value

string

Remarks

See: 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 string IpAddressVersion { get; set; }

Property Value

string

Remarks

See: 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 string? Name { get; set; }

Property Value

string

Remarks

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

See: 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 string Scope { get; set; }

Property Value

string

Remarks

A regional application can be an Application Load Balancer (ALB), an REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. Valid Values are CLOUDFRONT and REGIONAL .

For <code>CLOUDFRONT</code> , you must create your WAFv2 resources in the US East (N. Virginia) Region, <code>us-east-1</code> .

See: 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 ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

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.

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

Implements

ICfnIPSetProps