File Coverage

blib/lib/Paws/WAFRegional/FieldToMatch.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

line	stmt	sub	time	code
1				package Paws::WAFRegional::FieldToMatch;
2	1	1	340	use Moose;
	1		3
	1		7
3				has Data => (is => 'ro', isa => 'Str');
4				has Type => (is => 'ro', isa => 'Str', required => 1);
5				1;
6
7				### main pod documentation begin ###
8
9				=head1 NAME
10
11				Paws::WAFRegional::FieldToMatch
12
13				=head1 USAGE
14
15				This class represents one of two things:
16
17				=head3 Arguments in a call to a service
18
19				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20				Each attribute should be used as a named argument in the calls that expect this type of object.
21
22				As an example, if Att1 is expected to be a Paws::WAFRegional::FieldToMatch object:
23
24				$service_obj->Method(Att1 => { Data => $value, ..., Type => $value });
25
26				=head3 Results returned from an API call
27
28				Use accessors for each attribute. If Att1 is expected to be an Paws::WAFRegional::FieldToMatch object:
29
30				$result = $service_obj->Method(...);
31				$result->Att1->Data
32
33				=head1 DESCRIPTION
34
35				Specifies where in a web request to look for C<TargetString>.
36
37				=head1 ATTRIBUTES
38
39
40				=head2 Data => Str
41
42				When the value of C<Type> is C<HEADER>, enter the name of the header
43				that you want AWS WAF to search, for example, C<User-Agent> or
44				C<Referer>. If the value of C<Type> is any other value, omit C<Data>.
45
46				The name of the header is not case sensitive.
47
48
49				=head2 B<REQUIRED> Type => Str
50
51				The part of the web request that you want AWS WAF to search for a
52				specified string. Parts of a request that you can search include the
53				following:
54
55				=over
56
57				=item *
58
59				C<HEADER>: A specified request header, for example, the value of the
60				C<User-Agent> or C<Referer> header. If you choose C<HEADER> for the
61				type, specify the name of the header in C<Data>.
62
63				=item *
64
65				C<METHOD>: The HTTP method, which indicated the type of operation that
66				the request is asking the origin to perform. Amazon CloudFront supports
67				the following methods: C<DELETE>, C<GET>, C<HEAD>, C<OPTIONS>,
68				C<PATCH>, C<POST>, and C<PUT>.
69
70				=item *
71
72				C<QUERY_STRING>: A query string, which is the part of a URL that
73				appears after a C<?> character, if any.
74
75				=item *
76
77				C<URI>: The part of a web request that identifies a resource, for
78				example, C</images/daily-ad.jpg>.
79
80				=item *
81
82				C<BODY>: The part of a request that contains any additional data that
83				you want to send to your web server as the HTTP request body, such as
84				data from a form. The request body immediately follows the request
85				headers. Note that only the first C<8192> bytes of the request body are
86				forwarded to AWS WAF for inspection. To allow or block requests based
87				on the length of the body, you can create a size constraint set. For
88				more information, see CreateSizeConstraintSet.
89
90				=back
91
92
93
94
95				=head1 SEE ALSO
96
97				This class forms part of L<Paws>, describing an object used in L<Paws::WAFRegional>
98
99				=head1 BUGS and CONTRIBUTIONS
100
101				The source code is located here: https://github.com/pplu/aws-sdk-perl
102
103				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
104
105				=cut
106