FieldToMatch

public struct FieldToMatch : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Inspect all query arguments.

    Declaration

    Swift

    public let allQueryArguments: AllQueryArguments?

  • Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don’t need to inspect more than 8 KB, you can guarantee that you don’t allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn’t support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

    Declaration

    Swift

    public let body: Body?

  • Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

    Declaration

    Swift

    public let method: Method?

  • Inspect the query string. This is the part of a URL that appears after a ? character, if any.

    Declaration

    Swift

    public let queryString: QueryString?

  • Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn’t case sensitive.

    Declaration

    Swift

    public let singleHeader: SingleHeader?

  • Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn’t case sensitive. This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

    Declaration

    Swift

    public let singleQueryArgument: SingleQueryArgument?

  • Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

    Declaration

    Swift

    public let uriPath: UriPath?

  • Undocumented

    Declaration

    Swift

    public init(allQueryArguments: AllQueryArguments? = nil, body: Body? = nil, method: Method? = nil, queryString: QueryString? = nil, singleHeader: SingleHeader? = nil, singleQueryArgument: SingleQueryArgument? = nil, uriPath: UriPath? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws