interface HttpRouteProperty

Language	Type name
.NET	`Amazon.CDK.AWS.AppMesh.CfnRoute.HttpRouteProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#CfnRoute_HttpRouteProperty`
Java	`software.amazon.awscdk.services.appmesh.CfnRoute.HttpRouteProperty`
Python	`aws_cdk.aws_appmesh.CfnRoute.HttpRouteProperty`
TypeScript	`aws-cdk-lib` » `aws_appmesh` » `CfnRoute` » `HttpRouteProperty`

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 { aws_appmesh as appmesh } from 'aws-cdk-lib';
const httpRouteProperty: appmesh.CfnRoute.HttpRouteProperty = {
  action: {
    weightedTargets: [{
      virtualNode: 'virtualNode',
      weight: 123,

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

      // the properties below are optional
      invert: false,
      match: {
        exact: 'exact',
        prefix: 'prefix',
        range: {
          end: 123,
          start: 123,
        },
        regex: 'regex',
        suffix: 'suffix',
      },
    }],
    method: 'method',
    path: {
      exact: 'exact',
      regex: 'regex',
    },
    port: 123,
    prefix: 'prefix',
    queryParameters: [{
      name: 'name',

      // the properties below are optional
      match: {
        exact: 'exact',
      },
    }],
    scheme: 'scheme',
  },

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

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

Properties

Name	Type	Description
action	`IResolvable` `\|` `HttpRouteActionProperty`	An object that represents the action to take if a match is determined.
match	`IResolvable` `\|` `HttpRouteMatchProperty`	An object that represents the criteria for determining a request match.
retryPolicy?	`IResolvable` `\|` `HttpRetryPolicyProperty`	An object that represents a retry policy.
timeout?	`IResolvable` `\|` `HttpTimeoutProperty`	An object that represents types of timeouts.

action

Type: IResolvable | HttpRouteActionProperty

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

match

Type: IResolvable | HttpRouteMatchProperty

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

retryPolicy?

Type: IResolvable | HttpRetryPolicyProperty (optional)

An object that represents a retry policy.

timeout?

Type: IResolvable | HttpTimeoutProperty (optional)

An object that represents types of timeouts.