interface RouteSpecProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.AppMesh.Mixins.CfnRoutePropsMixin.RouteSpecProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsappmesh/mixins#CfnRoutePropsMixin_RouteSpecProperty`
Java	`software.amazon.awscdk.mixins.preview.services.appmesh.mixins.CfnRoutePropsMixin.RouteSpecProperty`
Python	`aws_cdk.mixins_preview.aws_appmesh.mixins.CfnRoutePropsMixin.RouteSpecProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_appmesh` » `mixins` » `CfnRoutePropsMixin` » `RouteSpecProperty`

An object that represents a route specification.

Specify one route type.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as appmesh_mixins } from '@aws-cdk/mixins-preview/aws-appmesh';
const routeSpecProperty: appmesh_mixins.CfnRoutePropsMixin.RouteSpecProperty = {
  grpcRoute: {
    action: {
      weightedTargets: [{
        port: 123,
        virtualNode: 'virtualNode',
        weight: 123,
      }],
    },
    match: {
      metadata: [{
        invert: false,
        match: {
          exact: 'exact',
          prefix: 'prefix',
          range: {
            end: 123,
            start: 123,
          },
          regex: 'regex',
          suffix: 'suffix',
        },
        name: 'name',
      }],
      methodName: 'methodName',
      port: 123,
      serviceName: 'serviceName',
    },
    retryPolicy: {
      grpcRetryEvents: ['grpcRetryEvents'],
      httpRetryEvents: ['httpRetryEvents'],
      maxRetries: 123,
      perRetryTimeout: {
        unit: 'unit',
        value: 123,
      },
      tcpRetryEvents: ['tcpRetryEvents'],
    },
    timeout: {
      idle: {
        unit: 'unit',
        value: 123,
      },
      perRequest: {
        unit: 'unit',
        value: 123,
      },
    },
  },
  http2Route: {
    action: {
      weightedTargets: [{
        port: 123,
        virtualNode: 'virtualNode',
        weight: 123,
      }],
    },
    match: {
      headers: [{
        invert: false,
        match: {
          exact: 'exact',
          prefix: 'prefix',
          range: {
            end: 123,
            start: 123,
          },
          regex: 'regex',
          suffix: 'suffix',
        },
        name: 'name',
      }],
      method: 'method',
      path: {
        exact: 'exact',
        regex: 'regex',
      },
      port: 123,
      prefix: 'prefix',
      queryParameters: [{
        match: {
          exact: 'exact',
        },
        name: 'name',
      }],
      scheme: 'scheme',
    },
    retryPolicy: {
      httpRetryEvents: ['httpRetryEvents'],
      maxRetries: 123,
      perRetryTimeout: {
        unit: 'unit',
        value: 123,
      },
      tcpRetryEvents: ['tcpRetryEvents'],
    },
    timeout: {
      idle: {
        unit: 'unit',
        value: 123,
      },
      perRequest: {
        unit: 'unit',
        value: 123,
      },
    },
  },
  httpRoute: {
    action: {
      weightedTargets: [{
        port: 123,
        virtualNode: 'virtualNode',
        weight: 123,
      }],
    },
    match: {
      headers: [{
        invert: false,
        match: {
          exact: 'exact',
          prefix: 'prefix',
          range: {
            end: 123,
            start: 123,
          },
          regex: 'regex',
          suffix: 'suffix',
        },
        name: 'name',
      }],
      method: 'method',
      path: {
        exact: 'exact',
        regex: 'regex',
      },
      port: 123,
      prefix: 'prefix',
      queryParameters: [{
        match: {
          exact: 'exact',
        },
        name: 'name',
      }],
      scheme: 'scheme',
    },
    retryPolicy: {
      httpRetryEvents: ['httpRetryEvents'],
      maxRetries: 123,
      perRetryTimeout: {
        unit: 'unit',
        value: 123,
      },
      tcpRetryEvents: ['tcpRetryEvents'],
    },
    timeout: {
      idle: {
        unit: 'unit',
        value: 123,
      },
      perRequest: {
        unit: 'unit',
        value: 123,
      },
    },
  },
  priority: 123,
  tcpRoute: {
    action: {
      weightedTargets: [{
        port: 123,
        virtualNode: 'virtualNode',
        weight: 123,
      }],
    },
    match: {
      port: 123,
    },
    timeout: {
      idle: {
        unit: 'unit',
        value: 123,
      },
    },
  },
};

Properties

Name	Type	Description
grpcRoute?	`IResolvable` `\|` `GrpcRouteProperty`	An object that represents the specification of a gRPC route.
http2Route?	`IResolvable` `\|` `HttpRouteProperty`	An object that represents the specification of an HTTP/2 route.
httpRoute?	`IResolvable` `\|` `HttpRouteProperty`	An object that represents the specification of an HTTP route.
priority?	`number`	The priority for the route.
tcpRoute?	`IResolvable` `\|` `TcpRouteProperty`	An object that represents the specification of a TCP route.

grpcRoute?

Type: IResolvable | GrpcRouteProperty (optional)

An object that represents the specification of a gRPC route.

http2Route?

Type: IResolvable | HttpRouteProperty (optional)

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

httpRoute?

Type: IResolvable | HttpRouteProperty (optional)

An object that represents the specification of an HTTP route.

priority?

Type: number (optional)

The priority for the route.

Routes are matched based on the specified value, where 0 is the highest priority.

tcpRoute?

Type: IResolvable | TcpRouteProperty (optional)

An object that represents the specification of a TCP route.

AWS CDK

2.233.0