Package org.cdk8s.plus24.k8s

Interface CustomResourceDefinitionSpec

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomResourceDefinitionSpec.Jsii$Proxy

@Generated(value="jsii-pacmak/1.80.0 (build bce6a1d)",
           date="2023-05-05T16:22:33.860Z")
@Stability(Stable)
public interface CustomResourceDefinitionSpec
extends software.amazon.jsii.JsiiSerializable

CustomResourceDefinitionSpec describes how a user wants their resource to appear.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CustomResourceDefinitionSpec.Builder	A builder for CustomResourceDefinitionSpec
static class	CustomResourceDefinitionSpec.Jsii$Proxy	An implementation for CustomResourceDefinitionSpec

Method Summary

Modifier and Type	Method	Description
static CustomResourceDefinitionSpec.Builder	builder()
default CustomResourceConversion	getConversion()	conversion defines conversion settings for the CRD.
String	getGroup()	group is the API group of the defined custom resource.
CustomResourceDefinitionNames	getNames()	names specify the resource and kind names for the custom resource.
default Boolean	getPreserveUnknownFields()	preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage.
String	getScope()	scope indicates whether the defined custom resource is cluster- or namespace-scoped.
List<CustomResourceDefinitionVersion>	getVersions()	versions is the list of all API versions of the defined custom resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getGroup

@Stability(Stable)
@NotNull
String getGroup()

group is the API group of the defined custom resource.

The custom resources are served under /apis/<group>/.... Must match the name of the CustomResourceDefinition (in the form <names.plural>.<group>).

getNames

@Stability(Stable)
@NotNull
CustomResourceDefinitionNames getNames()

names specify the resource and kind names for the custom resource.

getScope

@Stability(Stable)
@NotNull
String getScope()

scope indicates whether the defined custom resource is cluster- or namespace-scoped.

Allowed values are Cluster and Namespaced.

getVersions

@Stability(Stable)
@NotNull
List<CustomResourceDefinitionVersion> getVersions()

versions is the list of all API versions of the defined custom resource.

Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.

getConversion

@Stability(Stable)
@Nullable
default CustomResourceConversion getConversion()

conversion defines conversion settings for the CRD.

getPreserveUnknownFields

@Stability(Stable)
@Nullable
default Boolean getPreserveUnknownFields()

preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage.

apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting x-preserve-unknown-fields to true in spec.versions[*].schema.openAPIV3Schema. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.

builder

@Stability(Stable)
static CustomResourceDefinitionSpec.Builder builder()

Returns:

a CustomResourceDefinitionSpec.Builder of CustomResourceDefinitionSpec