Class CfnIPSet

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnIPSet

Implements

IInspectable

IIPSetRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.WAFv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnIPSet : CfnResource, IInspectable, IIPSetRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnIPSet Inherits CfnResource Implements IInspectable, IIPSetRef, IConstruct, IDependable, IEnvironmentAware, 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(Construct, string, ICfnIPSetProps)

Create a new AWS::WAFv2::IPSet.

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	This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019.
Description	A description of the IP set that helps with identification.
IpAddressVersion	The version of the IP addresses, either `IPV4` or `IPV6` .
IpSetRef	A reference to a IPSet resource.
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

ArnForIPSet(IIPSetRef)	This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnIPSet(object)	Checks whether the given object is a CfnIPSet.
RenderProperties(IDictionary<string, object>)	This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019.

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 string: Construct identifier for this resource (unique in its scope).
props ICfnIPSetProps: Resource properties.

Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

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

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

string[]

Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

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

AttrArn

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

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrId

The ID of the IP set.

public virtual string AttrId { get; }

Property Value

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

string

Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

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

CfnProperties

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

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

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

Description

A description of the IP set that helps with identification.

public virtual string? Description { get; set; }

Property Value

string

Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

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

IpAddressVersion

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

public virtual string IpAddressVersion { get; set; }

Property Value

string

Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

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

IpSetRef

A reference to a IPSet resource.

public virtual IIPSetReference IpSetRef { get; }

Property Value

IIPSetReference

Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

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

Name

The name of the IP set.

public virtual string? Name { get; set; }

Property Value

string

Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

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

Scope

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

public virtual string Scope { get; set; }

Property Value

string

Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

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

TagsRaw

Key:value pairs associated with an AWS resource.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

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

Methods

ArnForIPSet(IIPSetRef)

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

public static string ArnForIPSet(IIPSetRef resource)

Parameters

resource IIPSetRef

Returns

string

Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

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"
                 } }
             });

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.

Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

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

IsCfnIPSet(object)

Checks whether the given object is a CfnIPSet.

public static bool IsCfnIPSet(object x)

Parameters

x object

Returns

bool

Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

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

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

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

Implements

IInspectable

IIPSetRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable