aws-cdk-lib.aws_appmesh.CfnVirtualGateway.VirtualGatewaySpecProperty

VirtualGatewaySpecProperty Struct

An object that represents the specification of a service mesh resource.

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 virtualGatewaySpecProperty: appmesh.CfnVirtualGateway.VirtualGatewaySpecProperty = {
  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',
        },
      },
    },
  },
};

Properties

backendDefaults?optionalIResolvable | CfnVirtualGateway.VirtualGatewayBackendDefaultsPropertybackend_defaults?optionaltyping.Union[IResolvable, VirtualGatewayBackendDefaultsProperty]backendDefaults?optionalIResolvableBackendDefaults?optionalIResolvableBackendDefaults?optionalinterface{}#

A reference to an object that represents the defaults for backends.

listenersIResolvable | IResolvable | CfnVirtualGateway.VirtualGatewayListenerProperty[]listenerstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VirtualGatewayListenerProperty]]]listenersIResolvableListenersIResolvableListenersinterface{}required#

The listeners that the mesh endpoint is expected to receive inbound traffic from.

You can specify one listener.

logging?optionalIResolvable | CfnVirtualGateway.VirtualGatewayLoggingPropertylogging?optionaltyping.Union[IResolvable, VirtualGatewayLoggingProperty]logging?optionalIResolvableLogging?optionalIResolvableLogging?optionalinterface{}#

An object that represents logging information.