Skip to content
v2.277.0

Backend Class ​

Contains static factory methods to create backends.

Example ​

ts
declare const mesh: appmesh.Mesh;
declare const router: appmesh.VirtualRouter;
declare const service: cloudmap.Service;

const node = new appmesh.VirtualNode(this, 'node', {
  mesh,
  serviceDiscovery: appmesh.ServiceDiscovery.cloudMap(service),
  listeners: [appmesh.VirtualNodeListener.http({
    port: 8080,
    healthCheck: appmesh.HealthCheck.http({
      healthyThreshold: 3,
      interval: Duration.seconds(5),
      path: '/ping',
      timeout: Duration.seconds(2),
      unhealthyThreshold: 2,
    }),
    timeout: {
      idle: Duration.seconds(5),
    },
  })],
  accessLog: appmesh.AccessLog.fromFilePath('/dev/stdout'),
});

const virtualService = new appmesh.VirtualService(this, 'service-1', {
  virtualServiceProvider: appmesh.VirtualServiceProvider.virtualRouter(router),
  virtualServiceName: 'service1.domain.local',
});

node.addBackend(appmesh.Backend.virtualService(virtualService));
python
# mesh: appmesh.Mesh
# router: appmesh.VirtualRouter
# service: cloudmap.Service


node = appmesh.VirtualNode(self, "node",
    mesh=mesh,
    service_discovery=appmesh.ServiceDiscovery.cloud_map(service),
    listeners=[appmesh.VirtualNodeListener.http(
        port=8080,
        health_check=appmesh.HealthCheck.http(
            healthy_threshold=3,
            interval=Duration.seconds(5),
            path="/ping",
            timeout=Duration.seconds(2),
            unhealthy_threshold=2
        ),
        timeout=appmesh.HttpTimeout(
            idle=Duration.seconds(5)
        )
    )],
    access_log=appmesh.AccessLog.from_file_path("/dev/stdout")
)

virtual_service = appmesh.VirtualService(self, "service-1",
    virtual_service_provider=appmesh.VirtualServiceProvider.virtual_router(router),
    virtual_service_name="service1.domain.local"
)

node.add_backend(appmesh.Backend.virtual_service(virtual_service))
java
Mesh mesh;
VirtualRouter router;
Service service;


VirtualNode node = VirtualNode.Builder.create(this, "node")
        .mesh(mesh)
        .serviceDiscovery(ServiceDiscovery.cloudMap(service))
        .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder()
                .port(8080)
                .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder()
                        .healthyThreshold(3)
                        .interval(Duration.seconds(5))
                        .path("/ping")
                        .timeout(Duration.seconds(2))
                        .unhealthyThreshold(2)
                        .build()))
                .timeout(HttpTimeout.builder()
                        .idle(Duration.seconds(5))
                        .build())
                .build())))
        .accessLog(AccessLog.fromFilePath("/dev/stdout"))
        .build();

VirtualService virtualService = VirtualService.Builder.create(this, "service-1")
        .virtualServiceProvider(VirtualServiceProvider.virtualRouter(router))
        .virtualServiceName("service1.domain.local")
        .build();

node.addBackend(Backend.virtualService(virtualService));
csharp
// Install: dotnet add package Amazon.CDK.Lib
Mesh mesh;
VirtualRouter router;
Service service;


var node = new VirtualNode(this, "node", new VirtualNodeProps {
    Mesh = mesh,
    ServiceDiscovery = ServiceDiscovery.CloudMap(service),
    Listeners = new [] { VirtualNodeListener.Http(new HttpVirtualNodeListenerOptions {
        Port = 8080,
        HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
            HealthyThreshold = 3,
            Interval = Duration.Seconds(5),
            Path = "/ping",
            Timeout = Duration.Seconds(2),
            UnhealthyThreshold = 2
        }),
        Timeout = new HttpTimeout {
            Idle = Duration.Seconds(5)
        }
    }) },
    AccessLog = AccessLog.FromFilePath("/dev/stdout")
});

var virtualService = new VirtualService(this, "service-1", new VirtualServiceProps {
    VirtualServiceProvider = VirtualServiceProvider.VirtualRouter(router),
    VirtualServiceName = "service1.domain.local"
});

node.AddBackend(Backend.VirtualService(virtualService));
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var mesh Mesh
var router VirtualRouter
var service Service


node := appmesh.NewVirtualNode(this, jsii.String("node"), &VirtualNodeProps{
	Mesh: Mesh,
	ServiceDiscovery: appmesh.ServiceDiscovery_CloudMap(service),
	Listeners: []VirtualNodeListener{
		appmesh.VirtualNodeListener_Http(&HttpVirtualNodeListenerOptions{
			Port: jsii.Number(8080),
			HealthCheck: appmesh.HealthCheck_Http(&HttpHealthCheckOptions{
				HealthyThreshold: jsii.Number(3),
				Interval: awscdk.Duration_Seconds(jsii.Number(5)),
				Path: jsii.String("/ping"),
				Timeout: awscdk.Duration_*Seconds(jsii.Number(2)),
				UnhealthyThreshold: jsii.Number(2),
			}),
			Timeout: &HttpTimeout{
				Idle: awscdk.Duration_*Seconds(jsii.Number(5)),
			},
		}),
	},
	AccessLog: appmesh.AccessLog_FromFilePath(jsii.String("/dev/stdout")),
})

virtualService := appmesh.NewVirtualService(this, jsii.String("service-1"), &VirtualServiceProps{
	VirtualServiceProvider: appmesh.VirtualServiceProvider_VirtualRouter(router),
	VirtualServiceName: jsii.String("service1.domain.local"),
})

node.AddBackend(appmesh.Backend_VirtualService(virtualService))

Initializer ​

ts
new Backend()
python
Backend()
java
new Backend()
csharp
new Backend()
go
NewBackend()

Methods ​

bind(_scope: Construct): BackendConfigdef bind(self, _scope: Construct) -> BackendConfigpublic BackendConfig bind(Construct _scope)public BackendConfig Bind(Construct _scope)func Bind(_scope Construct) BackendConfig#
Return backend config.
virtualService(virtualService: IVirtualService, props?: VirtualServiceBackendOptions): Backend // chainable@staticmethod def virtual_service(virtual_service: IVirtualService, props: typing.Optional[VirtualServiceBackendOptions] = None) -> Backendpublic static Backend virtualService(IVirtualService virtualService, VirtualServiceBackendOptions props)public static Backend VirtualService(IVirtualService virtualService, VirtualServiceBackendOptions? props = null)func VirtualService(VirtualService IVirtualService, Props VirtualServiceBackendOptions) Backendstatic#
Construct a Virtual Service backend.