Package org.cdk8s.plus24

Class Topology

java.lang.Object

software.amazon.jsii.JsiiObject

org.cdk8s.plus24.Topology

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-04T02:31:05.031Z")
@Stability(Stable)
public class Topology
extends software.amazon.jsii.JsiiObject

Available topology domains.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field	Description
static Topology	HOSTNAME	A hostname represents a single node in the cluster.
static Topology	REGION	A region represents a larger domain, made up of one or more zones.
static Topology	ZONE	A zone represents a logical failure domain.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Topology(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Topology(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static Topology	custom(String key)	Custom key for the node label that the system uses to denote the topology domain.
String	getKey()

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

HOSTNAME

@Stability(Stable)
public static final Topology HOSTNAME

A hostname represents a single node in the cluster.

See Also:

https://kubernetes.io/docs/reference/labels-annotations-taints/#kubernetesiohostname

REGION

@Stability(Stable)
public static final Topology REGION

A region represents a larger domain, made up of one or more zones.

It is uncommon for Kubernetes clusters to span multiple regions. While the exact definition of a zone or region is left to infrastructure implementations, common properties of a region include higher network latency between them than within them, non-zero cost for network traffic between them, and failure independence from other zones or regions.

For example, nodes within a region might share power infrastructure (e.g. a UPS or generator), but nodes in different regions typically would not.

See Also:

https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesioregion

ZONE

@Stability(Stable)
public static final Topology ZONE

A zone represents a logical failure domain.

It is common for Kubernetes clusters to span multiple zones for increased availability. While the exact definition of a zone is left to infrastructure implementations, common properties of a zone include very low network latency within a zone, no-cost network traffic within a zone, and failure independence from other zones. For example, nodes within a zone might share a network switch, but nodes in different zones should not.

See Also:

https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone

Constructor Detail

Topology

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

Topology

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

Method Detail

custom

@Stability(Stable)
@NotNull
public static Topology custom(@NotNull
                              String key)

Custom key for the node label that the system uses to denote the topology domain.

Parameters:

key - This parameter is required.

getKey

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