Class CustomResourceDefinitionSpec

CustomResourceDefinitionSpec describes how a user wants their resource to appear

Inheritance

System.Object

CustomResourceDefinitionSpec

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Kubernetes.Types.Outputs.ApiExtensions.V1Beta1

Assembly: Pulumi.Kubernetes.dll

Syntax

public sealed class CustomResourceDefinitionSpec

Fields

AdditionalPrinterColumns

additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If present, this field configures columns for all versions. Top-level and per-version columns are mutually exclusive. If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used.

Declaration

public readonly ImmutableArray<CustomResourceColumnDefinition> AdditionalPrinterColumns

Field Value

Type	Description
System.Collections.Immutable.ImmutableArray<CustomResourceColumnDefinition>

Conversion

conversion defines conversion settings for the CRD.

Declaration

public readonly CustomResourceConversion Conversion

Field Value

Type	Description
CustomResourceConversion

Group

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>).

Declaration

public readonly string Group

Field Value

Type	Description
System.String

Names

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

Declaration

public readonly CustomResourceDefinitionNames Names

Field Value

Type	Description
CustomResourceDefinitionNames

PreserveUnknownFields

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. If false, schemas must be defined for all versions. Defaults to true in v1beta for backwards compatibility. Deprecated: will be required to be false in v1. Preservation of unknown fields can be specified in the validation schema using the x-kubernetes-preserve-unknown-fields: true extension. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.

Declaration

public readonly bool PreserveUnknownFields

Field Value

Type	Description
System.Boolean

Scope

scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are Cluster and Namespaced. Default is Namespaced.

Declaration

public readonly string Scope

Field Value

Type	Description
System.String

Subresources

subresources specify what subresources the defined custom resource has. If present, this field configures subresources for all versions. Top-level and per-version subresources are mutually exclusive.

Declaration

public readonly CustomResourceSubresources Subresources

Field Value

Type	Description
CustomResourceSubresources

Validation

validation describes the schema used for validation and pruning of the custom resource. If present, this validation schema is used to validate all versions. Top-level and per-version schemas are mutually exclusive.

Declaration

public readonly CustomResourceValidation Validation

Field Value

Type	Description
CustomResourceValidation

Version

version is the API version of the defined custom resource. The custom resources are served under /apis/<group>/<version>/.... Must match the name of the first item in the versions list if version and versions are both specified. Optional if versions is specified. Deprecated: use versions instead.

Declaration

public readonly string Version

Field Value

Type	Description
System.String

Versions

versions is the list of all API versions of the defined custom resource. Optional if version is specified. The name of the first item in the versions list must match the version field if version and versions are both specified. 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.

Declaration

public readonly ImmutableArray<CustomResourceDefinitionVersion> Versions

Field Value

Type	Description
System.Collections.Immutable.ImmutableArray<CustomResourceDefinitionVersion>