interface CfnVirtualRouterProps

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

Properties for defining a CfnVirtualRouter.

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 cfnVirtualRouterProps: appmesh.CfnVirtualRouterProps = {
  meshName: 'meshName',
  spec: {
    listeners: [{
      portMapping: {
        port: 123,
        protocol: 'protocol',
      },
    }],
  },

  // the properties below are optional
  meshOwner: 'meshOwner',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  virtualRouterName: 'virtualRouterName',
};

Properties

Name	Type	Description
meshName	`string`	The name of the service mesh to create the virtual router in.
spec	`IResolvable` `\|` `VirtualRouterSpecProperty`	The virtual router specification to apply.
meshOwner?	`string`	The AWS IAM account ID of the service mesh owner.
tags?	`CfnTag[]`	Optional metadata that you can apply to the virtual router to assist with categorization and organization.
virtualRouterName?	`string`	The name to use for the virtual router.

meshName

Type: string

The name of the service mesh to create the virtual router in.

spec

Type: IResolvable | VirtualRouterSpecProperty

The virtual router specification to apply.

meshOwner?

Type: string (optional)

The AWS IAM account ID of the service mesh owner.

If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes .

tags?

Type: CfnTag[] (optional)

Optional metadata that you can apply to the virtual router 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.

virtualRouterName?

Type: string (optional)

The name to use for the virtual router.