Class: Aws::AppMesh::Types::HttpRouteMatch

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb

Overview

Note:

When making an API call, you may pass HttpRouteMatch data as a hash:

{
  headers: [
    {
      invert: false,
      match: {
        exact: "HeaderMatch",
        prefix: "HeaderMatch",
        range: {
          end: 1, # required
          start: 1, # required
        },
        regex: "HeaderMatch",
        suffix: "HeaderMatch",
      },
      name: "HeaderName", # required
    },
  ],
  method: "GET", # accepts GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH
  path: {
    exact: "HttpPathExact",
    regex: "HttpPathRegex",
  },
  prefix: "String",
  query_parameters: [
    {
      match: {
        exact: "String",
      },
      name: "QueryParameterName", # required
    },
  ],
  scheme: "http", # accepts http, https
}

An object that represents the requirements for a route to match HTTP requests for a virtual router.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#headersArray<Types::HttpRouteHeader>

The client request headers to match on.

Returns:



4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4448

class HttpRouteMatch < Struct.new(
  :headers,
  :method,
  :path,
  :prefix,
  :query_parameters,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#methodString

The client request method to match on. Specify only one.

Returns:

  • (String)


4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4448

class HttpRouteMatch < Struct.new(
  :headers,
  :method,
  :path,
  :prefix,
  :query_parameters,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#pathTypes::HttpPathMatch

The client request path to match on.



4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4448

class HttpRouteMatch < Struct.new(
  :headers,
  :method,
  :path,
  :prefix,
  :query_parameters,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#prefixString

Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

Returns:

  • (String)


4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4448

class HttpRouteMatch < Struct.new(
  :headers,
  :method,
  :path,
  :prefix,
  :query_parameters,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#query_parametersArray<Types::HttpQueryParameter>

The client request query parameters to match on.

Returns:



4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4448

class HttpRouteMatch < Struct.new(
  :headers,
  :method,
  :path,
  :prefix,
  :query_parameters,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end

#schemeString

The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.

Returns:

  • (String)


4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4448

class HttpRouteMatch < Struct.new(
  :headers,
  :method,
  :path,
  :prefix,
  :query_parameters,
  :scheme)
  SENSITIVE = []
  include Aws::Structure
end