Show / Hide Table of Contents

Class VirtualService

VirtualService represents a service inside an AppMesh.

Inheritance
System.Object
Construct
Resource
VirtualService
Implements
IVirtualService
IResource
IConstruct
Constructs.IConstruct
IDependable
Inherited Members
Resource.IsResource(IConstruct)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(String, IArnComponents)
Resource.GetResourceNameAttribute(String)
Resource.Env
Resource.PhysicalName
Resource.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.AppMesh
Assembly: Amazon.CDK.AWS.AppMesh.dll
Syntax (csharp)
public class VirtualService : Resource, IVirtualService, IResource, IConstruct, IDependable
Syntax (vb)
Public Class VirtualService
    Inherits Resource
    Implements IVirtualService, IResource, IConstruct, IDependable
Remarks

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

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

ExampleMetadata: infused

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

Synopsis

Constructors

VirtualService(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

VirtualService(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

VirtualService(Construct, String, IVirtualServiceProps)

Properties

Mesh

The Mesh which the VirtualService belongs to.

VirtualServiceArn

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

VirtualServiceName

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

Methods

FromVirtualServiceArn(Construct, String, String)

Import an existing VirtualService given an ARN.

FromVirtualServiceAttributes(Construct, String, IVirtualServiceAttributes)

Import an existing VirtualService given its attributes.

Constructors

VirtualService(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected VirtualService(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

VirtualService(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected VirtualService(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

VirtualService(Construct, String, IVirtualServiceProps)

public VirtualService(Construct scope, string id, IVirtualServiceProps props)
Parameters
scope Constructs.Construct
id System.String
props IVirtualServiceProps

Properties

Mesh

The Mesh which the VirtualService belongs to.

public virtual IMesh Mesh { get; }
Property Value

IMesh

VirtualServiceArn

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

public virtual string VirtualServiceArn { get; }
Property Value

System.String

VirtualServiceName

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

public virtual string VirtualServiceName { get; }
Property Value

System.String

Methods

FromVirtualServiceArn(Construct, String, String)

Import an existing VirtualService given an ARN.

public static IVirtualService FromVirtualServiceArn(Construct scope, string id, string virtualServiceArn)
Parameters
scope Constructs.Construct
id System.String
virtualServiceArn System.String
Returns

IVirtualService

FromVirtualServiceAttributes(Construct, String, IVirtualServiceAttributes)

Import an existing VirtualService given its attributes.

public static IVirtualService FromVirtualServiceAttributes(Construct scope, string id, IVirtualServiceAttributes attrs)
Parameters
scope Constructs.Construct
id System.String
attrs IVirtualServiceAttributes
Returns

IVirtualService

Implements

IVirtualService
IResource
IConstruct
Constructs.IConstruct
IDependable
Back to top Generated by DocFX