Skip to content
v2.278.0

VirtualServiceProvider Class ​

Represents the properties needed to define the provider for a VirtualService.

Example ​

ts
declare const mesh: appmesh.Mesh;

const node = new appmesh.VirtualNode(this, 'node', {
  mesh,
  serviceDiscovery: appmesh.ServiceDiscovery.dns('node'),
});

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

node.addBackend(appmesh.Backend.virtualService(virtualService));
python
# mesh: appmesh.Mesh


node = appmesh.VirtualNode(self, "node",
    mesh=mesh,
    service_discovery=appmesh.ServiceDiscovery.dns("node")
)

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

node.add_backend(appmesh.Backend.virtual_service(virtual_service))
java
Mesh mesh;


VirtualNode node = VirtualNode.Builder.create(this, "node")
        .mesh(mesh)
        .serviceDiscovery(ServiceDiscovery.dns("node"))
        .build();

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

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


var node = new VirtualNode(this, "node", new VirtualNodeProps {
    Mesh = mesh,
    ServiceDiscovery = ServiceDiscovery.Dns("node")
});

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

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


node := appmesh.NewVirtualNode(this, jsii.String("node"), &VirtualNodeProps{
	Mesh: Mesh,
	ServiceDiscovery: appmesh.ServiceDiscovery_Dns(jsii.String("node")),
})

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

node.AddBackend(appmesh.Backend_VirtualService(virtualService))

Initializer ​

ts
new VirtualServiceProvider()
python
VirtualServiceProvider()
java
new VirtualServiceProvider()
csharp
new VirtualServiceProvider()
go
NewVirtualServiceProvider()

Methods ​

bind(_construct: Construct): VirtualServiceProviderConfigdef bind(self, _construct: Construct) -> VirtualServiceProviderConfigpublic VirtualServiceProviderConfig bind(Construct _construct)public VirtualServiceProviderConfig Bind(Construct _construct)func Bind(_construct Construct) VirtualServiceProviderConfig #
Enforces mutual exclusivity for VirtualService provider types.
none(mesh: IMesh): VirtualServiceProvider // chainable@staticmethod def none(mesh: IMesh) -> VirtualServiceProviderpublic static VirtualServiceProvider none(IMesh mesh)public static VirtualServiceProvider None(IMesh mesh)func None(Mesh IMesh) VirtualServiceProvider static #
Returns an Empty Provider for a VirtualService.

This provides no routing capabilities and should only be used as a placeholder

virtualNode(virtualNode: IVirtualNode): VirtualServiceProvider // chainable@staticmethod def virtual_node(virtual_node: IVirtualNode) -> VirtualServiceProviderpublic static VirtualServiceProvider virtualNode(IVirtualNode virtualNode)public static VirtualServiceProvider VirtualNode(IVirtualNode virtualNode)func VirtualNode(VirtualNode IVirtualNode) VirtualServiceProvider static #
Returns a VirtualNode based Provider for a VirtualService.
virtualRouter(virtualRouter: IVirtualRouter): VirtualServiceProvider // chainable@staticmethod def virtual_router(virtual_router: IVirtualRouter) -> VirtualServiceProviderpublic static VirtualServiceProvider virtualRouter(IVirtualRouter virtualRouter)public static VirtualServiceProvider VirtualRouter(IVirtualRouter virtualRouter)func VirtualRouter(VirtualRouter IVirtualRouter) VirtualServiceProvider static #
Returns a VirtualRouter based Provider for a VirtualService.