ByteMatchSet

Provides a WAF Byte Match Set Resource

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var byteSet = new Aws.Waf.ByteMatchSet("byteSet", new Aws.Waf.ByteMatchSetArgs
        {
            ByteMatchTuples = 
            {
                new Aws.Waf.Inputs.ByteMatchSetByteMatchTupleArgs
                {
                    FieldToMatch = new Aws.Waf.Inputs.ByteMatchSetByteMatchTupleFieldToMatchArgs
                    {
                        Data = "referer",
                        Type = "HEADER",
                    },
                    PositionalConstraint = "CONTAINS",
                    TargetString = "badrefer1",
                    TextTransformation = "NONE",
                },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/waf"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := waf.NewByteMatchSet(ctx, "byteSet", &waf.ByteMatchSetArgs{
            ByteMatchTuples: waf.ByteMatchSetByteMatchTupleArray{
                &waf.ByteMatchSetByteMatchTupleArgs{
                    FieldToMatch: &waf.ByteMatchSetByteMatchTupleFieldToMatchArgs{
                        Data: pulumi.String("referer"),
                        Type: pulumi.String("HEADER"),
                    },
                    PositionalConstraint: pulumi.String("CONTAINS"),
                    TargetString:         pulumi.String("badrefer1"),
                    TextTransformation:   pulumi.String("NONE"),
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

byte_set = aws.waf.ByteMatchSet("byteSet", byte_match_tuples=[{
    "fieldToMatch": {
        "data": "referer",
        "type": "HEADER",
    },
    "positionalConstraint": "CONTAINS",
    "targetString": "badrefer1",
    "textTransformation": "NONE",
}])

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const byteSet = new aws.waf.ByteMatchSet("byte_set", {
    byteMatchTuples: [{
        fieldToMatch: {
            data: "referer",
            type: "HEADER",
        },
        positionalConstraint: "CONTAINS",
        targetString: "badrefer1",
        textTransformation: "NONE",
    }],
});

Create a ByteMatchSet Resource

new ByteMatchSet(name: string, args?: ByteMatchSetArgs, opts?: CustomResourceOptions);

def ByteMatchSet(resource_name, opts=None, byte_match_tuples=None, name=None, __props__=None);

func NewByteMatchSet(ctx *Context, name string, args *ByteMatchSetArgs, opts ...ResourceOption) (*ByteMatchSet, error)

public ByteMatchSet(string name, ByteMatchSetArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ByteMatchSetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ByteMatchSetArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ByteMatchSetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ByteMatchSet Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ByteMatchSet resource accepts the following input properties:

ByteMatchTuples List<ByteMatchSetByteMatchTupleArgs>: Specifies the bytes (typically a string that corresponds with ASCII characters) that you want to search for in web requests, the location in requests that you want to search, and other settings.
Name string: The name or description of the Byte Match Set.

ByteMatchTuples []ByteMatchSetByteMatchTuple: Specifies the bytes (typically a string that corresponds with ASCII characters) that you want to search for in web requests, the location in requests that you want to search, and other settings.
Name string: The name or description of the Byte Match Set.

byteMatchTuples ByteMatchSetByteMatchTuple[]: Specifies the bytes (typically a string that corresponds with ASCII characters) that you want to search for in web requests, the location in requests that you want to search, and other settings.
name string: The name or description of the Byte Match Set.

byte_match_tuples List[ByteMatchSetByteMatchTuple]: Specifies the bytes (typically a string that corresponds with ASCII characters) that you want to search for in web requests, the location in requests that you want to search, and other settings.
name str: The name or description of the Byte Match Set.

Outputs

All input properties are implicitly available as output properties. Additionally, the ByteMatchSet resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing ByteMatchSet Resource

Get an existing ByteMatchSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ByteMatchSetState, opts?: CustomResourceOptions): ByteMatchSet

static get(resource_name, id, opts=None, byte_match_tuples=None, name=None, __props__=None);

func GetByteMatchSet(ctx *Context, name string, id IDInput, state *ByteMatchSetState, opts ...ResourceOption) (*ByteMatchSet, error)

public static ByteMatchSet Get(string name, Input<string> id, ByteMatchSetState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ByteMatchTuples List<ByteMatchSetByteMatchTupleArgs>: Specifies the bytes (typically a string that corresponds with ASCII characters) that you want to search for in web requests, the location in requests that you want to search, and other settings.
Name string: The name or description of the Byte Match Set.

ByteMatchTuples []ByteMatchSetByteMatchTuple: Specifies the bytes (typically a string that corresponds with ASCII characters) that you want to search for in web requests, the location in requests that you want to search, and other settings.
Name string: The name or description of the Byte Match Set.

byteMatchTuples ByteMatchSetByteMatchTuple[]: Specifies the bytes (typically a string that corresponds with ASCII characters) that you want to search for in web requests, the location in requests that you want to search, and other settings.
name string: The name or description of the Byte Match Set.

byte_match_tuples List[ByteMatchSetByteMatchTuple]: Specifies the bytes (typically a string that corresponds with ASCII characters) that you want to search for in web requests, the location in requests that you want to search, and other settings.
name str: The name or description of the Byte Match Set.

Supporting Types

ByteMatchSetByteMatchTuple

See the input and output API doc for this type.

FieldToMatch ByteMatchSetByteMatchTupleFieldToMatchArgs: The part of a web request that you want to search, such as a specified header or a query string.
PositionalConstraint string: Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want to search. e.g. CONTAINS, CONTAINS_WORD or EXACTLY. See docs for all supported values.
TextTransformation string: Text transformations used to eliminate unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on target_string before inspecting a request for a match. e.g. CMD_LINE, HTML_ENTITY_DECODE or NONE. See docs for all supported values.
TargetString string: The value that you want to search for. e.g. HEADER, METHOD or BODY. See docs for all supported values.

FieldToMatch ByteMatchSetByteMatchTupleFieldToMatch: The part of a web request that you want to search, such as a specified header or a query string.
PositionalConstraint string: Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want to search. e.g. CONTAINS, CONTAINS_WORD or EXACTLY. See docs for all supported values.
TextTransformation string: Text transformations used to eliminate unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on target_string before inspecting a request for a match. e.g. CMD_LINE, HTML_ENTITY_DECODE or NONE. See docs for all supported values.
TargetString string: The value that you want to search for. e.g. HEADER, METHOD or BODY. See docs for all supported values.

fieldToMatch ByteMatchSetByteMatchTupleFieldToMatch: The part of a web request that you want to search, such as a specified header or a query string.
positionalConstraint string: Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want to search. e.g. CONTAINS, CONTAINS_WORD or EXACTLY. See docs for all supported values.
textTransformation string: Text transformations used to eliminate unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on target_string before inspecting a request for a match. e.g. CMD_LINE, HTML_ENTITY_DECODE or NONE. See docs for all supported values.
targetString string: The value that you want to search for. e.g. HEADER, METHOD or BODY. See docs for all supported values.

fieldToMatch Dict[ByteMatchSetByteMatchTupleFieldToMatch]: The part of a web request that you want to search, such as a specified header or a query string.
positionalConstraint str: Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want to search. e.g. CONTAINS, CONTAINS_WORD or EXACTLY. See docs for all supported values.
textTransformation str: Text transformations used to eliminate unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on target_string before inspecting a request for a match. e.g. CMD_LINE, HTML_ENTITY_DECODE or NONE. See docs for all supported values.
targetString str: The value that you want to search for. e.g. HEADER, METHOD or BODY. See docs for all supported values.

ByteMatchSetByteMatchTupleFieldToMatch

See the input and output API doc for this type.

Type string: The part of the web request that you want AWS WAF to search for a specified string. e.g. HEADER, METHOD or BODY. See docs for all supported values.
Data string: When type is HEADER, enter the name of the header that you want to search, e.g. User-Agent or Referer. If type is any other value, omit this field.

Type string: The part of the web request that you want AWS WAF to search for a specified string. e.g. HEADER, METHOD or BODY. See docs for all supported values.
Data string: When type is HEADER, enter the name of the header that you want to search, e.g. User-Agent or Referer. If type is any other value, omit this field.

type string: The part of the web request that you want AWS WAF to search for a specified string. e.g. HEADER, METHOD or BODY. See docs for all supported values.
data string: When type is HEADER, enter the name of the header that you want to search, e.g. User-Agent or Referer. If type is any other value, omit this field.

type str: The part of the web request that you want AWS WAF to search for a specified string. e.g. HEADER, METHOD or BODY. See docs for all supported values.
data str: When type is HEADER, enter the name of the header that you want to search, e.g. User-Agent or Referer. If type is any other value, omit this field.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud