Class: Aws::AppMesh::Types::GatewayRouteSpec

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 GatewayRouteSpec data as a hash:

{
  grpc_route: {
    action: { # required
      rewrite: {
        hostname: {
          default_target_hostname: "ENABLED", # accepts ENABLED, DISABLED
        },
      },
      target: { # required
        virtual_service: { # required
          virtual_service_name: "ResourceName", # required
        },
      },
    },
    match: { # required
      hostname: {
        exact: "ExactHostName",
        suffix: "SuffixHostname",
      },
      metadata: [
        {
          invert: false,
          match: {
            exact: "HeaderMatch",
            prefix: "HeaderMatch",
            range: {
              end: 1, # required
              start: 1, # required
            },
            regex: "HeaderMatch",
            suffix: "HeaderMatch",
          },
          name: "HeaderName", # required
        },
      ],
      service_name: "ServiceName",
    },
  },
  http2_route: {
    action: { # required
      rewrite: {
        hostname: {
          default_target_hostname: "ENABLED", # accepts ENABLED, DISABLED
        },
        path: {
          exact: "HttpPathExact",
        },
        prefix: {
          default_prefix: "ENABLED", # accepts ENABLED, DISABLED
          value: "HttpGatewayRoutePrefix",
        },
      },
      target: { # required
        virtual_service: { # required
          virtual_service_name: "ResourceName", # required
        },
      },
    },
    match: { # required
      headers: [
        {
          invert: false,
          match: {
            exact: "HeaderMatch",
            prefix: "HeaderMatch",
            range: {
              end: 1, # required
              start: 1, # required
            },
            regex: "HeaderMatch",
            suffix: "HeaderMatch",
          },
          name: "HeaderName", # required
        },
      ],
      hostname: {
        exact: "ExactHostName",
        suffix: "SuffixHostname",
      },
      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
        },
      ],
    },
  },
  http_route: {
    action: { # required
      rewrite: {
        hostname: {
          default_target_hostname: "ENABLED", # accepts ENABLED, DISABLED
        },
        path: {
          exact: "HttpPathExact",
        },
        prefix: {
          default_prefix: "ENABLED", # accepts ENABLED, DISABLED
          value: "HttpGatewayRoutePrefix",
        },
      },
      target: { # required
        virtual_service: { # required
          virtual_service_name: "ResourceName", # required
        },
      },
    },
    match: { # required
      headers: [
        {
          invert: false,
          match: {
            exact: "HeaderMatch",
            prefix: "HeaderMatch",
            range: {
              end: 1, # required
              start: 1, # required
            },
            regex: "HeaderMatch",
            suffix: "HeaderMatch",
          },
          name: "HeaderName", # required
        },
      ],
      hostname: {
        exact: "ExactHostName",
        suffix: "SuffixHostname",
      },
      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
        },
      ],
    },
  },
  priority: 1,
}

An object that represents a gateway route specification. Specify one gateway route type.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#grpc_routeTypes::GrpcGatewayRoute

An object that represents the specification of a gRPC gateway route.



2926
2927
2928
2929
2930
2931
2932
2933
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 2926

class GatewayRouteSpec < Struct.new(
  :grpc_route,
  :http2_route,
  :http_route,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#http2_routeTypes::HttpGatewayRoute

An object that represents the specification of an HTTP/2 gateway route.



2926
2927
2928
2929
2930
2931
2932
2933
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 2926

class GatewayRouteSpec < Struct.new(
  :grpc_route,
  :http2_route,
  :http_route,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#http_routeTypes::HttpGatewayRoute

An object that represents the specification of an HTTP gateway route.



2926
2927
2928
2929
2930
2931
2932
2933
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 2926

class GatewayRouteSpec < Struct.new(
  :grpc_route,
  :http2_route,
  :http_route,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end

#priorityInteger

The ordering of the gateway routes spec.

Returns:

  • (Integer)


2926
2927
2928
2929
2930
2931
2932
2933
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 2926

class GatewayRouteSpec < Struct.new(
  :grpc_route,
  :http2_route,
  :http_route,
  :priority)
  SENSITIVE = []
  include Aws::Structure
end