Package software.amazon.awscdk.services.appmesh

Interface VirtualServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

VirtualServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:14.526Z")
@Stability(Stable)
public interface VirtualServiceProps
extends software.amazon.jsii.JsiiSerializable

The properties applied to the VirtualService being defined.

Example:

 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));
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	VirtualServiceProps.Builder	A builder for VirtualServiceProps
static final class	VirtualServiceProps.Jsii$Proxy	An implementation for VirtualServiceProps

Method Summary

Modifier and Type	Method	Description
static VirtualServiceProps.Builder	builder()
default String	getVirtualServiceName()	The name of the VirtualService.
VirtualServiceProvider	getVirtualServiceProvider()	The VirtualNode or VirtualRouter which the VirtualService uses as its provider.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getVirtualServiceProvider

@Stability(Stable)
@NotNull
VirtualServiceProvider getVirtualServiceProvider()

The VirtualNode or VirtualRouter which the VirtualService uses as its provider.

getVirtualServiceName

@Stability(Stable)
@Nullable
default String getVirtualServiceName()

The name of the VirtualService.

It is recommended this follows the fully-qualified domain name format, such as "my-service.default.svc.cluster.local".

Example value: service.domain.local

Default: - A name is automatically generated

builder

@Stability(Stable)
static VirtualServiceProps.Builder builder()

Returns:

a VirtualServiceProps.Builder of VirtualServiceProps