Package software.amazon.awscdk.services.appmesh

Interface CfnGatewayRoute.HttpGatewayRouteMatchProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGatewayRoute.HttpGatewayRouteMatchProperty.Jsii$Proxy

Enclosing class:

CfnGatewayRoute

@Stability(Stable)
public static interface CfnGatewayRoute.HttpGatewayRouteMatchProperty
extends software.amazon.jsii.JsiiSerializable

An object that represents the criteria for determining a request match.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appmesh.*;
 HttpGatewayRouteMatchProperty httpGatewayRouteMatchProperty = HttpGatewayRouteMatchProperty.builder()
         .headers(List.of(HttpGatewayRouteHeaderProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .invert(false)
                 .match(HttpGatewayRouteHeaderMatchProperty.builder()
                         .exact("exact")
                         .prefix("prefix")
                         .range(GatewayRouteRangeMatchProperty.builder()
                                 .end(123)
                                 .start(123)
                                 .build())
                         .regex("regex")
                         .suffix("suffix")
                         .build())
                 .build()))
         .hostname(GatewayRouteHostnameMatchProperty.builder()
                 .exact("exact")
                 .suffix("suffix")
                 .build())
         .method("method")
         .path(HttpPathMatchProperty.builder()
                 .exact("exact")
                 .regex("regex")
                 .build())
         .port(123)
         .prefix("prefix")
         .queryParameters(List.of(QueryParameterProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .match(HttpQueryParameterMatchProperty.builder()
                         .exact("exact")
                         .build())
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGatewayRoute.HttpGatewayRouteMatchProperty.Builder	A builder for CfnGatewayRoute.HttpGatewayRouteMatchProperty
static final class	CfnGatewayRoute.HttpGatewayRouteMatchProperty.Jsii$Proxy	An implementation for CfnGatewayRoute.HttpGatewayRouteMatchProperty

Method Summary

Modifier and Type	Method	Description
static CfnGatewayRoute.HttpGatewayRouteMatchProperty.Builder	builder()
default Object	getHeaders()	The client request headers to match on.
default Object	getHostname()	The host name to match on.
default String	getMethod()	The method to match on.
default Object	getPath()	The path to match on.
default Number	getPort()	The port number to match on.
default String	getPrefix()	Specifies the path to match requests with.
default Object	getQueryParameters()	The query parameter to match on.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHeaders

@Stability(Stable)
@Nullable
default Object getHeaders()

The client request headers to match on.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGatewayRoute.HttpGatewayRouteHeaderProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-headers

getHostname

@Stability(Stable)
@Nullable
default Object getHostname()

The host name to match on.

Returns union: either IResolvable or CfnGatewayRoute.GatewayRouteHostnameMatchProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-hostname

getMethod

@Stability(Stable)
@Nullable
default String getMethod()

The method to match on.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-method

getPath

@Stability(Stable)
@Nullable
default Object getPath()

The path to match on.

Returns union: either IResolvable or CfnGatewayRoute.HttpPathMatchProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-path

getPort

@Stability(Stable)
@Nullable
default Number getPort()

The port number to match on.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-port

getPrefix

@Stability(Stable)
@Nullable
default String getPrefix()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-prefix

getQueryParameters

@Stability(Stable)
@Nullable
default Object getQueryParameters()

The query parameter to match on.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGatewayRoute.QueryParameterProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-queryparameters

builder

@Stability(Stable)
static CfnGatewayRoute.HttpGatewayRouteMatchProperty.Builder builder()

Returns:

a CfnGatewayRoute.HttpGatewayRouteMatchProperty.Builder of CfnGatewayRoute.HttpGatewayRouteMatchProperty