VirtualGatewayProps

class aws_cdk.aws_appmesh.VirtualGatewayProps(*, access_log=None, backend_defaults=None, listeners=None, virtual_gateway_name=None, mesh)

Bases: aws_cdk.aws_appmesh.VirtualGatewayBaseProps

Properties used when creating a new VirtualGateway.

Parameters
  • access_log (Optional[AccessLog]) – Access Logging Configuration for the VirtualGateway. Default: - no access logging

  • backend_defaults (Optional[BackendDefaults]) – Default Configuration Virtual Node uses to communicate with Virtual Service. Default: - No Config

  • listeners (Optional[Sequence[VirtualGatewayListener]]) – Listeners for the VirtualGateway. Only one is supported. Default: - Single HTTP listener on port 8080

  • virtual_gateway_name (Optional[str]) – Name of the VirtualGateway. Default: - A name is automatically determined

  • mesh (IMesh) – The Mesh which the VirtualGateway belongs to.

Example:

# mesh is of type Mesh

certificate_authority_arn = "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012"

gateway = appmesh.VirtualGateway(self, "gateway",
    mesh=mesh,
    listeners=[appmesh.VirtualGatewayListener.http(
        port=443,
        health_check=appmesh.HealthCheck.http(
            interval=cdk.Duration.seconds(10)
        )
    )],
    backend_defaults=appmesh.BackendDefaults(
        tls_client_policy=appmesh.TlsClientPolicy(
            ports=[8080, 8081],
            validation=appmesh.TlsValidation(
                trust=appmesh.TlsValidationTrust.acm([
                    acmpca.CertificateAuthority.from_certificate_authority_arn(self, "certificate", certificate_authority_arn)
                ])
            )
        )
    ),
    access_log=appmesh.AccessLog.from_file_path("/dev/stdout"),
    virtual_gateway_name="virtualGateway"
)

Attributes

access_log

Access Logging Configuration for the VirtualGateway.

Default
  • no access logging

Return type

Optional[AccessLog]

backend_defaults

Default Configuration Virtual Node uses to communicate with Virtual Service.

Default
  • No Config

Return type

Optional[BackendDefaults]

listeners

Listeners for the VirtualGateway.

Only one is supported.

Default
  • Single HTTP listener on port 8080

Return type

Optional[List[VirtualGatewayListener]]

mesh

The Mesh which the VirtualGateway belongs to.

Return type

IMesh

virtual_gateway_name

Name of the VirtualGateway.

Default
  • A name is automatically determined

Return type

Optional[str]