Package software.amazon.awscdk.services.appmesh

Interface CfnRoute.HttpRouteProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRoute.HttpRouteProperty.Jsii$Proxy

Enclosing class:

CfnRoute

@Stability(Stable)
public static interface CfnRoute.HttpRouteProperty
extends software.amazon.jsii.JsiiSerializable

An object that represents an HTTP or HTTP/2 route type.

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.*;
 HttpRouteProperty httpRouteProperty = HttpRouteProperty.builder()
         .action(HttpRouteActionProperty.builder()
                 .weightedTargets(List.of(WeightedTargetProperty.builder()
                         .virtualNode("virtualNode")
                         .weight(123)
                         // the properties below are optional
                         .port(123)
                         .build()))
                 .build())
         .match(HttpRouteMatchProperty.builder()
                 .headers(List.of(HttpRouteHeaderProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .invert(false)
                         .match(HeaderMatchMethodProperty.builder()
                                 .exact("exact")
                                 .prefix("prefix")
                                 .range(MatchRangeProperty.builder()
                                         .end(123)
                                         .start(123)
                                         .build())
                                 .regex("regex")
                                 .suffix("suffix")
                                 .build())
                         .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()))
                 .scheme("scheme")
                 .build())
         // the properties below are optional
         .retryPolicy(HttpRetryPolicyProperty.builder()
                 .maxRetries(123)
                 .perRetryTimeout(DurationProperty.builder()
                         .unit("unit")
                         .value(123)
                         .build())
                 // the properties below are optional
                 .httpRetryEvents(List.of("httpRetryEvents"))
                 .tcpRetryEvents(List.of("tcpRetryEvents"))
                 .build())
         .timeout(HttpTimeoutProperty.builder()
                 .idle(DurationProperty.builder()
                         .unit("unit")
                         .value(123)
                         .build())
                 .perRequest(DurationProperty.builder()
                         .unit("unit")
                         .value(123)
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRoute.HttpRouteProperty.Builder	builder()
Object	getAction()	An object that represents the action to take if a match is determined.
Object	getMatch()	An object that represents the criteria for determining a request match.
default Object	getRetryPolicy()	An object that represents a retry policy.
default Object	getTimeout()	An object that represents types of timeouts.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@NotNull
Object getAction()

An object that represents the action to take if a match is determined.

getMatch

@Stability(Stable)
@NotNull
Object getMatch()

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

getRetryPolicy

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

An object that represents a retry policy.

getTimeout

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

An object that represents types of timeouts.

builder

@Stability(Stable)
static CfnRoute.HttpRouteProperty.Builder builder()

Returns:

a CfnRoute.HttpRouteProperty.Builder of CfnRoute.HttpRouteProperty