Skip to content
v2.277.0

RouteProps Struct ​

Properties to define new Routes.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appmesh as appmesh } from 'aws-cdk-lib';

declare const mesh: appmesh.Mesh;
declare const routeSpec: appmesh.RouteSpec;
declare const virtualRouter: appmesh.VirtualRouter;
const routeProps: appmesh.RouteProps = {
  mesh: mesh,
  routeSpec: routeSpec,
  virtualRouter: virtualRouter,

  // the properties below are optional
  routeName: 'routeName',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appmesh as appmesh

# mesh: appmesh.Mesh
# route_spec: appmesh.RouteSpec
# virtual_router: appmesh.VirtualRouter

route_props = appmesh.RouteProps(
    mesh=mesh,
    route_spec=route_spec,
    virtual_router=virtual_router,

    # the properties below are optional
    route_name="routeName"
)
java
// 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.*;

Mesh mesh;
RouteSpec routeSpec;
VirtualRouter virtualRouter;

RouteProps routeProps = RouteProps.builder()
        .mesh(mesh)
        .routeSpec(routeSpec)
        .virtualRouter(virtualRouter)

        // the properties below are optional
        .routeName("routeName")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppMesh;

Mesh mesh;
RouteSpec routeSpec;
VirtualRouter virtualRouter;

var routeProps = new RouteProps {
    Mesh = mesh,
    RouteSpec = routeSpec,
    VirtualRouter = virtualRouter,

    // the properties below are optional
    RouteName = "routeName"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var mesh Mesh
var routeSpec RouteSpec
var virtualRouter VirtualRouter

routeProps := &RouteProps{
	Mesh: mesh,
	RouteSpec: routeSpec,
	VirtualRouter: virtualRouter,

	// the properties below are optional
	RouteName: jsii.String("routeName"),
}

Properties ​

meshIMeshmeshIMeshmeshIMeshMeshIMeshMeshIMesh required #
The service mesh to define the route in.
routeNameoptionalstringroute_nameoptionalstrrouteNameoptionalStringRouteNameoptionalstringRouteNameoptional*string #
The name of the route.

Default: An automatically generated name

routeSpecRouteSpecroute_specRouteSpecrouteSpecRouteSpecRouteSpecRouteSpecRouteSpecRouteSpec required #
Protocol specific spec.
virtualRouterIVirtualRoutervirtual_routerIVirtualRoutervirtualRouterIVirtualRouterVirtualRouterIVirtualRouterVirtualRouterIVirtualRouter required #
The VirtualRouter the Route belongs to.