XssMatchSet

Provides a WAF XSS Match Set Resource

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var xssMatchSet = new Aws.Waf.XssMatchSet("xssMatchSet", new Aws.Waf.XssMatchSetArgs
        {
            XssMatchTuples = 
            {
                new Aws.Waf.Inputs.XssMatchSetXssMatchTupleArgs
                {
                    FieldToMatch = new Aws.Waf.Inputs.XssMatchSetXssMatchTupleFieldToMatchArgs
                    {
                        Type = "URI",
                    },
                    TextTransformation = "NONE",
                },
                new Aws.Waf.Inputs.XssMatchSetXssMatchTupleArgs
                {
                    FieldToMatch = new Aws.Waf.Inputs.XssMatchSetXssMatchTupleFieldToMatchArgs
                    {
                        Type = "QUERY_STRING",
                    },
                    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.NewXssMatchSet(ctx, "xssMatchSet", &waf.XssMatchSetArgs{
            XssMatchTuples: waf.XssMatchSetXssMatchTupleArray{
                &waf.XssMatchSetXssMatchTupleArgs{
                    FieldToMatch: &waf.XssMatchSetXssMatchTupleFieldToMatchArgs{
                        Type: pulumi.String("URI"),
                    },
                    TextTransformation: pulumi.String("NONE"),
                },
                &waf.XssMatchSetXssMatchTupleArgs{
                    FieldToMatch: &waf.XssMatchSetXssMatchTupleFieldToMatchArgs{
                        Type: pulumi.String("QUERY_STRING"),
                    },
                    TextTransformation: pulumi.String("NONE"),
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

xss_match_set = aws.waf.XssMatchSet("xssMatchSet", xss_match_tuples=[
    {
        "fieldToMatch": {
            "type": "URI",
        },
        "textTransformation": "NONE",
    },
    {
        "fieldToMatch": {
            "type": "QUERY_STRING",
        },
        "textTransformation": "NONE",
    },
])

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

const xssMatchSet = new aws.waf.XssMatchSet("xss_match_set", {
    xssMatchTuples: [
        {
            fieldToMatch: {
                type: "URI",
            },
            textTransformation: "NONE",
        },
        {
            fieldToMatch: {
                type: "QUERY_STRING",
            },
            textTransformation: "NONE",
        },
    ],
});

Create a XssMatchSet Resource

new XssMatchSet(name: string, args?: XssMatchSetArgs, opts?: CustomResourceOptions);

def XssMatchSet(resource_name, opts=None, name=None, xss_match_tuples=None, __props__=None);

func NewXssMatchSet(ctx *Context, name string, args *XssMatchSetArgs, opts ...ResourceOption) (*XssMatchSet, error)

public XssMatchSet(string name, XssMatchSetArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args XssMatchSetArgs: 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 XssMatchSetArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

XssMatchSet Resource Properties

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

Inputs

The XssMatchSet resource accepts the following input properties:

Name string: The name or description of the SizeConstraintSet.
XssMatchTuples List<XssMatchSetXssMatchTupleArgs>: The parts of web requests that you want to inspect for cross-site scripting attacks.

Name string: The name or description of the SizeConstraintSet.
XssMatchTuples []XssMatchSetXssMatchTuple: The parts of web requests that you want to inspect for cross-site scripting attacks.

name string: The name or description of the SizeConstraintSet.
xssMatchTuples XssMatchSetXssMatchTuple[]: The parts of web requests that you want to inspect for cross-site scripting attacks.

name str: The name or description of the SizeConstraintSet.
xss_match_tuples List[XssMatchSetXssMatchTuple]: The parts of web requests that you want to inspect for cross-site scripting attacks.

Outputs

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

Arn string: Amazon Resource Name (ARN)
Id string: The provider-assigned unique ID for this managed resource.

Arn string: Amazon Resource Name (ARN)
Id string: The provider-assigned unique ID for this managed resource.

arn string: Amazon Resource Name (ARN)
id string: The provider-assigned unique ID for this managed resource.

arn str: Amazon Resource Name (ARN)
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing XssMatchSet Resource

Get an existing XssMatchSet 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?: XssMatchSetState, opts?: CustomResourceOptions): XssMatchSet

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

func GetXssMatchSet(ctx *Context, name string, id IDInput, state *XssMatchSetState, opts ...ResourceOption) (*XssMatchSet, error)

public static XssMatchSet Get(string name, Input<string> id, XssMatchSetState? 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:

Arn string: Amazon Resource Name (ARN)
Name string: The name or description of the SizeConstraintSet.
XssMatchTuples List<XssMatchSetXssMatchTupleArgs>: The parts of web requests that you want to inspect for cross-site scripting attacks.

Arn string: Amazon Resource Name (ARN)
Name string: The name or description of the SizeConstraintSet.
XssMatchTuples []XssMatchSetXssMatchTuple: The parts of web requests that you want to inspect for cross-site scripting attacks.

arn string: Amazon Resource Name (ARN)
name string: The name or description of the SizeConstraintSet.
xssMatchTuples XssMatchSetXssMatchTuple[]: The parts of web requests that you want to inspect for cross-site scripting attacks.

arn str: Amazon Resource Name (ARN)
name str: The name or description of the SizeConstraintSet.
xss_match_tuples List[XssMatchSetXssMatchTuple]: The parts of web requests that you want to inspect for cross-site scripting attacks.

Supporting Types

XssMatchSetXssMatchTuple

See the input and output API doc for this type.

FieldToMatch XssMatchSetXssMatchTupleFieldToMatchArgs: Specifies where in a web request to look for cross-site scripting attacks.
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.

FieldToMatch XssMatchSetXssMatchTupleFieldToMatch: Specifies where in a web request to look for cross-site scripting attacks.
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.

fieldToMatch XssMatchSetXssMatchTupleFieldToMatch: Specifies where in a web request to look for cross-site scripting attacks.
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.

fieldToMatch Dict[XssMatchSetXssMatchTupleFieldToMatch]: Specifies where in a web request to look for cross-site scripting attacks.
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.

XssMatchSetXssMatchTupleFieldToMatch

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