« blib/lib/Paws/WAFRegional/SqlInjectionMatchSetUpdate.pm
↑ Summary
blib/lib/Paws/WAFRegional/SubscribedRuleGroupSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::WAFRegional::SqlInjectionMatchTuple; | ||
| 3 | use Moose; | ||
| 4 | has FieldToMatch => (is => 'ro', isa => 'Paws::WAFRegional::FieldToMatch', required => 1); | ||
| 5 | has TextTransformation => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::WAFRegional::SqlInjectionMatchTuple | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::WAFRegional::SqlInjectionMatchTuple object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { FieldToMatch => $value, ..., TextTransformation => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::WAFRegional::SqlInjectionMatchTuple object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->FieldToMatch | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | This is B<AWS WAF Classic> documentation. For more information, see AWS | ||
| 38 | WAF Classic | ||
| 39 | (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) | ||
| 40 | in the developer guide. | ||
| 41 | |||
| 42 | B<For the latest version of AWS WAF>, use the AWS WAFV2 API and see the | ||
| 43 | AWS WAF Developer Guide | ||
| 44 | (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). | ||
| 45 | With the latest version, AWS WAF has a single set of endpoints for | ||
| 46 | regional and global use. | ||
| 47 | |||
| 48 | Specifies the part of a web request that you want AWS WAF to inspect | ||
| 49 | for snippets of malicious SQL code and, if you want AWS WAF to inspect | ||
| 50 | a header, the name of the header. | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> FieldToMatch => L<Paws::WAFRegional::FieldToMatch> | ||
| 56 | |||
| 57 | Specifies where in a web request to look for snippets of malicious SQL | ||
| 58 | code. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> TextTransformation => Str | ||
| 62 | |||
| 63 | Text transformations eliminate some of the unusual formatting that | ||
| 64 | attackers use in web requests in an effort to bypass AWS WAF. If you | ||
| 65 | specify a transformation, AWS WAF performs the transformation on | ||
| 66 | C<FieldToMatch> before inspecting it for a match. | ||
| 67 | |||
| 68 | You can only specify a single type of TextTransformation. | ||
| 69 | |||
| 70 | B<CMD_LINE> | ||
| 71 | |||
| 72 | When you're concerned that attackers are injecting an operating system | ||
| 73 | command line command and using unusual formatting to disguise some or | ||
| 74 | all of the command, use this option to perform the following | ||
| 75 | transformations: | ||
| 76 | |||
| 77 | =over | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | Delete the following characters: \ " ' ^ | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | Delete spaces before the following characters: / ( | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | Replace the following characters with a space: , ; | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | Replace multiple spaces with one space | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | Convert uppercase letters (A-Z) to lowercase (a-z) | ||
| 98 | |||
| 99 | =back | ||
| 100 | |||
| 101 | B<COMPRESS_WHITE_SPACE> | ||
| 102 | |||
| 103 | Use this option to replace the following characters with a space | ||
| 104 | character (decimal 32): | ||
| 105 | |||
| 106 | =over | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | \f, formfeed, decimal 12 | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | \t, tab, decimal 9 | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | \n, newline, decimal 10 | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | \r, carriage return, decimal 13 | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | \v, vertical tab, decimal 11 | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | non-breaking space, decimal 160 | ||
| 131 | |||
| 132 | =back | ||
| 133 | |||
| 134 | C<COMPRESS_WHITE_SPACE> also replaces multiple spaces with one space. | ||
| 135 | |||
| 136 | B<HTML_ENTITY_DECODE> | ||
| 137 | |||
| 138 | Use this option to replace HTML-encoded characters with unencoded | ||
| 139 | characters. C<HTML_ENTITY_DECODE> performs the following operations: | ||
| 140 | |||
| 141 | =over | ||
| 142 | |||
| 143 | =item * | ||
| 144 | |||
| 145 | Replaces C<(ampersand)quot;> with C<"> | ||
| 146 | |||
| 147 | =item * | ||
| 148 | |||
| 149 | Replaces C<(ampersand)nbsp;> with a non-breaking space, decimal 160 | ||
| 150 | |||
| 151 | =item * | ||
| 152 | |||
| 153 | Replaces C<(ampersand)lt;> with a "less than" symbol | ||
| 154 | |||
| 155 | =item * | ||
| 156 | |||
| 157 | Replaces C<(ampersand)gt;> with C<E<gt>> | ||
| 158 | |||
| 159 | =item * | ||
| 160 | |||
| 161 | Replaces characters that are represented in hexadecimal format, | ||
| 162 | C<(ampersand)(hash)xhhhh;>, with the corresponding characters | ||
| 163 | |||
| 164 | =item * | ||
| 165 | |||
| 166 | Replaces characters that are represented in decimal format, | ||
| 167 | C<(ampersand)(hash)nnnn;>, with the corresponding characters | ||
| 168 | |||
| 169 | =back | ||
| 170 | |||
| 171 | B<LOWERCASE> | ||
| 172 | |||
| 173 | Use this option to convert uppercase letters (A-Z) to lowercase (a-z). | ||
| 174 | |||
| 175 | B<URL_DECODE> | ||
| 176 | |||
| 177 | Use this option to decode a URL-encoded value. | ||
| 178 | |||
| 179 | B<NONE> | ||
| 180 | |||
| 181 | Specify C<NONE> if you don't want to perform any text transformations. | ||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head1 SEE ALSO | ||
| 186 | |||
| 187 | This class forms part of L<Paws>, describing an object used in L<Paws::WAFRegional> | ||
| 188 | |||
| 189 | =head1 BUGS and CONTRIBUTIONS | ||
| 190 | |||
| 191 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 192 | |||
| 193 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 194 | |||
| 195 | =cut | ||
| 196 |