ByteMatchSet class
Provides a WAF Byte Match Set Resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const byteSet = new aws.waf.ByteMatchSet("byte_set", {
byteMatchTuples: [{
fieldToMatch: {
type: "HEADER",
data: "referer",
},
textTransformation: "NONE",
targetString: "badrefer1",
positionalConstraint: "CONTAINS",
}],
name: "my_waf_byte_match_set",
});
import pulumi
import pulumi_aws as aws
byte_set = aws.waf.ByteMatchSet("byte_set",
byte_match_tuples=[{
"field_to_match": {
"type": "HEADER",
"data": "referer",
},
"text_transformation": "NONE",
"target_string": "badrefer1",
"positional_constraint": "CONTAINS",
}],
name="my_waf_byte_match_set")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var byteSet = new Aws.Waf.ByteMatchSet("byte_set", new()
{
ByteMatchTuples = new[]
{
new Aws.Waf.Inputs.ByteMatchSetByteMatchTupleArgs
{
FieldToMatch = new Aws.Waf.Inputs.ByteMatchSetByteMatchTupleFieldToMatchArgs
{
Type = "HEADER",
Data = "referer",
},
TextTransformation = "NONE",
TargetString = "badrefer1",
PositionalConstraint = "CONTAINS",
},
},
Name = "my_waf_byte_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.NewByteMatchSet(ctx, "byte_set", &waf.ByteMatchSetArgs{
ByteMatchTuples: waf.ByteMatchSetByteMatchTupleArray{
&waf.ByteMatchSetByteMatchTupleArgs{
FieldToMatch: &waf.ByteMatchSetByteMatchTupleFieldToMatchArgs{
Type: pulumi.String("HEADER"),
Data: pulumi.String("referer"),
},
TextTransformation: pulumi.String("NONE"),
TargetString: pulumi.String("badrefer1"),
PositionalConstraint: pulumi.String("CONTAINS"),
},
},
Name: pulumi.String("my_waf_byte_match_set"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_waf_bytematchset" "byte_set" {
byte_match_tuples {
field_to_match = {
type = "HEADER"
data = "referer"
}
text_transformation = "NONE"
target_string = "badrefer1"
positional_constraint = "CONTAINS"
}
name = "my_waf_byte_match_set"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.waf.ByteMatchSet;
import com.pulumi.aws.waf.ByteMatchSetArgs;
import com.pulumi.aws.waf.inputs.ByteMatchSetByteMatchTupleArgs;
import com.pulumi.aws.waf.inputs.ByteMatchSetByteMatchTupleFieldToMatchArgs;
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 byteSet = new ByteMatchSet("byteSet", ByteMatchSetArgs.builder()
.byteMatchTuples(ByteMatchSetByteMatchTupleArgs.builder()
.fieldToMatch(ByteMatchSetByteMatchTupleFieldToMatchArgs.builder()
.type("HEADER")
.data("referer")
.build())
.textTransformation("NONE")
.targetString("badrefer1")
.positionalConstraint("CONTAINS")
.build())
.name("my_waf_byte_match_set")
.build());
}
}
resources:
byteSet:
type: aws:waf:ByteMatchSet
name: byte_set
properties:
byteMatchTuples:
- fieldToMatch:
type: HEADER
data: referer
textTransformation: NONE
targetString: badrefer1
positionalConstraint: CONTAINS
name: my_waf_byte_match_set
Import
Using pulumi import, import WAF Byte Match Set using the id. For example:
$ pulumi import aws:waf/byteMatchSet:ByteMatchSet byte_set a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc
Constructors
- ByteMatchSet(String name, {ByteMatchSetArgs? args, CustomResourceOptions? options})
-
Creates a new ByteMatchSet.
nameThe Pulumi resource name.argsArguments used to configure this ByteMatchSet. The set of arguments for ByteMatchSet.optionsResource options controlling this resource's behavior. - ByteMatchSet.reference(String urn)
- Creates a typed reference to an existing ByteMatchSet resource.
Properties
-
arn
↔ Output<
String> -
ARN of the byte match set.
latefinal
-
byteMatchTuples
↔ Output<
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.
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 Byte Match Set.
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
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, {ByteMatchSetState? state, CustomResourceOptions? options}) → ByteMatchSet -
Gets an existing ByteMatchSet resource's state with the given
nameandid.