Skip to content
v2.278.0

HttpGatewayListenerOptions Struct ​

Represents the properties needed to define HTTP Listeners for a VirtualGateway.

Example ​

ts
declare const mesh: appmesh.Mesh;
const certificateAuthorityArn = 'arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012';

const gateway = new appmesh.VirtualGateway(this, 'gateway', {
  mesh: mesh,
  listeners: [appmesh.VirtualGatewayListener.http({
    port: 443,
    healthCheck: appmesh.HealthCheck.http({
      interval: Duration.seconds(10),
    }),
  })],
  backendDefaults: {
    tlsClientPolicy: {
      ports: [8080, 8081],
      validation: {
        trust: appmesh.TlsValidationTrust.acm([
          acmpca.CertificateAuthority.fromCertificateAuthorityArn(this, 'certificate', certificateAuthorityArn)]),
      },
    },
  },
  accessLog: appmesh.AccessLog.fromFilePath('/dev/stdout'),
  virtualGatewayName: 'virtualGateway',
});
python
# mesh: appmesh.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=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"
)
java
Mesh mesh;

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

VirtualGateway gateway = VirtualGateway.Builder.create(this, "gateway")
        .mesh(mesh)
        .listeners(List.of(VirtualGatewayListener.http(HttpGatewayListenerOptions.builder()
                .port(443)
                .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder()
                        .interval(Duration.seconds(10))
                        .build()))
                .build())))
        .backendDefaults(BackendDefaults.builder()
                .tlsClientPolicy(TlsClientPolicy.builder()
                        .ports(List.of(8080, 8081))
                        .validation(TlsValidation.builder()
                                .trust(TlsValidationTrust.acm(List.of(CertificateAuthority.fromCertificateAuthorityArn(this, "certificate", certificateAuthorityArn))))
                                .build())
                        .build())
                .build())
        .accessLog(AccessLog.fromFilePath("/dev/stdout"))
        .virtualGatewayName("virtualGateway")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
Mesh mesh;

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

var gateway = new VirtualGateway(this, "gateway", new VirtualGatewayProps {
    Mesh = mesh,
    Listeners = new [] { VirtualGatewayListener.Http(new HttpGatewayListenerOptions {
        Port = 443,
        HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
            Interval = Duration.Seconds(10)
        })
    }) },
    BackendDefaults = new BackendDefaults {
        TlsClientPolicy = new TlsClientPolicy {
            Ports = new [] { 8080, 8081 },
            Validation = new TlsValidation {
                Trust = TlsValidationTrust.Acm(new [] { CertificateAuthority.FromCertificateAuthorityArn(this, "certificate", certificateAuthorityArn) })
            }
        }
    },
    AccessLog = AccessLog.FromFilePath("/dev/stdout"),
    VirtualGatewayName = "virtualGateway"
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var mesh Mesh

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

gateway := appmesh.NewVirtualGateway(this, jsii.String("gateway"), &VirtualGatewayProps{
	Mesh: mesh,
	Listeners: []VirtualGatewayListener{
		appmesh.VirtualGatewayListener_Http(&HttpGatewayListenerOptions{
			Port: jsii.Number(443),
			HealthCheck: appmesh.HealthCheck_Http(&HttpHealthCheckOptions{
				Interval: awscdk.Duration_Seconds(jsii.Number(10)),
			}),
		}),
	},
	BackendDefaults: &BackendDefaults{
		TlsClientPolicy: &TlsClientPolicy{
			Ports: []*f64{
				jsii.Number(8080),
				jsii.Number(8081),
			},
			Validation: &TlsValidation{
				Trust: appmesh.TlsValidationTrust_Acm([]ICertificateAuthorityRef{
					acmpca.CertificateAuthority_FromCertificateAuthorityArn(this, jsii.String("certificate"), certificateAuthorityArn),
				}),
			},
		},
	},
	AccessLog: appmesh.AccessLog_FromFilePath(jsii.String("/dev/stdout")),
	VirtualGatewayName: jsii.String("virtualGateway"),
})

Properties ​

connectionPooloptionalHttpConnectionPoolconnection_pooloptionalHttpConnectionPoolconnectionPooloptionalHttpConnectionPoolConnectionPooloptionalHttpConnectionPoolConnectionPooloptionalHttpConnectionPool = None #
Connection pool for http listeners.
healthCheckoptionalHealthCheckhealth_checkoptionalHealthCheckhealthCheckoptionalHealthCheckHealthCheckoptionalHealthCheckHealthCheckoptionalHealthCheck #
The health check information for the listener.

Default: no healthcheck

portoptionalnumberportoptionalint | floatportoptionalNumberPortoptionaldoublePortoptional*float64 = 8080 #
Port to listen for connections on.
tlsoptionalListenerTlsOptionstlsoptionalListenerTlsOptionstlsoptionalListenerTlsOptionsTlsoptionalListenerTlsOptionsTlsoptionalListenerTlsOptions = none #
Represents the configuration for enabling TLS on a listener.