types

package
v1.25.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 18, 2024 License: Apache-2.0 Imports: 4 Imported by: 9

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivatedRule

type ActivatedRule struct {

	// Specifies the order in which the Rules in a WebACL are evaluated. Rules with a
	// lower value for Priority are evaluated before Rules with a higher value. The
	// value must be a unique integer. If you add multiple Rules to a WebACL , the
	// values don't need to be consecutive.
	//
	// This member is required.
	Priority *int32

	// The RuleId for a Rule . You use RuleId to get more information about a Rule
	// (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from
	// a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
	//
	// RuleId is returned by CreateRule and by ListRules.
	//
	// This member is required.
	RuleId *string

	// Specifies the action that CloudFront or AWS WAF takes when a web request
	// matches the conditions in the Rule . Valid values for Action include the
	// following:
	//
	//   - ALLOW : CloudFront responds with the requested object.
	//
	//   - BLOCK : CloudFront responds with an HTTP 403 (Forbidden) status code.
	//
	//   - COUNT : AWS WAF increments a counter of requests that match the conditions
	//   in the rule and then continues to inspect the web request based on the remaining
	//   rules in the web ACL.
	//
	// ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup
	// to a WebACL . In this case, you do not use ActivatedRule|Action . For all other
	// update requests, ActivatedRule|Action is used instead of
	// ActivatedRule|OverrideAction .
	Action *WafAction

	// An array of rules to exclude from a rule group. This is applicable only when
	// the ActivatedRule refers to a RuleGroup .
	//
	// Sometimes it is necessary to troubleshoot rule groups that are blocking traffic
	// unexpectedly (false positives). One troubleshooting technique is to identify the
	// specific rule within the rule group that is blocking the legitimate traffic and
	// then disable (exclude) that particular rule. You can exclude rules from both
	// your own rule groups and AWS Marketplace rule groups that have been associated
	// with a web ACL.
	//
	// Specifying ExcludedRules does not remove those rules from the rule group.
	// Rather, it changes the action for the rules to COUNT . Therefore, requests that
	// match an ExcludedRule are counted but not blocked. The RuleGroup owner will
	// receive COUNT metrics for each ExcludedRule .
	//
	// If you want to exclude rules from a rule group that is already associated with
	// a web ACL, perform the following steps:
	//
	//   - Use the AWS WAF logs to identify the IDs of the rules that you want to
	//   exclude. For more information about the logs, see [Logging Web ACL Traffic Information].
	//
	//   - Submit an UpdateWebACLrequest that has two actions:
	//
	//   - The first action deletes the existing rule group from the web ACL. That is,
	//   in the UpdateWebACLrequest, the first Updates:Action should be DELETE and
	//   Updates:ActivatedRule:RuleId should be the rule group that contains the rules
	//   that you want to exclude.
	//
	//   - The second action inserts the same rule group back in, but specifying the
	//   rules to exclude. That is, the second Updates:Action should be INSERT ,
	//   Updates:ActivatedRule:RuleId should be the rule group that you just removed,
	//   and ExcludedRules should contain the rules that you want to exclude.
	//
	// [Logging Web ACL Traffic Information]: https://docs.aws.amazon.com/waf/latest/developerguide/logging.html
	ExcludedRules []ExcludedRule

	// Use the OverrideAction to test your RuleGroup .
	//
	// Any rule in a RuleGroup can potentially block a request. If you set the
	// OverrideAction to None , the RuleGroup will block a request if any individual
	// rule in the RuleGroup matches the request and is configured to block that
	// request. However if you first want to test the RuleGroup , set the
	// OverrideAction to Count . The RuleGroup will then override any block action
	// specified by individual rules contained within the group. Instead of blocking
	// matching requests, those requests will be counted. You can view a record of
	// counted requests using GetSampledRequests.
	//
	// ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup
	// to a WebACL . In this case you do not use ActivatedRule|Action . For all other
	// update requests, ActivatedRule|Action is used instead of
	// ActivatedRule|OverrideAction .
	OverrideAction *WafOverrideAction

	// The rule type, either REGULAR , as defined by Rule, RATE_BASED , as defined by RateBasedRule, or
	// GROUP , as defined by RuleGroup. The default is REGULAR. Although this field is
	// optional, be aware that if you try to add a RATE_BASED rule to a web ACL without
	// setting the type, the UpdateWebACLrequest will fail because the request tries to add a
	// REGULAR rule with the specified ID, which does not exist.
	Type WafRuleType
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL , and the action that you want AWS WAF to take when a web request matches the Rule ( ALLOW , BLOCK , or COUNT ).

To specify whether to insert or delete a Rule , use the Action parameter in the WebACLUpdate data type.

type ByteMatchSet

type ByteMatchSet struct {

	// The ByteMatchSetId for a ByteMatchSet . You use ByteMatchSetId to get
	// information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a
	// ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a
	// ByteMatchSet from AWS WAF (see DeleteByteMatchSet).
	//
	// ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
	//
	// This member is required.
	ByteMatchSetId *string

	// Specifies the bytes (typically a string that corresponds with ASCII characters)
	// that you want AWS WAF to search for in web requests, the location in requests
	// that you want AWS WAF to search, and other settings.
	//
	// This member is required.
	ByteMatchTuples []ByteMatchTuple

	// A friendly name or description of the ByteMatchSet. You can't change Name after you create
	// a ByteMatchSet .
	Name *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the ByteMatchSetId and Name of a ByteMatchSet , and the values that you specified when you updated the ByteMatchSet .

A complex type that contains ByteMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

type ByteMatchSetSummary

type ByteMatchSetSummary struct {

	// The ByteMatchSetId for a ByteMatchSet . You use ByteMatchSetId to get
	// information about a ByteMatchSet , update a ByteMatchSet , remove a ByteMatchSet
	// from a Rule , and delete a ByteMatchSet from AWS WAF.
	//
	// ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
	//
	// This member is required.
	ByteMatchSetId *string

	// A friendly name or description of the ByteMatchSet. You can't change Name after you create
	// a ByteMatchSet .
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returned by ListByteMatchSets. Each ByteMatchSetSummary object includes the Name and ByteMatchSetId for one ByteMatchSet.

type ByteMatchSetUpdate

type ByteMatchSetUpdate struct {

	// Specifies whether to insert or delete a ByteMatchTuple.
	//
	// This member is required.
	Action ChangeAction

	// Information about the part of a web request that you want AWS WAF to inspect
	// and the value that you want AWS WAF to search for. If you specify DELETE for
	// the value of Action , the ByteMatchTuple values must exactly match the values
	// in the ByteMatchTuple that you want to delete from the ByteMatchSet .
	//
	// This member is required.
	ByteMatchTuple *ByteMatchTuple
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In an UpdateByteMatchSet request, ByteMatchSetUpdate specifies whether to insert or delete a ByteMatchTuple and includes the settings for the ByteMatchTuple .

type ByteMatchTuple

type ByteMatchTuple struct {

	// The part of a web request that you want AWS WAF to search, such as a specified
	// header or a query string. For more information, see FieldToMatch.
	//
	// This member is required.
	FieldToMatch *FieldToMatch

	// Within the portion of a web request that you want to search (for example, in
	// the query string, if any), specify where you want AWS WAF to search. Valid
	// values include the following:
	//
	// CONTAINS
	//
	// The specified part of the web request must include the value of TargetString ,
	// but the location doesn't matter.
	//
	// CONTAINS_WORD
	//
	// The specified part of the web request must include the value of TargetString ,
	// and TargetString must contain only alphanumeric characters or underscore (A-Z,
	// a-z, 0-9, or _). In addition, TargetString must be a word, which means one of
	// the following:
	//
	//   - TargetString exactly matches the value of the specified part of the web
	//   request, such as the value of a header.
	//
	//   - TargetString is at the beginning of the specified part of the web request
	//   and is followed by a character other than an alphanumeric character or
	//   underscore (_), for example, BadBot; .
	//
	//   - TargetString is at the end of the specified part of the web request and is
	//   preceded by a character other than an alphanumeric character or underscore (_),
	//   for example, ;BadBot .
	//
	//   - TargetString is in the middle of the specified part of the web request and
	//   is preceded and followed by characters other than alphanumeric characters or
	//   underscore (_), for example, -BadBot; .
	//
	// EXACTLY
	//
	// The value of the specified part of the web request must exactly match the value
	// of TargetString .
	//
	// STARTS_WITH
	//
	// The value of TargetString must appear at the beginning of the specified part of
	// the web request.
	//
	// ENDS_WITH
	//
	// The value of TargetString must appear at the end of the specified part of the
	// web request.
	//
	// This member is required.
	PositionalConstraint PositionalConstraint

	// The value that you want AWS WAF to search for. AWS WAF searches for the
	// specified string in the part of web requests that you specified in FieldToMatch
	// . The maximum length of the value is 50 bytes.
	//
	// Valid values depend on the values that you specified for FieldToMatch :
	//
	//   - HEADER : The value that you want AWS WAF to search for in the request header
	//   that you specified in FieldToMatch, for example, the value of the User-Agent or Referer
	//   header.
	//
	//   - METHOD : The HTTP method, which indicates the type of operation specified in
	//   the request. CloudFront supports the following methods: DELETE , GET , HEAD ,
	//   OPTIONS , PATCH , POST , and PUT .
	//
	//   - QUERY_STRING : The value that you want AWS WAF to search for in the query
	//   string, which is the part of a URL that appears after a ? character.
	//
	//   - URI : The value that you want AWS WAF to search for in the part of a URL
	//   that identifies a resource, for example, /images/daily-ad.jpg .
	//
	//   - BODY : 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.
	//   The request body immediately follows the request headers. Note that only the
	//   first 8192 bytes of the request body are forwarded to AWS WAF for inspection.
	//   To allow or block requests based on the length of the body, you can create a
	//   size constraint set. For more information, see CreateSizeConstraintSet.
	//
	//   - SINGLE_QUERY_ARG : The parameter in the query string that you will inspect,
	//   such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30
	//   characters.
	//
	//   - ALL_QUERY_ARGS : Similar to SINGLE_QUERY_ARG , but instead of inspecting a
	//   single parameter, AWS WAF inspects all parameters within the query string for
	//   the value or regex pattern that you specify in TargetString .
	//
	// If TargetString 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 TargetString .
	//
	// 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.
	TargetString []byte

	// Text transformations eliminate some of the unusual formatting that attackers
	// use in web requests in an effort to bypass AWS WAF. If you specify a
	// transformation, AWS WAF performs the transformation on FieldToMatch before
	// inspecting it for a match.
	//
	// You can only specify a single type of TextTransformation.
	//
	// 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 to perform any text transformations.
	//
	// This member is required.
	TextTransformation TextTransformation
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

type ChangeAction

type ChangeAction string
const (
	ChangeActionInsert ChangeAction = "INSERT"
	ChangeActionDelete ChangeAction = "DELETE"
)

Enum values for ChangeAction

func (ChangeAction) Values added in v0.29.0

func (ChangeAction) Values() []ChangeAction

Values returns all known values for ChangeAction. 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 ChangeTokenStatus

type ChangeTokenStatus string
const (
	ChangeTokenStatusProvisioned ChangeTokenStatus = "PROVISIONED"
	ChangeTokenStatusPending     ChangeTokenStatus = "PENDING"
	ChangeTokenStatusInsync      ChangeTokenStatus = "INSYNC"
)

Enum values for ChangeTokenStatus

func (ChangeTokenStatus) Values added in v0.29.0

Values returns all known values for ChangeTokenStatus. 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 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 added in v0.29.0

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 ExcludedRule

type ExcludedRule struct {

	// The unique identifier for the rule to exclude from the rule group.
	//
	// This member is required.
	RuleId *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The rule to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup . The rule must belong to the RuleGroup that is specified by the ActivatedRule .

type FieldToMatch

type FieldToMatch struct {

	// The part of the web request that you want AWS WAF to search for a specified
	// string. Parts of a request that you can search include the following:
	//
	//   - HEADER : A specified request header, for example, the value of the
	//   User-Agent or Referer header. If you choose HEADER for the type, specify the
	//   name of the header in Data .
	//
	//   - METHOD : The HTTP method, which indicated the type of operation that the
	//   request is asking the origin to perform. Amazon CloudFront supports the
	//   following methods: DELETE , GET , HEAD , OPTIONS , PATCH , POST , and PUT .
	//
	//   - QUERY_STRING : A query string, which is the part of a URL that appears after
	//   a ? character, if any.
	//
	//   - URI : The part of a web request that identifies a resource, for example,
	//   /images/daily-ad.jpg .
	//
	//   - BODY : 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.
	//   The request body immediately follows the request headers. Note that only the
	//   first 8192 bytes of the request body are forwarded to AWS WAF for inspection.
	//   To allow or block requests based on the length of the body, you can create a
	//   size constraint set. For more information, see CreateSizeConstraintSet.
	//
	//   - SINGLE_QUERY_ARG : The parameter in the query string that you will inspect,
	//   such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30
	//   characters.
	//
	//   - ALL_QUERY_ARGS : Similar to SINGLE_QUERY_ARG , but rather than inspecting a
	//   single parameter, AWS WAF will inspect all parameters within the query for the
	//   value or regex pattern that you specify in TargetString .
	//
	// This member is required.
	Type MatchFieldType

	// When the value of Type is HEADER , enter the name of the header that you want
	// AWS WAF to search, for example, User-Agent or Referer . The name of the header
	// is not case sensitive.
	//
	// When the value of Type is SINGLE_QUERY_ARG , enter the name of the parameter
	// that you want AWS WAF to search, for example, UserName or SalesRegion . The
	// parameter name is not case sensitive.
	//
	// If the value of Type is any other value, omit Data .
	Data *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies where in a web request to look for TargetString .

type GeoMatchConstraint

type GeoMatchConstraint struct {

	// The type of geographical area you want AWS WAF to search for. Currently Country
	// is the only valid value.
	//
	// This member is required.
	Type GeoMatchConstraintType

	// The country that you want AWS WAF to search for.
	//
	// This member is required.
	Value GeoMatchConstraintValue
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The country from which web requests originate that you want AWS WAF to search for.

type GeoMatchConstraintType

type GeoMatchConstraintType string
const (
	GeoMatchConstraintTypeCountry GeoMatchConstraintType = "Country"
)

Enum values for GeoMatchConstraintType

func (GeoMatchConstraintType) Values added in v0.29.0

Values returns all known values for GeoMatchConstraintType. 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 GeoMatchConstraintValue

type GeoMatchConstraintValue string
const (
	GeoMatchConstraintValueAf GeoMatchConstraintValue = "AF"
	GeoMatchConstraintValueAx GeoMatchConstraintValue = "AX"
	GeoMatchConstraintValueAl GeoMatchConstraintValue = "AL"
	GeoMatchConstraintValueDz GeoMatchConstraintValue = "DZ"
	GeoMatchConstraintValueAs GeoMatchConstraintValue = "AS"
	GeoMatchConstraintValueAd GeoMatchConstraintValue = "AD"
	GeoMatchConstraintValueAo GeoMatchConstraintValue = "AO"
	GeoMatchConstraintValueAi GeoMatchConstraintValue = "AI"
	GeoMatchConstraintValueAq GeoMatchConstraintValue = "AQ"
	GeoMatchConstraintValueAg GeoMatchConstraintValue = "AG"
	GeoMatchConstraintValueAr GeoMatchConstraintValue = "AR"
	GeoMatchConstraintValueAm GeoMatchConstraintValue = "AM"
	GeoMatchConstraintValueAw GeoMatchConstraintValue = "AW"
	GeoMatchConstraintValueAu GeoMatchConstraintValue = "AU"
	GeoMatchConstraintValueAt GeoMatchConstraintValue = "AT"
	GeoMatchConstraintValueAz GeoMatchConstraintValue = "AZ"
	GeoMatchConstraintValueBs GeoMatchConstraintValue = "BS"
	GeoMatchConstraintValueBh GeoMatchConstraintValue = "BH"
	GeoMatchConstraintValueBd GeoMatchConstraintValue = "BD"
	GeoMatchConstraintValueBb GeoMatchConstraintValue = "BB"
	GeoMatchConstraintValueBy GeoMatchConstraintValue = "BY"
	GeoMatchConstraintValueBe GeoMatchConstraintValue = "BE"
	GeoMatchConstraintValueBz GeoMatchConstraintValue = "BZ"
	GeoMatchConstraintValueBj GeoMatchConstraintValue = "BJ"
	GeoMatchConstraintValueBm GeoMatchConstraintValue = "BM"
	GeoMatchConstraintValueBt GeoMatchConstraintValue = "BT"
	GeoMatchConstraintValueBo GeoMatchConstraintValue = "BO"
	GeoMatchConstraintValueBq GeoMatchConstraintValue = "BQ"
	GeoMatchConstraintValueBa GeoMatchConstraintValue = "BA"
	GeoMatchConstraintValueBw GeoMatchConstraintValue = "BW"
	GeoMatchConstraintValueBv GeoMatchConstraintValue = "BV"
	GeoMatchConstraintValueBr GeoMatchConstraintValue = "BR"
	GeoMatchConstraintValueIo GeoMatchConstraintValue = "IO"
	GeoMatchConstraintValueBn GeoMatchConstraintValue = "BN"
	GeoMatchConstraintValueBg GeoMatchConstraintValue = "BG"
	GeoMatchConstraintValueBf GeoMatchConstraintValue = "BF"
	GeoMatchConstraintValueBi GeoMatchConstraintValue = "BI"
	GeoMatchConstraintValueKh GeoMatchConstraintValue = "KH"
	GeoMatchConstraintValueCm GeoMatchConstraintValue = "CM"
	GeoMatchConstraintValueCa GeoMatchConstraintValue = "CA"
	GeoMatchConstraintValueCv GeoMatchConstraintValue = "CV"
	GeoMatchConstraintValueKy GeoMatchConstraintValue = "KY"
	GeoMatchConstraintValueCf GeoMatchConstraintValue = "CF"
	GeoMatchConstraintValueTd GeoMatchConstraintValue = "TD"
	GeoMatchConstraintValueCl GeoMatchConstraintValue = "CL"
	GeoMatchConstraintValueCn GeoMatchConstraintValue = "CN"
	GeoMatchConstraintValueCx GeoMatchConstraintValue = "CX"
	GeoMatchConstraintValueCc GeoMatchConstraintValue = "CC"
	GeoMatchConstraintValueCo GeoMatchConstraintValue = "CO"
	GeoMatchConstraintValueKm GeoMatchConstraintValue = "KM"
	GeoMatchConstraintValueCg GeoMatchConstraintValue = "CG"
	GeoMatchConstraintValueCd GeoMatchConstraintValue = "CD"
	GeoMatchConstraintValueCk GeoMatchConstraintValue = "CK"
	GeoMatchConstraintValueCr GeoMatchConstraintValue = "CR"
	GeoMatchConstraintValueCi GeoMatchConstraintValue = "CI"
	GeoMatchConstraintValueHr GeoMatchConstraintValue = "HR"
	GeoMatchConstraintValueCu GeoMatchConstraintValue = "CU"
	GeoMatchConstraintValueCw GeoMatchConstraintValue = "CW"
	GeoMatchConstraintValueCy GeoMatchConstraintValue = "CY"
	GeoMatchConstraintValueCz GeoMatchConstraintValue = "CZ"
	GeoMatchConstraintValueDk GeoMatchConstraintValue = "DK"
	GeoMatchConstraintValueDj GeoMatchConstraintValue = "DJ"
	GeoMatchConstraintValueDm GeoMatchConstraintValue = "DM"
	GeoMatchConstraintValueDo GeoMatchConstraintValue = "DO"
	GeoMatchConstraintValueEc GeoMatchConstraintValue = "EC"
	GeoMatchConstraintValueEg GeoMatchConstraintValue = "EG"
	GeoMatchConstraintValueSv GeoMatchConstraintValue = "SV"
	GeoMatchConstraintValueGq GeoMatchConstraintValue = "GQ"
	GeoMatchConstraintValueEr GeoMatchConstraintValue = "ER"
	GeoMatchConstraintValueEe GeoMatchConstraintValue = "EE"
	GeoMatchConstraintValueEt GeoMatchConstraintValue = "ET"
	GeoMatchConstraintValueFk GeoMatchConstraintValue = "FK"
	GeoMatchConstraintValueFo GeoMatchConstraintValue = "FO"
	GeoMatchConstraintValueFj GeoMatchConstraintValue = "FJ"
	GeoMatchConstraintValueFi GeoMatchConstraintValue = "FI"
	GeoMatchConstraintValueFr GeoMatchConstraintValue = "FR"
	GeoMatchConstraintValueGf GeoMatchConstraintValue = "GF"
	GeoMatchConstraintValuePf GeoMatchConstraintValue = "PF"
	GeoMatchConstraintValueTf GeoMatchConstraintValue = "TF"
	GeoMatchConstraintValueGa GeoMatchConstraintValue = "GA"
	GeoMatchConstraintValueGm GeoMatchConstraintValue = "GM"
	GeoMatchConstraintValueGe GeoMatchConstraintValue = "GE"
	GeoMatchConstraintValueDe GeoMatchConstraintValue = "DE"
	GeoMatchConstraintValueGh GeoMatchConstraintValue = "GH"
	GeoMatchConstraintValueGi GeoMatchConstraintValue = "GI"
	GeoMatchConstraintValueGr GeoMatchConstraintValue = "GR"
	GeoMatchConstraintValueGl GeoMatchConstraintValue = "GL"
	GeoMatchConstraintValueGd GeoMatchConstraintValue = "GD"
	GeoMatchConstraintValueGp GeoMatchConstraintValue = "GP"
	GeoMatchConstraintValueGu GeoMatchConstraintValue = "GU"
	GeoMatchConstraintValueGt GeoMatchConstraintValue = "GT"
	GeoMatchConstraintValueGg GeoMatchConstraintValue = "GG"
	GeoMatchConstraintValueGn GeoMatchConstraintValue = "GN"
	GeoMatchConstraintValueGw GeoMatchConstraintValue = "GW"
	GeoMatchConstraintValueGy GeoMatchConstraintValue = "GY"
	GeoMatchConstraintValueHt GeoMatchConstraintValue = "HT"
	GeoMatchConstraintValueHm GeoMatchConstraintValue = "HM"
	GeoMatchConstraintValueVa GeoMatchConstraintValue = "VA"
	GeoMatchConstraintValueHn GeoMatchConstraintValue = "HN"
	GeoMatchConstraintValueHk GeoMatchConstraintValue = "HK"
	GeoMatchConstraintValueHu GeoMatchConstraintValue = "HU"
	GeoMatchConstraintValueIs GeoMatchConstraintValue = "IS"
	GeoMatchConstraintValueIn GeoMatchConstraintValue = "IN"
	GeoMatchConstraintValueId GeoMatchConstraintValue = "ID"
	GeoMatchConstraintValueIr GeoMatchConstraintValue = "IR"
	GeoMatchConstraintValueIq GeoMatchConstraintValue = "IQ"
	GeoMatchConstraintValueIe GeoMatchConstraintValue = "IE"
	GeoMatchConstraintValueIm GeoMatchConstraintValue = "IM"
	GeoMatchConstraintValueIl GeoMatchConstraintValue = "IL"
	GeoMatchConstraintValueIt GeoMatchConstraintValue = "IT"
	GeoMatchConstraintValueJm GeoMatchConstraintValue = "JM"
	GeoMatchConstraintValueJp GeoMatchConstraintValue = "JP"
	GeoMatchConstraintValueJe GeoMatchConstraintValue = "JE"
	GeoMatchConstraintValueJo GeoMatchConstraintValue = "JO"
	GeoMatchConstraintValueKz GeoMatchConstraintValue = "KZ"
	GeoMatchConstraintValueKe GeoMatchConstraintValue = "KE"
	GeoMatchConstraintValueKi GeoMatchConstraintValue = "KI"
	GeoMatchConstraintValueKp GeoMatchConstraintValue = "KP"
	GeoMatchConstraintValueKr GeoMatchConstraintValue = "KR"
	GeoMatchConstraintValueKw GeoMatchConstraintValue = "KW"
	GeoMatchConstraintValueKg GeoMatchConstraintValue = "KG"
	GeoMatchConstraintValueLa GeoMatchConstraintValue = "LA"
	GeoMatchConstraintValueLv GeoMatchConstraintValue = "LV"
	GeoMatchConstraintValueLb GeoMatchConstraintValue = "LB"
	GeoMatchConstraintValueLs GeoMatchConstraintValue = "LS"
	GeoMatchConstraintValueLr GeoMatchConstraintValue = "LR"
	GeoMatchConstraintValueLy GeoMatchConstraintValue = "LY"
	GeoMatchConstraintValueLi GeoMatchConstraintValue = "LI"
	GeoMatchConstraintValueLt GeoMatchConstraintValue = "LT"
	GeoMatchConstraintValueLu GeoMatchConstraintValue = "LU"
	GeoMatchConstraintValueMo GeoMatchConstraintValue = "MO"
	GeoMatchConstraintValueMk GeoMatchConstraintValue = "MK"
	GeoMatchConstraintValueMg GeoMatchConstraintValue = "MG"
	GeoMatchConstraintValueMw GeoMatchConstraintValue = "MW"
	GeoMatchConstraintValueMy GeoMatchConstraintValue = "MY"
	GeoMatchConstraintValueMv GeoMatchConstraintValue = "MV"
	GeoMatchConstraintValueMl GeoMatchConstraintValue = "ML"
	GeoMatchConstraintValueMt GeoMatchConstraintValue = "MT"
	GeoMatchConstraintValueMh GeoMatchConstraintValue = "MH"
	GeoMatchConstraintValueMq GeoMatchConstraintValue = "MQ"
	GeoMatchConstraintValueMr GeoMatchConstraintValue = "MR"
	GeoMatchConstraintValueMu GeoMatchConstraintValue = "MU"
	GeoMatchConstraintValueYt GeoMatchConstraintValue = "YT"
	GeoMatchConstraintValueMx GeoMatchConstraintValue = "MX"
	GeoMatchConstraintValueFm GeoMatchConstraintValue = "FM"
	GeoMatchConstraintValueMd GeoMatchConstraintValue = "MD"
	GeoMatchConstraintValueMc GeoMatchConstraintValue = "MC"
	GeoMatchConstraintValueMn GeoMatchConstraintValue = "MN"
	GeoMatchConstraintValueMe GeoMatchConstraintValue = "ME"
	GeoMatchConstraintValueMs GeoMatchConstraintValue = "MS"
	GeoMatchConstraintValueMa GeoMatchConstraintValue = "MA"
	GeoMatchConstraintValueMz GeoMatchConstraintValue = "MZ"
	GeoMatchConstraintValueMm GeoMatchConstraintValue = "MM"
	GeoMatchConstraintValueNa GeoMatchConstraintValue = "NA"
	GeoMatchConstraintValueNr GeoMatchConstraintValue = "NR"
	GeoMatchConstraintValueNp GeoMatchConstraintValue = "NP"
	GeoMatchConstraintValueNl GeoMatchConstraintValue = "NL"
	GeoMatchConstraintValueNc GeoMatchConstraintValue = "NC"
	GeoMatchConstraintValueNz GeoMatchConstraintValue = "NZ"
	GeoMatchConstraintValueNi GeoMatchConstraintValue = "NI"
	GeoMatchConstraintValueNe GeoMatchConstraintValue = "NE"
	GeoMatchConstraintValueNg GeoMatchConstraintValue = "NG"
	GeoMatchConstraintValueNu GeoMatchConstraintValue = "NU"
	GeoMatchConstraintValueNf GeoMatchConstraintValue = "NF"
	GeoMatchConstraintValueMp GeoMatchConstraintValue = "MP"
	GeoMatchConstraintValueNo GeoMatchConstraintValue = "NO"
	GeoMatchConstraintValueOm GeoMatchConstraintValue = "OM"
	GeoMatchConstraintValuePk GeoMatchConstraintValue = "PK"
	GeoMatchConstraintValuePw GeoMatchConstraintValue = "PW"
	GeoMatchConstraintValuePs GeoMatchConstraintValue = "PS"
	GeoMatchConstraintValuePa GeoMatchConstraintValue = "PA"
	GeoMatchConstraintValuePg GeoMatchConstraintValue = "PG"
	GeoMatchConstraintValuePy GeoMatchConstraintValue = "PY"
	GeoMatchConstraintValuePe GeoMatchConstraintValue = "PE"
	GeoMatchConstraintValuePh GeoMatchConstraintValue = "PH"
	GeoMatchConstraintValuePn GeoMatchConstraintValue = "PN"
	GeoMatchConstraintValuePl GeoMatchConstraintValue = "PL"
	GeoMatchConstraintValuePt GeoMatchConstraintValue = "PT"
	GeoMatchConstraintValuePr GeoMatchConstraintValue = "PR"
	GeoMatchConstraintValueQa GeoMatchConstraintValue = "QA"
	GeoMatchConstraintValueRe GeoMatchConstraintValue = "RE"
	GeoMatchConstraintValueRo GeoMatchConstraintValue = "RO"
	GeoMatchConstraintValueRu GeoMatchConstraintValue = "RU"
	GeoMatchConstraintValueRw GeoMatchConstraintValue = "RW"
	GeoMatchConstraintValueBl GeoMatchConstraintValue = "BL"
	GeoMatchConstraintValueSh GeoMatchConstraintValue = "SH"
	GeoMatchConstraintValueKn GeoMatchConstraintValue = "KN"
	GeoMatchConstraintValueLc GeoMatchConstraintValue = "LC"
	GeoMatchConstraintValueMf GeoMatchConstraintValue = "MF"
	GeoMatchConstraintValuePm GeoMatchConstraintValue = "PM"
	GeoMatchConstraintValueVc GeoMatchConstraintValue = "VC"
	GeoMatchConstraintValueWs GeoMatchConstraintValue = "WS"
	GeoMatchConstraintValueSm GeoMatchConstraintValue = "SM"
	GeoMatchConstraintValueSt GeoMatchConstraintValue = "ST"
	GeoMatchConstraintValueSa GeoMatchConstraintValue = "SA"
	GeoMatchConstraintValueSn GeoMatchConstraintValue = "SN"
	GeoMatchConstraintValueRs GeoMatchConstraintValue = "RS"
	GeoMatchConstraintValueSc GeoMatchConstraintValue = "SC"
	GeoMatchConstraintValueSl GeoMatchConstraintValue = "SL"
	GeoMatchConstraintValueSg GeoMatchConstraintValue = "SG"
	GeoMatchConstraintValueSx GeoMatchConstraintValue = "SX"
	GeoMatchConstraintValueSk GeoMatchConstraintValue = "SK"
	GeoMatchConstraintValueSi GeoMatchConstraintValue = "SI"
	GeoMatchConstraintValueSb GeoMatchConstraintValue = "SB"
	GeoMatchConstraintValueSo GeoMatchConstraintValue = "SO"
	GeoMatchConstraintValueZa GeoMatchConstraintValue = "ZA"
	GeoMatchConstraintValueGs GeoMatchConstraintValue = "GS"
	GeoMatchConstraintValueSs GeoMatchConstraintValue = "SS"
	GeoMatchConstraintValueEs GeoMatchConstraintValue = "ES"
	GeoMatchConstraintValueLk GeoMatchConstraintValue = "LK"
	GeoMatchConstraintValueSd GeoMatchConstraintValue = "SD"
	GeoMatchConstraintValueSr GeoMatchConstraintValue = "SR"
	GeoMatchConstraintValueSj GeoMatchConstraintValue = "SJ"
	GeoMatchConstraintValueSz GeoMatchConstraintValue = "SZ"
	GeoMatchConstraintValueSe GeoMatchConstraintValue = "SE"
	GeoMatchConstraintValueCh GeoMatchConstraintValue = "CH"
	GeoMatchConstraintValueSy GeoMatchConstraintValue = "SY"
	GeoMatchConstraintValueTw GeoMatchConstraintValue = "TW"
	GeoMatchConstraintValueTj GeoMatchConstraintValue = "TJ"
	GeoMatchConstraintValueTz GeoMatchConstraintValue = "TZ"
	GeoMatchConstraintValueTh GeoMatchConstraintValue = "TH"
	GeoMatchConstraintValueTl GeoMatchConstraintValue = "TL"
	GeoMatchConstraintValueTg GeoMatchConstraintValue = "TG"
	GeoMatchConstraintValueTk GeoMatchConstraintValue = "TK"
	GeoMatchConstraintValueTo GeoMatchConstraintValue = "TO"
	GeoMatchConstraintValueTt GeoMatchConstraintValue = "TT"
	GeoMatchConstraintValueTn GeoMatchConstraintValue = "TN"
	GeoMatchConstraintValueTr GeoMatchConstraintValue = "TR"
	GeoMatchConstraintValueTm GeoMatchConstraintValue = "TM"
	GeoMatchConstraintValueTc GeoMatchConstraintValue = "TC"
	GeoMatchConstraintValueTv GeoMatchConstraintValue = "TV"
	GeoMatchConstraintValueUg GeoMatchConstraintValue = "UG"
	GeoMatchConstraintValueUa GeoMatchConstraintValue = "UA"
	GeoMatchConstraintValueAe GeoMatchConstraintValue = "AE"
	GeoMatchConstraintValueGb GeoMatchConstraintValue = "GB"
	GeoMatchConstraintValueUs GeoMatchConstraintValue = "US"
	GeoMatchConstraintValueUm GeoMatchConstraintValue = "UM"
	GeoMatchConstraintValueUy GeoMatchConstraintValue = "UY"
	GeoMatchConstraintValueUz GeoMatchConstraintValue = "UZ"
	GeoMatchConstraintValueVu GeoMatchConstraintValue = "VU"
	GeoMatchConstraintValueVe GeoMatchConstraintValue = "VE"
	GeoMatchConstraintValueVn GeoMatchConstraintValue = "VN"
	GeoMatchConstraintValueVg GeoMatchConstraintValue = "VG"
	GeoMatchConstraintValueVi GeoMatchConstraintValue = "VI"
	GeoMatchConstraintValueWf GeoMatchConstraintValue = "WF"
	GeoMatchConstraintValueEh GeoMatchConstraintValue = "EH"
	GeoMatchConstraintValueYe GeoMatchConstraintValue = "YE"
	GeoMatchConstraintValueZm GeoMatchConstraintValue = "ZM"
	GeoMatchConstraintValueZw GeoMatchConstraintValue = "ZW"
)

Enum values for GeoMatchConstraintValue

func (GeoMatchConstraintValue) Values added in v0.29.0

Values returns all known values for GeoMatchConstraintValue. 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 GeoMatchSet

type GeoMatchSet struct {

	// An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search
	// for.
	//
	// This member is required.
	GeoMatchConstraints []GeoMatchConstraint

	// The GeoMatchSetId for an GeoMatchSet . You use GeoMatchSetId to get information
	// about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see UpdateGeoMatchSet), insert a GeoMatchSet
	// into a Rule or delete one from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS
	// WAF (see DeleteGeoMatchSet).
	//
	// GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
	//
	// This member is required.
	GeoMatchSetId *string

	// A friendly name or description of the GeoMatchSet. You can't change the name of an
	// GeoMatchSet after you create it.
	Name *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains one or more countries that AWS WAF will search for.

type GeoMatchSetSummary

type GeoMatchSetSummary struct {

	// The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a GetGeoMatchSet request to get
	// detailed information about an GeoMatchSet.
	//
	// This member is required.
	GeoMatchSetId *string

	// A friendly name or description of the GeoMatchSet. You can't change the name of an
	// GeoMatchSet after you create it.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the name of the GeoMatchSet .

type GeoMatchSetUpdate

type GeoMatchSetUpdate struct {

	// Specifies whether to insert or delete a country with UpdateGeoMatchSet.
	//
	// This member is required.
	Action ChangeAction

	// The country from which web requests originate that you want AWS WAF to search
	// for.
	//
	// This member is required.
	GeoMatchConstraint *GeoMatchConstraint
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the type of update to perform to an GeoMatchSet with UpdateGeoMatchSet.

type HTTPHeader

type HTTPHeader struct {

	// The name of one of the headers in the sampled web request.
	Name *string

	// The value of one of the headers in the sampled web request.
	Value *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The response from a GetSampledRequests request includes an HTTPHeader 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 that were returned by GetSampledRequests .

type HTTPRequest

type HTTPRequest struct {

	// The IP address that the request originated from. If the WebACL 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].
	//
	// [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 two values for each header in the sampled web
	// request: the name of the header and the value of the header.
	Headers []HTTPHeader

	// The HTTP method specified in the sampled web request. CloudFront supports the
	// following methods: DELETE , GET , HEAD , OPTIONS , PATCH , POST , and PUT .
	Method *string

	// The part of a web request that identifies the resource, for example,
	// /images/daily-ad.jpg .
	URI *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The response from a GetSampledRequests request includes an HTTPRequest complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests that were returned by GetSampledRequests .

type IPSet

type IPSet struct {

	// The IP address type ( IPV4 or IPV6 ) and the IP address range (in CIDR notation)
	// that web requests originate from. If the WebACL is associated with a CloudFront
	// distribution and the viewer did not use an HTTP proxy or a load balancer to send
	// the request, this is the value of the c-ip field in the CloudFront access logs.
	//
	// This member is required.
	IPSetDescriptors []IPSetDescriptor

	// The IPSetId for an IPSet . You use IPSetId to get information about an IPSet
	// (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from
	// a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).
	//
	// IPSetId is returned by CreateIPSet and by ListIPSets.
	//
	// This member is required.
	IPSetId *string

	// A friendly name or description of the IPSet. You can't change the name of an IPSet
	// after you create it.
	Name *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128.

To specify an individual IP address, you specify the four-part IP address followed by a /32 , for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

type IPSetDescriptor

type IPSetDescriptor struct {

	// Specify IPV4 or IPV6 .
	//
	// This member is required.
	Type IPSetDescriptorType

	// Specify an IPv4 address by using CIDR notation. For example:
	//
	//   - 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 .
	//
	// For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing].
	//
	// Specify an IPv6 address by using CIDR notation. For example:
	//
	//   - 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 .
	//
	// [Classless Inter-Domain Routing]: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the IP address type ( IPV4 or IPV6 ) and the IP address range (in CIDR format) that web requests originate from.

type IPSetDescriptorType

type IPSetDescriptorType string
const (
	IPSetDescriptorTypeIpv4 IPSetDescriptorType = "IPV4"
	IPSetDescriptorTypeIpv6 IPSetDescriptorType = "IPV6"
)

Enum values for IPSetDescriptorType

func (IPSetDescriptorType) Values added in v0.29.0

Values returns all known values for IPSetDescriptorType. 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 IPSetSummary

type IPSetSummary struct {

	// The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed
	// information about an IPSet.
	//
	// This member is required.
	IPSetId *string

	// A friendly name or description of the IPSet. You can't change the name of an IPSet
	// after you create it.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the name of the IPSet .

type IPSetUpdate

type IPSetUpdate struct {

	// Specifies whether to insert or delete an IP address with UpdateIPSet.
	//
	// This member is required.
	Action ChangeAction

	// The IP address type ( IPV4 or IPV6 ) and the IP address range (in CIDR notation)
	// that web requests originate from.
	//
	// This member is required.
	IPSetDescriptor *IPSetDescriptor
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the type of update to perform to an IPSet with UpdateIPSet.

type LoggingConfiguration

type LoggingConfiguration struct {

	// An array of Amazon Kinesis Data Firehose ARNs.
	//
	// 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

	// The parts of the request that you want redacted from the logs. For example, if
	// you redact the cookie field, the cookie field in the firehose will be xxx .
	RedactedFields []FieldToMatch
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The Amazon Kinesis Data Firehose, RedactedFields information, and the web ACL Amazon Resource Name (ARN).

type MatchFieldType

type MatchFieldType string
const (
	MatchFieldTypeUri            MatchFieldType = "URI"
	MatchFieldTypeQueryString    MatchFieldType = "QUERY_STRING"
	MatchFieldTypeHeader         MatchFieldType = "HEADER"
	MatchFieldTypeMethod         MatchFieldType = "METHOD"
	MatchFieldTypeBody           MatchFieldType = "BODY"
	MatchFieldTypeSingleQueryArg MatchFieldType = "SINGLE_QUERY_ARG"
	MatchFieldTypeAllQueryArgs   MatchFieldType = "ALL_QUERY_ARGS"
)

Enum values for MatchFieldType

func (MatchFieldType) Values added in v0.29.0

func (MatchFieldType) Values() []MatchFieldType

Values returns all known values for MatchFieldType. 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 MigrationErrorType

type MigrationErrorType string
const (
	MigrationErrorTypeEntityNotSupported    MigrationErrorType = "ENTITY_NOT_SUPPORTED"
	MigrationErrorTypeEntityNotFound        MigrationErrorType = "ENTITY_NOT_FOUND"
	MigrationErrorTypeS3BucketNoPermission  MigrationErrorType = "S3_BUCKET_NO_PERMISSION"
	MigrationErrorTypeS3BucketNotAccessible MigrationErrorType = "S3_BUCKET_NOT_ACCESSIBLE"
	MigrationErrorTypeS3BucketNotFound      MigrationErrorType = "S3_BUCKET_NOT_FOUND"
	MigrationErrorTypeS3BucketInvalidRegion MigrationErrorType = "S3_BUCKET_INVALID_REGION"
	MigrationErrorTypeS3InternalError       MigrationErrorType = "S3_INTERNAL_ERROR"
)

Enum values for MigrationErrorType

func (MigrationErrorType) Values added in v0.29.0

Values returns all known values for MigrationErrorType. 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 ParameterExceptionField

type ParameterExceptionField string
const (
	ParameterExceptionFieldChangeAction                     ParameterExceptionField = "CHANGE_ACTION"
	ParameterExceptionFieldWafAction                        ParameterExceptionField = "WAF_ACTION"
	ParameterExceptionFieldWafOverrideAction                ParameterExceptionField = "WAF_OVERRIDE_ACTION"
	ParameterExceptionFieldPredicateType                    ParameterExceptionField = "PREDICATE_TYPE"
	ParameterExceptionFieldIpsetType                        ParameterExceptionField = "IPSET_TYPE"
	ParameterExceptionFieldByteMatchFieldType               ParameterExceptionField = "BYTE_MATCH_FIELD_TYPE"
	ParameterExceptionFieldSqlInjectionMatchFieldType       ParameterExceptionField = "SQL_INJECTION_MATCH_FIELD_TYPE"
	ParameterExceptionFieldByteMatchTextTransformation      ParameterExceptionField = "BYTE_MATCH_TEXT_TRANSFORMATION"
	ParameterExceptionFieldByteMatchPositionalConstraint    ParameterExceptionField = "BYTE_MATCH_POSITIONAL_CONSTRAINT"
	ParameterExceptionFieldSizeConstraintComparisonOperator ParameterExceptionField = "SIZE_CONSTRAINT_COMPARISON_OPERATOR"
	ParameterExceptionFieldGeoMatchLocationType             ParameterExceptionField = "GEO_MATCH_LOCATION_TYPE"
	ParameterExceptionFieldGeoMatchLocationValue            ParameterExceptionField = "GEO_MATCH_LOCATION_VALUE"
	ParameterExceptionFieldRateKey                          ParameterExceptionField = "RATE_KEY"
	ParameterExceptionFieldRuleType                         ParameterExceptionField = "RULE_TYPE"
	ParameterExceptionFieldNextMarker                       ParameterExceptionField = "NEXT_MARKER"
	ParameterExceptionFieldResourceArn                      ParameterExceptionField = "RESOURCE_ARN"
	ParameterExceptionFieldTags                             ParameterExceptionField = "TAGS"
	ParameterExceptionFieldTagKeys                          ParameterExceptionField = "TAG_KEYS"
)

Enum values for ParameterExceptionField

func (ParameterExceptionField) Values added in v0.29.0

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 ParameterExceptionReason

type ParameterExceptionReason string
const (
	ParameterExceptionReasonInvalidOption      ParameterExceptionReason = "INVALID_OPTION"
	ParameterExceptionReasonIllegalCombination ParameterExceptionReason = "ILLEGAL_COMBINATION"
	ParameterExceptionReasonIllegalArgument    ParameterExceptionReason = "ILLEGAL_ARGUMENT"
	ParameterExceptionReasonInvalidTagKey      ParameterExceptionReason = "INVALID_TAG_KEY"
)

Enum values for ParameterExceptionReason

func (ParameterExceptionReason) Values added in v0.29.0

Values returns all known values for ParameterExceptionReason. 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 added in v0.29.0

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 Predicate

type Predicate struct {

	// A unique identifier for a predicate in a Rule , such as ByteMatchSetId or
	// IPSetId . The ID is returned by the corresponding Create or List command.
	//
	// This member is required.
	DataId *string

	// Set Negated to False if you want AWS WAF to allow, block, or count requests
	// based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet
	// includes the IP address 192.0.2.44 , AWS WAF will allow or block requests based
	// on that IP address.
	//
	// Set Negated to True if you want AWS WAF to allow or block a request based on
	// the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet
	// includes the IP address 192.0.2.44 , AWS WAF will allow, block, or count
	// requests based on all IP addresses except 192.0.2.44 .
	//
	// This member is required.
	Negated *bool

	// The type of predicate in a Rule , such as ByteMatch or IPSet .
	//
	// This member is required.
	Type PredicateType
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.

type PredicateType

type PredicateType string
const (
	PredicateTypeIpMatch           PredicateType = "IPMatch"
	PredicateTypeByteMatch         PredicateType = "ByteMatch"
	PredicateTypeSqlInjectionMatch PredicateType = "SqlInjectionMatch"
	PredicateTypeGeoMatch          PredicateType = "GeoMatch"
	PredicateTypeSizeConstraint    PredicateType = "SizeConstraint"
	PredicateTypeXssMatch          PredicateType = "XssMatch"
	PredicateTypeRegexMatch        PredicateType = "RegexMatch"
)

Enum values for PredicateType

func (PredicateType) Values added in v0.29.0

func (PredicateType) Values() []PredicateType

Values returns all known values for PredicateType. 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 RateBasedRule

type RateBasedRule struct {

	// The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object
	// that you want to include in a RateBasedRule .
	//
	// This member is required.
	MatchPredicates []Predicate

	// The field that AWS WAF uses to determine if requests are likely arriving from
	// single source and thus subject to rate monitoring. The only valid value for
	// RateKey is IP . IP indicates that requests arriving from the same IP address
	// are subject to the RateLimit that is specified in the RateBasedRule .
	//
	// This member is required.
	RateKey RateKey

	// The maximum number of requests, which have an identical value in the field
	// specified by the RateKey , allowed in a five-minute period. If the number of
	// requests exceeds the RateLimit and the other predicates specified in the rule
	// are also met, AWS WAF triggers the action that is specified for this rule.
	//
	// This member is required.
	RateLimit *int64

	// A unique identifier for a RateBasedRule . You use RuleId to get more
	// information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert
	// a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a
	// RateBasedRule from AWS WAF (see DeleteRateBasedRule).
	//
	// This member is required.
	RuleId *string

	// A friendly name or description for the metrics for a RateBasedRule . The name
	// can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length
	// 128 and minimum length one. It can't contain whitespace or metric names reserved
	// for AWS WAF, including "All" and "Default_Action." You can't change the name of
	// the metric after you create the RateBasedRule .
	MetricName *string

	// A friendly name or description for a RateBasedRule . You can't change the name
	// of a RateBasedRule after you create it.
	Name *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A RateBasedRule is identical to a regular Rule, with one addition: a RateBasedRule counts the number of requests that arrive from a specified IP address every five minutes. For example, based on recent requests that you've seen from an attacker, you might create a RateBasedRule that includes the following conditions:

  • The requests come from 192.0.2.44.

  • They contain the value BadBot in the User-Agent header.

In the rule, you also define the rate limit as 1,000.

Requests that meet both of these conditions and exceed 1,000 requests every five minutes trigger the rule's action (block or count), which is defined in the web ACL.

type RateKey

type RateKey string
const (
	RateKeyIp RateKey = "IP"
)

Enum values for RateKey

func (RateKey) Values added in v0.29.0

func (RateKey) Values() []RateKey

Values returns all known values for RateKey. 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 RegexMatchSet

type RegexMatchSet struct {

	// A friendly name or description of the RegexMatchSet. You can't change Name after you create
	// a RegexMatchSet .
	Name *string

	// The RegexMatchSetId for a RegexMatchSet . You use RegexMatchSetId to get
	// information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see UpdateRegexMatchSet), insert
	// a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a
	// RegexMatchSet from AWS WAF (see DeleteRegexMatchSet).
	//
	// RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
	RegexMatchSetId *string

	// Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:
	//
	//   - The part of a web request that you want AWS WAF to inspect, such as a query
	//   string or the value of the User-Agent header.
	//
	//   - The identifier of the pattern (a regular expression) that you want AWS WAF
	//   to look for. For more information, see RegexPatternSet.
	//
	//   - Whether to perform any conversions on the request, such as converting it to
	//   lowercase, before inspecting it for the specified string.
	RegexMatchTuples []RegexMatchTuple
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In a GetRegexMatchSet request, RegexMatchSet is a complex type that contains the RegexMatchSetId and Name of a RegexMatchSet , and the values that you specified when you updated the RegexMatchSet .

The values are contained in a RegexMatchTuple object, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a RegexMatchSet contains more than one RegexMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

type RegexMatchSetSummary

type RegexMatchSetSummary struct {

	// A friendly name or description of the RegexMatchSet. You can't change Name after you create
	// a RegexMatchSet .
	//
	// This member is required.
	Name *string

	// The RegexMatchSetId for a RegexMatchSet . You use RegexMatchSetId to get
	// information about a RegexMatchSet , update a RegexMatchSet , remove a
	// RegexMatchSet from a Rule , and delete a RegexMatchSet from AWS WAF.
	//
	// RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
	//
	// This member is required.
	RegexMatchSetId *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returned by ListRegexMatchSets. Each RegexMatchSetSummary object includes the Name and RegexMatchSetId for one RegexMatchSet.

type RegexMatchSetUpdate

type RegexMatchSetUpdate struct {

	// Specifies whether to insert or delete a RegexMatchTuple.
	//
	// This member is required.
	Action ChangeAction

	// Information about the part of a web request that you want AWS WAF to inspect
	// and the identifier of the regular expression (regex) pattern that you want AWS
	// WAF to search for. If you specify DELETE for the value of Action , the
	// RegexMatchTuple values must exactly match the values in the RegexMatchTuple
	// that you want to delete from the RegexMatchSet .
	//
	// This member is required.
	RegexMatchTuple *RegexMatchTuple
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In an UpdateRegexMatchSet request, RegexMatchSetUpdate specifies whether to insert or delete a RegexMatchTuple and includes the settings for the RegexMatchTuple .

type RegexMatchTuple

type RegexMatchTuple struct {

	// Specifies where in a web request to look for the RegexPatternSet .
	//
	// This member is required.
	FieldToMatch *FieldToMatch

	// The RegexPatternSetId for a RegexPatternSet . You use RegexPatternSetId to get
	// information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet),
	// insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet
	// (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).
	//
	// RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
	//
	// This member is required.
	RegexPatternSetId *string

	// Text transformations eliminate some of the unusual formatting that attackers
	// use in web requests in an effort to bypass AWS WAF. If you specify a
	// transformation, AWS WAF performs the transformation on RegexPatternSet before
	// inspecting a request for a match.
	//
	// You can only specify a single type of TextTransformation.
	//
	// CMD_LINE
	//
	// When you're concerned that attackers are injecting an operating system
	// commandline 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 to perform any text transformations.
	//
	// This member is required.
	TextTransformation TextTransformation
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each RegexMatchTuple object contains:

  • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

  • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

  • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

type RegexPatternSet

type RegexPatternSet struct {

	// The identifier for the RegexPatternSet . You use RegexPatternSetId to get
	// information about a RegexPatternSet , update a RegexPatternSet , remove a
	// RegexPatternSet from a RegexMatchSet , and delete a RegexPatternSet from AWS
	// WAF.
	//
	// RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
	//
	// This member is required.
	RegexPatternSetId *string

	// Specifies the regular expression (regex) patterns that you want AWS WAF to
	// search for, such as B[a@]dB[o0]t .
	//
	// This member is required.
	RegexPatternStrings []string

	// A friendly name or description of the RegexPatternSet. You can't change Name after you create
	// a RegexPatternSet .
	Name *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The RegexPatternSet specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t . You can then configure AWS WAF to reject those requests.

type RegexPatternSetSummary

type RegexPatternSetSummary struct {

	// A friendly name or description of the RegexPatternSet. You can't change Name after you create
	// a RegexPatternSet .
	//
	// This member is required.
	Name *string

	// The RegexPatternSetId for a RegexPatternSet . You use RegexPatternSetId to get
	// information about a RegexPatternSet , update a RegexPatternSet , remove a
	// RegexPatternSet from a RegexMatchSet , and delete a RegexPatternSet from AWS
	// WAF.
	//
	// RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
	//
	// This member is required.
	RegexPatternSetId *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returned by ListRegexPatternSets. Each RegexPatternSetSummary object includes the Name and RegexPatternSetId for one RegexPatternSet.

type RegexPatternSetUpdate

type RegexPatternSetUpdate struct {

	// Specifies whether to insert or delete a RegexPatternString .
	//
	// This member is required.
	Action ChangeAction

	// Specifies the regular expression (regex) pattern that you want AWS WAF to
	// search for, such as B[a@]dB[o0]t .
	//
	// This member is required.
	RegexPatternString *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

In an UpdateRegexPatternSet request, RegexPatternSetUpdate specifies whether to insert or delete a RegexPatternString and includes the settings for the RegexPatternString .

type Rule

type Rule struct {

	// The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object
	// that you want to include in a Rule .
	//
	// This member is required.
	Predicates []Predicate

	// A unique identifier for a Rule . You use RuleId to get more information about a
	// Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one
	// from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
	//
	// RuleId is returned by CreateRule and by ListRules.
	//
	// This member is required.
	RuleId *string

	// A friendly name or description for the metrics for this Rule . The name can
	// contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128
	// and minimum length one. It can't contain whitespace or metric names reserved for
	// AWS WAF, including "All" and "Default_Action." You can't change MetricName
	// after you create the Rule .
	MetricName *string

	// The friendly name or description for the Rule . You can't change the name of a
	// Rule after you create it.
	Name *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:

  • An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44

  • A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot .

To match the settings in this Rule , a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot .

type RuleGroup

type RuleGroup struct {

	// A unique identifier for a RuleGroup . You use RuleGroupId to get more
	// information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a
	// RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a
	// RuleGroup from AWS WAF (see DeleteRuleGroup).
	//
	// RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
	//
	// This member is required.
	RuleGroupId *string

	// A friendly name or description for the metrics for this RuleGroup . The name can
	// contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128
	// and minimum length one. It can't contain whitespace or metric names reserved for
	// AWS WAF, including "All" and "Default_Action." You can't change the name of the
	// metric after you create the RuleGroup .
	MetricName *string

	// The friendly name or description for the RuleGroup . You can't change the name
	// of a RuleGroup after you create it.
	Name *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A collection of predefined rules that you can add to a web ACL.

Rule groups are subject to the following limits:

  • Three rule groups per account. You can request an increase to this limit by contacting customer support.

  • One rule group per web ACL.

  • Ten rules per rule group.

type RuleGroupSummary

type RuleGroupSummary struct {

	// A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup
	// after you create it.
	//
	// This member is required.
	Name *string

	// A unique identifier for a RuleGroup . You use RuleGroupId to get more
	// information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a
	// RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a
	// RuleGroup from AWS WAF (see DeleteRuleGroup).
	//
	// RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
	//
	// This member is required.
	RuleGroupId *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the friendly name or description of the RuleGroup .

type RuleGroupUpdate

type RuleGroupUpdate struct {

	// Specify INSERT to add an ActivatedRule to a RuleGroup . Use DELETE to remove an
	// ActivatedRule from a RuleGroup .
	//
	// This member is required.
	Action ChangeAction

	// The ActivatedRule object specifies a Rule that you want to insert or delete,
	// the priority of the Rule in the WebACL , and the action that you want AWS WAF to
	// take when a web request matches the Rule ( ALLOW , BLOCK , or COUNT ).
	//
	// This member is required.
	ActivatedRule *ActivatedRule
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies an ActivatedRule and indicates whether you want to add it to a RuleGroup or delete it from a RuleGroup .

type RuleSummary

type RuleSummary struct {

	// A friendly name or description of the Rule. You can't change the name of a Rule
	// after you create it.
	//
	// This member is required.
	Name *string

	// A unique identifier for a Rule . You use RuleId to get more information about a
	// Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one
	// from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
	//
	// RuleId is returned by CreateRule and by ListRules.
	//
	// This member is required.
	RuleId *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the friendly name or description of the Rule .

type RuleUpdate

type RuleUpdate struct {

	// Specify INSERT to add a Predicate to a Rule . Use DELETE to remove a Predicate
	// from a Rule .
	//
	// This member is required.
	Action ChangeAction

	// The ID of the Predicate (such as an IPSet ) that you want to add to a Rule .
	//
	// This member is required.
	Predicate *Predicate
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies a Predicate (such as an IPSet ) and indicates whether you want to add it to a Rule or delete it from 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. A result that has a weight of 2 represents
	// roughly twice as many CloudFront 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

	// This value is returned if the GetSampledRequests request specifies the ID of a
	// RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the
	// rule within the specified RuleGroup that matched the request listed in the
	// response.
	RuleWithinRuleGroup *string

	// The time at which AWS WAF received the request from your AWS resource, in Unix
	// time format (in seconds).
	Timestamp *time.Time
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The response from a GetSampledRequests request includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains one SampledHTTPRequest object for each web request that is returned by GetSampledRequests .

type SizeConstraint

type SizeConstraint struct {

	// The type of comparison you want AWS WAF to perform. AWS WAF uses this in
	// combination with the provided Size and FieldToMatch to build an expression in
	// the form of " Size ComparisonOperator size in bytes of FieldToMatch ". If that
	// expression is true, the SizeConstraint is considered to match.
	//
	// EQ: Used to test if the Size is equal to the size of the FieldToMatch
	//
	// NE: Used to test if the Size is not equal to the size of the FieldToMatch
	//
	// LE: Used to test if the Size is less than or equal to the size of the
	// FieldToMatch
	//
	// LT: Used to test if the Size is strictly less than the size of the FieldToMatch
	//
	// GE: Used to test if the Size is greater than or equal to the size of the
	// FieldToMatch
	//
	// GT: Used to test if the Size is strictly greater than the size of the
	// FieldToMatch
	//
	// This member is required.
	ComparisonOperator ComparisonOperator

	// Specifies where in a web request to look for the size constraint.
	//
	// This member is required.
	FieldToMatch *FieldToMatch

	// The size in bytes that you want AWS WAF to compare against the size of the
	// specified FieldToMatch . AWS WAF uses this in combination with
	// ComparisonOperator and FieldToMatch to build an expression in the form of " Size
	// ComparisonOperator size in bytes of FieldToMatch ". If that expression is true,
	// the SizeConstraint is considered to match.
	//
	// Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).
	//
	// If you specify URI for the value of Type , the / in the URI counts as one
	// character. For example, the URI /logo.jpg is nine characters long.
	//
	// 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 AWS WAF. If you specify a
	// transformation, AWS WAF performs the transformation on FieldToMatch before
	// inspecting it for a match.
	//
	// You can only specify a single type of TextTransformation.
	//
	// Note that if you choose BODY for the value of Type , you must choose NONE for
	// TextTransformation because CloudFront forwards only the first 8192 bytes for
	// inspection.
	//
	// NONE
	//
	// Specify NONE if you don't want to perform any text transformations.
	//
	// 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.
	//
	// This member is required.
	TextTransformation TextTransformation
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size , ComparisonOperator , and FieldToMatch to build an expression in the form of " Size ComparisonOperator size in bytes of FieldToMatch ". If that expression is true, the SizeConstraint is considered to match.

type SizeConstraintSet

type SizeConstraintSet struct {

	// A unique identifier for a SizeConstraintSet . You use SizeConstraintSetId to
	// get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet
	// (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule
	// ), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).
	//
	// SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
	//
	// This member is required.
	SizeConstraintSetId *string

	// Specifies the parts of web requests that you want to inspect the size of.
	//
	// This member is required.
	SizeConstraints []SizeConstraint

	// The name, if any, of the SizeConstraintSet .
	Name *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match.

type SizeConstraintSetSummary

type SizeConstraintSetSummary struct {

	// The name of the SizeConstraintSet , if any.
	//
	// This member is required.
	Name *string

	// A unique identifier for a SizeConstraintSet . You use SizeConstraintSetId to
	// get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet
	// (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule
	// ), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).
	//
	// SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
	//
	// This member is required.
	SizeConstraintSetId *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The Id and Name of a SizeConstraintSet .

type SizeConstraintSetUpdate

type SizeConstraintSetUpdate struct {

	// Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate
	// from a SizeConstraintSet .
	//
	// This member is required.
	Action ChangeAction

	// Specifies a constraint on the size of a part of the web request. AWS WAF uses
	// the Size , ComparisonOperator , and FieldToMatch to build an expression in the
	// form of " Size ComparisonOperator size in bytes of FieldToMatch ". If that
	// expression is true, the SizeConstraint is considered to match.
	//
	// This member is required.
	SizeConstraint *SizeConstraint
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want to inspect the size of and indicates whether you want to add the specification to a SizeConstraintSetor delete it from a SizeConstraintSet .

type SqlInjectionMatchSet

type SqlInjectionMatchSet struct {

	// A unique identifier for a SqlInjectionMatchSet . You use SqlInjectionMatchSetId
	// to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a
	// SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or
	// delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF
	// (see DeleteSqlInjectionMatchSet).
	//
	// SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
	//
	// This member is required.
	SqlInjectionMatchSetId *string

	// Specifies the parts of web requests that you want to inspect for snippets of
	// malicious SQL code.
	//
	// This member is required.
	SqlInjectionMatchTuples []SqlInjectionMatchTuple

	// The name, if any, of the SqlInjectionMatchSet .
	Name *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match.

type SqlInjectionMatchSetSummary

type SqlInjectionMatchSetSummary struct {

	// The name of the SqlInjectionMatchSet , if any, specified by Id .
	//
	// This member is required.
	Name *string

	// A unique identifier for a SqlInjectionMatchSet . You use SqlInjectionMatchSetId
	// to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a
	// SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or
	// delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF
	// (see DeleteSqlInjectionMatchSet).
	//
	// SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
	//
	// This member is required.
	SqlInjectionMatchSetId *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The Id and Name of a SqlInjectionMatchSet .

type SqlInjectionMatchSetUpdate

type SqlInjectionMatchSetUpdate struct {

	// Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a
	// SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet .
	//
	// This member is required.
	Action ChangeAction

	// Specifies the part of a web request that you want AWS WAF to inspect for
	// snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the
	// name of the header.
	//
	// This member is required.
	SqlInjectionMatchTuple *SqlInjectionMatchTuple
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to add the specification to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet .

type SqlInjectionMatchTuple

type SqlInjectionMatchTuple struct {

	// Specifies where in a web request to look for snippets of malicious SQL code.
	//
	// 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 AWS WAF. If you specify a
	// transformation, AWS WAF performs the transformation on FieldToMatch before
	// inspecting it for a match.
	//
	// You can only specify a single type of TextTransformation.
	//
	// 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 to perform any text transformations.
	//
	// This member is required.
	TextTransformation TextTransformation
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

type SubscribedRuleGroupSummary

type SubscribedRuleGroupSummary struct {

	// A friendly name or description for the metrics for this RuleGroup . The name can
	// contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128
	// and minimum length one. It can't contain whitespace or metric names reserved for
	// AWS WAF, including "All" and "Default_Action." You can't change the name of the
	// metric after you create the RuleGroup .
	//
	// This member is required.
	MetricName *string

	// A friendly name or description of the RuleGroup . You can't change the name of a
	// RuleGroup after you create it.
	//
	// This member is required.
	Name *string

	// A unique identifier for a RuleGroup .
	//
	// This member is required.
	RuleGroupId *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A summary of the rule groups you are subscribed to.

type Tag

type Tag struct {

	//
	//
	// This member is required.
	Key *string

	//
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

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. For example, 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.

Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.

type TagInfoForResource

type TagInfoForResource struct {

	//
	ResourceARN *string

	//
	TagList []Tag
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Information for 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. For example, 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.

Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.

type TextTransformation

type TextTransformation string
const (
	TextTransformationNone               TextTransformation = "NONE"
	TextTransformationCompressWhiteSpace TextTransformation = "COMPRESS_WHITE_SPACE"
	TextTransformationHtmlEntityDecode   TextTransformation = "HTML_ENTITY_DECODE"
	TextTransformationLowercase          TextTransformation = "LOWERCASE"
	TextTransformationCmdLine            TextTransformation = "CMD_LINE"
	TextTransformationUrlDecode          TextTransformation = "URL_DECODE"
)

Enum values for TextTransformation

func (TextTransformation) Values added in v0.29.0

Values returns all known values for TextTransformation. 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
	// date and time 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 date and time 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
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

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" .

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 WAFBadRequestException

type WAFBadRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

func (*WAFBadRequestException) Error

func (e *WAFBadRequestException) Error() string

func (*WAFBadRequestException) ErrorCode

func (e *WAFBadRequestException) ErrorCode() string

func (*WAFBadRequestException) ErrorFault

func (e *WAFBadRequestException) ErrorFault() smithy.ErrorFault

func (*WAFBadRequestException) ErrorMessage

func (e *WAFBadRequestException) ErrorMessage() string

type WAFDisallowedNameException

type WAFDisallowedNameException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The name specified is invalid.

func (*WAFDisallowedNameException) Error

func (*WAFDisallowedNameException) ErrorCode

func (e *WAFDisallowedNameException) ErrorCode() string

func (*WAFDisallowedNameException) ErrorFault

func (*WAFDisallowedNameException) ErrorMessage

func (e *WAFDisallowedNameException) ErrorMessage() string

type WAFEntityMigrationException

type WAFEntityMigrationException struct {
	Message *string

	ErrorCodeOverride *string

	MigrationErrorType   MigrationErrorType
	MigrationErrorReason *string
	// contains filtered or unexported fields
}

The operation failed due to a problem with the migration. The failure cause is provided in the exception, in the MigrationErrorType :

  • ENTITY_NOT_SUPPORTED - The web ACL has an unsupported entity but the IgnoreUnsupportedType is not set to true.

  • ENTITY_NOT_FOUND - The web ACL doesn't exist.

  • S3_BUCKET_NO_PERMISSION - You don't have permission to perform the PutObject action to the specified Amazon S3 bucket.

  • S3_BUCKET_NOT_ACCESSIBLE - The bucket policy doesn't allow AWS WAF to perform the PutObject action in the bucket.

  • S3_BUCKET_NOT_FOUND - The S3 bucket doesn't exist.

  • S3_BUCKET_INVALID_REGION - The S3 bucket is not in the same Region as the web ACL.

  • S3_INTERNAL_ERROR - AWS WAF failed to create the template in the S3 bucket for another reason.

func (*WAFEntityMigrationException) Error

func (*WAFEntityMigrationException) ErrorCode

func (e *WAFEntityMigrationException) ErrorCode() string

func (*WAFEntityMigrationException) ErrorFault

func (*WAFEntityMigrationException) ErrorMessage

func (e *WAFEntityMigrationException) ErrorMessage() string

type WAFInternalErrorException

type WAFInternalErrorException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation failed because of a system problem, even though the request was valid. Retry your request.

func (*WAFInternalErrorException) Error

func (e *WAFInternalErrorException) Error() string

func (*WAFInternalErrorException) ErrorCode

func (e *WAFInternalErrorException) ErrorCode() string

func (*WAFInternalErrorException) ErrorFault

func (*WAFInternalErrorException) ErrorMessage

func (e *WAFInternalErrorException) ErrorMessage() string

type WAFInvalidAccountException

type WAFInvalidAccountException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

func (*WAFInvalidAccountException) Error

func (*WAFInvalidAccountException) ErrorCode

func (e *WAFInvalidAccountException) ErrorCode() string

func (*WAFInvalidAccountException) ErrorFault

func (*WAFInvalidAccountException) ErrorMessage

func (e *WAFInvalidAccountException) ErrorMessage() string

type WAFInvalidOperationException

type WAFInvalidOperationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation failed because there was nothing to do. For example:

  • You tried to remove a Rule from a WebACL , but the Rule isn't in the specified WebACL .

  • You tried to remove an IP address from an IPSet , but the IP address isn't in the specified IPSet .

  • You tried to remove a ByteMatchTuple from a ByteMatchSet , but the ByteMatchTuple isn't in the specified WebACL .

  • You tried to add a Rule to a WebACL , but the Rule already exists in the specified WebACL .

  • You tried to add a ByteMatchTuple to a ByteMatchSet , but the ByteMatchTuple already exists in the specified WebACL .

func (*WAFInvalidOperationException) Error

func (*WAFInvalidOperationException) ErrorCode

func (e *WAFInvalidOperationException) ErrorCode() string

func (*WAFInvalidOperationException) ErrorFault

func (*WAFInvalidOperationException) ErrorMessage

func (e *WAFInvalidOperationException) ErrorMessage() string

type WAFInvalidParameterException

type WAFInvalidParameterException struct {
	Message *string

	ErrorCodeOverride *string

	Field     ParameterExceptionField
	Parameter *string
	Reason    ParameterExceptionReason
	// contains filtered or unexported fields
}

The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

  • You specified an invalid parameter name.

  • You specified an invalid value.

  • You tried to update an object ( ByteMatchSet , IPSet , Rule , or WebACL ) using an action other than INSERT or DELETE .

  • You tried to create a WebACL with a DefaultAction Type other than ALLOW , BLOCK , or COUNT .

  • You tried to create a RateBasedRule with a RateKey value other than IP .

  • You tried to update a WebACL with a WafAction Type other than ALLOW , BLOCK , or COUNT .

  • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

  • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data .

  • 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 (*WAFInvalidParameterException) ErrorCode

func (e *WAFInvalidParameterException) ErrorCode() string

func (*WAFInvalidParameterException) ErrorFault

func (*WAFInvalidParameterException) ErrorMessage

func (e *WAFInvalidParameterException) ErrorMessage() string

type WAFInvalidPermissionPolicyException

type WAFInvalidPermissionPolicyException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation failed because the specified policy is not in the proper format.

The policy is subject to the following restrictions:

  • You can attach only one policy with each PutPermissionPolicy request.

  • The policy must include an Effect , Action and Principal .

  • Effect must specify Allow .

  • The Action in the policy must be waf:UpdateWebACL , waf-regional:UpdateWebACL , waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.

  • The policy cannot include a Resource parameter.

  • The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.

  • The user making the request must be the owner of the RuleGroup.

  • Your policy must be composed using IAM Policy version 2012-10-17.

func (*WAFInvalidPermissionPolicyException) Error

func (*WAFInvalidPermissionPolicyException) ErrorCode

func (*WAFInvalidPermissionPolicyException) ErrorFault

func (*WAFInvalidPermissionPolicyException) ErrorMessage

func (e *WAFInvalidPermissionPolicyException) ErrorMessage() string

type WAFInvalidRegexPatternException

type WAFInvalidRegexPatternException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The regular expression (regex) you specified in RegexPatternString is invalid.

func (*WAFInvalidRegexPatternException) Error

func (*WAFInvalidRegexPatternException) ErrorCode

func (e *WAFInvalidRegexPatternException) ErrorCode() string

func (*WAFInvalidRegexPatternException) ErrorFault

func (*WAFInvalidRegexPatternException) ErrorMessage

func (e *WAFInvalidRegexPatternException) ErrorMessage() string

type WAFLimitsExceededException

type WAFLimitsExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.

func (*WAFLimitsExceededException) Error

func (*WAFLimitsExceededException) ErrorCode

func (e *WAFLimitsExceededException) ErrorCode() string

func (*WAFLimitsExceededException) ErrorFault

func (*WAFLimitsExceededException) ErrorMessage

func (e *WAFLimitsExceededException) ErrorMessage() string

type WAFNonEmptyEntityException

type WAFNonEmptyEntityException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation failed because you tried to delete an object that isn't empty. For example:

  • You tried to delete a WebACL that still contains one or more Rule objects.

  • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

  • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

  • You tried to delete an IPSet that references one or more IP addresses.

func (*WAFNonEmptyEntityException) Error

func (*WAFNonEmptyEntityException) ErrorCode

func (e *WAFNonEmptyEntityException) ErrorCode() string

func (*WAFNonEmptyEntityException) ErrorFault

func (*WAFNonEmptyEntityException) ErrorMessage

func (e *WAFNonEmptyEntityException) ErrorMessage() string

type WAFNonexistentContainerException

type WAFNonexistentContainerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

  • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

  • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

  • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

  • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

func (*WAFNonexistentContainerException) Error

func (*WAFNonexistentContainerException) ErrorCode

func (*WAFNonexistentContainerException) ErrorFault

func (*WAFNonexistentContainerException) ErrorMessage

func (e *WAFNonexistentContainerException) ErrorMessage() string

type WAFNonexistentItemException

type WAFNonexistentItemException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation failed because the referenced object doesn't exist.

func (*WAFNonexistentItemException) Error

func (*WAFNonexistentItemException) ErrorCode

func (e *WAFNonexistentItemException) ErrorCode() string

func (*WAFNonexistentItemException) ErrorFault

func (*WAFNonexistentItemException) ErrorMessage

func (e *WAFNonexistentItemException) ErrorMessage() string

type WAFReferencedItemException

type WAFReferencedItemException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation failed because you tried to delete an object that is still in use. For example:

  • You tried to delete a ByteMatchSet that is still referenced by a Rule .

  • You tried to delete a Rule that is still referenced by a WebACL .

func (*WAFReferencedItemException) Error

func (*WAFReferencedItemException) ErrorCode

func (e *WAFReferencedItemException) ErrorCode() string

func (*WAFReferencedItemException) ErrorFault

func (*WAFReferencedItemException) ErrorMessage

func (e *WAFReferencedItemException) ErrorMessage() string

type WAFServiceLinkedRoleErrorException

type WAFServiceLinkedRoleErrorException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 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 (*WAFServiceLinkedRoleErrorException) ErrorCode

func (*WAFServiceLinkedRoleErrorException) ErrorFault

func (*WAFServiceLinkedRoleErrorException) ErrorMessage

func (e *WAFServiceLinkedRoleErrorException) ErrorMessage() string

type WAFStaleDataException

type WAFStaleDataException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

func (*WAFStaleDataException) Error

func (e *WAFStaleDataException) Error() string

func (*WAFStaleDataException) ErrorCode

func (e *WAFStaleDataException) ErrorCode() string

func (*WAFStaleDataException) ErrorFault

func (e *WAFStaleDataException) ErrorFault() smithy.ErrorFault

func (*WAFStaleDataException) ErrorMessage

func (e *WAFStaleDataException) ErrorMessage() string

type WAFSubscriptionNotFoundException

type WAFSubscriptionNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified subscription does not exist.

func (*WAFSubscriptionNotFoundException) Error

func (*WAFSubscriptionNotFoundException) ErrorCode

func (*WAFSubscriptionNotFoundException) ErrorFault

func (*WAFSubscriptionNotFoundException) ErrorMessage

func (e *WAFSubscriptionNotFoundException) ErrorMessage() string

type WAFTagOperationException

type WAFTagOperationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

func (*WAFTagOperationInternalErrorException) Error

func (*WAFTagOperationInternalErrorException) ErrorCode

func (*WAFTagOperationInternalErrorException) ErrorFault

func (*WAFTagOperationInternalErrorException) ErrorMessage

type WafAction

type WafAction struct {

	// Specifies how you want AWS WAF to respond to requests that match the settings
	// in a Rule . Valid settings include the following:
	//
	//   - ALLOW : AWS WAF allows requests
	//
	//   - BLOCK : AWS WAF blocks requests
	//
	//   - COUNT : AWS WAF increments a counter of the requests that match all of the
	//   conditions in the rule. AWS WAF then continues to inspect the web request based
	//   on the remaining rules in the web ACL. You can't specify COUNT for the default
	//   action for a WebACL .
	//
	// This member is required.
	Type WafActionType
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

For the action that is associated with a rule in a WebACL , specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL , specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL .

type WafActionType

type WafActionType string
const (
	WafActionTypeBlock WafActionType = "BLOCK"
	WafActionTypeAllow WafActionType = "ALLOW"
	WafActionTypeCount WafActionType = "COUNT"
)

Enum values for WafActionType

func (WafActionType) Values added in v0.29.0

func (WafActionType) Values() []WafActionType

Values returns all known values for WafActionType. 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 WafOverrideAction

type WafOverrideAction struct {

	// COUNT overrides the action specified by the individual rule within a RuleGroup
	// . If set to NONE , the rule's action will take place.
	//
	// This member is required.
	Type WafOverrideActionType
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The action to take if any rule within the RuleGroup matches a request.

type WafOverrideActionType

type WafOverrideActionType string
const (
	WafOverrideActionTypeNone  WafOverrideActionType = "NONE"
	WafOverrideActionTypeCount WafOverrideActionType = "COUNT"
)

Enum values for WafOverrideActionType

func (WafOverrideActionType) Values added in v0.29.0

Values returns all known values for WafOverrideActionType. 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 WafRuleType

type WafRuleType string
const (
	WafRuleTypeRegular   WafRuleType = "REGULAR"
	WafRuleTypeRateBased WafRuleType = "RATE_BASED"
	WafRuleTypeGroup     WafRuleType = "GROUP"
)

Enum values for WafRuleType

func (WafRuleType) Values added in v0.29.0

func (WafRuleType) Values() []WafRuleType

Values returns all known values for WafRuleType. 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 WebACL

type WebACL struct {

	// The action to perform if none of the Rules contained in the WebACL match. The
	// action is specified by the WafActionobject.
	//
	// This member is required.
	DefaultAction *WafAction

	// An array that contains the action for each Rule in a WebACL , the priority of
	// the Rule , and the ID of the Rule .
	//
	// This member is required.
	Rules []ActivatedRule

	// A unique identifier for a WebACL . You use WebACLId to get information about a
	// WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).
	//
	// WebACLId is returned by CreateWebACL and by ListWebACLs.
	//
	// This member is required.
	WebACLId *string

	// A friendly name or description for the metrics for this WebACL . The name can
	// contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128
	// and minimum length one. It can't contain whitespace or metric names reserved for
	// AWS WAF, including "All" and "Default_Action." You can't change MetricName
	// after you create the WebACL .
	MetricName *string

	// A friendly name or description of the WebACL . You can't change the name of a
	// WebACL after you create it.
	Name *string

	// Tha Amazon Resource Name (ARN) of the web ACL.
	WebACLArn *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL , you also specify a default action ( ALLOW or BLOCK ), and the action for each Rule that you add to a WebACL , for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL , a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.

type WebACLSummary

type WebACLSummary struct {

	// A friendly name or description of the WebACL. You can't change the name of a WebACL
	// after you create it.
	//
	// This member is required.
	Name *string

	// A unique identifier for a WebACL . You use WebACLId to get information about a
	// WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).
	//
	// WebACLId is returned by CreateWebACL and by ListWebACLs.
	//
	// This member is required.
	WebACLId *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Contains the identifier and the name or description of the WebACL.

type WebACLUpdate

type WebACLUpdate struct {

	// Specifies whether to insert a Rule into or delete a Rule from a WebACL .
	//
	// This member is required.
	Action ChangeAction

	// The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to
	// insert or delete, the priority of the Rule in the WebACL , and the action that
	// you want AWS WAF to take when a web request matches the Rule ( ALLOW , BLOCK ,
	// or COUNT ).
	//
	// This member is required.
	ActivatedRule *ActivatedRule
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies whether to insert a Rule into or delete a Rule from a WebACL .

type XssMatchSet

type XssMatchSet struct {

	// A unique identifier for an XssMatchSet . You use XssMatchSetId to get
	// information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert
	// an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an
	// XssMatchSet from AWS WAF (see DeleteXssMatchSet).
	//
	// XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
	//
	// This member is required.
	XssMatchSetId *string

	// Specifies the parts of web requests that you want to inspect for cross-site
	// scripting attacks.
	//
	// This member is required.
	XssMatchTuples []XssMatchTuple

	// The name, if any, of the XssMatchSet .
	Name *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match.

type XssMatchSetSummary

type XssMatchSetSummary struct {

	// The name of the XssMatchSet , if any, specified by Id .
	//
	// This member is required.
	Name *string

	// A unique identifier for an XssMatchSet . You use XssMatchSetId to get
	// information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an
	// XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an
	// XssMatchSet from AWS WAF (see DeleteXssMatchSet).
	//
	// XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
	//
	// This member is required.
	XssMatchSetId *string
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The Id and Name of an XssMatchSet .

type XssMatchSetUpdate

type XssMatchSetUpdate struct {

	// Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate
	// from an XssMatchSet .
	//
	// This member is required.
	Action ChangeAction

	// Specifies the part of a web request that you want AWS WAF to inspect for
	// cross-site scripting attacks and, if you want AWS WAF to inspect a header, the
	// name of the header.
	//
	// This member is required.
	XssMatchTuple *XssMatchTuple
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want to inspect for cross-site scripting attacks and indicates whether you want to add the specification to an XssMatchSet or delete it from an XssMatchSet .

type XssMatchTuple

type XssMatchTuple struct {

	// Specifies where in a web request to look for cross-site scripting attacks.
	//
	// 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 AWS WAF. If you specify a
	// transformation, AWS WAF performs the transformation on FieldToMatch before
	// inspecting it for a match.
	//
	// You can only specify a single type of TextTransformation.
	//
	// 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 to perform any text transformations.
	//
	// This member is required.
	TextTransformation TextTransformation
	// contains filtered or unexported fields
}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL