Interface ICfnIPSetProps
Properties for defining a CfnIPSet
.
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.AWS.WAFv2.dll
Syntax (csharp)
public interface ICfnIPSetProps
Syntax (vb)
Public Interface ICfnIPSetProps
Remarks
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;
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
Properties
Addresses | Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. |
Description | A description of the IP set that helps with identification. |
IpAddressVersion | The version of the IP addresses, either |
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. |
Properties
Addresses
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses.
string[] Addresses { get; }
Property Value
System.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:
Description
A description of the IP set that helps with identification.
virtual string Description { get; }
Property Value
System.String
Remarks
IpAddressVersion
The version of the IP addresses, either IPV4
or IPV6
.
string IpAddressVersion { get; }
Property Value
System.String
Remarks
Name
The name of the IP set.
virtual string Name { get; }
Property Value
System.String
Remarks
You cannot change the name of an IPSet
after you create it.
Scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
string Scope { get; }
Property Value
System.String
Remarks
A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, or an AWS App Runner service. Valid Values are CLOUDFRONT
and REGIONAL
.
For CLOUDFRONT
, you must create your WAFv2 resources in the US East (N. Virginia) Region, us-east-1
.
Tags
Key:value pairs associated with an AWS resource.
virtual ICfnTag[] Tags { get; }
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.