XssMatchSet class

Provides a WAF XSS Match Set Resource

Example Usage

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",
        },
    ],
    name: "xss_match_set",
});
import pulumi
import pulumi_aws as aws

xss_match_set = aws.waf.XssMatchSet("xss_match_set",
    xss_match_tuples=[
        {
            "field_to_match": {
                "type": "URI",
            },
            "text_transformation": "NONE",
        },
        {
            "field_to_match": {
                "type": "QUERY_STRING",
            },
            "text_transformation": "NONE",
        },
    ],
    name="xss_match_set")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var xssMatchSet = new Aws.Waf.XssMatchSet("xss_match_set", new()
    {
        XssMatchTuples = new[]
        {
            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",
            },
        },
        Name = "xss_match_set",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := waf.NewXssMatchSet(ctx, "xss_match_set", &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"),
				},
			},
			Name: pulumi.String("xss_match_set"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_waf_xssmatchset" "xss_match_set" {
  xss_match_tuples {
    field_to_match = {
      type = "URI"
    }
    text_transformation = "NONE"
  }
  xss_match_tuples {
    field_to_match = {
      type = "QUERY_STRING"
    }
    text_transformation = "NONE"
  }
  name = "xss_match_set"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.waf.XssMatchSet;
import com.pulumi.aws.waf.XssMatchSetArgs;
import com.pulumi.aws.waf.inputs.XssMatchSetXssMatchTupleArgs;
import com.pulumi.aws.waf.inputs.XssMatchSetXssMatchTupleFieldToMatchArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var xssMatchSet = new XssMatchSet("xssMatchSet", XssMatchSetArgs.builder()
            .xssMatchTuples(
                XssMatchSetXssMatchTupleArgs.builder()
                    .fieldToMatch(XssMatchSetXssMatchTupleFieldToMatchArgs.builder()
                        .type("URI")
                        .build())
                    .textTransformation("NONE")
                    .build(),
                XssMatchSetXssMatchTupleArgs.builder()
                    .fieldToMatch(XssMatchSetXssMatchTupleFieldToMatchArgs.builder()
                        .type("QUERY_STRING")
                        .build())
                    .textTransformation("NONE")
                    .build())
            .name("xss_match_set")
            .build());

    }
}
resources:
  xssMatchSet:
    type: aws:waf:XssMatchSet
    name: xss_match_set
    properties:
      xssMatchTuples:
        - fieldToMatch:
            type: URI
          textTransformation: NONE
        - fieldToMatch:
            type: QUERY_STRING
          textTransformation: NONE
      name: xss_match_set

Import

Using pulumi import, import WAF XSS Match Set using their ID. For example:

$ pulumi import aws:waf/xssMatchSet:XssMatchSet example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc

Constructors

XssMatchSet(String name, {XssMatchSetArgs? args, CustomResourceOptions? options})
Creates a new XssMatchSet. name The Pulumi resource name. args Arguments used to configure this XssMatchSet. The set of arguments for XssMatchSet. options Resource options controlling this resource's behavior.
XssMatchSet.reference(String urn)
Creates a typed reference to an existing XssMatchSet resource.

Properties

arn ↔ Output<String>
ARN
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
The name or description of the SizeConstraintSet.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
xssMatchTuples ↔ Output<List<XssMatchSetXssMatchTuple>?>
The parts of web requests that you want to inspect for cross-site scripting attacks.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {XssMatchSetState? state, CustomResourceOptions? options}) → XssMatchSet
Gets an existing XssMatchSet resource's state with the given name and id.