Package software.amazon.awscdk.services.appmesh

Interface CfnRoute.GrpcRouteProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRoute.GrpcRouteProperty.Jsii$Proxy

Enclosing class:

CfnRoute

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

An object that represents a gRPC 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.*;
 GrpcRouteProperty grpcRouteProperty = GrpcRouteProperty.builder()
         .action(GrpcRouteActionProperty.builder()
                 .weightedTargets(List.of(WeightedTargetProperty.builder()
                         .virtualNode("virtualNode")
                         .weight(123)
                         // the properties below are optional
                         .port(123)
                         .build()))
                 .build())
         .match(GrpcRouteMatchProperty.builder()
                 .metadata(List.of(GrpcRouteMetadataProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .invert(false)
                         .match(GrpcRouteMetadataMatchMethodProperty.builder()
                                 .exact("exact")
                                 .prefix("prefix")
                                 .range(MatchRangeProperty.builder()
                                         .end(123)
                                         .start(123)
                                         .build())
                                 .regex("regex")
                                 .suffix("suffix")
                                 .build())
                         .build()))
                 .methodName("methodName")
                 .port(123)
                 .serviceName("serviceName")
                 .build())
         // the properties below are optional
         .retryPolicy(GrpcRetryPolicyProperty.builder()
                 .maxRetries(123)
                 .perRetryTimeout(DurationProperty.builder()
                         .unit("unit")
                         .value(123)
                         .build())
                 // the properties below are optional
                 .grpcRetryEvents(List.of("grpcRetryEvents"))
                 .httpRetryEvents(List.of("httpRetryEvents"))
                 .tcpRetryEvents(List.of("tcpRetryEvents"))
                 .build())
         .timeout(GrpcTimeoutProperty.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.GrpcRouteProperty.Builder	A builder for CfnRoute.GrpcRouteProperty
static final class	CfnRoute.GrpcRouteProperty.Jsii$Proxy	An implementation for CfnRoute.GrpcRouteProperty

Method Summary

Modifier and Type	Method	Description
static CfnRoute.GrpcRouteProperty.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.GrpcRouteProperty.Builder builder()

Returns:

a CfnRoute.GrpcRouteProperty.Builder of CfnRoute.GrpcRouteProperty