interface CfnVirtualGatewayProps

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

Properties for defining a CfnVirtualGateway.

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

      // the properties below are optional
      connectionPool: {
        grpc: {
          maxRequests: 123,
        },
        http: {
          maxConnections: 123,

          // the properties below are optional
          maxPendingRequests: 123,
        },
        http2: {
          maxRequests: 123,
        },
      },
      healthCheck: {
        healthyThreshold: 123,
        intervalMillis: 123,
        protocol: 'protocol',
        timeoutMillis: 123,
        unhealthyThreshold: 123,

        // the properties below are optional
        path: 'path',
        port: 123,
      },
      tls: {
        certificate: {
          acm: {
            certificateArn: 'certificateArn',
          },
          file: {
            certificateChain: 'certificateChain',
            privateKey: 'privateKey',
          },
          sds: {
            secretName: 'secretName',
          },
        },
        mode: 'mode',

        // the properties below are optional
        validation: {
          trust: {
            file: {
              certificateChain: 'certificateChain',
            },
            sds: {
              secretName: 'secretName',
            },
          },

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

    // the properties below are optional
    backendDefaults: {
      clientPolicy: {
        tls: {
          validation: {
            trust: {
              acm: {
                certificateAuthorityArns: ['certificateAuthorityArns'],
              },
              file: {
                certificateChain: 'certificateChain',
              },
              sds: {
                secretName: 'secretName',
              },
            },

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

          // the properties below are optional
          certificate: {
            file: {
              certificateChain: 'certificateChain',
              privateKey: 'privateKey',
            },
            sds: {
              secretName: 'secretName',
            },
          },
          enforce: false,
          ports: [123],
        },
      },
    },
    logging: {
      accessLog: {
        file: {
          path: 'path',

          // the properties below are optional
          format: {
            json: [{
              key: 'key',
              value: 'value',
            }],
            text: 'text',
          },
        },
      },
    },
  },

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

Properties

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

meshName

Type: string

The name of the service mesh that the virtual gateway resides in.

spec

Type: IResolvable | VirtualGatewaySpecProperty

The specifications of the virtual gateway.

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 .

tags?

Type: CfnTag[] (optional)

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

virtualGatewayName?

Type: string (optional)

The name of the virtual gateway.