API.md

API Reference

Table of Contents

• Classes
  • ApiObject
• Structs
  • ApiObjectProps

ApiObject (preflight class)

No description

Constructor

new(props: ApiObjectProps): ApiObject

Properties

Name	Type	Description
apiGroup	str	The group portion of the API version (e.g. authorization.k8s.io).
apiVersion	str	The object's API version (e.g. authorization.k8s.io/v1).
chart	Chart	The chart in which this object is defined.
kind	str	The object kind.
metadata	ApiObjectMetadataDefinition	Metadata associated with this API object.
name	str	The name of the API object.

Methods

Signature	Description
addDependency(dependencies: Array): void	Create a dependency between this ApiObject and other constructs.
addJsonPatch(ops: Array): void	Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object.
static isApiObject(o: any): bool	Return whether the given object is an ApiObject.
static of(c: IConstruct): ApiObject	Returns the ApiObject named Resource which is a child of the given construct.
toJson(): any	Renders the object to Kubernetes JSON.

ApiObjectProps (struct)

No description

Properties

Name	Type	Description
apiVersion	str	API version.
kind	str	Resource kind.
metadata	ApiObjectMetadata?	Object metadata.
spec	Json?	No description