software.amazon.awscdk.services.appmesh

Class VirtualService

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.appmesh.VirtualService

All Implemented Interfaces:

IConstruct, IDependable, IResource, IVirtualService

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.704Z")
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 and Description
static class	VirtualService.Builder A fluent builder for VirtualService.

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

IVirtualService.Jsii$Default, IVirtualService.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static IVirtualService	fromVirtualServiceArn(software.constructs.Construct scope, java.lang.String id, java.lang.String virtualServiceArn) Import an existing VirtualService given an ARN.
static IVirtualService	fromVirtualServiceAttributes(software.constructs.Construct scope, java.lang.String id, VirtualServiceAttributes attrs) Import an existing VirtualService given its attributes.
IMesh	getMesh() The Mesh which the VirtualService belongs to.
java.lang.String	getVirtualServiceArn() The Amazon Resource Name (ARN) for the virtual service.
java.lang.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.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

VirtualService

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

VirtualService

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

VirtualService

public VirtualService(software.constructs.Construct scope,
                      java.lang.String id,
                      VirtualServiceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromVirtualServiceArn

public static IVirtualService fromVirtualServiceArn(software.constructs.Construct scope,
                                                    java.lang.String id,
                                                    java.lang.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

public static IVirtualService fromVirtualServiceAttributes(software.constructs.Construct scope,
                                                           java.lang.String id,
                                                           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

public IMesh getMesh()

The Mesh which the VirtualService belongs to.

Specified by:

getMesh in interface IVirtualService

getVirtualServiceArn

public java.lang.String getVirtualServiceArn()

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

Specified by:

getVirtualServiceArn in interface IVirtualService

getVirtualServiceName

public java.lang.String getVirtualServiceName()

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

Specified by:

getVirtualServiceName in interface IVirtualService