interface CfnGatewayRouteMixinProps

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

Properties for CfnGatewayRoutePropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html

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 cfnGatewayRouteMixinProps: appmesh_mixins.CfnGatewayRouteMixinProps = {
  gatewayRouteName: 'gatewayRouteName',
  meshName: 'meshName',
  meshOwner: 'meshOwner',
  spec: {
    grpcRoute: {
      action: {
        rewrite: {
          hostname: {
            defaultTargetHostname: 'defaultTargetHostname',
          },
        },
        target: {
          port: 123,
          virtualService: {
            virtualServiceName: 'virtualServiceName',
          },
        },
      },
      match: {
        hostname: {
          exact: 'exact',
          suffix: 'suffix',
        },
        metadata: [{
          invert: false,
          match: {
            exact: 'exact',
            prefix: 'prefix',
            range: {
              end: 123,
              start: 123,
            },
            regex: 'regex',
            suffix: 'suffix',
          },
          name: 'name',
        }],
        port: 123,
        serviceName: 'serviceName',
      },
    },
    http2Route: {
      action: {
        rewrite: {
          hostname: {
            defaultTargetHostname: 'defaultTargetHostname',
          },
          path: {
            exact: 'exact',
          },
          prefix: {
            defaultPrefix: 'defaultPrefix',
            value: 'value',
          },
        },
        target: {
          port: 123,
          virtualService: {
            virtualServiceName: 'virtualServiceName',
          },
        },
      },
      match: {
        headers: [{
          invert: false,
          match: {
            exact: 'exact',
            prefix: 'prefix',
            range: {
              end: 123,
              start: 123,
            },
            regex: 'regex',
            suffix: 'suffix',
          },
          name: 'name',
        }],
        hostname: {
          exact: 'exact',
          suffix: 'suffix',
        },
        method: 'method',
        path: {
          exact: 'exact',
          regex: 'regex',
        },
        port: 123,
        prefix: 'prefix',
        queryParameters: [{
          match: {
            exact: 'exact',
          },
          name: 'name',
        }],
      },
    },
    httpRoute: {
      action: {
        rewrite: {
          hostname: {
            defaultTargetHostname: 'defaultTargetHostname',
          },
          path: {
            exact: 'exact',
          },
          prefix: {
            defaultPrefix: 'defaultPrefix',
            value: 'value',
          },
        },
        target: {
          port: 123,
          virtualService: {
            virtualServiceName: 'virtualServiceName',
          },
        },
      },
      match: {
        headers: [{
          invert: false,
          match: {
            exact: 'exact',
            prefix: 'prefix',
            range: {
              end: 123,
              start: 123,
            },
            regex: 'regex',
            suffix: 'suffix',
          },
          name: 'name',
        }],
        hostname: {
          exact: 'exact',
          suffix: 'suffix',
        },
        method: 'method',
        path: {
          exact: 'exact',
          regex: 'regex',
        },
        port: 123,
        prefix: 'prefix',
        queryParameters: [{
          match: {
            exact: 'exact',
          },
          name: 'name',
        }],
      },
    },
    priority: 123,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  virtualGatewayName: 'virtualGatewayName',
};

Properties

Name	Type	Description
gatewayRouteName?	string	The name of the gateway route.
meshName?	string	The name of the service mesh that the resource resides in.
meshOwner?	string	The AWS IAM account ID of the service mesh owner.
spec?	IResolvable | GatewayRouteSpecProperty	The specifications of the gateway route.
tags?	CfnTag[]	Optional metadata that you can apply to the gateway route to assist with categorization and organization.
virtualGatewayName?	string	The virtual gateway that the gateway route is associated with.

---

gatewayRouteName?

Type: string (optional)

The name of the gateway route.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-gatewayroutename

---

meshName?

Type: string (optional)

The name of the service mesh that the resource resides in.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshname

---

meshOwner?

Type: string (optional)

The AWS IAM account ID of the service mesh owner.

If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshowner

---

spec?

Type: IResolvable | GatewayRouteSpecProperty (optional)

The specifications of the gateway route.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-spec

---

tags?

Type: CfnTag[] (optional)

Optional metadata that you can apply to the gateway route to assist with categorization and organization.

Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-tags

---

virtualGatewayName?

Type: string (optional)

The virtual gateway that the gateway route is associated with.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-virtualgatewayname