Class CfnByteMatchSet.FieldToMatchProperty

AWS WAF Classic support will end on September 30, 2025.

Inheritance
object
CfnByteMatchSet.FieldToMatchProperty
Inherited Members
Namespace: Amazon.CDK.AWS.WAF
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnByteMatchSet.FieldToMatchProperty : CfnByteMatchSet.IFieldToMatchProperty
Syntax (vb)
Public Class CfnByteMatchSet.FieldToMatchProperty Implements CfnByteMatchSet.IFieldToMatchProperty
Remarks
This is <em>AWS WAF Classic</em> documentation. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS WAF Classic</a> in the developer guide.

For the latest version of AWS WAF , use the AWS WAF V2 API and see the AWS WAF Developer Guide . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies where in a web request to look for TargetString .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-fieldtomatch.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.WAF;

             var fieldToMatchProperty = new FieldToMatchProperty {
                 Type = "type",

                 // the properties below are optional
                 Data = "data"
             };

Synopsis

Constructors

FieldToMatchProperty()

AWS WAF Classic support will end on September 30, 2025.

Properties

Data

When the value of Type is HEADER , enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer .
Type

The part of the web request that you want AWS WAF to search for a specified string.

Constructors

FieldToMatchProperty()

AWS WAF Classic support will end on September 30, 2025.

public FieldToMatchProperty()
Remarks
This is <em>AWS WAF Classic</em> documentation. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS WAF Classic</a> in the developer guide.

For the latest version of AWS WAF , use the AWS WAF V2 API and see the AWS WAF Developer Guide . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies where in a web request to look for TargetString .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-fieldtomatch.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.WAF;

             var fieldToMatchProperty = new FieldToMatchProperty {
                 Type = "type",

                 // the properties below are optional
                 Data = "data"
             };

Properties

Data

When the value of Type is HEADER , enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer .

public string? Data { get; set; }
Property Value

string

Remarks

The name of the header is not case sensitive.

When the value of Type is SINGLE_QUERY_ARG , enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion . The parameter name is not case sensitive.

If the value of Type is any other value, omit Data .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-fieldtomatch.html#cfn-waf-bytematchset-fieldtomatch-data

Type

The part of the web request that you want AWS WAF to search for a specified string.

public string Type { get; set; }
Property Value

string

Remarks

Parts of a request that you can search include the following:

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-waf-bytematchset-fieldtomatch.html#cfn-waf-bytematchset-fieldtomatch-type

    Implements