Package org.cdk8s.plus25.k8s

Class KubeStatefulSet

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.88.0 (build eaabd08)",
           date="2023-09-11T06:17:58.715Z")
@Stability(Stable)
public class KubeStatefulSet
extends org.cdk8s.ApiObject
    StatefulSet represents a set of pods with consistent identities.

    Identities are defined as:

    • Network: A single stable DNS and hostname.
    • Storage: As many VolumeClaims as requested.

    The StatefulSet guarantees that a given network identity will always map to the same storage identity.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  KubeStatefulSet.Builder
      A fluent builder for KubeStatefulSet.

      • 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, software.constructs.IConstruct.Jsii$Proxy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static org.cdk8s.GroupVersionKind GVK
      Returns the apiVersion and kind for "io.k8s.api.apps.v1.StatefulSet".

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected KubeStatefulSet​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)  
      protected KubeStatefulSet​(software.amazon.jsii.JsiiObjectRef objRef)  
        KubeStatefulSet​(software.constructs.Construct scope, String id)
      Defines a "io.k8s.api.apps.v1.StatefulSet" API object.
        KubeStatefulSet​(software.constructs.Construct scope, String id, KubeStatefulSetProps props)
      Defines a "io.k8s.api.apps.v1.StatefulSet" API object.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Object manifest()
      Renders a Kubernetes manifest for "io.k8s.api.apps.v1.StatefulSet".
      static Object manifest​(KubeStatefulSetProps props)
      Renders a Kubernetes manifest for "io.k8s.api.apps.v1.StatefulSet".
      Object toJson()
      Renders the object to Kubernetes JSON.

      • Methods inherited from class org.cdk8s.ApiObject

        addDependency, addJsonPatch, getApiGroup, getApiVersion, getChart, getKind, getMetadata, getName, isApiObject, of

      • 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 interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Field Detail

      • GVK

        @Stability(Stable)
public static final org.cdk8s.GroupVersionKind GVK
        Returns the apiVersion and kind for "io.k8s.api.apps.v1.StatefulSet".

    • Constructor Detail

      • KubeStatefulSet

        protected KubeStatefulSet​(software.amazon.jsii.JsiiObjectRef objRef)

      • KubeStatefulSet

        protected KubeStatefulSet​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • KubeStatefulSet

        @Stability(Stable)
public KubeStatefulSet​(@NotNull
                       software.constructs.Construct scope,
                       @NotNull
                       String id,
                       @Nullable
                       KubeStatefulSetProps props)
        Defines a "io.k8s.api.apps.v1.StatefulSet" API object.

        Parameters:
        scope - the scope in which to define this object. This parameter is required.
        id - a scope-local name for the object. This parameter is required.
        props - initialization props.

      • KubeStatefulSet

        @Stability(Stable)
public KubeStatefulSet​(@NotNull
                       software.constructs.Construct scope,
                       @NotNull
                       String id)
        Defines a "io.k8s.api.apps.v1.StatefulSet" API object.

        Parameters:
        scope - the scope in which to define this object. This parameter is required.
        id - a scope-local name for the object. This parameter is required.

    • Method Detail

      • manifest

        @Stability(Stable)
@NotNull
public static Object manifest​(@Nullable
                              KubeStatefulSetProps props)
        Renders a Kubernetes manifest for "io.k8s.api.apps.v1.StatefulSet".

        This can be used to inline resource manifests inside other objects (e.g. as templates).

        Parameters:
        props - initialization props.

      • manifest

        @Stability(Stable)
@NotNull
public static Object manifest()
        Renders a Kubernetes manifest for "io.k8s.api.apps.v1.StatefulSet".

        This can be used to inline resource manifests inside other objects (e.g. as templates).

      • toJson

        @Stability(Stable)
@NotNull
public Object toJson()
        Renders the object to Kubernetes JSON.
        Overrides:
        toJson in class org.cdk8s.ApiObject