aws-cdk-lib.aws_appmesh.CfnRoute.GrpcRouteProperty

GrpcRouteProperty Struct

An object that represents a gRPC route type.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// 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';
const grpcRouteProperty: appmesh.CfnRoute.GrpcRouteProperty = {
  action: {
    weightedTargets: [{
      virtualNode: 'virtualNode',
      weight: 123,

      // the properties below are optional
      port: 123,
    }],
  },
  match: {
    metadata: [{
      name: 'name',

      // the properties below are optional
      invert: false,
      match: {
        exact: 'exact',
        prefix: 'prefix',
        range: {
          end: 123,
          start: 123,
        },
        regex: 'regex',
        suffix: 'suffix',
      },
    }],
    methodName: 'methodName',
    port: 123,
    serviceName: 'serviceName',
  },

  // the properties below are optional
  retryPolicy: {
    maxRetries: 123,
    perRetryTimeout: {
      unit: 'unit',
      value: 123,
    },

    // the properties below are optional
    grpcRetryEvents: ['grpcRetryEvents'],
    httpRetryEvents: ['httpRetryEvents'],
    tcpRetryEvents: ['tcpRetryEvents'],
  },
  timeout: {
    idle: {
      unit: 'unit',
      value: 123,
    },
    perRequest: {
      unit: 'unit',
      value: 123,
    },
  },
};

Properties

actionIResolvable | CfnRoute.GrpcRouteActionPropertyactiontyping.Union[IResolvable, GrpcRouteActionProperty]actionIResolvableActionIResolvableActioninterface{}required#

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

matchIResolvable | CfnRoute.GrpcRouteMatchPropertymatchtyping.Union[IResolvable, GrpcRouteMatchProperty]matchIResolvableMatchIResolvableMatchinterface{}required#

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

retryPolicyIResolvable | CfnRoute.GrpcRetryPolicyPropertyretry_policytyping.Union[IResolvable, GrpcRetryPolicyProperty]retryPolicyIResolvableRetryPolicyIResolvableRetryPolicyinterface{}#

An object that represents a retry policy.

timeoutIResolvable | CfnRoute.GrpcTimeoutPropertytimeouttyping.Union[IResolvable, GrpcTimeoutProperty]timeoutIResolvableTimeoutIResolvableTimeoutinterface{}#

An object that represents types of timeouts.