Package software.amazon.awscdk.services.appmesh

Class VirtualService

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.appmesh.VirtualService

All Implemented Interfaces:

IResource, IVirtualService, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:21.396Z")
@Stability(Stable)
public class VirtualService
extends Resource
implements IVirtualService

VirtualService represents a service inside an AppMesh.

It routes traffic either to a Virtual Node or to a Virtual Router.

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

See Also:

• https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	VirtualService.Builder	A fluent builder for VirtualService.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appmesh.IVirtualService

IVirtualService.Jsii$Default, IVirtualService.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VirtualService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	VirtualService(software.amazon.jsii.JsiiObjectRef objRef)
	VirtualService(software.constructs.Construct scope, String id, VirtualServiceProps props)

Method Summary

Modifier and Type	Method	Description
static IVirtualService	fromVirtualServiceArn(software.constructs.Construct scope, String id, String virtualServiceArn)	Import an existing VirtualService given an ARN.
static IVirtualService	fromVirtualServiceAttributes(software.constructs.Construct scope, String id, VirtualServiceAttributes attrs)	Import an existing VirtualService given its attributes.
IMesh	getMesh()	The Mesh which the VirtualService belongs to.
String	getVirtualServiceArn()	The Amazon Resource Name (ARN) for the virtual service.
String	getVirtualServiceName()	The name of the VirtualService, it is recommended this follows the fully-qualified domain name format.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

VirtualService

protected VirtualService(software.amazon.jsii.JsiiObjectRef objRef)

VirtualService

protected VirtualService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

VirtualService

@Stability(Stable)
public VirtualService(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 VirtualServiceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromVirtualServiceArn

@Stability(Stable)
@NotNull
public static IVirtualService fromVirtualServiceArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String virtualServiceArn)

Import an existing VirtualService given an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

virtualServiceArn - This parameter is required.

fromVirtualServiceAttributes

@Stability(Stable)
@NotNull
public static IVirtualService fromVirtualServiceAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 VirtualServiceAttributes attrs)

Import an existing VirtualService given its attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getMesh

@Stability(Stable)
@NotNull
public IMesh getMesh()

The Mesh which the VirtualService belongs to.

Specified by:

getMesh in interface IVirtualService

getVirtualServiceArn

@Stability(Stable)
@NotNull
public String getVirtualServiceArn()

The Amazon Resource Name (ARN) for the virtual service.

Specified by:

getVirtualServiceArn in interface IVirtualService

getVirtualServiceName

@Stability(Stable)
@NotNull
public String getVirtualServiceName()

The name of the VirtualService, it is recommended this follows the fully-qualified domain name format.

Specified by:

getVirtualServiceName in interface IVirtualService