Class CfnWebACL

This is AWS WAF Classic documentation.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnWebACL
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.WAF
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnWebACL : CfnResource, IInspectable, IWebACLRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class CfnWebACL Inherits CfnResource Implements IInspectable, IWebACLRef, IConstruct, IDependable, IEnvironmentAware
Remarks

For more information, see AWS WAF Classic in the developer guide.

<em>For the latest version of AWS WAF</em> , use the AWS WAF V2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a> . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL , you also specify a default action ( ALLOW or BLOCK ), and the action for each Rule that you add to a WebACL , for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a Amazon CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL , a request needs to match only one of the specifications to be allowed, blocked, or counted.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html

CloudformationResource: AWS::WAF::WebACL

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

             var cfnWebACL = new CfnWebACL(this, "MyCfnWebACL", new CfnWebACLProps {
                 DefaultAction = new WafActionProperty {
                     Type = "type"
                 },
                 MetricName = "metricName",
                 Name = "name",

                 // the properties below are optional
                 Rules = new [] { new ActivatedRuleProperty {
                     Priority = 123,
                     RuleId = "ruleId",

                     // the properties below are optional
                     Action = new WafActionProperty {
                         Type = "type"
                     }
                 } }
             });

Synopsis

Constructors

CfnWebACL(Construct, string, ICfnWebACLProps)

Create a new AWS::WAF::WebACL.

Properties

AttrId

This is AWS WAF Classic documentation.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

This is AWS WAF Classic documentation.
DefaultAction

The action to perform if none of the Rules contained in the WebACL match.
MetricName

The name of the metrics for this WebACL .
Name

A friendly name or description of the WebACL .
Rules

An array that contains the action for each Rule in a WebACL , the priority of the Rule , and the ID of the Rule .
WebAclRef

A reference to a WebACL resource.

Methods

ArnForWebACL(IWebACLRef)

This is AWS WAF Classic documentation.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnWebACL(object)

Checks whether the given object is a CfnWebACL.
RenderProperties(IDictionary<string, object>)

This is AWS WAF Classic documentation.

Constructors

CfnWebACL(Construct, string, ICfnWebACLProps)

Create a new AWS::WAF::WebACL.

