Class CfnByteMatchSet

This is AWS WAF Classic documentation.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnByteMatchSet

Implements

IInspectable

IByteMatchSetRef

IConstruct

IDependable

IEnvironmentAware

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

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnByteMatchSet : CfnResource, IInspectable, IByteMatchSetRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnByteMatchSet Inherits CfnResource Implements IInspectable, IByteMatchSetRef, 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.

The AWS::WAFRegional::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html

CloudformationResource: AWS::WAFRegional::ByteMatchSet

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

             var cfnByteMatchSet = new CfnByteMatchSet(this, "MyCfnByteMatchSet", new CfnByteMatchSetProps {
                 Name = "name",

                 // the properties below are optional
                 ByteMatchTuples = new [] { new ByteMatchTupleProperty {
                     FieldToMatch = new FieldToMatchProperty {
                         Type = "type",

                         // the properties below are optional
                         Data = "data"
                     },
                     PositionalConstraint = "positionalConstraint",
                     TextTransformation = "textTransformation",

                     // the properties below are optional
                     TargetString = "targetString",
                     TargetStringBase64 = "targetStringBase64"
                 } }
             });

Synopsis

Constructors

CfnByteMatchSet(Construct, string, ICfnByteMatchSetProps)

Create a new AWS::WAFRegional::ByteMatchSet.

Properties

AttrId	This is AWS WAF Classic documentation.
ByteMatchSetRef	A reference to a ByteMatchSet resource.
ByteMatchTuples	Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	This is AWS WAF Classic documentation.
Name	A friendly name or description of the ByteMatchSet .

Methods

ArnForByteMatchSet(IByteMatchSetRef)	This is AWS WAF Classic documentation.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnByteMatchSet(object)	Checks whether the given object is a CfnByteMatchSet.
RenderProperties(IDictionary<string, object>)	This is AWS WAF Classic documentation.

Constructors

CfnByteMatchSet(Construct, string, ICfnByteMatchSetProps)

Create a new AWS::WAFRegional::ByteMatchSet.

public CfnByteMatchSet(Construct scope, string id, ICfnByteMatchSetProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnByteMatchSetProps

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.

The AWS::WAFRegional::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html

CloudformationResource: AWS::WAFRegional::ByteMatchSet

ExampleMetadata: fixture=_generated

Properties

AttrId

This is AWS WAF Classic documentation.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

ByteMatchSetRef

A reference to a ByteMatchSet resource.

public virtual IByteMatchSetReference ByteMatchSetRef { get; }

Property Value

IByteMatchSetReference

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.

The AWS::WAFRegional::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html

CloudformationResource: AWS::WAFRegional::ByteMatchSet

ExampleMetadata: fixture=_generated

ByteMatchTuples

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

public virtual object? ByteMatchTuples { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnByteMatchSet.IByteMatchTupleProperty)[]

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.

The AWS::WAFRegional::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html

CloudformationResource: AWS::WAFRegional::ByteMatchSet

ExampleMetadata: fixture=_generated

CfnProperties

This is AWS WAF Classic documentation.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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.

The AWS::WAFRegional::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html

CloudformationResource: AWS::WAFRegional::ByteMatchSet

ExampleMetadata: fixture=_generated

Name

A friendly name or description of the ByteMatchSet .

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.

The AWS::WAFRegional::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html

CloudformationResource: AWS::WAFRegional::ByteMatchSet

ExampleMetadata: fixture=_generated

Methods

ArnForByteMatchSet(IByteMatchSetRef)

This is AWS WAF Classic documentation.

public static string ArnForByteMatchSet(IByteMatchSetRef resource)

Parameters

resource IByteMatchSetRef

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.

The AWS::WAFRegional::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html

CloudformationResource: AWS::WAFRegional::ByteMatchSet

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

             var cfnByteMatchSet = new CfnByteMatchSet(this, "MyCfnByteMatchSet", new CfnByteMatchSetProps {
                 Name = "name",

                 // the properties below are optional
                 ByteMatchTuples = new [] { new ByteMatchTupleProperty {
                     FieldToMatch = new FieldToMatchProperty {
                         Type = "type",

                         // the properties below are optional
                         Data = "data"
                     },
                     PositionalConstraint = "positionalConstraint",
                     TextTransformation = "textTransformation",

                     // the properties below are optional
                     TargetString = "targetString",
                     TargetStringBase64 = "targetStringBase64"
                 } }
             });

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.

The AWS::WAFRegional::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html

CloudformationResource: AWS::WAFRegional::ByteMatchSet

ExampleMetadata: fixture=_generated

IsCfnByteMatchSet(object)

Checks whether the given object is a CfnByteMatchSet.

public static bool IsCfnByteMatchSet(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.

The AWS::WAFRegional::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html

CloudformationResource: AWS::WAFRegional::ByteMatchSet

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

CfnResource.RenderProperties(IDictionary<string, object>)

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.

The AWS::WAFRegional::ByteMatchSet resource creates an AWS WAF ByteMatchSet that identifies a part of a web request that you want to inspect.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafregional-bytematchset.html

CloudformationResource: AWS::WAFRegional::ByteMatchSet

ExampleMetadata: fixture=_generated

Implements

IInspectable

IByteMatchSetRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware