package types
import "github.com/aws/aws-sdk-go-v2/service/wafv2/types"
Index ¶
- type ActionCondition
- type ActionValue
- type All
- type AllQueryArguments
- type AllowAction
- type AndStatement
- type BlockAction
- type Body
- type BodyParsingFallbackBehavior
- type ByteMatchStatement
- type ComparisonOperator
- type Condition
- type CountAction
- type CountryCode
- type CustomHTTPHeader
- type CustomRequestHandling
- type CustomResponse
- type CustomResponseBody
- type DefaultAction
- type ExcludedRule
- type FallbackBehavior
- type FieldToMatch
- type Filter
- type FilterBehavior
- type FilterRequirement
- type FirewallManagerRuleGroup
- type FirewallManagerStatement
- type ForwardedIPConfig
- type ForwardedIPPosition
- type GeoMatchStatement
- type HTTPHeader
- type HTTPRequest
- type IPAddressVersion
- type IPSet
- type IPSetForwardedIPConfig
- type IPSetReferenceStatement
- type IPSetSummary
- type JsonBody
- type JsonMatchPattern
- type JsonMatchScope
- type Label
- type LabelMatchScope
- type LabelMatchStatement
- type LabelNameCondition
- type LabelSummary
- type LoggingConfiguration
- type LoggingFilter
- type ManagedRuleGroupStatement
- type ManagedRuleGroupSummary
- type Method
- type NoneAction
- type NotStatement
- type OrStatement
- type OverrideAction
- type ParameterExceptionField
- type PositionalConstraint
- type QueryString
- type RateBasedStatement
- type RateBasedStatementAggregateKeyType
- type RateBasedStatementManagedKeysIPSet
- type Regex
- type RegexPatternSet
- type RegexPatternSetReferenceStatement
- type RegexPatternSetSummary
- type ResourceType
- type ResponseContentType
- type Rule
- type RuleAction
- type RuleGroup
- type RuleGroupReferenceStatement
- type RuleGroupSummary
- type RuleSummary
- type SampledHTTPRequest
- type Scope
- type SingleHeader
- type SingleQueryArgument
- type SizeConstraintStatement
- type SqliMatchStatement
- type Statement
- type Tag
- type TagInfoForResource
- type TextTransformation
- type TextTransformationType
- type TimeWindow
- type UriPath
- type VisibilityConfig
- type WAFAssociatedItemException
- func (e *WAFAssociatedItemException) Error() string
- func (e *WAFAssociatedItemException) ErrorCode() string
- func (e *WAFAssociatedItemException) ErrorFault() smithy.ErrorFault
- func (e *WAFAssociatedItemException) ErrorMessage() string
- type WAFDuplicateItemException
- func (e *WAFDuplicateItemException) Error() string
- func (e *WAFDuplicateItemException) ErrorCode() string
- func (e *WAFDuplicateItemException) ErrorFault() smithy.ErrorFault
- func (e *WAFDuplicateItemException) ErrorMessage() string
- type WAFInternalErrorException
- func (e *WAFInternalErrorException) Error() string
- func (e *WAFInternalErrorException) ErrorCode() string
- func (e *WAFInternalErrorException) ErrorFault() smithy.ErrorFault
- func (e *WAFInternalErrorException) ErrorMessage() string
- type WAFInvalidOperationException
- func (e *WAFInvalidOperationException) Error() string
- func (e *WAFInvalidOperationException) ErrorCode() string
- func (e *WAFInvalidOperationException) ErrorFault() smithy.ErrorFault
- func (e *WAFInvalidOperationException) ErrorMessage() string
- type WAFInvalidParameterException
- func (e *WAFInvalidParameterException) Error() string
- func (e *WAFInvalidParameterException) ErrorCode() string
- func (e *WAFInvalidParameterException) ErrorFault() smithy.ErrorFault
- func (e *WAFInvalidParameterException) ErrorMessage() string
- type WAFInvalidPermissionPolicyException
- func (e *WAFInvalidPermissionPolicyException) Error() string
- func (e *WAFInvalidPermissionPolicyException) ErrorCode() string
- func (e *WAFInvalidPermissionPolicyException) ErrorFault() smithy.ErrorFault
- func (e *WAFInvalidPermissionPolicyException) ErrorMessage() string
- type WAFInvalidResourceException
- func (e *WAFInvalidResourceException) Error() string
- func (e *WAFInvalidResourceException) ErrorCode() string
- func (e *WAFInvalidResourceException) ErrorFault() smithy.ErrorFault
- func (e *WAFInvalidResourceException) ErrorMessage() string
- type WAFLimitsExceededException
- func (e *WAFLimitsExceededException) Error() string
- func (e *WAFLimitsExceededException) ErrorCode() string
- func (e *WAFLimitsExceededException) ErrorFault() smithy.ErrorFault
- func (e *WAFLimitsExceededException) ErrorMessage() string
- type WAFNonexistentItemException
- func (e *WAFNonexistentItemException) Error() string
- func (e *WAFNonexistentItemException) ErrorCode() string
- func (e *WAFNonexistentItemException) ErrorFault() smithy.ErrorFault
- func (e *WAFNonexistentItemException) ErrorMessage() string
- type WAFOptimisticLockException
- func (e *WAFOptimisticLockException) Error() string
- func (e *WAFOptimisticLockException) ErrorCode() string
- func (e *WAFOptimisticLockException) ErrorFault() smithy.ErrorFault
- func (e *WAFOptimisticLockException) ErrorMessage() string
- type WAFServiceLinkedRoleErrorException
- func (e *WAFServiceLinkedRoleErrorException) Error() string
- func (e *WAFServiceLinkedRoleErrorException) ErrorCode() string
- func (e *WAFServiceLinkedRoleErrorException) ErrorFault() smithy.ErrorFault
- func (e *WAFServiceLinkedRoleErrorException) ErrorMessage() string
- type WAFSubscriptionNotFoundException
- func (e *WAFSubscriptionNotFoundException) Error() string
- func (e *WAFSubscriptionNotFoundException) ErrorCode() string
- func (e *WAFSubscriptionNotFoundException) ErrorFault() smithy.ErrorFault
- func (e *WAFSubscriptionNotFoundException) ErrorMessage() string
- type WAFTagOperationException
- func (e *WAFTagOperationException) Error() string
- func (e *WAFTagOperationException) ErrorCode() string
- func (e *WAFTagOperationException) ErrorFault() smithy.ErrorFault
- func (e *WAFTagOperationException) ErrorMessage() string
- type WAFTagOperationInternalErrorException
- func (e *WAFTagOperationInternalErrorException) Error() string
- func (e *WAFTagOperationInternalErrorException) ErrorCode() string
- func (e *WAFTagOperationInternalErrorException) ErrorFault() smithy.ErrorFault
- func (e *WAFTagOperationInternalErrorException) ErrorMessage() string
- type WAFUnavailableEntityException
- func (e *WAFUnavailableEntityException) Error() string
- func (e *WAFUnavailableEntityException) ErrorCode() string
- func (e *WAFUnavailableEntityException) ErrorFault() smithy.ErrorFault
- func (e *WAFUnavailableEntityException) ErrorMessage() string
- type WebACL
- type WebACLSummary
- type XssMatchStatement
Types ¶
type ActionCondition ¶
type ActionCondition struct { // The action setting that a log record must contain in order to meet the // condition. // // This member is required. Action ActionValue }
A single action condition for a Condition in a logging filter.
type ActionValue ¶
type ActionValue string
const ( ActionValueAllow ActionValue = "ALLOW" ActionValueBlock ActionValue = "BLOCK" ActionValueCount ActionValue = "COUNT" )
Enum values for ActionValue
func (ActionValue) Values ¶
func (ActionValue) Values() []ActionValue
Values returns all known values for ActionValue. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type All ¶
type All struct { }
Inspect all of the elements that AWS WAF has parsed and extracted from the web request JSON body that are within the JsonBodyMatchScope. This is used with the FieldToMatch option JsonBody. This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
type AllQueryArguments ¶
type AllQueryArguments struct { }
All query arguments of a web request. This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
type AllowAction ¶
type AllowAction struct { // Defines custom handling for the web request. For information about customizing // web requests and responses, see Customizing web requests and responses in AWS // WAF // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) // in the AWS WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). CustomRequestHandling *CustomRequestHandling }
Specifies that AWS WAF should allow the request and optionally defines additional custom handling for the request. This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
type AndStatement ¶
type AndStatement struct { // The statements to combine with AND logic. You can use any statements that can be // nested. // // This member is required. Statements []Statement }
A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.
type BlockAction ¶
type BlockAction struct { // Defines a custom response for the web request. For information about customizing // web requests and responses, see Customizing web requests and responses in AWS // WAF // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) // in the AWS WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). CustomResponse *CustomResponse }
Specifies that AWS WAF should block the request and optionally defines additional custom handling for the response to the web request. This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
type Body ¶
type Body struct { }
The body of a web request. This immediately follows the request headers. This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
type BodyParsingFallbackBehavior ¶
type BodyParsingFallbackBehavior string
const ( BodyParsingFallbackBehaviorMatch BodyParsingFallbackBehavior = "MATCH" BodyParsingFallbackBehaviorNoMatch BodyParsingFallbackBehavior = "NO_MATCH" BodyParsingFallbackBehaviorEvaluateAsString BodyParsingFallbackBehavior = "EVALUATE_AS_STRING" )
Enum values for BodyParsingFallbackBehavior
func (BodyParsingFallbackBehavior) Values ¶
func (BodyParsingFallbackBehavior) Values() []BodyParsingFallbackBehavior
Values returns all known values for BodyParsingFallbackBehavior. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ByteMatchStatement ¶
type ByteMatchStatement struct { // The part of a web request that you want AWS WAF to inspect. For more // information, see FieldToMatch. // // This member is required. FieldToMatch *FieldToMatch // The area within the portion of a web request that you want AWS WAF to search for // SearchString. Valid values include the following: CONTAINS The specified part of // the web request must include the value of SearchString, but the location doesn't // matter. CONTAINS_WORD The specified part of the web request must include the // value of SearchString, and SearchString must contain only alphanumeric // characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must // be a word, which means that both of the following are true: // // * SearchString is // at the beginning of the specified part of the web request or is preceded by a // character other than an alphanumeric character or underscore (_). Examples // include the value of a header and ;BadBot. // // * SearchString is at the end of the // specified part of the web request or is followed by a character other than an // alphanumeric character or underscore (_), for example, BadBot; and // -BadBot;. // // EXACTLY The value of the specified part of the web request must // exactly match the value of SearchString. STARTS_WITH The value of SearchString // must appear at the beginning of the specified part of the web request. ENDS_WITH // The value of SearchString must appear at the end of the specified part of the // web request. // // This member is required. PositionalConstraint PositionalConstraint // A string value that you want AWS WAF to search for. AWS WAF searches only in the // part of web requests that you designate for inspection in FieldToMatch. The // maximum length of the value is 50 bytes. Valid values depend on the component // that you specify for inspection in FieldToMatch: // // * Method: The HTTP method that // you want AWS WAF to search for. This indicates the type of operation specified // in the request. // // * UriPath: The value that you want AWS WAF to search for in the // URI path, for example, /images/daily-ad.jpg. // // If SearchString includes // alphabetic characters A-Z and a-z, note that the value is case sensitive. If // you're using the AWS WAF API Specify a base64-encoded version of the value. The // maximum length of the value before you base64-encode it is 50 bytes. For // example, suppose the value of Type is HEADER and the value of Data is // User-Agent. If you want to search the User-Agent header for the value BadBot, // you base64-encode BadBot using MIME base64-encoding and include the resulting // value, QmFkQm90, in the value of SearchString. If you're using the AWS CLI or // one of the AWS SDKs The value that you want AWS WAF to search for. The SDK // automatically base64 encodes the value. // // This member is required. SearchString []byte // Text transformations eliminate some of the unusual formatting that attackers use // in web requests in an effort to bypass detection. If you specify one or more // transformations in a rule statement, AWS WAF performs all transformations on the // content of the request component identified by FieldToMatch, starting from the // lowest priority setting, before inspecting the content for a match. // // This member is required. TextTransformations []TextTransformation }
A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
type ComparisonOperator ¶
type ComparisonOperator string
const ( ComparisonOperatorEq ComparisonOperator = "EQ" ComparisonOperatorNe ComparisonOperator = "NE" ComparisonOperatorLe ComparisonOperator = "LE" ComparisonOperatorLt ComparisonOperator = "LT" ComparisonOperatorGe ComparisonOperator = "GE" ComparisonOperatorGt ComparisonOperator = "GT" )
Enum values for ComparisonOperator
func (ComparisonOperator) Values ¶
func (ComparisonOperator) Values() []ComparisonOperator
Values returns all known values for ComparisonOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type Condition ¶
type Condition struct { // A single action condition. ActionCondition *ActionCondition // A single label name condition. LabelNameCondition *LabelNameCondition }
A single match condition for a Filter.
type CountAction ¶
type CountAction struct { // Defines custom handling for the web request. For information about customizing // web requests and responses, see Customizing web requests and responses in AWS // WAF // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) // in the AWS WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). CustomRequestHandling *CustomRequestHandling }
Specifies that AWS WAF should count the request. Optionally defines additional custom handling for the request. This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
type CountryCode ¶
type CountryCode string
const ( CountryCodeAf CountryCode = "AF" CountryCodeAx CountryCode = "AX" CountryCodeAl CountryCode = "AL" CountryCodeDz CountryCode = "DZ" CountryCodeAs CountryCode = "AS" CountryCodeAd CountryCode = "AD" CountryCodeAo CountryCode = "AO" CountryCodeAi CountryCode = "AI" CountryCodeAq CountryCode = "AQ" CountryCodeAg CountryCode = "AG" CountryCodeAr CountryCode = "AR" CountryCodeAm CountryCode = "AM" CountryCodeAw CountryCode = "AW" CountryCodeAu CountryCode = "AU" CountryCodeAt CountryCode = "AT" CountryCodeAz CountryCode = "AZ" CountryCodeBs CountryCode = "BS" CountryCodeBh CountryCode = "BH" CountryCodeBd CountryCode = "BD" CountryCodeBb CountryCode = "BB" CountryCodeBy CountryCode = "BY" CountryCodeBe CountryCode = "BE" CountryCodeBz CountryCode = "BZ" CountryCodeBj CountryCode = "BJ" CountryCodeBm CountryCode = "BM" CountryCodeBt CountryCode = "BT" CountryCodeBo CountryCode = "BO" CountryCodeBq CountryCode = "BQ" CountryCodeBa CountryCode = "BA" CountryCodeBw CountryCode = "BW" CountryCodeBv CountryCode = "BV" CountryCodeBr CountryCode = "BR" CountryCodeIo CountryCode = "IO" CountryCodeBn CountryCode = "BN" CountryCodeBg CountryCode = "BG" CountryCodeBf CountryCode = "BF" CountryCodeBi CountryCode = "BI" CountryCodeKh CountryCode = "KH" CountryCodeCm CountryCode = "CM" CountryCodeCa CountryCode = "CA" CountryCodeCv CountryCode = "CV" CountryCodeKy CountryCode = "KY" CountryCodeCf CountryCode = "CF" CountryCodeTd CountryCode = "TD" CountryCodeCl CountryCode = "CL" CountryCodeCn CountryCode = "CN" CountryCodeCx CountryCode = "CX" CountryCodeCc CountryCode = "CC" CountryCodeCo CountryCode = "CO" CountryCodeKm CountryCode = "KM" CountryCodeCg CountryCode = "CG" CountryCodeCd CountryCode = "CD" CountryCodeCk CountryCode = "CK" CountryCodeCr CountryCode = "CR" CountryCodeCi CountryCode = "CI" CountryCodeHr CountryCode = "HR" CountryCodeCu CountryCode = "CU" CountryCodeCw CountryCode = "CW" CountryCodeCy CountryCode = "CY" CountryCodeCz CountryCode = "CZ" CountryCodeDk CountryCode = "DK" CountryCodeDj CountryCode = "DJ" CountryCodeDm CountryCode = "DM" CountryCodeDo CountryCode = "DO" CountryCodeEc CountryCode = "EC" CountryCodeEg CountryCode = "EG" CountryCodeSv CountryCode = "SV" CountryCodeGq CountryCode = "GQ" CountryCodeEr CountryCode = "ER" CountryCodeEe CountryCode = "EE" CountryCodeEt CountryCode = "ET" CountryCodeFk CountryCode = "FK" CountryCodeFo CountryCode = "FO" CountryCodeFj CountryCode = "FJ" CountryCodeFi CountryCode = "FI" CountryCodeFr CountryCode = "FR" CountryCodeGf CountryCode = "GF" CountryCodePf CountryCode = "PF" CountryCodeTf CountryCode = "TF" CountryCodeGa CountryCode = "GA" CountryCodeGm CountryCode = "GM" CountryCodeGe CountryCode = "GE" CountryCodeDe CountryCode = "DE" CountryCodeGh CountryCode = "GH" CountryCodeGi CountryCode = "GI" CountryCodeGr CountryCode = "GR" CountryCodeGl CountryCode = "GL" CountryCodeGd CountryCode = "GD" CountryCodeGp CountryCode = "GP" CountryCodeGu CountryCode = "GU" CountryCodeGt CountryCode = "GT" CountryCodeGg CountryCode = "GG" CountryCodeGn CountryCode = "GN" CountryCodeGw CountryCode = "GW" CountryCodeGy CountryCode = "GY" CountryCodeHt CountryCode = "HT" CountryCodeHm CountryCode = "HM" CountryCodeVa CountryCode = "VA" CountryCodeHn CountryCode = "HN" CountryCodeHk CountryCode = "HK" CountryCodeHu CountryCode = "HU" CountryCodeIs CountryCode = "IS" CountryCodeIn CountryCode = "IN" CountryCodeId CountryCode = "ID" CountryCodeIr CountryCode = "IR" CountryCodeIq CountryCode = "IQ" CountryCodeIe CountryCode = "IE" CountryCodeIm CountryCode = "IM" CountryCodeIl CountryCode = "IL" CountryCodeIt CountryCode = "IT" CountryCodeJm CountryCode = "JM" CountryCodeJp CountryCode = "JP" CountryCodeJe CountryCode = "JE" CountryCodeJo CountryCode = "JO" CountryCodeKz CountryCode = "KZ" CountryCodeKe CountryCode = "KE" CountryCodeKi CountryCode = "KI" CountryCodeKp CountryCode = "KP" CountryCodeKr CountryCode = "KR" CountryCodeKw CountryCode = "KW" CountryCodeKg CountryCode = "KG" CountryCodeLa CountryCode = "LA" CountryCodeLv CountryCode = "LV" CountryCodeLb CountryCode = "LB" CountryCodeLs CountryCode = "LS" CountryCodeLr CountryCode = "LR" CountryCodeLy CountryCode = "LY" CountryCodeLi CountryCode = "LI" CountryCodeLt CountryCode = "LT" CountryCodeLu CountryCode = "LU" CountryCodeMo CountryCode = "MO" CountryCodeMk CountryCode = "MK" CountryCodeMg CountryCode = "MG" CountryCodeMw CountryCode = "MW" CountryCodeMy CountryCode = "MY" CountryCodeMv CountryCode = "MV" CountryCodeMl CountryCode = "ML" CountryCodeMt CountryCode = "MT" CountryCodeMh CountryCode = "MH" CountryCodeMq CountryCode = "MQ" CountryCodeMr CountryCode = "MR" CountryCodeMu CountryCode = "MU" CountryCodeYt CountryCode = "YT" CountryCodeMx CountryCode = "MX" CountryCodeFm CountryCode = "FM" CountryCodeMd CountryCode = "MD" CountryCodeMc CountryCode = "MC" CountryCodeMn CountryCode = "MN" CountryCodeMe CountryCode = "ME" CountryCodeMs CountryCode = "MS" CountryCodeMa CountryCode = "MA" CountryCodeMz CountryCode = "MZ" CountryCodeMm CountryCode = "MM" CountryCodeNa CountryCode = "NA" CountryCodeNr CountryCode = "NR" CountryCodeNp CountryCode = "NP" CountryCodeNl CountryCode = "NL" CountryCodeNc CountryCode = "NC" CountryCodeNz CountryCode = "NZ" CountryCodeNi CountryCode = "NI" CountryCodeNe CountryCode = "NE" CountryCodeNg CountryCode = "NG" CountryCodeNu CountryCode = "NU" CountryCodeNf CountryCode = "NF" CountryCodeMp CountryCode = "MP" CountryCodeNo CountryCode = "NO" CountryCodeOm CountryCode = "OM" CountryCodePk CountryCode = "PK" CountryCodePw CountryCode = "PW" CountryCodePs CountryCode = "PS" CountryCodePa CountryCode = "PA" CountryCodePg CountryCode = "PG" CountryCodePy CountryCode = "PY" CountryCodePe CountryCode = "PE" CountryCodePh CountryCode = "PH" CountryCodePn CountryCode = "PN" CountryCodePl CountryCode = "PL" CountryCodePt CountryCode = "PT" CountryCodePr CountryCode = "PR" CountryCodeQa CountryCode = "QA" CountryCodeRe CountryCode = "RE" CountryCodeRo CountryCode = "RO" CountryCodeRu CountryCode = "RU" CountryCodeRw CountryCode = "RW" CountryCodeBl CountryCode = "BL" CountryCodeSh CountryCode = "SH" CountryCodeKn CountryCode = "KN" CountryCodeLc CountryCode = "LC" CountryCodeMf CountryCode = "MF" CountryCodePm CountryCode = "PM" CountryCodeVc CountryCode = "VC" CountryCodeWs CountryCode = "WS" CountryCodeSm CountryCode = "SM" CountryCodeSt CountryCode = "ST" CountryCodeSa CountryCode = "SA" CountryCodeSn CountryCode = "SN" CountryCodeRs CountryCode = "RS" CountryCodeSc CountryCode = "SC" CountryCodeSl CountryCode = "SL" CountryCodeSg CountryCode = "SG" CountryCodeSx CountryCode = "SX" CountryCodeSk CountryCode = "SK" CountryCodeSi CountryCode = "SI" CountryCodeSb CountryCode = "SB" CountryCodeSo CountryCode = "SO" CountryCodeZa CountryCode = "ZA" CountryCodeGs CountryCode = "GS" CountryCodeSs CountryCode = "SS" CountryCodeEs CountryCode = "ES" CountryCodeLk CountryCode = "LK" CountryCodeSd CountryCode = "SD" CountryCodeSr CountryCode = "SR" CountryCodeSj CountryCode = "SJ" CountryCodeSz CountryCode = "SZ" CountryCodeSe CountryCode = "SE" CountryCodeCh CountryCode = "CH" CountryCodeSy CountryCode = "SY" CountryCodeTw CountryCode = "TW" CountryCodeTj CountryCode = "TJ" CountryCodeTz CountryCode = "TZ" CountryCodeTh CountryCode = "TH" CountryCodeTl CountryCode = "TL" CountryCodeTg CountryCode = "TG" CountryCodeTk CountryCode = "TK" CountryCodeTo CountryCode = "TO" CountryCodeTt CountryCode = "TT" CountryCodeTn CountryCode = "TN" CountryCodeTr CountryCode = "TR" CountryCodeTm CountryCode = "TM" CountryCodeTc CountryCode = "TC" CountryCodeTv CountryCode = "TV" CountryCodeUg CountryCode = "UG" CountryCodeUa CountryCode = "UA" CountryCodeAe CountryCode = "AE" CountryCodeGb CountryCode = "GB" CountryCodeUs CountryCode = "US" CountryCodeUm CountryCode = "UM" CountryCodeUy CountryCode = "UY" CountryCodeUz CountryCode = "UZ" CountryCodeVu CountryCode = "VU" CountryCodeVe CountryCode = "VE" CountryCodeVn CountryCode = "VN" CountryCodeVg CountryCode = "VG" CountryCodeVi CountryCode = "VI" CountryCodeWf CountryCode = "WF" CountryCodeEh CountryCode = "EH" CountryCodeYe CountryCode = "YE" CountryCodeZm CountryCode = "ZM" CountryCodeZw CountryCode = "ZW" )
Enum values for CountryCode
func (CountryCode) Values ¶
func (CountryCode) Values() []CountryCode
Values returns all known values for CountryCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type CustomHTTPHeader ¶
type CustomHTTPHeader struct { // The name of the custom header. For custom request header insertion, when AWS WAF // inserts the header into the request, it prefixes this name x-amzn-waf-, to avoid // confusion with the headers that are already in the request. For example, for the // header name sample, AWS WAF inserts the header x-amzn-waf-sample. // // This member is required. Name *string // The value of the custom header. // // This member is required. Value *string }
A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling.
type CustomRequestHandling ¶
type CustomRequestHandling struct { // The HTTP headers to insert into the request. Duplicate header names are not // allowed. For information about the limits on count and size for custom request // and response settings, see AWS WAF quotas // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS // WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). // // This member is required. InsertHeaders []CustomHTTPHeader }
Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling for the rule actions allow and count. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
type CustomResponse ¶
type CustomResponse struct { // The HTTP status code to return to the client. For a list of status codes that // you can use in your custom reqponses, see Supported status codes for custom // response // (https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) // in the AWS WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). // // This member is required. ResponseCode *int32 // References the response body that you want AWS WAF to return to the web request // client. You can define a custom response for a rule action or a default web ACL // action that is set to block. To do this, you first define the response body key // and value in the CustomResponseBodies setting for the WebACL or RuleGroup where // you want to use it. Then, in the rule action or web ACL default action // BlockAction setting, you reference the response body using this key. CustomResponseBodyKey *string // The HTTP headers to use in the response. Duplicate header names are not allowed. // For information about the limits on count and size for custom request and // response settings, see AWS WAF quotas // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS // WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). ResponseHeaders []CustomHTTPHeader }
A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to BlockAction. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
type CustomResponseBody ¶
type CustomResponseBody struct { // The payload of the custom response. You can use JSON escape strings in JSON // content. To do this, you must specify JSON content in the ContentType setting. // For information about the limits on count and size for custom request and // response settings, see AWS WAF quotas // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS // WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). // // This member is required. Content *string // The type of content in the payload that you are defining in the Content string. // // This member is required. ContentType ResponseContentType }
The response body to use in a custom response to a web request. This is referenced by key from CustomResponseCustomResponseBodyKey.
type DefaultAction ¶
type DefaultAction struct { // Specifies that AWS WAF should allow requests by default. Allow *AllowAction // Specifies that AWS WAF should block requests by default. Block *BlockAction }
In a WebACL, this is the action that you want AWS WAF to perform when a web request doesn't match any of the rules in the WebACL. The default action must be a terminating action, so you can't use count.
type ExcludedRule ¶
type ExcludedRule struct { // The name of the rule to exclude. // // This member is required. Name *string }
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT. This effectively excludes the rule from acting on web requests.
type FallbackBehavior ¶
type FallbackBehavior string
const ( FallbackBehaviorMatch FallbackBehavior = "MATCH" FallbackBehaviorNoMatch FallbackBehavior = "NO_MATCH" )
Enum values for FallbackBehavior
func (FallbackBehavior) Values ¶
func (FallbackBehavior) Values() []FallbackBehavior
Values returns all known values for FallbackBehavior. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type FieldToMatch ¶
type FieldToMatch struct { // Inspect all query arguments. AllQueryArguments *AllQueryArguments // Inspect the request body as plain text. The request body immediately follows the // request headers. This is the part of a request that contains any additional data // that you want to send to your web server as the HTTP request body, such as data // from a form. Note that only the first 8 KB (8192 bytes) of the request body are // forwarded to AWS WAF for inspection by the underlying host service. If you don't // need to inspect more than 8 KB, you can guarantee that you don't allow // additional bytes in by combining a statement that inspects the body of the web // request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a // SizeConstraintStatement that enforces an 8 KB size limit on the body of the // request. AWS WAF doesn't support inspecting the entire contents of web requests // whose bodies exceed the 8 KB limit. Body *Body // Inspect the request body as JSON. The request body immediately follows the // request headers. This is the part of a request that contains any additional data // that you want to send to your web server as the HTTP request body, such as data // from a form. Note that only the first 8 KB (8192 bytes) of the request body are // forwarded to AWS WAF for inspection by the underlying host service. If you don't // need to inspect more than 8 KB, you can guarantee that you don't allow // additional bytes in by combining a statement that inspects the body of the web // request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a // SizeConstraintStatement that enforces an 8 KB size limit on the body of the // request. AWS WAF doesn't support inspecting the entire contents of web requests // whose bodies exceed the 8 KB limit. JsonBody *JsonBody // Inspect the HTTP method. The method indicates the type of operation that the // request is asking the origin to perform. Method *Method // Inspect the query string. This is the part of a URL that appears after a ? // character, if any. QueryString *QueryString // Inspect a single header. Provide the name of the header to inspect, for example, // User-Agent or Referer. This setting isn't case sensitive. Example JSON: // "SingleHeader": { "Name": "haystack" } SingleHeader *SingleHeader // Inspect a single query argument. Provide the name of the query argument to // inspect, such as UserName or SalesRegion. The name can be up to 30 characters // long and isn't case sensitive. This is used only to indicate the web request // component for AWS WAF to inspect, in the FieldToMatch specification. Example // JSON: "SingleQueryArgument": { "Name": "myArgument" } SingleQueryArgument *SingleQueryArgument // Inspect the request URI path. This is the part of a web request that identifies // a resource, for example, /images/daily-ad.jpg. UriPath *UriPath }
The part of a web request that you want AWS WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of a web request, create a separate rule statement for each component.
type Filter ¶
type Filter struct { // How to handle logs that satisfy the filter's conditions and requirement. // // This member is required. Behavior FilterBehavior // Match conditions for the filter. // // This member is required. Conditions []Condition // Logic to apply to the filtering conditions. You can specify that, in order to // satisfy the filter, a log must match all conditions or must match at least one // condition. // // This member is required. Requirement FilterRequirement }
A single logging filter, used in LoggingFilter.
type FilterBehavior ¶
type FilterBehavior string
const ( FilterBehaviorKeep FilterBehavior = "KEEP" FilterBehaviorDrop FilterBehavior = "DROP" )
Enum values for FilterBehavior
func (FilterBehavior) Values ¶
func (FilterBehavior) Values() []FilterBehavior
Values returns all known values for FilterBehavior. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type FilterRequirement ¶
type FilterRequirement string
const ( FilterRequirementMeetsAll FilterRequirement = "MEETS_ALL" FilterRequirementMeetsAny FilterRequirement = "MEETS_ANY" )
Enum values for FilterRequirement
func (FilterRequirement) Values ¶
func (FilterRequirement) Values() []FilterRequirement
Values returns all known values for FilterRequirement. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type FirewallManagerRuleGroup ¶
type FirewallManagerRuleGroup struct { // The processing guidance for an AWS Firewall Manager rule. This is like a regular // rule Statement, but it can only contain a rule group reference. // // This member is required. FirewallManagerStatement *FirewallManagerStatement // The name of the rule group. You cannot change the name of a rule group after you // create it. // // This member is required. Name *string // The override action to apply to the rules in a rule group. Used only for rule // statements that reference a rule group, like RuleGroupReferenceStatement and // ManagedRuleGroupStatement. Set the override action to none to leave the rule // actions in effect. Set it to count to only count matches, regardless of the rule // action settings. In a Rule, you must specify either this OverrideAction setting // or the rule Action setting, but not both: // // * If the rule statement references a // rule group, use this override action setting and not the action setting. // // * If // the rule statement does not reference a rule group, use the rule action setting // and not this rule override action setting. // // This member is required. OverrideAction *OverrideAction // If you define more than one rule group in the first or last Firewall Manager // rule groups, AWS WAF evaluates each request against the rule groups in order, // starting from the lowest priority setting. The priorities don't need to be // consecutive, but they must all be different. // // This member is required. Priority int32 // Defines and enables Amazon CloudWatch metrics and web request sample collection. // // This member is required. VisibilityConfig *VisibilityConfig }
A rule group that's defined for an AWS Firewall Manager WAF policy.
type FirewallManagerStatement ¶
type FirewallManagerStatement struct { // A rule statement used to run the rules that are defined in a managed rule group. // To use this, provide the vendor name and the name of the rule group in this // statement. You can retrieve the required names by calling // ListAvailableManagedRuleGroups. You can't nest a ManagedRuleGroupStatement, for // example for use inside a NotStatement or OrStatement. It can only be referenced // as a top-level statement within a rule. ManagedRuleGroupStatement *ManagedRuleGroupStatement // A rule statement used to run the rules that are defined in a RuleGroup. To use // this, create a rule group with your rules, then provide the ARN of the rule // group in this statement. You cannot nest a RuleGroupReferenceStatement, for // example for use inside a NotStatement or OrStatement. It can only be referenced // as a top-level statement within a rule. RuleGroupReferenceStatement *RuleGroupReferenceStatement }
The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
type ForwardedIPConfig ¶
type ForwardedIPConfig struct { // The match status to assign to the web request if the request doesn't have a // valid IP address in the specified position. If the specified header isn't // present in the request, AWS WAF doesn't apply the rule to the web request at // all. You can specify the following fallback behaviors: // // * MATCH - Treat the web // request as matching the rule statement. AWS WAF applies the rule action to the // request. // // * NO_MATCH - Treat the web request as not matching the rule statement. // // This member is required. FallbackBehavior FallbackBehavior // The name of the HTTP header to use for the IP address. For example, to use the // X-Forwarded-For (XFF) header, set this to X-Forwarded-For. If the specified // header isn't present in the request, AWS WAF doesn't apply the rule to the web // request at all. // // This member is required. HeaderName *string }
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead. AWS WAF only evaluates the first IP address found in the specified HTTP header.
type ForwardedIPPosition ¶
type ForwardedIPPosition string
const ( ForwardedIPPositionFirst ForwardedIPPosition = "FIRST" ForwardedIPPositionLast ForwardedIPPosition = "LAST" ForwardedIPPositionAny ForwardedIPPosition = "ANY" )
Enum values for ForwardedIPPosition
func (ForwardedIPPosition) Values ¶
func (ForwardedIPPosition) Values() []ForwardedIPPosition
Values returns all known values for ForwardedIPPosition. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type GeoMatchStatement ¶
type GeoMatchStatement struct { // An array of two-character country codes, for example, [ "US", "CN" ], from the // alpha-2 country ISO codes of the ISO 3166 international standard. CountryCodes []CountryCode // The configuration for inspecting IP addresses in an HTTP header that you // specify, instead of using the IP address that's reported by the web request // origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify // any header name. If the specified header isn't present in the request, AWS WAF // doesn't apply the rule to the web request at all. ForwardedIPConfig *ForwardedIPConfig }
A rule statement used to identify web requests based on country of origin.
type HTTPHeader ¶
type HTTPHeader struct { // The name of the HTTP header. Name *string // The value of the HTTP header. Value *string }
Part of the response from GetSampledRequests. This is a complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests.
type HTTPRequest ¶
type HTTPRequest struct { // The IP address that the request originated from. If the web ACL is associated // with a CloudFront distribution, this is the value of one of the following fields // in CloudFront access logs: // // * c-ip, if the viewer did not use an HTTP proxy or a // load balancer to send the request // // * x-forwarded-for, if the viewer did use an // HTTP proxy or a load balancer to send the request ClientIP *string // The two-letter country code for the country that the request originated from. // For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2 // (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Country *string // The HTTP version specified in the sampled web request, for example, HTTP/1.1. HTTPVersion *string // A complex type that contains the name and value for each header in the sampled // web request. Headers []HTTPHeader // The HTTP method specified in the sampled web request. Method *string // The URI path of the request, which identifies the resource, for example, // /images/daily-ad.jpg. URI *string }
Part of the response from GetSampledRequests. This is a complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests.
type IPAddressVersion ¶
type IPAddressVersion string
const ( IPAddressVersionIpv4 IPAddressVersion = "IPV4" IPAddressVersionIpv6 IPAddressVersion = "IPV6" )
Enum values for IPAddressVersion
func (IPAddressVersion) Values ¶
func (IPAddressVersion) Values() []IPAddressVersion
Values returns all known values for IPAddressVersion. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type IPSet ¶
type IPSet struct { // The Amazon Resource Name (ARN) of the entity. // // This member is required. ARN *string // Contains an array of strings that specify one or more IP addresses or blocks of // IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports // all IPv4 and IPv6 CIDR ranges except for /0. Examples: // // * To configure AWS WAF // to allow, block, or count requests that originated from the IP address // 192.0.2.44, specify 192.0.2.44/32. // // * To configure AWS WAF to allow, block, or // count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, // specify 192.0.2.0/24. // // * To configure AWS WAF to allow, block, or count requests // that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, // specify 1111:0000:0000:0000:0000:0000:0000:0111/128. // // * To configure AWS WAF to // allow, block, or count requests that originated from IP addresses // 1111:0000:0000:0000:0000:0000:0000:0000 to // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify // 1111:0000:0000:0000:0000:0000:0000:0000/64. // // For more information about CIDR // notation, see the Wikipedia entry Classless Inter-Domain Routing // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). // // This member is required. Addresses []string // Specify IPV4 or IPV6. // // This member is required. IPAddressVersion IPAddressVersion // A unique identifier for the set. This ID is returned in the responses to create // and list commands. You provide it to operations like update and delete. // // This member is required. Id *string // The name of the IP set. You cannot change the name of an IPSet after you create // it. // // This member is required. Name *string // A description of the IP set that helps with identification. Description *string }
Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). AWS WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.
type IPSetForwardedIPConfig ¶
type IPSetForwardedIPConfig struct { // The match status to assign to the web request if the request doesn't have a // valid IP address in the specified position. If the specified header isn't // present in the request, AWS WAF doesn't apply the rule to the web request at // all. You can specify the following fallback behaviors: // // * MATCH - Treat the web // request as matching the rule statement. AWS WAF applies the rule action to the // request. // // * NO_MATCH - Treat the web request as not matching the rule statement. // // This member is required. FallbackBehavior FallbackBehavior // The name of the HTTP header to use for the IP address. For example, to use the // X-Forwarded-For (XFF) header, set this to X-Forwarded-For. If the specified // header isn't present in the request, AWS WAF doesn't apply the rule to the web // request at all. // // This member is required. HeaderName *string // The position in the header to search for the IP address. The header can contain // IP addresses of the original client and also of proxies. For example, the header // value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address // identifies the original client and the rest identify proxies that the request // went through. The options for this setting are the following: // // * FIRST - Inspect // the first IP address in the list of IP addresses in the header. This is usually // the client's original IP. // // * LAST - Inspect the last IP address in the list of // IP addresses in the header. // // * ANY - Inspect all IP addresses in the header for // a match. If the header contains more than 10 IP addresses, AWS WAF inspects the // last 10. // // This member is required. Position ForwardedIPPosition }
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.
type IPSetReferenceStatement ¶
type IPSetReferenceStatement struct { // The Amazon Resource Name (ARN) of the IPSet that this statement references. // // This member is required. ARN *string // The configuration for inspecting IP addresses in an HTTP header that you // specify, instead of using the IP address that's reported by the web request // origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify // any header name. If the specified header isn't present in the request, AWS WAF // doesn't apply the rule to the web request at all. IPSetForwardedIPConfig *IPSetForwardedIPConfig }
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet. Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
type IPSetSummary ¶
type IPSetSummary struct { // The Amazon Resource Name (ARN) of the entity. ARN *string // A description of the IP set that helps with identification. Description *string // A unique identifier for the set. This ID is returned in the responses to create // and list commands. You provide it to operations like update and delete. Id *string // A token used for optimistic locking. AWS WAF returns a token to your get and // list requests, to mark the state of the entity at the time of the request. To // make changes to the entity associated with the token, you provide the token to // operations like update and delete. AWS WAF uses the token to ensure that no // changes have been made to the entity since you last retrieved it. If a change // has been made, the update fails with a WAFOptimisticLockException. If this // happens, perform another get, and use the new token returned by that operation. LockToken *string // The name of the IP set. You cannot change the name of an IPSet after you create // it. Name *string }
High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.
type JsonBody ¶
type JsonBody struct { // The patterns to look for in the JSON body. AWS WAF inspects the results of these // pattern matches against the rule inspection criteria. // // This member is required. MatchPattern *JsonMatchPattern // The parts of the JSON to match against using the MatchPattern. If you specify // All, AWS WAF matches against keys and values. // // This member is required. MatchScope JsonMatchScope // What AWS WAF should do if it fails to completely parse the JSON body. The // options are the following: // // * EVALUATE_AS_STRING - Inspect the body as plain // text. AWS WAF applies the text transformations and inspection criteria that you // defined for the JSON inspection to the body text string. // // * MATCH - Treat the // web request as matching the rule statement. AWS WAF applies the rule action to // the request. // // * NO_MATCH - Treat the web request as not matching the rule // statement. // // If you don't provide this setting, AWS WAF parses and evaluates the // content only up to the first parsing failure that it encounters. AWS WAF does // its best to parse the entire JSON body, but might be forced to stop for reasons // such as invalid characters, duplicate keys, truncation, and any content whose // root node isn't an object or an array. AWS WAF parses the JSON in the following // examples as two valid key, value pairs: // // * Missing comma: // {"key1":"value1""key2":"value2"} // // * Missing colon: // {"key1":"value1","key2""value2"} // // * Extra colons: // {"key1"::"value1","key2""value2"} InvalidFallbackBehavior BodyParsingFallbackBehavior }
The body of a web request, inspected as JSON. The body immediately follows the request headers. This is used in the FieldToMatch specification. Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. AWS WAF inspects only the parts of the JSON that result from the matches that you indicate.
type JsonMatchPattern ¶
type JsonMatchPattern struct { // Match all of the elements. See also MatchScope in JsonBody. You must specify // either this setting or the IncludedPaths setting, but not both. All *All // Match only the specified include paths. See also MatchScope in JsonBody. Provide // the include paths using JSON Pointer syntax. For example, "IncludedPaths": // ["/dogs/0/name", "/dogs/1/name"]. For information about this syntax, see the // Internet Engineering Task Force (IETF) documentation JavaScript Object Notation // (JSON) Pointer (https://tools.ietf.org/html/rfc6901). You must specify either // this setting or the All setting, but not both. Don't use this option to include // all paths. Instead, use the All setting. IncludedPaths []string }
The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.
type JsonMatchScope ¶
type JsonMatchScope string
const ( JsonMatchScopeAll JsonMatchScope = "ALL" JsonMatchScopeKey JsonMatchScope = "KEY" JsonMatchScopeValue JsonMatchScope = "VALUE" )
Enum values for JsonMatchScope
func (JsonMatchScope) Values ¶
func (JsonMatchScope) Values() []JsonMatchScope
Values returns all known values for JsonMatchScope. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type Label ¶
type Label struct { // The label string. // // This member is required. Name *string }
A single label container. This is used as an element of a label array in multiple contexts, for example, in RuleLabels inside a Rule and in Labels inside a SampledHTTPRequest.
type LabelMatchScope ¶
type LabelMatchScope string
const ( LabelMatchScopeLabel LabelMatchScope = "LABEL" LabelMatchScopeNamespace LabelMatchScope = "NAMESPACE" )
Enum values for LabelMatchScope
func (LabelMatchScope) Values ¶
func (LabelMatchScope) Values() []LabelMatchScope
Values returns all known values for LabelMatchScope. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type LabelMatchStatement ¶
type LabelMatchStatement struct { // The string to match against. The setting you provide for this depends on the // match statement's Scope settings: // // * If the Scope indicates LABEL, then this // specification must include the name and can include any number of preceding // namespace specifications and prefix up to providing the fully qualified label // name. // // * If the Scope indicates NAMESPACE, then this specification can include // any number of contiguous namespace strings, and can include the entire label // namespace prefix from the rule group or web ACL where the label // originates. // // Labels are case sensitive and components of a label must be // separated by colon, for example NS1:NS2:name. // // This member is required. Key *string // Specify whether you want to match using the label name or just the namespace. // // This member is required. Scope LabelMatchScope }
A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL. The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement.
type LabelNameCondition ¶
type LabelNameCondition struct { // The label name that a log record must contain in order to meet the condition. // This must be a fully qualified label name. Fully qualified labels have a prefix, // optional namespaces, and label name. The prefix identifies the rule group or web // ACL context of the rule that added the label. // // This member is required. LabelName *string }
A single label name condition for a Condition in a logging filter.
type LabelSummary ¶
type LabelSummary struct { // An individual label specification. Name *string }
List of labels used by one or more of the rules of a RuleGroup. This summary object is used for the following rule group lists:
* AvailableLabels - Labels that rules add to matching requests. These labels are defined in the RuleLabels for a Rule.
* ConsumedLabels - Labels that rules match against. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule.
type LoggingConfiguration ¶
type LoggingConfiguration struct { // The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to // associate with the web ACL. // // This member is required. LogDestinationConfigs []string // The Amazon Resource Name (ARN) of the web ACL that you want to associate with // LogDestinationConfigs. // // This member is required. ResourceArn *string // Filtering that specifies which web requests are kept in the logs and which are // dropped. You can filter on the rule action and on the web request labels that // were applied by matching rules during web ACL evaluation. LoggingFilter *LoggingFilter // Indicates whether the logging configuration was created by AWS Firewall Manager, // as part of an AWS WAF policy configuration. If true, only Firewall Manager can // modify or delete the configuration. ManagedByFirewallManager bool // The parts of the request that you want to keep out of the logs. For example, if // you redact the HEADER field, the HEADER field in the firehose will be xxx. You // must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD. RedactedFields []FieldToMatch }
Defines an association between Amazon Kinesis Data Firehose destinations and a web ACL resource, for logging from AWS WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records.
type LoggingFilter ¶
type LoggingFilter struct { // Default handling for logs that don't match any of the specified filtering // conditions. // // This member is required. DefaultBehavior FilterBehavior // The filters that you want to apply to the logs. // // This member is required. Filters []Filter }
Filtering that specifies which web requests are kept in the logs and which are dropped, defined for a web ACL's LoggingConfiguration. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.
type ManagedRuleGroupStatement ¶
type ManagedRuleGroupStatement struct { // The name of the managed rule group. You use this, along with the vendor name, to // identify the rule group. // // This member is required. Name *string // The name of the managed rule group vendor. You use this, along with the rule // group name, to identify the rule group. // // This member is required. VendorName *string // The rules whose actions are set to COUNT by the web ACL, regardless of the // action that is set on the rule. This effectively excludes the rule from acting // on web requests. ExcludedRules []ExcludedRule // The processing guidance for a Rule, used by AWS WAF to determine whether a web // request matches the rule. ScopeDownStatement *Statement }
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups. You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
type ManagedRuleGroupSummary ¶
type ManagedRuleGroupSummary struct { // The description of the managed rule group, provided by AWS Managed Rules or the // AWS Marketplace seller who manages it. Description *string // The name of the managed rule group. You use this, along with the vendor name, to // identify the rule group. Name *string // The name of the managed rule group vendor. You use this, along with the rule // group name, to identify the rule group. VendorName *string }
High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include AWS Managed Rules rule groups, which are free of charge to AWS WAF customers, and AWS Marketplace managed rule groups, which you can subscribe to through AWS Marketplace.
type Method ¶
type Method struct { }
The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform. This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
type NoneAction ¶
type NoneAction struct { }
Specifies that AWS WAF should do nothing. This is generally used to try out a rule without performing any actions. You set the OverrideAction on the Rule. This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
type NotStatement ¶
type NotStatement struct { // The statement to negate. You can use any statement that can be nested. // // This member is required. Statement *Statement }
A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.
type OrStatement ¶
type OrStatement struct { // The statements to combine with OR logic. You can use any statements that can be // nested. // // This member is required. Statements []Statement }
A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.
type OverrideAction ¶
type OverrideAction struct { // Override the rule action setting to count. Count *CountAction // Don't override the rule action setting. None *NoneAction }
The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement. Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings. In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:
* If the rule statement references a rule group, use this override action setting and not the action setting.
* If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.
type ParameterExceptionField ¶
type ParameterExceptionField string
const ( ParameterExceptionFieldWebAcl ParameterExceptionField = "WEB_ACL" ParameterExceptionFieldRuleGroup ParameterExceptionField = "RULE_GROUP" ParameterExceptionFieldRegexPatternSet ParameterExceptionField = "REGEX_PATTERN_SET" ParameterExceptionFieldIpSet ParameterExceptionField = "IP_SET" ParameterExceptionFieldManagedRuleSet ParameterExceptionField = "MANAGED_RULE_SET" ParameterExceptionFieldRule ParameterExceptionField = "RULE" ParameterExceptionFieldExcludedRule ParameterExceptionField = "EXCLUDED_RULE" ParameterExceptionFieldStatement ParameterExceptionField = "STATEMENT" ParameterExceptionFieldByteMatchStatement ParameterExceptionField = "BYTE_MATCH_STATEMENT" ParameterExceptionFieldSqliMatchStatement ParameterExceptionField = "SQLI_MATCH_STATEMENT" ParameterExceptionFieldXssMatchStatement ParameterExceptionField = "XSS_MATCH_STATEMENT" ParameterExceptionFieldSizeConstraintStatement ParameterExceptionField = "SIZE_CONSTRAINT_STATEMENT" ParameterExceptionFieldGeoMatchStatement ParameterExceptionField = "GEO_MATCH_STATEMENT" ParameterExceptionFieldRateBasedStatement ParameterExceptionField = "RATE_BASED_STATEMENT" ParameterExceptionFieldRuleGroupReferenceStatement ParameterExceptionField = "RULE_GROUP_REFERENCE_STATEMENT" ParameterExceptionFieldRegexPatternReferenceStatement ParameterExceptionField = "REGEX_PATTERN_REFERENCE_STATEMENT" ParameterExceptionFieldIpSetReferenceStatement ParameterExceptionField = "IP_SET_REFERENCE_STATEMENT" ParameterExceptionFieldManagedRuleSetStatement ParameterExceptionField = "MANAGED_RULE_SET_STATEMENT" ParameterExceptionFieldLabelMatchStatement ParameterExceptionField = "LABEL_MATCH_STATEMENT" ParameterExceptionFieldAndStatement ParameterExceptionField = "AND_STATEMENT" ParameterExceptionFieldOrStatement ParameterExceptionField = "OR_STATEMENT" ParameterExceptionFieldNotStatement ParameterExceptionField = "NOT_STATEMENT" ParameterExceptionFieldIpAddress ParameterExceptionField = "IP_ADDRESS" ParameterExceptionFieldIpAddressVersion ParameterExceptionField = "IP_ADDRESS_VERSION" ParameterExceptionFieldFieldToMatch ParameterExceptionField = "FIELD_TO_MATCH" ParameterExceptionFieldTextTransformation ParameterExceptionField = "TEXT_TRANSFORMATION" ParameterExceptionFieldSingleQueryArgument ParameterExceptionField = "SINGLE_QUERY_ARGUMENT" ParameterExceptionFieldSingleHeader ParameterExceptionField = "SINGLE_HEADER" ParameterExceptionFieldDefaultAction ParameterExceptionField = "DEFAULT_ACTION" ParameterExceptionFieldRuleAction ParameterExceptionField = "RULE_ACTION" ParameterExceptionFieldEntityLimit ParameterExceptionField = "ENTITY_LIMIT" ParameterExceptionFieldOverrideAction ParameterExceptionField = "OVERRIDE_ACTION" ParameterExceptionFieldScopeValue ParameterExceptionField = "SCOPE_VALUE" ParameterExceptionFieldResourceArn ParameterExceptionField = "RESOURCE_ARN" ParameterExceptionFieldResourceType ParameterExceptionField = "RESOURCE_TYPE" ParameterExceptionFieldTags ParameterExceptionField = "TAGS" ParameterExceptionFieldTagKeys ParameterExceptionField = "TAG_KEYS" ParameterExceptionFieldMetricName ParameterExceptionField = "METRIC_NAME" ParameterExceptionFieldFirewallManagerStatement ParameterExceptionField = "FIREWALL_MANAGER_STATEMENT" ParameterExceptionFieldFallbackBehavior ParameterExceptionField = "FALLBACK_BEHAVIOR" ParameterExceptionFieldPosition ParameterExceptionField = "POSITION" ParameterExceptionFieldForwardedIpConfig ParameterExceptionField = "FORWARDED_IP_CONFIG" ParameterExceptionFieldIpSetForwardedIpConfig ParameterExceptionField = "IP_SET_FORWARDED_IP_CONFIG" ParameterExceptionFieldHeaderName ParameterExceptionField = "HEADER_NAME" ParameterExceptionFieldCustomRequestHandling ParameterExceptionField = "CUSTOM_REQUEST_HANDLING" ParameterExceptionFieldResponseContentType ParameterExceptionField = "RESPONSE_CONTENT_TYPE" ParameterExceptionFieldCustomResponse ParameterExceptionField = "CUSTOM_RESPONSE" ParameterExceptionFieldCustomResponseBody ParameterExceptionField = "CUSTOM_RESPONSE_BODY" ParameterExceptionFieldJsonMatchPattern ParameterExceptionField = "JSON_MATCH_PATTERN" ParameterExceptionFieldJsonMatchScope ParameterExceptionField = "JSON_MATCH_SCOPE" ParameterExceptionFieldBodyParsingFallbackBehavior ParameterExceptionField = "BODY_PARSING_FALLBACK_BEHAVIOR" ParameterExceptionFieldLoggingFilter ParameterExceptionField = "LOGGING_FILTER" ParameterExceptionFieldFilterCondition ParameterExceptionField = "FILTER_CONDITION" )
Enum values for ParameterExceptionField
func (ParameterExceptionField) Values ¶
func (ParameterExceptionField) Values() []ParameterExceptionField
Values returns all known values for ParameterExceptionField. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type PositionalConstraint ¶
type PositionalConstraint string
const ( PositionalConstraintExactly PositionalConstraint = "EXACTLY" PositionalConstraintStartsWith PositionalConstraint = "STARTS_WITH" PositionalConstraintEndsWith PositionalConstraint = "ENDS_WITH" PositionalConstraintContains PositionalConstraint = "CONTAINS" PositionalConstraintContainsWord PositionalConstraint = "CONTAINS_WORD" )
Enum values for PositionalConstraint
func (PositionalConstraint) Values ¶
func (PositionalConstraint) Values() []PositionalConstraint
Values returns all known values for PositionalConstraint. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type QueryString ¶
type QueryString struct { }
The query string of a web request. This is the part of a URL that appears after a ? character, if any. This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
type RateBasedStatement ¶
type RateBasedStatement struct { // Setting that indicates how to aggregate the request counts. The options are the // following: // // * IP - Aggregate the request counts on the IP address from the web // request origin. // // * FORWARDED_IP - Aggregate the request counts on the first IP // address in an HTTP header. If you use this, configure the ForwardedIPConfig, to // specify the header to use. // // This member is required. AggregateKeyType RateBasedStatementAggregateKeyType // The limit on requests per 5-minute period for a single originating IP address. // If the statement includes a ScopeDownStatement, this limit is applied only to // the requests that match the statement. // // This member is required. Limit int64 // The configuration for inspecting IP addresses in an HTTP header that you // specify, instead of using the IP address that's reported by the web request // origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify // any header name. If the specified header isn't present in the request, AWS WAF // doesn't apply the rule to the web request at all. This is required if // AggregateKeyType is set to FORWARDED_IP. ForwardedIPConfig *ForwardedIPConfig // An optional nested statement that narrows the scope of the rate-based statement // to matching web requests. This can be any nestable statement, and you can nest // statements at any level below this scope-down statement. ScopeDownStatement *Statement }
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests. When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit. You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
* An IP match statement with an IP set that specified the address 192.0.2.44.
* A string match statement that searches in the User-Agent header for the string BadBot.
In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule. You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
type RateBasedStatementAggregateKeyType ¶
type RateBasedStatementAggregateKeyType string
const ( RateBasedStatementAggregateKeyTypeIp RateBasedStatementAggregateKeyType = "IP" RateBasedStatementAggregateKeyTypeForwardedIp RateBasedStatementAggregateKeyType = "FORWARDED_IP" )
Enum values for RateBasedStatementAggregateKeyType
func (RateBasedStatementAggregateKeyType) Values ¶
func (RateBasedStatementAggregateKeyType) Values() []RateBasedStatementAggregateKeyType
Values returns all known values for RateBasedStatementAggregateKeyType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type RateBasedStatementManagedKeysIPSet ¶
type RateBasedStatementManagedKeysIPSet struct { // The IP addresses that are currently blocked. Addresses []string IPAddressVersion IPAddressVersion }
The set of IP addresses that are currently blocked for a rate-based statement.
type Regex ¶
type Regex struct { // The string representing the regular expression. RegexString *string }
A single regular expression. This is used in a RegexPatternSet.
type RegexPatternSet ¶
type RegexPatternSet struct { // The Amazon Resource Name (ARN) of the entity. ARN *string // A description of the set that helps with identification. Description *string // A unique identifier for the set. This ID is returned in the responses to create // and list commands. You provide it to operations like update and delete. Id *string // The name of the set. You cannot change the name after you create the set. Name *string // The regular expression patterns in the set. RegularExpressionList []Regex }
Contains one or more regular expressions. AWS WAF assigns an ARN to each RegexPatternSet that you create. To use a set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.
type RegexPatternSetReferenceStatement ¶
type RegexPatternSetReferenceStatement struct { // The Amazon Resource Name (ARN) of the RegexPatternSet that this statement // references. // // This member is required. ARN *string // The part of a web request that you want AWS WAF to inspect. For more // information, see FieldToMatch. // // This member is required. FieldToMatch *FieldToMatch // Text transformations eliminate some of the unusual formatting that attackers use // in web requests in an effort to bypass detection. If you specify one or more // transformations in a rule statement, AWS WAF performs all transformations on the // content of the request component identified by FieldToMatch, starting from the // lowest priority setting, before inspecting the content for a match. // // This member is required. TextTransformations []TextTransformation }
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet. Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
type RegexPatternSetSummary ¶
type RegexPatternSetSummary struct { // The Amazon Resource Name (ARN) of the entity. ARN *string // A description of the set that helps with identification. Description *string // A unique identifier for the set. This ID is returned in the responses to create // and list commands. You provide it to operations like update and delete. Id *string // A token used for optimistic locking. AWS WAF returns a token to your get and // list requests, to mark the state of the entity at the time of the request. To // make changes to the entity associated with the token, you provide the token to // operations like update and delete. AWS WAF uses the token to ensure that no // changes have been made to the entity since you last retrieved it. If a change // has been made, the update fails with a WAFOptimisticLockException. If this // happens, perform another get, and use the new token returned by that operation. LockToken *string // The name of the data type instance. You cannot change the name after you create // the instance. Name *string }
High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.
type ResourceType ¶
type ResourceType string
const ( ResourceTypeApplicationLoadBalancer ResourceType = "APPLICATION_LOAD_BALANCER" ResourceTypeApiGateway ResourceType = "API_GATEWAY" ResourceTypeAppsync ResourceType = "APPSYNC" )
Enum values for ResourceType
func (ResourceType) Values ¶
func (ResourceType) Values() []ResourceType
Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ResponseContentType ¶
type ResponseContentType string
const ( ResponseContentTypeTextPlain ResponseContentType = "TEXT_PLAIN" ResponseContentTypeTextHtml ResponseContentType = "TEXT_HTML" ResponseContentTypeApplicationJson ResponseContentType = "APPLICATION_JSON" )
Enum values for ResponseContentType
func (ResponseContentType) Values ¶
func (ResponseContentType) Values() []ResponseContentType
Values returns all known values for ResponseContentType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type Rule ¶
type Rule struct { // The name of the rule. You can't change the name of a Rule after you create it. // // This member is required. Name *string // If you define more than one Rule in a WebACL, AWS WAF evaluates each request // against the Rules in order based on the value of Priority. AWS WAF processes // rules with lower priority first. The priorities don't need to be consecutive, // but they must all be different. // // This member is required. Priority int32 // The AWS WAF processing statement for the rule, for example ByteMatchStatement or // SizeConstraintStatement. // // This member is required. Statement *Statement // Defines and enables Amazon CloudWatch metrics and web request sample collection. // // This member is required. VisibilityConfig *VisibilityConfig // The action that AWS WAF should take on a web request when it matches the rule // statement. Settings at the web ACL level can override the rule action setting. // This is used only for rules whose statements do not reference a rule group. Rule // statements that reference a rule group include RuleGroupReferenceStatement and // ManagedRuleGroupStatement. You must specify either this Action setting or the // rule OverrideAction setting, but not both: // // * If the rule statement does not // reference a rule group, use this rule action setting and not the rule override // action setting. // // * If the rule statement references a rule group, use the // override action setting and not this action setting. Action *RuleAction // The override action to apply to the rules in a rule group. Used only for rule // statements that reference a rule group, like RuleGroupReferenceStatement and // ManagedRuleGroupStatement. Set the override action to none to leave the rule // actions in effect. Set it to count to only count matches, regardless of the rule // action settings. In a Rule, you must specify either this OverrideAction setting // or the rule Action setting, but not both: // // * If the rule statement references a // rule group, use this override action setting and not the action setting. // // * If // the rule statement does not reference a rule group, use the rule action setting // and not this rule override action setting. OverrideAction *OverrideAction // Labels to apply to web requests that match the rule match statement. AWS WAF // applies fully qualified labels to matching web requests. A fully qualified label // is the concatenation of a label namespace and a rule label. The rule's rule // group or web ACL defines the label namespace. Rules that run after this rule in // the web ACL can match against these labels using a LabelMatchStatement. For each // label, provide a case-sensitive string containing optional namespaces and a // label name, according to the following guidelines: // // * Separate each component of // the label with a colon. // // * Each namespace or name can have up to 128 // characters. // // * You can specify up to 5 namespaces in a label. // // * Don't use the // following reserved words in your label specification: aws, waf, managed, // rulegroup, webacl, regexpatternset, or ipset. // // For example, myLabelName or // nameSpace1:nameSpace2:myLabelName. RuleLabels []Label }
A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. Each rule includes one top-level Statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
type RuleAction ¶
type RuleAction struct { // Instructs AWS WAF to allow the web request. Allow *AllowAction // Instructs AWS WAF to block the web request. Block *BlockAction // Instructs AWS WAF to count the web request and allow it. Count *CountAction }
The action that AWS WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.
type RuleGroup ¶
type RuleGroup struct { // The Amazon Resource Name (ARN) of the entity. // // This member is required. ARN *string // The web ACL capacity units (WCUs) required for this rule group. When you create // your own rule group, you define this, and you cannot change it after creation. // When you add or modify the rules in a rule group, AWS WAF enforces this limit. // You can check the capacity for a set of rules using CheckCapacity. AWS WAF uses // WCUs to calculate and control the operating resources that are used to run your // rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for // each rule type, to reflect the relative cost of each rule. Simple rules that // cost little to run use fewer WCUs than more complex rules that use more // processing power. Rule group capacity is fixed at creation, which helps users // plan their web ACL WCU usage when they use a rule group. The WCU limit for web // ACLs is 1,500. // // This member is required. Capacity int64 // A unique identifier for the rule group. This ID is returned in the responses to // create and list commands. You provide it to operations like update and delete. // // This member is required. Id *string // The name of the rule group. You cannot change the name of a rule group after you // create it. // // This member is required. Name *string // Defines and enables Amazon CloudWatch metrics and web request sample collection. // // This member is required. VisibilityConfig *VisibilityConfig // The labels that one or more rules in this rule group add to matching web ACLs. // These labels are defined in the RuleLabels for a Rule. AvailableLabels []LabelSummary // The labels that one or more rules in this rule group match against in label // match statements. These labels are defined in a LabelMatchStatement // specification, in the Statement definition of a rule. ConsumedLabels []LabelSummary // A map of custom response keys and content bodies. When you create a rule with a // block action, you can send a custom response to the web request. You define // these for the rule group, and then use them in the rules that you define in the // rule group. For information about customizing web requests and responses, see // Customizing web requests and responses in AWS WAF // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) // in the AWS WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). For // information about the limits on count and size for custom request and response // settings, see AWS WAF quotas // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS // WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). CustomResponseBodies map[string]CustomResponseBody // A description of the rule group that helps with identification. Description *string // The label namespace prefix for this rule group. All labels added by rules in // this rule group have this prefix. // // * The syntax for the label namespace prefix // for your rule groups is the following: awswaf::rulegroup:: // // * When a rule with a // label matches a web request, AWS WAF adds the fully qualified label to the // request. A fully qualified label is made up of the label namespace from the rule // group or web ACL where the rule is defined and the label from the rule, // separated by a colon: : LabelNamespace *string // The Rule statements used to identify the web requests that you want to allow, // block, or count. Each rule includes one top-level statement that AWS WAF uses to // identify matching web requests, and parameters that govern how AWS WAF handles // them. Rules []Rule }
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
type RuleGroupReferenceStatement ¶
type RuleGroupReferenceStatement struct { // The Amazon Resource Name (ARN) of the entity. // // This member is required. ARN *string // The names of rules that are in the referenced rule group, but that you want AWS // WAF to exclude from processing for this rule statement. ExcludedRules []ExcludedRule }
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement. You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.
type RuleGroupSummary ¶
type RuleGroupSummary struct { // The Amazon Resource Name (ARN) of the entity. ARN *string // A description of the rule group that helps with identification. Description *string // A unique identifier for the rule group. This ID is returned in the responses to // create and list commands. You provide it to operations like update and delete. Id *string // A token used for optimistic locking. AWS WAF returns a token to your get and // list requests, to mark the state of the entity at the time of the request. To // make changes to the entity associated with the token, you provide the token to // operations like update and delete. AWS WAF uses the token to ensure that no // changes have been made to the entity since you last retrieved it. If a change // has been made, the update fails with a WAFOptimisticLockException. If this // happens, perform another get, and use the new token returned by that operation. LockToken *string // The name of the data type instance. You cannot change the name after you create // the instance. Name *string }
High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.
type RuleSummary ¶
type RuleSummary struct { // The action that AWS WAF should take on a web request when it matches a rule's // statement. Settings at the web ACL level can override the rule action setting. Action *RuleAction // The name of the rule. Name *string }
High-level information about a Rule, returned by operations like DescribeManagedRuleGroup. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.
type SampledHTTPRequest ¶
type SampledHTTPRequest struct { // A complex type that contains detailed information about the request. // // This member is required. Request *HTTPRequest // A value that indicates how one result in the response relates proportionally to // other results in the response. For example, a result that has a weight of 2 // represents roughly twice as many web requests as a result that has a weight of // 1. // // This member is required. Weight int64 // The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT. Action *string // Labels applied to the web request by matching rules. AWS WAF applies fully // qualified labels to matching web requests. A fully qualified label is the // concatenation of a label namespace and a rule label. The rule's rule group or // web ACL defines the label namespace. For example, // awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or // awswaf:managed:aws:managed-rule-set:header:encoding:utf8. Labels []Label // Custom request headers inserted by AWS WAF into the request, according to the // custom request configuration for the matching rule action. RequestHeadersInserted []HTTPHeader // The response code that was sent for the request. ResponseCodeSent *int32 // The name of the Rule that the request matched. For managed rule groups, the // format for this name is ##. For your own rule groups, the format for this name // is #. If the rule is not in a rule group, this field is absent. RuleNameWithinRuleGroup *string // The time at which AWS WAF received the request from your AWS resource, in Unix // time format (in seconds). Timestamp *time.Time }
Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains an array of SampledHTTPRequest objects.
type Scope ¶
type Scope string
Enum values for Scope
func (Scope) Values ¶
Values returns all known values for Scope. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type SingleHeader ¶
type SingleHeader struct { // The name of the query header to inspect. // // This member is required. Name *string }
One of the headers in a web request, identified by name, for example, User-Agent or Referer. This setting isn't case sensitive. This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
type SingleQueryArgument ¶
type SingleQueryArgument struct { // The name of the query argument to inspect. // // This member is required. Name *string }
One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
type SizeConstraintStatement ¶
type SizeConstraintStatement struct { // The operator to use to compare the request part to the size setting. // // This member is required. ComparisonOperator ComparisonOperator // The part of a web request that you want AWS WAF to inspect. For more // information, see FieldToMatch. // // This member is required. FieldToMatch *FieldToMatch // The size, in byte, to compare to the request part, after any transformations. // // This member is required. Size int64 // Text transformations eliminate some of the unusual formatting that attackers use // in web requests in an effort to bypass detection. If you specify one or more // transformations in a rule statement, AWS WAF performs all transformations on the // content of the request component identified by FieldToMatch, starting from the // lowest priority setting, before inspecting the content for a match. // // This member is required. TextTransformations []TextTransformation }
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
type SqliMatchStatement ¶
type SqliMatchStatement struct { // The part of a web request that you want AWS WAF to inspect. For more // information, see FieldToMatch. // // This member is required. FieldToMatch *FieldToMatch // Text transformations eliminate some of the unusual formatting that attackers use // in web requests in an effort to bypass detection. If you specify one or more // transformations in a rule statement, AWS WAF performs all transformations on the // content of the request component identified by FieldToMatch, starting from the // lowest priority setting, before inspecting the content for a match. // // This member is required. TextTransformations []TextTransformation }
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
type Statement ¶
type Statement struct { // A logical rule statement used to combine other rule statements with AND logic. // You provide more than one Statement within the AndStatement. AndStatement *AndStatement // A rule statement that defines a string match search for AWS WAF to apply to web // requests. The byte match statement provides the bytes to search for, the // location in requests that you want AWS WAF to search, and other settings. The // bytes to search for are typically a string that corresponds with ASCII // characters. In the AWS WAF console and the developer guide, this is refered to // as a string match statement. ByteMatchStatement *ByteMatchStatement // A rule statement used to identify web requests based on country of origin. GeoMatchStatement *GeoMatchStatement // A rule statement used to detect web requests coming from particular IP addresses // or address ranges. To use this, create an IPSet that specifies the addresses you // want to detect, then use the ARN of that set in this statement. To create an IP // set, see CreateIPSet. Each IP set rule statement references an IP set. You // create and maintain the set independent of your rules. This allows you to use // the single set in multiple rules. When you update the referenced set, AWS WAF // automatically updates all rules that reference it. IPSetReferenceStatement *IPSetReferenceStatement // A rule statement that defines a string match search against labels that have // been added to the web request by rules that have already run in the web ACL. The // label match statement provides the label or namespace string to search for. The // label string can represent a part or all of the fully qualified label name that // had been added to the web request. Fully qualified labels have a prefix, // optional namespaces, and label name. The prefix identifies the rule group or web // ACL context of the rule that added the label. If you do not provide the fully // qualified name in your label match string, AWS WAF performs the search for // labels that were added in the same context as the label match statement. LabelMatchStatement *LabelMatchStatement // A rule statement used to run the rules that are defined in a managed rule group. // To use this, provide the vendor name and the name of the rule group in this // statement. You can retrieve the required names by calling // ListAvailableManagedRuleGroups. You can't nest a ManagedRuleGroupStatement, for // example for use inside a NotStatement or OrStatement. It can only be referenced // as a top-level statement within a rule. ManagedRuleGroupStatement *ManagedRuleGroupStatement // A logical rule statement used to negate the results of another rule statement. // You provide one Statement within the NotStatement. NotStatement *NotStatement // A logical rule statement used to combine other rule statements with OR logic. // You provide more than one Statement within the OrStatement. OrStatement *OrStatement // A rate-based rule tracks the rate of requests for each originating IP address, // and triggers the rule action when the rate exceeds a limit that you specify on // the number of requests in any 5-minute time span. You can use this to put a // temporary block on requests from an IP address that is sending excessive // requests. When the rule action triggers, AWS WAF blocks additional requests from // the IP address until the request rate falls below the limit. You can optionally // nest another statement inside the rate-based statement, to narrow the scope of // the rule so that it only counts requests that match the nested statement. For // example, based on recent requests that you have seen from an attacker, you might // create a rate-based rule with a nested AND rule statement that contains the // following nested statements: // // * An IP match statement with an IP set that // specified the address 192.0.2.44. // // * A string match statement that searches in // the User-Agent header for the string BadBot. // // In this rate-based rule, you also // define a rate limit. For this example, the rate limit is 1,000. Requests that // meet both of the conditions in the statements are counted. If the count exceeds // 1,000 requests per five minutes, the rule action triggers. Requests that do not // meet both conditions are not counted towards the rate limit and are not affected // by this rule. You cannot nest a RateBasedStatement, for example for use inside a // NotStatement or OrStatement. It can only be referenced as a top-level statement // within a rule. RateBasedStatement *RateBasedStatement // A rule statement used to search web request components for matches with regular // expressions. To use this, create a RegexPatternSet that specifies the // expressions that you want to detect, then use the ARN of that set in this // statement. A web request matches the pattern set rule statement if the request // component matches any of the patterns in the set. To create a regex pattern set, // see CreateRegexPatternSet. Each regex pattern set rule statement references a // regex pattern set. You create and maintain the set independent of your rules. // This allows you to use the single set in multiple rules. When you update the // referenced set, AWS WAF automatically updates all rules that reference it. RegexPatternSetReferenceStatement *RegexPatternSetReferenceStatement // A rule statement used to run the rules that are defined in a RuleGroup. To use // this, create a rule group with your rules, then provide the ARN of the rule // group in this statement. You cannot nest a RuleGroupReferenceStatement, for // example for use inside a NotStatement or OrStatement. It can only be referenced // as a top-level statement within a rule. RuleGroupReferenceStatement *RuleGroupReferenceStatement // A rule statement that compares a number of bytes against the size of a request // component, using a comparison operator, such as greater than (>) or less than // (<). For example, you can use a size constraint statement to look for query // strings that are longer than 100 bytes. If you configure AWS WAF to inspect the // request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request // body for your web requests never exceeds 8192 bytes, you can create a size // constraint condition and block requests that have a request body greater than // 8192 bytes. If you choose URI for the value of Part of the request to filter on, // the slash (/) in the URI counts as one character. For example, the URI /logo.jpg // is nine characters long. SizeConstraintStatement *SizeConstraintStatement // Attackers sometimes insert malicious SQL code into web requests in an effort to // extract data from your database. To allow or block web requests that appear to // contain malicious SQL code, create one or more SQL injection match conditions. // An SQL injection match condition identifies the part of web requests, such as // the URI or the query string, that you want AWS WAF to inspect. Later in the // process, when you create a web ACL, you specify whether to allow or block // requests that appear to contain malicious SQL code. SqliMatchStatement *SqliMatchStatement // A rule statement that defines a cross-site scripting (XSS) match search for AWS // WAF to apply to web requests. XSS attacks are those where the attacker uses // vulnerabilities in a benign website as a vehicle to inject malicious client-site // scripts into other legitimate web browsers. The XSS match statement provides the // location in requests that you want AWS WAF to search and text transformations to // use on the search area before AWS WAF searches for character sequences that are // likely to be malicious strings. XssMatchStatement *XssMatchStatement }
The processing guidance for a Rule, used by AWS WAF to determine whether a web request matches the rule.
type Tag ¶
type Tag struct { // Part of the key:value pair that defines a tag. You can use a tag key to describe // a category of information, such as "customer." Tag keys are case-sensitive. // // This member is required. Key *string // Part of the key:value pair that defines a tag. You can use a tag value to // describe a specific value within a category, such as "companyA" or "companyB." // Tag values are case-sensitive. // // This member is required. Value *string }
A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.
type TagInfoForResource ¶
type TagInfoForResource struct { // The Amazon Resource Name (ARN) of the resource. ResourceARN *string // The array of Tag objects defined for the resource. TagList []Tag }
The collection of tagging definitions for an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.
type TextTransformation ¶
type TextTransformation struct { // Sets the relative processing order for multiple transformations that are defined // for a rule statement. AWS WAF processes all transformations, from lowest // priority to highest, before inspecting the transformed content. The priorities // don't need to be consecutive, but they must all be different. // // This member is required. Priority int32 // You can specify the following transformation types: CMD_LINE When you're // concerned that attackers are injecting an operating system command line command // and using unusual formatting to disguise some or all of the command, use this // option to perform the following transformations: // // * Delete the following // characters: \ " ' ^ // // * Delete spaces before the following characters: / ( // // * // Replace the following characters with a space: , ; // // * Replace multiple spaces // with one space // // * Convert uppercase letters (A-Z) to lowercase // (a-z) // // COMPRESS_WHITE_SPACE Use this option to replace the following characters // with a space character (decimal 32): // // * \f, formfeed, decimal 12 // // * \t, tab, // decimal 9 // // * \n, newline, decimal 10 // // * \r, carriage return, decimal 13 // // * \v, // vertical tab, decimal 11 // // * non-breaking space, decimal // 160 // // COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. // HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with // unencoded characters. HTML_ENTITY_DECODE performs the following operations: // // * // Replaces (ampersand)quot; with " // // * Replaces (ampersand)nbsp; with a // non-breaking space, decimal 160 // // * Replaces (ampersand)lt; with a "less than" // symbol // // * Replaces (ampersand)gt; with > // // * Replaces characters that are // represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding // characters // // * Replaces characters that are represented in decimal format, // (ampersand)#nnnn;, with the corresponding characters // // LOWERCASE Use this option // to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this // option to decode a URL-encoded value. NONE Specify NONE if you don't want any // text transformations. // // This member is required. Type TextTransformationType }
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
type TextTransformationType ¶
type TextTransformationType string
const ( TextTransformationTypeNone TextTransformationType = "NONE" TextTransformationTypeCompressWhiteSpace TextTransformationType = "COMPRESS_WHITE_SPACE" TextTransformationTypeHtmlEntityDecode TextTransformationType = "HTML_ENTITY_DECODE" TextTransformationTypeLowercase TextTransformationType = "LOWERCASE" TextTransformationTypeCmdLine TextTransformationType = "CMD_LINE" TextTransformationTypeUrlDecode TextTransformationType = "URL_DECODE" )
Enum values for TextTransformationType
func (TextTransformationType) Values ¶
func (TextTransformationType) Values() []TextTransformationType
Values returns all known values for TextTransformationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type TimeWindow ¶
type TimeWindow struct { // The end of the time range from which you want GetSampledRequests to return a // sample of the requests that your AWS resource received. You must specify the // times in Coordinated Universal Time (UTC) format. UTC format includes the // special designator, Z. For example, "2016-09-27T14:50Z". You can specify any // time range in the previous three hours. // // This member is required. EndTime *time.Time // The beginning of the time range from which you want GetSampledRequests to return // a sample of the requests that your AWS resource received. You must specify the // times in Coordinated Universal Time (UTC) format. UTC format includes the // special designator, Z. For example, "2016-09-27T14:50Z". You can specify any // time range in the previous three hours. // // This member is required. StartTime *time.Time }
In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request.
type UriPath ¶
type UriPath struct { }
The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
type VisibilityConfig ¶
type VisibilityConfig struct { // A boolean indicating whether the associated resource sends metrics to // CloudWatch. For the list of available metrics, see AWS WAF Metrics // (https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics). // // This member is required. CloudWatchMetricsEnabled bool // A name of the CloudWatch metric. The name can contain only the characters: A-Z, // a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 // characters long. It can't contain whitespace or metric names reserved for AWS // WAF, for example "All" and "Default_Action." // // This member is required. MetricName *string // A boolean indicating whether AWS WAF should store a sampling of the web requests // that match the rules. You can view the sampled requests through the AWS WAF // console. // // This member is required. SampledRequestsEnabled bool }
Defines and enables Amazon CloudWatch metrics and web request sample collection.
type WAFAssociatedItemException ¶
type WAFAssociatedItemException struct { Message *string }
AWS WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
func (*WAFAssociatedItemException) Error ¶
func (e *WAFAssociatedItemException) Error() string
func (*WAFAssociatedItemException) ErrorCode ¶
func (e *WAFAssociatedItemException) ErrorCode() string
func (*WAFAssociatedItemException) ErrorFault ¶
func (e *WAFAssociatedItemException) ErrorFault() smithy.ErrorFault
func (*WAFAssociatedItemException) ErrorMessage ¶
func (e *WAFAssociatedItemException) ErrorMessage() string
type WAFDuplicateItemException ¶
type WAFDuplicateItemException struct { Message *string }
AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
func (*WAFDuplicateItemException) Error ¶
func (e *WAFDuplicateItemException) Error() string
func (*WAFDuplicateItemException) ErrorCode ¶
func (e *WAFDuplicateItemException) ErrorCode() string
func (*WAFDuplicateItemException) ErrorFault ¶
func (e *WAFDuplicateItemException) ErrorFault() smithy.ErrorFault
func (*WAFDuplicateItemException) ErrorMessage ¶
func (e *WAFDuplicateItemException) ErrorMessage() string
type WAFInternalErrorException ¶
type WAFInternalErrorException struct { Message *string }
Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request.
func (*WAFInternalErrorException) Error ¶
func (e *WAFInternalErrorException) Error() string
func (*WAFInternalErrorException) ErrorCode ¶
func (e *WAFInternalErrorException) ErrorCode() string
func (*WAFInternalErrorException) ErrorFault ¶
func (e *WAFInternalErrorException) ErrorFault() smithy.ErrorFault
func (*WAFInternalErrorException) ErrorMessage ¶
func (e *WAFInternalErrorException) ErrorMessage() string
type WAFInvalidOperationException ¶
type WAFInvalidOperationException struct { Message *string }
The operation isn't valid.
func (*WAFInvalidOperationException) Error ¶
func (e *WAFInvalidOperationException) Error() string
func (*WAFInvalidOperationException) ErrorCode ¶
func (e *WAFInvalidOperationException) ErrorCode() string
func (*WAFInvalidOperationException) ErrorFault ¶
func (e *WAFInvalidOperationException) ErrorFault() smithy.ErrorFault
func (*WAFInvalidOperationException) ErrorMessage ¶
func (e *WAFInvalidOperationException) ErrorMessage() string
type WAFInvalidParameterException ¶
type WAFInvalidParameterException struct { Message *string Field ParameterExceptionField Parameter *string Reason *string }
The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
* You specified an invalid parameter name or value.
* Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
* You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.
* Your request references an ARN that is malformed, or corresponds to a resource with which a Web ACL cannot be associated.
func (*WAFInvalidParameterException) Error ¶
func (e *WAFInvalidParameterException) Error() string
func (*WAFInvalidParameterException) ErrorCode ¶
func (e *WAFInvalidParameterException) ErrorCode() string
func (*WAFInvalidParameterException) ErrorFault ¶
func (e *WAFInvalidParameterException) ErrorFault() smithy.ErrorFault
func (*WAFInvalidParameterException) ErrorMessage ¶
func (e *WAFInvalidParameterException) ErrorMessage() string
type WAFInvalidPermissionPolicyException ¶
type WAFInvalidPermissionPolicyException struct { Message *string }
The operation failed because the specified policy isn't in the proper format. The policy specifications must conform to the following:
* The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
* The policy must include specifications for Effect, Action, and Principal.
* Effect must specify Allow.
* Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups. AWS WAF rejects any extra actions or wildcard actions in the policy.
* The policy must not include a Resource parameter.
For more information, see IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html).
func (*WAFInvalidPermissionPolicyException) Error ¶
func (e *WAFInvalidPermissionPolicyException) Error() string
func (*WAFInvalidPermissionPolicyException) ErrorCode ¶
func (e *WAFInvalidPermissionPolicyException) ErrorCode() string
func (*WAFInvalidPermissionPolicyException) ErrorFault ¶
func (e *WAFInvalidPermissionPolicyException) ErrorFault() smithy.ErrorFault
func (*WAFInvalidPermissionPolicyException) ErrorMessage ¶
func (e *WAFInvalidPermissionPolicyException) ErrorMessage() string
type WAFInvalidResourceException ¶
type WAFInvalidResourceException struct { Message *string }
AWS WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
func (*WAFInvalidResourceException) Error ¶
func (e *WAFInvalidResourceException) Error() string
func (*WAFInvalidResourceException) ErrorCode ¶
func (e *WAFInvalidResourceException) ErrorCode() string
func (*WAFInvalidResourceException) ErrorFault ¶
func (e *WAFInvalidResourceException) ErrorFault() smithy.ErrorFault
func (*WAFInvalidResourceException) ErrorMessage ¶
func (e *WAFInvalidResourceException) ErrorMessage() string
type WAFLimitsExceededException ¶
type WAFLimitsExceededException struct { Message *string }
AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS WAF Developer Guide.
func (*WAFLimitsExceededException) Error ¶
func (e *WAFLimitsExceededException) Error() string
func (*WAFLimitsExceededException) ErrorCode ¶
func (e *WAFLimitsExceededException) ErrorCode() string
func (*WAFLimitsExceededException) ErrorFault ¶
func (e *WAFLimitsExceededException) ErrorFault() smithy.ErrorFault
func (*WAFLimitsExceededException) ErrorMessage ¶
func (e *WAFLimitsExceededException) ErrorMessage() string
type WAFNonexistentItemException ¶
type WAFNonexistentItemException struct { Message *string }
AWS WAF couldn’t perform the operation because your resource doesn’t exist.
func (*WAFNonexistentItemException) Error ¶
func (e *WAFNonexistentItemException) Error() string
func (*WAFNonexistentItemException) ErrorCode ¶
func (e *WAFNonexistentItemException) ErrorCode() string
func (*WAFNonexistentItemException) ErrorFault ¶
func (e *WAFNonexistentItemException) ErrorFault() smithy.ErrorFault
func (*WAFNonexistentItemException) ErrorMessage ¶
func (e *WAFNonexistentItemException) ErrorMessage() string
type WAFOptimisticLockException ¶
type WAFOptimisticLockException struct { Message *string }
AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
func (*WAFOptimisticLockException) Error ¶
func (e *WAFOptimisticLockException) Error() string
func (*WAFOptimisticLockException) ErrorCode ¶
func (e *WAFOptimisticLockException) ErrorCode() string
func (*WAFOptimisticLockException) ErrorFault ¶
func (e *WAFOptimisticLockException) ErrorFault() smithy.ErrorFault
func (*WAFOptimisticLockException) ErrorMessage ¶
func (e *WAFOptimisticLockException) ErrorMessage() string
type WAFServiceLinkedRoleErrorException ¶
type WAFServiceLinkedRoleErrorException struct { Message *string }
AWS WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a call to DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.
func (*WAFServiceLinkedRoleErrorException) Error ¶
func (e *WAFServiceLinkedRoleErrorException) Error() string
func (*WAFServiceLinkedRoleErrorException) ErrorCode ¶
func (e *WAFServiceLinkedRoleErrorException) ErrorCode() string
func (*WAFServiceLinkedRoleErrorException) ErrorFault ¶
func (e *WAFServiceLinkedRoleErrorException) ErrorFault() smithy.ErrorFault
func (*WAFServiceLinkedRoleErrorException) ErrorMessage ¶
func (e *WAFServiceLinkedRoleErrorException) ErrorMessage() string
type WAFSubscriptionNotFoundException ¶
type WAFSubscriptionNotFoundException struct { Message *string }
You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
func (*WAFSubscriptionNotFoundException) Error ¶
func (e *WAFSubscriptionNotFoundException) Error() string
func (*WAFSubscriptionNotFoundException) ErrorCode ¶
func (e *WAFSubscriptionNotFoundException) ErrorCode() string
func (*WAFSubscriptionNotFoundException) ErrorFault ¶
func (e *WAFSubscriptionNotFoundException) ErrorFault() smithy.ErrorFault
func (*WAFSubscriptionNotFoundException) ErrorMessage ¶
func (e *WAFSubscriptionNotFoundException) ErrorMessage() string
type WAFTagOperationException ¶
type WAFTagOperationException struct { Message *string }
An error occurred during the tagging operation. Retry your request.
func (*WAFTagOperationException) Error ¶
func (e *WAFTagOperationException) Error() string
func (*WAFTagOperationException) ErrorCode ¶
func (e *WAFTagOperationException) ErrorCode() string
func (*WAFTagOperationException) ErrorFault ¶
func (e *WAFTagOperationException) ErrorFault() smithy.ErrorFault
func (*WAFTagOperationException) ErrorMessage ¶
func (e *WAFTagOperationException) ErrorMessage() string
type WAFTagOperationInternalErrorException ¶
type WAFTagOperationInternalErrorException struct { Message *string }
AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
func (*WAFTagOperationInternalErrorException) Error ¶
func (e *WAFTagOperationInternalErrorException) Error() string
func (*WAFTagOperationInternalErrorException) ErrorCode ¶
func (e *WAFTagOperationInternalErrorException) ErrorCode() string
func (*WAFTagOperationInternalErrorException) ErrorFault ¶
func (e *WAFTagOperationInternalErrorException) ErrorFault() smithy.ErrorFault
func (*WAFTagOperationInternalErrorException) ErrorMessage ¶
func (e *WAFTagOperationInternalErrorException) ErrorMessage() string
type WAFUnavailableEntityException ¶
type WAFUnavailableEntityException struct { string }*
AWS WAF couldn’t retrieve the resource that you requested. Retry your request.
func (*WAFUnavailableEntityException) Error ¶
func (e *WAFUnavailableEntityException) Error() string
func (*WAFUnavailableEntityException) ErrorCode ¶
func (e *WAFUnavailableEntityException) ErrorCode() string
func (*WAFUnavailableEntityException) ErrorFault ¶
func (e *WAFUnavailableEntityException) ErrorFault() smithy.ErrorFault
func (*WAFUnavailableEntityException) ErrorMessage ¶
func (e *WAFUnavailableEntityException) ErrorMessage() string
type WebACL ¶
type WebACL struct { // The Amazon Resource Name (ARN) of the Web ACL that you want to associate with // the resource. // // This member is required. ARN *string // The action to perform if none of the Rules contained in the WebACL match. // // This member is required. DefaultAction *DefaultAction // A unique identifier for the WebACL. This ID is returned in the responses to // create and list commands. You use this ID to do things like get, update, and // delete a WebACL. // // This member is required. Id *string // The name of the Web ACL. You cannot change the name of a Web ACL after you // create it. // // This member is required. Name *string // Defines and enables Amazon CloudWatch metrics and web request sample collection. // // This member is required. VisibilityConfig *VisibilityConfig // The web ACL capacity units (WCUs) currently being used by this web ACL. AWS WAF // uses WCUs to calculate and control the operating resources that are used to run // your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently // for each rule type, to reflect the relative cost of each rule. Simple rules that // cost little to run use fewer WCUs than more complex rules that use more // processing power. Rule group capacity is fixed at creation, which helps users // plan their web ACL WCU usage when they use a rule group. The WCU limit for web // ACLs is 1,500. Capacity int64 // A map of custom response keys and content bodies. When you create a rule with a // block action, you can send a custom response to the web request. You define // these for the web ACL, and then use them in the rules and default actions that // you define in the web ACL. For information about customizing web requests and // responses, see Customizing web requests and responses in AWS WAF // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) // in the AWS WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). For // information about the limits on count and size for custom request and response // settings, see AWS WAF quotas // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the AWS // WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). CustomResponseBodies map[string]CustomResponseBody // A description of the Web ACL that helps with identification. Description *string // The label namespace prefix for this web ACL. All labels added by rules in this // web ACL have this prefix. // // * The syntax for the label namespace prefix for a web // ACL is the following: awswaf::webacl:: // // * When a rule with a label matches a web // request, AWS WAF adds the fully qualified label to the request. A fully // qualified label is made up of the label namespace from the rule group or web ACL // where the rule is defined and the label from the rule, separated by a colon: : LabelNamespace *string // Indicates whether this web ACL is managed by AWS Firewall Manager. If true, then // only AWS Firewall Manager can delete the web ACL or any Firewall Manager rule // groups in the web ACL. ManagedByFirewallManager bool // The last set of rules for AWS WAF to process in the web ACL. This is defined in // an AWS Firewall Manager WAF policy and contains only rule group references. You // can't alter these. Any rules and rule groups that you define for the web ACL are // prioritized before these. In the Firewall Manager WAF policy, the Firewall // Manager administrator can define a set of rule groups to run first in the web // ACL and a set of rule groups to run last. Within each set, the administrator // prioritizes the rule groups, to determine their relative processing order. PostProcessFirewallManagerRuleGroups []FirewallManagerRuleGroup // The first set of rules for AWS WAF to process in the web ACL. This is defined in // an AWS Firewall Manager WAF policy and contains only rule group references. You // can't alter these. Any rules and rule groups that you define for the web ACL are // prioritized after these. In the Firewall Manager WAF policy, the Firewall // Manager administrator can define a set of rule groups to run first in the web // ACL and a set of rule groups to run last. Within each set, the administrator // prioritizes the rule groups, to determine their relative processing order. PreProcessFirewallManagerRuleGroups []FirewallManagerRuleGroup // The Rule statements used to identify the web requests that you want to allow, // block, or count. Each rule includes one top-level statement that AWS WAF uses to // identify matching web requests, and parameters that govern how AWS WAF handles // them. Rules []Rule }
A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.
type WebACLSummary ¶
type WebACLSummary struct { // The Amazon Resource Name (ARN) of the entity. ARN *string // A description of the Web ACL that helps with identification. Description *string // The unique identifier for the Web ACL. This ID is returned in the responses to // create and list commands. You provide it to operations like update and delete. Id *string // A token used for optimistic locking. AWS WAF returns a token to your get and // list requests, to mark the state of the entity at the time of the request. To // make changes to the entity associated with the token, you provide the token to // operations like update and delete. AWS WAF uses the token to ensure that no // changes have been made to the entity since you last retrieved it. If a change // has been made, the update fails with a WAFOptimisticLockException. If this // happens, perform another get, and use the new token returned by that operation. LockToken *string // The name of the Web ACL. You cannot change the name of a Web ACL after you // create it. Name *string }
High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.
type XssMatchStatement ¶
type XssMatchStatement struct { // The part of a web request that you want AWS WAF to inspect. For more // information, see FieldToMatch. // // This member is required. FieldToMatch *FieldToMatch // Text transformations eliminate some of the unusual formatting that attackers use // in web requests in an effort to bypass detection. If you specify one or more // transformations in a rule statement, AWS WAF performs all transformations on the // content of the request component identified by FieldToMatch, starting from the // lowest priority setting, before inspecting the content for a match. // // This member is required. TextTransformations []TextTransformation }
A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
Source Files ¶
- Version
- v1.5.0
- Published
- May 14, 2021
- Platform
- js/wasm
- Imports
- 3 packages
- Last checked
- 3 hours ago –
Tools for package owners.