public CfnWebACL(Construct scope, string id, ICfnWebACLProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

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

props ICfnWebACLProps

Resource properties.

Remarks

For more information, see AWS WAF Classic in the developer guide.

<em>For the latest version of AWS WAF</em> , use the AWS WAF V2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a> . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL , you also specify a default action ( ALLOW or BLOCK ), and the action for each Rule that you add to a WebACL , for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a Amazon CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL , a request needs to match only one of the specifications to be allowed, blocked, or counted.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html

CloudformationResource: AWS::WAF::WebACL

ExampleMetadata: fixture=_generated

Properties

AttrId

This is AWS WAF Classic documentation.

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 more information, see AWS WAF Classic in the developer guide.

<em>For the latest version of AWS WAF</em> , use the AWS WAF V2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a> . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL , you also specify a default action ( ALLOW or BLOCK ), and the action for each Rule that you add to a WebACL , for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a Amazon CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL , a request needs to match only one of the specifications to be allowed, blocked, or counted.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html

CloudformationResource: AWS::WAF::WebACL

ExampleMetadata: fixture=_generated

CfnProperties

This is AWS WAF Classic documentation.

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

IDictionary<string, object>

Overrides
Remarks

For more information, see AWS WAF Classic in the developer guide.

<em>For the latest version of AWS WAF</em> , use the AWS WAF V2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a> . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL , you also specify a default action ( ALLOW or BLOCK ), and the action for each Rule that you add to a WebACL , for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a Amazon CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL , a request needs to match only one of the specifications to be allowed, blocked, or counted.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html

CloudformationResource: AWS::WAF::WebACL

ExampleMetadata: fixture=_generated

DefaultAction

The action to perform if none of the Rules contained in the WebACL match.

public virtual object DefaultAction { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnWebACL.IWafActionProperty

MetricName

The name of the metrics for this WebACL .

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

string

Remarks

For more information, see AWS WAF Classic in the developer guide.

<em>For the latest version of AWS WAF</em> , use the AWS WAF V2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a> . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL , you also specify a default action ( ALLOW or BLOCK ), and the action for each Rule that you add to a WebACL , for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a Amazon CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL , a request needs to match only one of the specifications to be allowed, blocked, or counted.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html

CloudformationResource: AWS::WAF::WebACL

ExampleMetadata: fixture=_generated

Name

A friendly name or description of the WebACL .

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

string

Remarks

For more information, see AWS WAF Classic in the developer guide.

<em>For the latest version of AWS WAF</em> , use the AWS WAF V2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a> . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL , you also specify a default action ( ALLOW or BLOCK ), and the action for each Rule that you add to a WebACL , for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a Amazon CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL , a request needs to match only one of the specifications to be allowed, blocked, or counted.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html

CloudformationResource: AWS::WAF::WebACL

ExampleMetadata: fixture=_generated

Rules

An array that contains the action for each Rule in a WebACL , the priority of the Rule , and the ID of the Rule .

public virtual object? Rules { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnWebACL.IActivatedRuleProperty)[]

WebAclRef

A reference to a WebACL resource.

public virtual IWebACLReference WebAclRef { get; }
Property Value

IWebACLReference

Remarks

For more information, see AWS WAF Classic in the developer guide.

<em>For the latest version of AWS WAF</em> , use the AWS WAF V2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a> . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL , you also specify a default action ( ALLOW or BLOCK ), and the action for each Rule that you add to a WebACL , for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a Amazon CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL , a request needs to match only one of the specifications to be allowed, blocked, or counted.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html

CloudformationResource: AWS::WAF::WebACL

ExampleMetadata: fixture=_generated

Methods

ArnForWebACL(IWebACLRef)

This is AWS WAF Classic documentation.

public static string ArnForWebACL(IWebACLRef resource)
Parameters
resource IWebACLRef
Returns

string

Remarks

For more information, see AWS WAF Classic in the developer guide.

<em>For the latest version of AWS WAF</em> , use the AWS WAF V2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a> . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL , you also specify a default action ( ALLOW or BLOCK ), and the action for each Rule that you add to a WebACL , for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a Amazon CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL , a request needs to match only one of the specifications to be allowed, blocked, or counted.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html

CloudformationResource: AWS::WAF::WebACL

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

             var cfnWebACL = new CfnWebACL(this, "MyCfnWebACL", new CfnWebACLProps {
                 DefaultAction = new WafActionProperty {
                     Type = "type"
                 },
                 MetricName = "metricName",
                 Name = "name",

                 // the properties below are optional
                 Rules = new [] { new ActivatedRuleProperty {
                     Priority = 123,
                     RuleId = "ruleId",

                     // the properties below are optional
                     Action = new WafActionProperty {
                         Type = "type"
                     }
                 } }
             });

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 more information, see AWS WAF Classic in the developer guide.

<em>For the latest version of AWS WAF</em> , use the AWS WAF V2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a> . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL , you also specify a default action ( ALLOW or BLOCK ), and the action for each Rule that you add to a WebACL , for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a Amazon CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL , a request needs to match only one of the specifications to be allowed, blocked, or counted.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html

CloudformationResource: AWS::WAF::WebACL

ExampleMetadata: fixture=_generated

IsCfnWebACL(object)

Checks whether the given object is a CfnWebACL.

public static bool IsCfnWebACL(object x)
Parameters
x object
Returns

bool

Remarks

For more information, see AWS WAF Classic in the developer guide.

<em>For the latest version of AWS WAF</em> , use the AWS WAF V2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a> . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL , you also specify a default action ( ALLOW or BLOCK ), and the action for each Rule that you add to a WebACL , for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a Amazon CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL , a request needs to match only one of the specifications to be allowed, blocked, or counted.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html

CloudformationResource: AWS::WAF::WebACL

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

This is AWS WAF Classic documentation.

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

IDictionary<string, object>

Overrides
Remarks

For more information, see AWS WAF Classic in the developer guide.

<em>For the latest version of AWS WAF</em> , use the AWS WAF V2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a> . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL , you also specify a default action ( ALLOW or BLOCK ), and the action for each Rule that you add to a WebACL , for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a Amazon CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL , a request needs to match only one of the specifications to be allowed, blocked, or counted.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-waf-webacl.html

CloudformationResource: AWS::WAF::WebACL

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable