Fork me on GitHub

Module apiextensions/v1beta1

@pulumi/kubernetes > apiextensions > v1beta1

Index

types/input.ts types/output.ts

function isCustomResourceDefinition

isCustomResourceDefinition(o: any): boolean

function isCustomResourceDefinitionList

isCustomResourceDefinitionList(o: any): boolean

interface CustomResourceDefinition

CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ObjectMeta;

property spec

spec: CustomResourceDefinitionSpec;

Spec describes how the user wants the resources to appear

property status

status: CustomResourceDefinitionStatus;

Status indicates the actual state of the CustomResourceDefinition

interface CustomResourceDefinitionCondition

CustomResourceDefinitionCondition contains details for the current condition of this pod.

property lastTransitionTime

lastTransitionTime: string;

Last time the condition transitioned from one status to another.

property message

message: string;

Human-readable message indicating details about last transition.

property reason

reason: string;

Unique, one-word, CamelCase reason for the condition’s last transition.

property status

status: string;

Status is the status of the condition. Can be True, False, Unknown.

property type

type: string;

Type is the type of the condition.

interface CustomResourceDefinitionList

CustomResourceDefinitionList is a list of CustomResourceDefinition objects.

property apiVersion

apiVersion: string;

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

property items

items: CustomResourceDefinition[];

Items individual CustomResourceDefinitions

property kind

kind: string;

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

property metadata

metadata: ListMeta;

interface CustomResourceDefinitionNames

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

property kind

kind: string;

Kind is the serialized kind of the resource. It is normally CamelCase and singular.

property listKind

listKind: string;

ListKind is the serialized kind of the list for this resource. Defaults to List.

property plural

plural: string;

Plural is the plural name of the resource to serve. It must match the name of the CustomResourceDefinition-registration too: plural.group and it must be all lowercase.

property shortNames

shortNames: string[];

ShortNames are short names for the resource. It must be all lowercase.

property singular

singular: string;

Singular is the singular name of the resource. It must be all lowercase Defaults to lowercased

interface CustomResourceDefinitionSpec

CustomResourceDefinitionSpec describes how a user wants their resource to appear

property group

group: string;

Group is the group this resource belongs in

property names

names: CustomResourceDefinitionNames;

Names are the names used to describe this custom resource

property scope

scope: string;

Scope indicates whether this resource is cluster or namespace scoped. Default is namespaced

property validation

validation: CustomResourceValidation;

Validation describes the validation methods for CustomResources

property version

version: string;

Version is the version this resource belongs in

interface CustomResourceDefinitionStatus

CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition

property acceptedNames

acceptedNames: CustomResourceDefinitionNames;

AcceptedNames are the names that are actually being used to serve discovery They may be different than the names in spec.

property conditions

conditions: CustomResourceDefinitionCondition[];

Conditions indicate state for particular aspects of a CustomResourceDefinition

interface CustomResourceValidation

CustomResourceValidation is a list of validation methods for CustomResources.

property openAPIV3Schema

openAPIV3Schema: JSONSchemaProps;

OpenAPIV3Schema is the OpenAPI v3 schema to be validated against.

interface ExternalDocumentation

ExternalDocumentation allows referencing an external resource for extended documentation.

property description

description: string;

property url

url: string;

interface JSON

JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.

property Raw

Raw: string;

interface JSONSchemaProps

JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).

property $ref

$ref: string;

property $schema

$schema: string;

property additionalItems

additionalItems: JSONSchemaPropsOrBool;

property additionalProperties

additionalProperties: JSONSchemaPropsOrBool;

property allOf

allOf: JSONSchemaProps[];

property anyOf

anyOf: JSONSchemaProps[];

property default

default: JSON;

property definitions

definitions: object;

property dependencies

dependencies: object;

property description

description: string;

property enum

enum: JSON[];

property example

example: JSON;

property exclusiveMaximum

exclusiveMaximum: boolean;

property exclusiveMinimum

exclusiveMinimum: boolean;

property externalDocs

externalDocs: ExternalDocumentation;

property format

format: string;

property id

id: string;

property items

items: JSONSchemaPropsOrArray;

property maxItems

maxItems: number;

property maxLength

maxLength: number;

property maxProperties

maxProperties: number;

property maximum

maximum: number;

property minItems

minItems: number;

property minLength

minLength: number;

property minProperties

minProperties: number;

property minimum

minimum: number;

property multipleOf

multipleOf: number;

property not

not: JSONSchemaProps;

property oneOf

oneOf: JSONSchemaProps[];

property pattern

pattern: string;

property patternProperties

patternProperties: object;

property properties

properties: object;

property required

required: string[];

property title

title: string;

property type

type: string;

property uniqueItems

uniqueItems: boolean;

interface JSONSchemaPropsOrArray

JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.

property JSONSchemas

JSONSchemas: JSONSchemaProps[];

property Schema

Schema: JSONSchemaProps;

interface JSONSchemaPropsOrBool

JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.

property Allows

Allows: boolean;

property Schema

Schema: JSONSchemaProps;

interface JSONSchemaPropsOrStringArray

JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array.

property Property

Property: string[];

property Schema

Schema: JSONSchemaProps;