Class VirtualNodeBaseProps

Basic configuration properties for a VirtualNode.

Inheritance

object

VirtualNodeBaseProps

Implements

IVirtualNodeBaseProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AppMesh

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class VirtualNodeBaseProps : IVirtualNodeBaseProps

Syntax (vb)

Public Class VirtualNodeBaseProps Implements IVirtualNodeBaseProps

Remarks

ExampleMetadata: infused

Examples

Mesh mesh;
            var vpc = new Vpc(this, "vpc");
            var namespace = new PrivateDnsNamespace(this, "test-namespace", new PrivateDnsNamespaceProps {
                Vpc = vpc,
                Name = "domain.local"
            });
            var service = namespace.CreateService("Svc");
            var node = mesh.AddVirtualNode("virtual-node", new VirtualNodeBaseProps {
                ServiceDiscovery = ServiceDiscovery.CloudMap(service),
                Listeners = new [] { VirtualNodeListener.Http(new HttpVirtualNodeListenerOptions {
                    Port = 8081,
                    HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
                        HealthyThreshold = 3,
                        Interval = Duration.Seconds(5),  // minimum
                        Path = "/health-check-path",
                        Timeout = Duration.Seconds(2),  // minimum
                        UnhealthyThreshold = 2
                    })
                }) },
                AccessLog = AccessLog.FromFilePath("/dev/stdout")
            });

Synopsis

Constructors

VirtualNodeBaseProps()

Basic configuration properties for a VirtualNode.

Properties

AccessLog	Access Logging Configuration for the virtual node.
BackendDefaults	Default Configuration Virtual Node uses to communicate with Virtual Service.
Backends	Virtual Services that this is node expected to send outbound traffic to.
Listeners	Initial listener for the virtual node.
ServiceDiscovery	Defines how upstream clients will discover this VirtualNode.
VirtualNodeName	The name of the VirtualNode.

Constructors

VirtualNodeBaseProps()

Basic configuration properties for a VirtualNode.

public VirtualNodeBaseProps()

Remarks

ExampleMetadata: infused

Examples

Mesh mesh;
            var vpc = new Vpc(this, "vpc");
            var namespace = new PrivateDnsNamespace(this, "test-namespace", new PrivateDnsNamespaceProps {
                Vpc = vpc,
                Name = "domain.local"
            });
            var service = namespace.CreateService("Svc");
            var node = mesh.AddVirtualNode("virtual-node", new VirtualNodeBaseProps {
                ServiceDiscovery = ServiceDiscovery.CloudMap(service),
                Listeners = new [] { VirtualNodeListener.Http(new HttpVirtualNodeListenerOptions {
                    Port = 8081,
                    HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
                        HealthyThreshold = 3,
                        Interval = Duration.Seconds(5),  // minimum
                        Path = "/health-check-path",
                        Timeout = Duration.Seconds(2),  // minimum
                        UnhealthyThreshold = 2
                    })
                }) },
                AccessLog = AccessLog.FromFilePath("/dev/stdout")
            });

Properties

AccessLog

Access Logging Configuration for the virtual node.

public AccessLog? AccessLog { get; set; }

Property Value

AccessLog

Remarks

Default: - No access logging

BackendDefaults

Default Configuration Virtual Node uses to communicate with Virtual Service.

public IBackendDefaults? BackendDefaults { get; set; }

Property Value

IBackendDefaults

Remarks

Default: - No Config

Backends

Virtual Services that this is node expected to send outbound traffic to.

public Backend[]? Backends { get; set; }

Property Value

Backend[]

Remarks

Default: - No backends

Listeners

Initial listener for the virtual node.

public VirtualNodeListener[]? Listeners { get; set; }

Property Value

VirtualNodeListener[]

Remarks

Default: - No listeners

ServiceDiscovery

Defines how upstream clients will discover this VirtualNode.

public ServiceDiscovery? ServiceDiscovery { get; set; }

Property Value

ServiceDiscovery

Remarks

Default: - No Service Discovery

VirtualNodeName

The name of the VirtualNode.

public string? VirtualNodeName { get; set; }

Property Value

string

Remarks

Default: - A name is automatically determined

Implements

IVirtualNodeBaseProps