# API Reference ## Constructs ### ApiObject #### Initializers ```typescript import { ApiObject } from 'cdk8s' new ApiObject(scope: Construct, id: string, props: ApiObjectProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | the construct scope. | | id | string | namespace. | | props | ApiObjectProps | options. | --- ##### `scope`^Required - *Type:* constructs.Construct the construct scope. --- ##### `id`^Required - *Type:* string namespace. --- ##### `props`^Required - *Type:* ApiObjectProps options. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addDependency | Create a dependency between this ApiObject and other constructs. | | addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | | toJson | Renders the object to Kubernetes JSON. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addDependency` ```typescript public addDependency(dependencies: ...IConstruct[]): void ``` Create a dependency between this ApiObject and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* ...constructs.IConstruct[] the dependencies to add. --- ##### `addJsonPatch` ```typescript public addJsonPatch(ops: ...JsonPatch[]): void ``` Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. *Example* ```typescript kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); ``` ###### `ops`^Required - *Type:* ...JsonPatch[] The JSON-Patch operations to apply. --- ##### `toJson` ```typescript public toJson(): any ``` Renders the object to Kubernetes JSON. To disable sorting of dictionary keys in output object set the `CDK8S_DISABLE_SORT` environment variable to any non-empty value. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isApiObject | Return whether the given object is an `ApiObject`. | | of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | --- ##### ~~`isConstruct`~~ ```typescript import { ApiObject } from 'cdk8s' ApiObject.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isApiObject` ```typescript import { ApiObject } from 'cdk8s' ApiObject.isApiObject(o: any) ``` Return whether the given object is an `ApiObject`. We do attribute detection since we can't reliably use 'instanceof'. ###### `o`^Required - *Type:* any The object to check. --- ##### `of` ```typescript import { ApiObject } from 'cdk8s' ApiObject.of(c: IConstruct) ``` Returns the `ApiObject` named `Resource` which is a child of the given construct. If `c` is an `ApiObject`, it is returned directly. Throws an exception if the construct does not have a child named `Default` _or_ if this child is not an `ApiObject`. ###### `c`^Required - *Type:* constructs.IConstruct The higher-level construct. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | | apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | | chart | Chart | The chart in which this object is defined. | | kind | string | The object kind. | | metadata | ApiObjectMetadataDefinition | Metadata associated with this API object. | | name | string | The name of the API object. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiGroup`^Required ```typescript public readonly apiGroup: string; ``` - *Type:* string The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `chart`^Required ```typescript public readonly chart: Chart; ``` - *Type:* Chart The chart in which this object is defined. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ##### `metadata`^Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* ApiObjectMetadataDefinition Metadata associated with this API object. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- ### App Represents a cdk8s application. #### Initializers ```typescript import { App } from 'cdk8s' new App(props?: AppProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | AppProps | configuration options. | --- ##### `props`^Optional - *Type:* AppProps configuration options. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | synth | Synthesizes all manifests to the output directory. | | synthYaml | Synthesizes the app into a YAML string. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `synth` ```typescript public synth(): void ``` Synthesizes all manifests to the output directory. ##### `synthYaml` ```typescript public synthYaml(): string ``` Synthesizes the app into a YAML string. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | of | *No description.* | --- ##### ~~`isConstruct`~~ ```typescript import { App } from 'cdk8s' App.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `of` ```typescript import { App } from 'cdk8s' App.of(c: IConstruct) ``` ###### `c`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | charts | Chart[] | Returns all the charts in this app, sorted topologically. | | outdir | string | The output directory into which manifests will be synthesized. | | outputFileExtension | string | The file extension to use for rendered YAML files. | | resolvers | IResolver[] | Resolvers used by this app. | | yamlOutputType | YamlOutputType | How to divide the YAML output into files. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `charts`^Required ```typescript public readonly charts: Chart[]; ``` - *Type:* Chart[] Returns all the charts in this app, sorted topologically. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string The output directory into which manifests will be synthesized. --- ##### `outputFileExtension`^Required ```typescript public readonly outputFileExtension: string; ``` - *Type:* string - *Default:* .k8s.yaml The file extension to use for rendered YAML files. --- ##### `resolvers`^Required ```typescript public readonly resolvers: IResolver[]; ``` - *Type:* IResolver[] Resolvers used by this app. This includes both custom resolvers passed by the `resolvers` property, as well as built-in resolvers. --- ##### `yamlOutputType`^Required ```typescript public readonly yamlOutputType: YamlOutputType; ``` - *Type:* YamlOutputType - *Default:* YamlOutputType.FILE_PER_CHART How to divide the YAML output into files. --- ### Chart #### Initializers ```typescript import { Chart } from 'cdk8s' new Chart(scope: Construct, id: string, props?: ChartProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ChartProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* ChartProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addDependency | Create a dependency between this Chart and other constructs. | | generateObjectName | Generates a app-unique name for an object given it's construct node path. | | toJson | Renders this chart to a set of Kubernetes JSON resources. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addDependency` ```typescript public addDependency(dependencies: ...IConstruct[]): void ``` Create a dependency between this Chart and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`^Required - *Type:* ...constructs.IConstruct[] the dependencies to add. --- ##### `generateObjectName` ```typescript public generateObjectName(apiObject: ApiObject): string ``` Generates a app-unique name for an object given it's construct node path. Different resource types may have different constraints on names (`metadata.name`). The previous version of the name generator was compatible with DNS_SUBDOMAIN but not with DNS_LABEL. For example, `Deployment` names must comply with DNS_SUBDOMAIN while `Service` names must comply with DNS_LABEL. Since there is no formal specification for this, the default name generation scheme for kubernetes objects in cdk8s was changed to DNS_LABEL, since it’s the common denominator for all kubernetes resources (supposedly). You can override this method if you wish to customize object names at the chart level. ###### `apiObject`^Required - *Type:* ApiObject The API object to generate a name for. --- ##### `toJson` ```typescript public toJson(): any[] ``` Renders this chart to a set of Kubernetes JSON resources. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isChart | Return whether the given object is a Chart. | | of | Finds the chart in which a node is defined. | --- ##### ~~`isConstruct`~~ ```typescript import { Chart } from 'cdk8s' Chart.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- ##### `isChart` ```typescript import { Chart } from 'cdk8s' Chart.isChart(x: any) ``` Return whether the given object is a Chart. We do attribute detection since we can't reliably use 'instanceof'. ###### `x`^Required - *Type:* any --- ##### `of` ```typescript import { Chart } from 'cdk8s' Chart.of(c: IConstruct) ``` Finds the chart in which a node is defined. ###### `c`^Required - *Type:* constructs.IConstruct a construct node. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | apiObjects | ApiObject[] | Returns all the included API objects. | | labels | {[ key: string ]: string} | Labels applied to all resources in this chart. | | namespace | string | The default namespace for all objects in this chart. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiObjects`^Required ```typescript public readonly apiObjects: ApiObject[]; ``` - *Type:* ApiObject[] Returns all the included API objects. --- ##### `labels`^Required ```typescript public readonly labels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Labels applied to all resources in this chart. This is an immutable copy. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string The default namespace for all objects in this chart. --- ### Helm Represents a Helm deployment. Use this construct to import an existing Helm chart and incorporate it into your constructs. #### Initializers ```typescript import { Helm } from 'cdk8s' new Helm(scope: Construct, id: string, props: HelmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | HelmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* HelmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { Helm } from 'cdk8s' Helm.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | apiObjects | ApiObject[] | Returns all the included API objects. | | releaseName | string | The helm release name. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiObjects`^Required ```typescript public readonly apiObjects: ApiObject[]; ``` - *Type:* ApiObject[] Returns all the included API objects. --- ##### `releaseName`^Required ```typescript public readonly releaseName: string; ``` - *Type:* string The helm release name. --- ### Include Reads a YAML manifest from a file or a URL and defines all resources as API objects within the defined scope. The names (`metadata.name`) of imported resources will be preserved as-is from the manifest. #### Initializers ```typescript import { Include } from 'cdk8s' new Include(scope: Construct, id: string, props: IncludeProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | IncludeProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* IncludeProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### ~~`isConstruct`~~ ```typescript import { Include } from 'cdk8s' Include.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | apiObjects | ApiObject[] | Returns all the included API objects. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiObjects`^Required ```typescript public readonly apiObjects: ApiObject[]; ``` - *Type:* ApiObject[] Returns all the included API objects. --- ## Structs ### ApiObjectMetadata Metadata associated with this object. #### Initializer ```typescript import { ApiObjectMetadata } from 'cdk8s' const apiObjectMetadata: ApiObjectMetadata = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | annotations | {[ key: string ]: string} | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. | | finalizers | string[] | Namespaced keys that tell Kubernetes to wait until specific conditions are met before it fully deletes resources marked for deletion. | | labels | {[ key: string ]: string} | Map of string keys and values that can be used to organize and categorize (scope and select) objects. | | name | string | The unique, namespace-global, name of this object inside the Kubernetes cluster. | | namespace | string | Namespace defines the space within each name must be unique. | | ownerReferences | OwnerReference[] | List of objects depended by this object. | --- ##### `annotations`^Optional ```typescript public readonly annotations: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* No annotations. Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. > [http://kubernetes.io/docs/user-guide/annotations](http://kubernetes.io/docs/user-guide/annotations) --- ##### `finalizers`^Optional ```typescript public readonly finalizers: string[]; ``` - *Type:* string[] - *Default:* No finalizers. Namespaced keys that tell Kubernetes to wait until specific conditions are met before it fully deletes resources marked for deletion. Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/finalizers/](https://kubernetes.io/docs/concepts/overview/working-with-objects/finalizers/) --- ##### `labels`^Optional ```typescript public readonly labels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* No labels. Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. > [http://kubernetes.io/docs/user-guide/labels](http://kubernetes.io/docs/user-guide/labels) --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* an app-unique name generated by the chart The unique, namespace-global, name of this object inside the Kubernetes cluster. Normally, you shouldn't specify names for objects and let the CDK generate a name for you that is application-unique. The names CDK generates are composed from the construct path components, separated by dots and a suffix that is based on a hash of the entire path, to ensure uniqueness. You can supply custom name allocation logic by overriding the `chart.generateObjectName` method. If you use an explicit name here, bear in mind that this reduces the composability of your construct because it won't be possible to include more than one instance in any app. Therefore it is highly recommended to leave this unspecified. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string - *Default:* undefined (will be assigned to the 'default' namespace) Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces --- ##### `ownerReferences`^Optional ```typescript public readonly ownerReferences: OwnerReference[]; ``` - *Type:* OwnerReference[] - *Default:* automatically set by Kubernetes List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. Kubernetes sets the value of this field automatically for objects that are dependents of other objects like ReplicaSets, DaemonSets, Deployments, Jobs and CronJobs, and ReplicationControllers. You can also configure these relationships manually by changing the value of this field. However, you usually don't need to and can allow Kubernetes to automatically manage the relationships. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/owners-dependents/](https://kubernetes.io/docs/concepts/overview/working-with-objects/owners-dependents/) --- ### ApiObjectMetadataDefinitionOptions Options for `ApiObjectMetadataDefinition`. #### Initializer ```typescript import { ApiObjectMetadataDefinitionOptions } from 'cdk8s' const apiObjectMetadataDefinitionOptions: ApiObjectMetadataDefinitionOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | annotations | {[ key: string ]: string} | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. | | finalizers | string[] | Namespaced keys that tell Kubernetes to wait until specific conditions are met before it fully deletes resources marked for deletion. | | labels | {[ key: string ]: string} | Map of string keys and values that can be used to organize and categorize (scope and select) objects. | | name | string | The unique, namespace-global, name of this object inside the Kubernetes cluster. | | namespace | string | Namespace defines the space within each name must be unique. | | ownerReferences | OwnerReference[] | List of objects depended by this object. | | apiObject | ApiObject | Which ApiObject instance is the metadata attached to. | --- ##### `annotations`^Optional ```typescript public readonly annotations: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* No annotations. Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. > [http://kubernetes.io/docs/user-guide/annotations](http://kubernetes.io/docs/user-guide/annotations) --- ##### `finalizers`^Optional ```typescript public readonly finalizers: string[]; ``` - *Type:* string[] - *Default:* No finalizers. Namespaced keys that tell Kubernetes to wait until specific conditions are met before it fully deletes resources marked for deletion. Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/finalizers/](https://kubernetes.io/docs/concepts/overview/working-with-objects/finalizers/) --- ##### `labels`^Optional ```typescript public readonly labels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* No labels. Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. > [http://kubernetes.io/docs/user-guide/labels](http://kubernetes.io/docs/user-guide/labels) --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string - *Default:* an app-unique name generated by the chart The unique, namespace-global, name of this object inside the Kubernetes cluster. Normally, you shouldn't specify names for objects and let the CDK generate a name for you that is application-unique. The names CDK generates are composed from the construct path components, separated by dots and a suffix that is based on a hash of the entire path, to ensure uniqueness. You can supply custom name allocation logic by overriding the `chart.generateObjectName` method. If you use an explicit name here, bear in mind that this reduces the composability of your construct because it won't be possible to include more than one instance in any app. Therefore it is highly recommended to leave this unspecified. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string - *Default:* undefined (will be assigned to the 'default' namespace) Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces --- ##### `ownerReferences`^Optional ```typescript public readonly ownerReferences: OwnerReference[]; ``` - *Type:* OwnerReference[] - *Default:* automatically set by Kubernetes List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. Kubernetes sets the value of this field automatically for objects that are dependents of other objects like ReplicaSets, DaemonSets, Deployments, Jobs and CronJobs, and ReplicationControllers. You can also configure these relationships manually by changing the value of this field. However, you usually don't need to and can allow Kubernetes to automatically manage the relationships. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/owners-dependents/](https://kubernetes.io/docs/concepts/overview/working-with-objects/owners-dependents/) --- ##### `apiObject`^Required ```typescript public readonly apiObject: ApiObject; ``` - *Type:* ApiObject Which ApiObject instance is the metadata attached to. --- ### ApiObjectProps Options for defining API objects. #### Initializer ```typescript import { ApiObjectProps } from 'cdk8s' const apiObjectProps: ApiObjectProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | API version. | | kind | string | Resource kind. | | metadata | ApiObjectMetadata | Object metadata. | --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string API version. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string Resource kind. --- ##### `metadata`^Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* ApiObjectMetadata Object metadata. If `name` is not specified, an app-unique name will be allocated by the framework based on the path of the construct within thes construct tree. --- ### AppProps #### Initializer ```typescript import { AppProps } from 'cdk8s' const appProps: AppProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | outdir | string | The directory to output Kubernetes manifests. | | outputFileExtension | string | The file extension to use for rendered YAML files. | | recordConstructMetadata | boolean | When set to true, the output directory will contain a `construct-metadata.json` file that holds construct related metadata on every resource in the app. | | resolvers | IResolver[] | A list of resolvers that can be used to replace property values before they are written to the manifest file. | | yamlOutputType | YamlOutputType | How to divide the YAML output into files. | --- ##### `outdir`^Optional ```typescript public readonly outdir: string; ``` - *Type:* string - *Default:* CDK8S_OUTDIR if defined, otherwise "dist" The directory to output Kubernetes manifests. If you synthesize your application using `cdk8s synth`, you must also pass this value to the CLI using the `--output` option or the `output` property in the `cdk8s.yaml` configuration file. Otherwise, the CLI will not know about the output directory, and synthesis will fail. This property is intended for internal and testing use. --- ##### `outputFileExtension`^Optional ```typescript public readonly outputFileExtension: string; ``` - *Type:* string - *Default:* .k8s.yaml The file extension to use for rendered YAML files. --- ##### `recordConstructMetadata`^Optional ```typescript public readonly recordConstructMetadata: boolean; ``` - *Type:* boolean - *Default:* false When set to true, the output directory will contain a `construct-metadata.json` file that holds construct related metadata on every resource in the app. --- ##### `resolvers`^Optional ```typescript public readonly resolvers: IResolver[]; ``` - *Type:* IResolver[] - *Default:* no resolvers. A list of resolvers that can be used to replace property values before they are written to the manifest file. When multiple resolvers are passed, they are invoked by order in the list, and only the first one that applies (e.g calls `context.replaceValue`) is invoked. > [https://cdk8s.io/docs/latest/basics/app/#resolvers](https://cdk8s.io/docs/latest/basics/app/#resolvers) --- ##### `yamlOutputType`^Optional ```typescript public readonly yamlOutputType: YamlOutputType; ``` - *Type:* YamlOutputType - *Default:* YamlOutputType.FILE_PER_CHART How to divide the YAML output into files. --- ### ChartProps #### Initializer ```typescript import { ChartProps } from 'cdk8s' const chartProps: ChartProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | disableResourceNameHashes | boolean | The autogenerated resource name by default is suffixed with a stable hash of the construct path. | | labels | {[ key: string ]: string} | Labels to apply to all resources in this chart. | | namespace | string | The default namespace for all objects defined in this chart (directly or indirectly). | --- ##### `disableResourceNameHashes`^Optional ```typescript public readonly disableResourceNameHashes: boolean; ``` - *Type:* boolean - *Default:* false The autogenerated resource name by default is suffixed with a stable hash of the construct path. Setting this property to true drops the hash suffix. --- ##### `labels`^Optional ```typescript public readonly labels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* no common labels Labels to apply to all resources in this chart. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string - *Default:* no namespace is synthesized (usually this implies "default") The default namespace for all objects defined in this chart (directly or indirectly). This namespace will only apply to objects that don't have a `namespace` explicitly defined for them. --- ### CronOptions Options to configure a cron expression. All fields are strings so you can use complex expressions. Absence of a field implies '*' #### Initializer ```typescript import { CronOptions } from 'cdk8s' const cronOptions: CronOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | day | string | The day of the month to run this rule at. | | hour | string | The hour to run this rule at. | | minute | string | The minute to run this rule at. | | month | string | The month to run this rule at. | | weekDay | string | The day of the week to run this rule at. | --- ##### `day`^Optional ```typescript public readonly day: string; ``` - *Type:* string - *Default:* Every day of the month The day of the month to run this rule at. --- ##### `hour`^Optional ```typescript public readonly hour: string; ``` - *Type:* string - *Default:* Every hour The hour to run this rule at. --- ##### `minute`^Optional ```typescript public readonly minute: string; ``` - *Type:* string - *Default:* Every minute The minute to run this rule at. --- ##### `month`^Optional ```typescript public readonly month: string; ``` - *Type:* string - *Default:* Every month The month to run this rule at. --- ##### `weekDay`^Optional ```typescript public readonly weekDay: string; ``` - *Type:* string - *Default:* Any day of the week The day of the week to run this rule at. --- ### GroupVersionKind #### Initializer ```typescript import { GroupVersionKind } from 'cdk8s' const groupVersionKind: GroupVersionKind = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | | kind | string | The object kind. | --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string The object's API version (e.g. `authorization.k8s.io/v1`). --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string The object kind. --- ### HelmProps Options for `Helm`. #### Initializer ```typescript import { HelmProps } from 'cdk8s' const helmProps: HelmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | chart | string | The chart name to use. It can be a chart from a helm repository or a local directory. | | helmExecutable | string | The local helm executable to use in order to create the manifest the chart. | | helmFlags | string[] | Additional flags to add to the `helm` execution. | | namespace | string | Scope all resources in to a given namespace. | | releaseName | string | The release name. | | repo | string | Chart repository url where to locate the requested chart. | | values | {[ key: string ]: any} | Values to pass to the chart. | | version | string | Version constraint for the chart version to use. | --- ##### `chart`^Required ```typescript public readonly chart: string; ``` - *Type:* string The chart name to use. It can be a chart from a helm repository or a local directory. This name is passed to `helm template` and has all the relevant semantics. --- *Example* ```typescript "bitnami/redis" ``` ##### `helmExecutable`^Optional ```typescript public readonly helmExecutable: string; ``` - *Type:* string - *Default:* "helm" The local helm executable to use in order to create the manifest the chart. --- ##### `helmFlags`^Optional ```typescript public readonly helmFlags: string[]; ``` - *Type:* string[] - *Default:* [] Additional flags to add to the `helm` execution. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string Scope all resources in to a given namespace. --- ##### `releaseName`^Optional ```typescript public readonly releaseName: string; ``` - *Type:* string - *Default:* if unspecified, a name will be allocated based on the construct path The release name. > [https://helm.sh/docs/intro/using_helm/#three-big-concepts](https://helm.sh/docs/intro/using_helm/#three-big-concepts) --- ##### `repo`^Optional ```typescript public readonly repo: string; ``` - *Type:* string Chart repository url where to locate the requested chart. --- ##### `values`^Optional ```typescript public readonly values: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* If no values are specified, chart will use the defaults. Values to pass to the chart. --- ##### `version`^Optional ```typescript public readonly version: string; ``` - *Type:* string Version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used This name is passed to `helm template --version` and has all the relevant semantics. --- *Example* ```typescript "^2.0.0" ``` ### IncludeProps #### Initializer ```typescript import { IncludeProps } from 'cdk8s' const includeProps: IncludeProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | url | string | Local file path or URL which includes a Kubernetes YAML manifest. | --- ##### `url`^Required ```typescript public readonly url: string; ``` - *Type:* string Local file path or URL which includes a Kubernetes YAML manifest. --- *Example* ```typescript mymanifest.yaml ``` ### NameOptions Options for name generation. #### Initializer ```typescript import { NameOptions } from 'cdk8s' const nameOptions: NameOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | delimiter | string | Delimiter to use between components. | | extra | string[] | Extra components to include in the name. | | includeHash | boolean | Include a short hash as last part of the name. | | maxLen | number | Maximum allowed length for the name. | --- ##### `delimiter`^Optional ```typescript public readonly delimiter: string; ``` - *Type:* string - *Default:* "-" Delimiter to use between components. --- ##### `extra`^Optional ```typescript public readonly extra: string[]; ``` - *Type:* string[] - *Default:* [] use the construct path components Extra components to include in the name. --- ##### `includeHash`^Optional ```typescript public readonly includeHash: boolean; ``` - *Type:* boolean - *Default:* true Include a short hash as last part of the name. --- ##### `maxLen`^Optional ```typescript public readonly maxLen: number; ``` - *Type:* number - *Default:* 63 Maximum allowed length for the name. --- ### OwnerReference OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. #### Initializer ```typescript import { OwnerReference } from 'cdk8s' const ownerReference: OwnerReference = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | apiVersion | string | API version of the referent. | | kind | string | Kind of the referent. | | name | string | Name of the referent. | | uid | string | UID of the referent. | | blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. | | controller | boolean | If true, this reference points to the managing controller. | --- ##### `apiVersion`^Required ```typescript public readonly apiVersion: string; ``` - *Type:* string API version of the referent. --- ##### `kind`^Required ```typescript public readonly kind: string; ``` - *Type:* string Kind of the referent. > [https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds) --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Name of the referent. > [http://kubernetes.io/docs/user-guide/identifiers#names](http://kubernetes.io/docs/user-guide/identifiers#names) --- ##### `uid`^Required ```typescript public readonly uid: string; ``` - *Type:* string UID of the referent. > [http://kubernetes.io/docs/user-guide/identifiers#uids](http://kubernetes.io/docs/user-guide/identifiers#uids) --- ##### `blockOwnerDeletion`^Optional ```typescript public readonly blockOwnerDeletion: boolean; ``` - *Type:* boolean - *Default:* false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. --- ##### `controller`^Optional ```typescript public readonly controller: boolean; ``` - *Type:* boolean If true, this reference points to the managing controller. --- ### SizeConversionOptions Options for how to convert size to a different unit. #### Initializer ```typescript import { SizeConversionOptions } from 'cdk8s' const sizeConversionOptions: SizeConversionOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | rounding | SizeRoundingBehavior | How conversions should behave when it encounters a non-integer result. | --- ##### `rounding`^Optional ```typescript public readonly rounding: SizeRoundingBehavior; ``` - *Type:* SizeRoundingBehavior - *Default:* SizeRoundingBehavior.FAIL How conversions should behave when it encounters a non-integer result. --- ### TimeConversionOptions Options for how to convert time to a different unit. #### Initializer ```typescript import { TimeConversionOptions } from 'cdk8s' const timeConversionOptions: TimeConversionOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | integral | boolean | If `true`, conversions into a larger time unit (e.g. `Seconds` to `Minutes`) will fail if the result is not an integer. | --- ##### `integral`^Optional ```typescript public readonly integral: boolean; ``` - *Type:* boolean - *Default:* true If `true`, conversions into a larger time unit (e.g. `Seconds` to `Minutes`) will fail if the result is not an integer. --- ## Classes ### ApiObjectMetadataDefinition Object metadata. #### Initializers ```typescript import { ApiObjectMetadataDefinition } from 'cdk8s' new ApiObjectMetadataDefinition(options: ApiObjectMetadataDefinitionOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | ApiObjectMetadataDefinitionOptions | *No description.* | --- ##### `options`^Required - *Type:* ApiObjectMetadataDefinitionOptions --- #### Methods | **Name** | **Description** | | --- | --- | | add | Adds an arbitrary key/value to the object metadata. | | addAnnotation | Add an annotation. | | addFinalizers | Add one or more finalizers. | | addLabel | Add a label. | | addOwnerReference | Add an owner. | | getLabel | *No description.* | | toJson | Synthesizes a k8s ObjectMeta for this metadata set. | --- ##### `add` ```typescript public add(key: string, value: any): void ``` Adds an arbitrary key/value to the object metadata. ###### `key`^Required - *Type:* string Metadata key. --- ###### `value`^Required - *Type:* any Metadata value. --- ##### `addAnnotation` ```typescript public addAnnotation(key: string, value: string): void ``` Add an annotation. ###### `key`^Required - *Type:* string The key. --- ###### `value`^Required - *Type:* string The value. --- ##### `addFinalizers` ```typescript public addFinalizers(finalizers: ...string[]): void ``` Add one or more finalizers. ###### `finalizers`^Required - *Type:* ...string[] the finalizers. --- ##### `addLabel` ```typescript public addLabel(key: string, value: string): void ``` Add a label. ###### `key`^Required - *Type:* string The key. --- ###### `value`^Required - *Type:* string The value. --- ##### `addOwnerReference` ```typescript public addOwnerReference(owner: OwnerReference): void ``` Add an owner. ###### `owner`^Required - *Type:* OwnerReference the owner. --- ##### `getLabel` ```typescript public getLabel(key: string): string ``` ###### `key`^Required - *Type:* string the label. --- ##### `toJson` ```typescript public toJson(): any ``` Synthesizes a k8s ObjectMeta for this metadata set. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | The name of the API object. | | namespace | string | The object's namespace. | --- ##### `name`^Optional ```typescript public readonly name: string; ``` - *Type:* string The name of the API object. If a name is specified in `metadata.name` this will be the name returned. Otherwise, a name will be generated by calling `Chart.of(this).generatedObjectName(this)`, which by default uses the construct path to generate a DNS-compatible name for the resource. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string The object's namespace. --- ### Cron Represents a cron schedule. #### Initializers ```typescript import { Cron } from 'cdk8s' new Cron(cronOptions?: CronOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | cronOptions | CronOptions | *No description.* | --- ##### `cronOptions`^Optional - *Type:* CronOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | annually | Create a cron schedule which runs first day of January every year. | | daily | Create a cron schedule which runs every day at midnight. | | everyMinute | Create a cron schedule which runs every minute. | | hourly | Create a cron schedule which runs every hour. | | monthly | Create a cron schedule which runs first day of every month. | | schedule | Create a custom cron schedule from a set of cron fields. | | weekly | Create a cron schedule which runs every week on Sunday. | --- ##### `annually` ```typescript import { Cron } from 'cdk8s' Cron.annually() ``` Create a cron schedule which runs first day of January every year. ##### `daily` ```typescript import { Cron } from 'cdk8s' Cron.daily() ``` Create a cron schedule which runs every day at midnight. ##### `everyMinute` ```typescript import { Cron } from 'cdk8s' Cron.everyMinute() ``` Create a cron schedule which runs every minute. ##### `hourly` ```typescript import { Cron } from 'cdk8s' Cron.hourly() ``` Create a cron schedule which runs every hour. ##### `monthly` ```typescript import { Cron } from 'cdk8s' Cron.monthly() ``` Create a cron schedule which runs first day of every month. ##### `schedule` ```typescript import { Cron } from 'cdk8s' Cron.schedule(options: CronOptions) ``` Create a custom cron schedule from a set of cron fields. ###### `options`^Required - *Type:* CronOptions --- ##### `weekly` ```typescript import { Cron } from 'cdk8s' Cron.weekly() ``` Create a cron schedule which runs every week on Sunday. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expressionString | string | Retrieve the expression for this schedule. | --- ##### `expressionString`^Required ```typescript public readonly expressionString: string; ``` - *Type:* string Retrieve the expression for this schedule. --- ### DependencyGraph Represents the dependency graph for a given Node. This graph includes the dependency relationships between all nodes in the node (construct) sub-tree who's root is this Node. Note that this means that lonely nodes (no dependencies and no dependants) are also included in this graph as childless children of the root node of the graph. The graph does not include cross-scope dependencies. That is, if a child on the current scope depends on a node from a different scope, that relationship is not represented in this graph. #### Initializers ```typescript import { DependencyGraph } from 'cdk8s' new DependencyGraph(node: Node) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | *No description.* | --- ##### `node`^Required - *Type:* constructs.Node --- #### Methods | **Name** | **Description** | | --- | --- | | topology | *No description.* | --- ##### `topology` ```typescript public topology(): IConstruct[] ``` > [Vertex.topology ()](Vertex.topology ()) #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | root | DependencyVertex | Returns the root of the graph. | --- ##### `root`^Required ```typescript public readonly root: DependencyVertex; ``` - *Type:* DependencyVertex Returns the root of the graph. Note that this vertex will always have `null` as its `.value` since it is an artifical root that binds all the connected spaces of the graph. --- ### DependencyVertex Represents a vertex in the graph. The value of each vertex is an `IConstruct` that is accessible via the `.value` getter. #### Initializers ```typescript import { DependencyVertex } from 'cdk8s' new DependencyVertex(value?: IConstruct) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | value | constructs.IConstruct | *No description.* | --- ##### `value`^Optional - *Type:* constructs.IConstruct --- #### Methods | **Name** | **Description** | | --- | --- | | addChild | Adds a vertex as a dependency of the current node. | | topology | Returns a topologically sorted array of the constructs in the sub-graph. | --- ##### `addChild` ```typescript public addChild(dep: DependencyVertex): void ``` Adds a vertex as a dependency of the current node. Also updates the parents of `dep`, so that it contains this node as a parent. This operation will fail in case it creates a cycle in the graph. ###### `dep`^Required - *Type:* DependencyVertex The dependency. --- ##### `topology` ```typescript public topology(): IConstruct[] ``` Returns a topologically sorted array of the constructs in the sub-graph. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | inbound | DependencyVertex[] | Returns the parents of the vertex (i.e dependants). | | outbound | DependencyVertex[] | Returns the children of the vertex (i.e dependencies). | | value | constructs.IConstruct | Returns the IConstruct this graph vertex represents. | --- ##### `inbound`^Required ```typescript public readonly inbound: DependencyVertex[]; ``` - *Type:* DependencyVertex[] Returns the parents of the vertex (i.e dependants). --- ##### `outbound`^Required ```typescript public readonly outbound: DependencyVertex[]; ``` - *Type:* DependencyVertex[] Returns the children of the vertex (i.e dependencies). --- ##### `value`^Optional ```typescript public readonly value: IConstruct; ``` - *Type:* constructs.IConstruct Returns the IConstruct this graph vertex represents. `null` in case this is the root of the graph. --- ### Duration Represents a length of time. The amount can be specified either as a literal value (e.g: `10`) which cannot be negative. #### Methods | **Name** | **Description** | | --- | --- | | toDays | Return the total number of days in this Duration. | | toHours | Return the total number of hours in this Duration. | | toHumanString | Turn this duration into a human-readable string. | | toIsoString | Return an ISO 8601 representation of this period. | | toMilliseconds | Return the total number of milliseconds in this Duration. | | toMinutes | Return the total number of minutes in this Duration. | | toSeconds | Return the total number of seconds in this Duration. | | unitLabel | Return unit of Duration. | --- ##### `toDays` ```typescript public toDays(opts?: TimeConversionOptions): number ``` Return the total number of days in this Duration. ###### `opts`^Optional - *Type:* TimeConversionOptions --- ##### `toHours` ```typescript public toHours(opts?: TimeConversionOptions): number ``` Return the total number of hours in this Duration. ###### `opts`^Optional - *Type:* TimeConversionOptions --- ##### `toHumanString` ```typescript public toHumanString(): string ``` Turn this duration into a human-readable string. ##### `toIsoString` ```typescript public toIsoString(): string ``` Return an ISO 8601 representation of this period. > [https://www.iso.org/fr/standard/70907.html](https://www.iso.org/fr/standard/70907.html) ##### `toMilliseconds` ```typescript public toMilliseconds(opts?: TimeConversionOptions): number ``` Return the total number of milliseconds in this Duration. ###### `opts`^Optional - *Type:* TimeConversionOptions --- ##### `toMinutes` ```typescript public toMinutes(opts?: TimeConversionOptions): number ``` Return the total number of minutes in this Duration. ###### `opts`^Optional - *Type:* TimeConversionOptions --- ##### `toSeconds` ```typescript public toSeconds(opts?: TimeConversionOptions): number ``` Return the total number of seconds in this Duration. ###### `opts`^Optional - *Type:* TimeConversionOptions --- ##### `unitLabel` ```typescript public unitLabel(): string ``` Return unit of Duration. #### Static Functions | **Name** | **Description** | | --- | --- | | days | Create a Duration representing an amount of days. | | hours | Create a Duration representing an amount of hours. | | millis | Create a Duration representing an amount of milliseconds. | | minutes | Create a Duration representing an amount of minutes. | | parse | Parse a period formatted according to the ISO 8601 standard. | | seconds | Create a Duration representing an amount of seconds. | --- ##### `days` ```typescript import { Duration } from 'cdk8s' Duration.days(amount: number) ``` Create a Duration representing an amount of days. ###### `amount`^Required - *Type:* number the amount of Days the `Duration` will represent. --- ##### `hours` ```typescript import { Duration } from 'cdk8s' Duration.hours(amount: number) ``` Create a Duration representing an amount of hours. ###### `amount`^Required - *Type:* number the amount of Hours the `Duration` will represent. --- ##### `millis` ```typescript import { Duration } from 'cdk8s' Duration.millis(amount: number) ``` Create a Duration representing an amount of milliseconds. ###### `amount`^Required - *Type:* number the amount of Milliseconds the `Duration` will represent. --- ##### `minutes` ```typescript import { Duration } from 'cdk8s' Duration.minutes(amount: number) ``` Create a Duration representing an amount of minutes. ###### `amount`^Required - *Type:* number the amount of Minutes the `Duration` will represent. --- ##### `parse` ```typescript import { Duration } from 'cdk8s' Duration.parse(duration: string) ``` Parse a period formatted according to the ISO 8601 standard. > [https://www.iso.org/fr/standard/70907.html](https://www.iso.org/fr/standard/70907.html) ###### `duration`^Required - *Type:* string an ISO-formtted duration to be parsed. --- ##### `seconds` ```typescript import { Duration } from 'cdk8s' Duration.seconds(amount: number) ``` Create a Duration representing an amount of seconds. ###### `amount`^Required - *Type:* number the amount of Seconds the `Duration` will represent. --- ### ImplicitTokenResolver - *Implements:* IResolver Resolves implicit tokens. #### Initializers ```typescript import { ImplicitTokenResolver } from 'cdk8s' new ImplicitTokenResolver() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | resolve | This function is invoked on every property during cdk8s synthesis. | --- ##### `resolve` ```typescript public resolve(context: ResolutionContext): void ``` This function is invoked on every property during cdk8s synthesis. To replace a value, implementations must invoke `context.replaceValue`. ###### `context`^Required - *Type:* ResolutionContext --- ### JsonPatch Utility for applying RFC-6902 JSON-Patch to a document. Use the the `JsonPatch.apply(doc, ...ops)` function to apply a set of operations to a JSON document and return the result. Operations can be created using the factory methods `JsonPatch.add()`, `JsonPatch.remove()`, etc. *Example* ```typescript const output = JsonPatch.apply(input, JsonPatch.replace('/world/hi/there', 'goodbye'), JsonPatch.add('/world/foo/', 'boom'), JsonPatch.remove('/hello')); ``` #### Static Functions | **Name** | **Description** | | --- | --- | | add | Adds a value to an object or inserts it into an array. | | apply | Applies a set of JSON-Patch (RFC-6902) operations to `document` and returns the result. | | copy | Copies a value from one location to another within the JSON document. | | move | Moves a value from one location to the other. | | remove | Removes a value from an object or array. | | replace | Replaces a value. | | test | Tests that the specified value is set in the document. | --- ##### `add` ```typescript import { JsonPatch } from 'cdk8s' JsonPatch.add(path: string, value: any) ``` Adds a value to an object or inserts it into an array. In the case of an array, the value is inserted before the given index. The - character can be used instead of an index to insert at the end of an array. *Example* ```typescript JsonPatch.add('/biscuits/1', { "name": "Ginger Nut" }) ``` ###### `path`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `apply` ```typescript import { JsonPatch } from 'cdk8s' JsonPatch.apply(document: any, ops: ...JsonPatch[]) ``` Applies a set of JSON-Patch (RFC-6902) operations to `document` and returns the result. ###### `document`^Required - *Type:* any The document to patch. --- ###### `ops`^Required - *Type:* ...JsonPatch[] The operations to apply. --- ##### `copy` ```typescript import { JsonPatch } from 'cdk8s' JsonPatch.copy(from: string, path: string) ``` Copies a value from one location to another within the JSON document. Both from and path are JSON Pointers. *Example* ```typescript JsonPatch.copy('/biscuits/0', '/best_biscuit') ``` ###### `from`^Required - *Type:* string --- ###### `path`^Required - *Type:* string --- ##### `move` ```typescript import { JsonPatch } from 'cdk8s' JsonPatch.move(from: string, path: string) ``` Moves a value from one location to the other. Both from and path are JSON Pointers. *Example* ```typescript JsonPatch.move('/biscuits', '/cookies') ``` ###### `from`^Required - *Type:* string --- ###### `path`^Required - *Type:* string --- ##### `remove` ```typescript import { JsonPatch } from 'cdk8s' JsonPatch.remove(path: string) ``` Removes a value from an object or array. *Example* ```typescript JsonPatch.remove('/biscuits/0') ``` ###### `path`^Required - *Type:* string --- ##### `replace` ```typescript import { JsonPatch } from 'cdk8s' JsonPatch.replace(path: string, value: any) ``` Replaces a value. Equivalent to a “remove” followed by an “add”. *Example* ```typescript JsonPatch.replace('/biscuits/0/name', 'Chocolate Digestive') ``` ###### `path`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `test` ```typescript import { JsonPatch } from 'cdk8s' JsonPatch.test(path: string, value: any) ``` Tests that the specified value is set in the document. If the test fails, then the patch as a whole should not apply. *Example* ```typescript JsonPatch.test('/best_biscuit/name', 'Choco Leibniz') ``` ###### `path`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ### Lazy #### Methods | **Name** | **Description** | | --- | --- | | produce | *No description.* | --- ##### `produce` ```typescript public produce(): any ``` #### Static Functions | **Name** | **Description** | | --- | --- | | any | *No description.* | --- ##### `any` ```typescript import { Lazy } from 'cdk8s' Lazy.any(producer: IAnyProducer) ``` ###### `producer`^Required - *Type:* IAnyProducer --- ### LazyResolver - *Implements:* IResolver Resolvers instanecs of `Lazy`. #### Initializers ```typescript import { LazyResolver } from 'cdk8s' new LazyResolver() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | resolve | This function is invoked on every property during cdk8s synthesis. | --- ##### `resolve` ```typescript public resolve(context: ResolutionContext): void ``` This function is invoked on every property during cdk8s synthesis. To replace a value, implementations must invoke `context.replaceValue`. ###### `context`^Required - *Type:* ResolutionContext --- ### Names Utilities for generating unique and stable names. #### Static Functions | **Name** | **Description** | | --- | --- | | toDnsLabel | Generates a unique and stable name compatible DNS_LABEL from RFC-1123 from a path. | | toLabelValue | Generates a unique and stable name compatible label key name segment and label value from a path. | --- ##### `toDnsLabel` ```typescript import { Names } from 'cdk8s' Names.toDnsLabel(scope: Construct, options?: NameOptions) ``` Generates a unique and stable name compatible DNS_LABEL from RFC-1123 from a path. The generated name will: - contain at most 63 characters - contain only lowercase alphanumeric characters or ‘-’ - start with an alphanumeric character - end with an alphanumeric character The generated name will have the form: --..-- Where are the path components (assuming they are is separated by "/"). Note that if the total length is longer than 63 characters, we will trim the first components since the last components usually encode more meaning. > [https://tools.ietf.org/html/rfc1123](https://tools.ietf.org/html/rfc1123) ###### `scope`^Required - *Type:* constructs.Construct The construct for which to render the DNS label. --- ###### `options`^Optional - *Type:* NameOptions Name options. --- ##### `toLabelValue` ```typescript import { Names } from 'cdk8s' Names.toLabelValue(scope: Construct, options?: NameOptions) ``` Generates a unique and stable name compatible label key name segment and label value from a path. The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. Valid label values must be 63 characters or less and must be empty or begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The generated name will have the form: ..

Where are the path components (assuming they are is separated by "/"). Note that if the total length is longer than 63 characters, we will trim the first components since the last components usually encode more meaning. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set) ###### `scope`^Required - *Type:* constructs.Construct The construct for which to render the DNS label. --- ###### `options`^Optional - *Type:* NameOptions Name options. --- ### NumberStringUnionResolver - *Implements:* IResolver Resolves union types that allow using either number or string (as generated by the CLI). E.g IntOrString, Quantity, ... #### Initializers ```typescript import { NumberStringUnionResolver } from 'cdk8s' new NumberStringUnionResolver() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | resolve | This function is invoked on every property during cdk8s synthesis. | --- ##### `resolve` ```typescript public resolve(context: ResolutionContext): void ``` This function is invoked on every property during cdk8s synthesis. To replace a value, implementations must invoke `context.replaceValue`. ###### `context`^Required - *Type:* ResolutionContext --- ### ResolutionContext Context object for a specific resolution process. #### Initializers ```typescript import { ResolutionContext } from 'cdk8s' new ResolutionContext(obj: ApiObject, key: string[], value: any) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | obj | ApiObject | Which ApiObject is currently being resolved. | | key | string[] | Which key is currently being resolved. | | value | any | The value associated to the key currently being resolved. | --- ##### `obj`^Required - *Type:* ApiObject Which ApiObject is currently being resolved. --- ##### `key`^Required - *Type:* string[] Which key is currently being resolved. --- ##### `value`^Required - *Type:* any The value associated to the key currently being resolved. --- #### Methods | **Name** | **Description** | | --- | --- | | replaceValue | Replaces the original value in this resolution context with a new value. | --- ##### `replaceValue` ```typescript public replaceValue(newValue: any): void ``` Replaces the original value in this resolution context with a new value. The new value is what will end up in the manifest. ###### `newValue`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | key | string[] | Which key is currently being resolved. | | obj | ApiObject | Which ApiObject is currently being resolved. | | value | any | The value associated to the key currently being resolved. | | replaced | boolean | Whether or not the value was replaced by invoking the `replaceValue` method. | | replacedValue | any | The replaced value that was set via the `replaceValue` method. | --- ##### `key`^Required ```typescript public readonly key: string[]; ``` - *Type:* string[] Which key is currently being resolved. --- ##### `obj`^Required ```typescript public readonly obj: ApiObject; ``` - *Type:* ApiObject Which ApiObject is currently being resolved. --- ##### `value`^Required ```typescript public readonly value: any; ``` - *Type:* any The value associated to the key currently being resolved. --- ##### `replaced`^Required ```typescript public readonly replaced: boolean; ``` - *Type:* boolean Whether or not the value was replaced by invoking the `replaceValue` method. --- ##### `replacedValue`^Required ```typescript public readonly replacedValue: any; ``` - *Type:* any The replaced value that was set via the `replaceValue` method. --- ### Size Represents the amount of digital storage. The amount can be specified either as a literal value (e.g: `10`) which cannot be negative. When the amount is passed as a token, unit conversion is not possible. #### Methods | **Name** | **Description** | | --- | --- | | asString | Returns amount with abbreviated storage unit. | | toGibibytes | Return this storage as a total number of gibibytes. | | toKibibytes | Return this storage as a total number of kibibytes. | | toMebibytes | Return this storage as a total number of mebibytes. | | toPebibytes | Return this storage as a total number of pebibytes. | | toTebibytes | Return this storage as a total number of tebibytes. | --- ##### `asString` ```typescript public asString(): string ``` Returns amount with abbreviated storage unit. ##### `toGibibytes` ```typescript public toGibibytes(opts?: SizeConversionOptions): number ``` Return this storage as a total number of gibibytes. ###### `opts`^Optional - *Type:* SizeConversionOptions --- ##### `toKibibytes` ```typescript public toKibibytes(opts?: SizeConversionOptions): number ``` Return this storage as a total number of kibibytes. ###### `opts`^Optional - *Type:* SizeConversionOptions --- ##### `toMebibytes` ```typescript public toMebibytes(opts?: SizeConversionOptions): number ``` Return this storage as a total number of mebibytes. ###### `opts`^Optional - *Type:* SizeConversionOptions --- ##### `toPebibytes` ```typescript public toPebibytes(opts?: SizeConversionOptions): number ``` Return this storage as a total number of pebibytes. ###### `opts`^Optional - *Type:* SizeConversionOptions --- ##### `toTebibytes` ```typescript public toTebibytes(opts?: SizeConversionOptions): number ``` Return this storage as a total number of tebibytes. ###### `opts`^Optional - *Type:* SizeConversionOptions --- #### Static Functions | **Name** | **Description** | | --- | --- | | gibibytes | Create a Storage representing an amount gibibytes. | | kibibytes | Create a Storage representing an amount kibibytes. | | mebibytes | Create a Storage representing an amount mebibytes. | | pebibyte | Create a Storage representing an amount pebibytes. | | tebibytes | Create a Storage representing an amount tebibytes. | --- ##### `gibibytes` ```typescript import { Size } from 'cdk8s' Size.gibibytes(amount: number) ``` Create a Storage representing an amount gibibytes. 1 GiB = 1024 MiB ###### `amount`^Required - *Type:* number --- ##### `kibibytes` ```typescript import { Size } from 'cdk8s' Size.kibibytes(amount: number) ``` Create a Storage representing an amount kibibytes. 1 KiB = 1024 bytes ###### `amount`^Required - *Type:* number --- ##### `mebibytes` ```typescript import { Size } from 'cdk8s' Size.mebibytes(amount: number) ``` Create a Storage representing an amount mebibytes. 1 MiB = 1024 KiB ###### `amount`^Required - *Type:* number --- ##### `pebibyte` ```typescript import { Size } from 'cdk8s' Size.pebibyte(amount: number) ``` Create a Storage representing an amount pebibytes. 1 PiB = 1024 TiB ###### `amount`^Required - *Type:* number --- ##### `tebibytes` ```typescript import { Size } from 'cdk8s' Size.tebibytes(amount: number) ``` Create a Storage representing an amount tebibytes. 1 TiB = 1024 GiB ###### `amount`^Required - *Type:* number --- ### Testing Testing utilities for cdk8s applications. #### Static Functions | **Name** | **Description** | | --- | --- | | app | Returns an app for testing with the following properties: - Output directory is a temp dir. | | chart | *No description.* | | synth | Returns the Kubernetes manifest synthesized from this chart. | --- ##### `app` ```typescript import { Testing } from 'cdk8s' Testing.app(props?: AppProps) ``` Returns an app for testing with the following properties: - Output directory is a temp dir. ###### `props`^Optional - *Type:* AppProps --- ##### `chart` ```typescript import { Testing } from 'cdk8s' Testing.chart() ``` ##### `synth` ```typescript import { Testing } from 'cdk8s' Testing.synth(chart: Chart) ``` Returns the Kubernetes manifest synthesized from this chart. ###### `chart`^Required - *Type:* Chart --- ### Yaml YAML utilities. #### Static Functions | **Name** | **Description** | | --- | --- | | formatObjects | *No description.* | | load | Downloads a set of YAML documents (k8s manifest for example) from a URL or a file and returns them as javascript objects. | | save | Saves a set of objects as a multi-document YAML file. | | stringify | Stringify a document (or multiple documents) into YAML. | | tmp | Saves a set of YAML documents into a temp file (in /tmp). | --- ##### ~~`formatObjects`~~ ```typescript import { Yaml } from 'cdk8s' Yaml.formatObjects(docs: any[]) ``` ###### `docs`^Required - *Type:* any[] --- ##### `load` ```typescript import { Yaml } from 'cdk8s' Yaml.load(urlOrFile: string) ``` Downloads a set of YAML documents (k8s manifest for example) from a URL or a file and returns them as javascript objects. Empty documents are filtered out. ###### `urlOrFile`^Required - *Type:* string a URL of a file path to load from. --- ##### `save` ```typescript import { Yaml } from 'cdk8s' Yaml.save(filePath: string, docs: any[]) ``` Saves a set of objects as a multi-document YAML file. ###### `filePath`^Required - *Type:* string The output path. --- ###### `docs`^Required - *Type:* any[] The set of objects. --- ##### `stringify` ```typescript import { Yaml } from 'cdk8s' Yaml.stringify(docs: ...any[]) ``` Stringify a document (or multiple documents) into YAML. We convert undefined values to null, but ignore any documents that are undefined. ###### `docs`^Required - *Type:* ...any[] A set of objects to convert to YAML. --- ##### `tmp` ```typescript import { Yaml } from 'cdk8s' Yaml.tmp(docs: any[]) ``` Saves a set of YAML documents into a temp file (in /tmp). ###### `docs`^Required - *Type:* any[] the set of documents to save. --- ## Protocols ### IAnyProducer - *Implemented By:* IAnyProducer #### Methods | **Name** | **Description** | | --- | --- | | produce | *No description.* | --- ##### `produce` ```typescript public produce(): any ``` ### IResolver - *Implemented By:* ImplicitTokenResolver, LazyResolver, NumberStringUnionResolver, IResolver Contract for resolver objects. #### Methods | **Name** | **Description** | | --- | --- | | resolve | This function is invoked on every property during cdk8s synthesis. | --- ##### `resolve` ```typescript public resolve(context: ResolutionContext): void ``` This function is invoked on every property during cdk8s synthesis. To replace a value, implementations must invoke `context.replaceValue`. ###### `context`^Required - *Type:* ResolutionContext --- ## Enums ### SizeRoundingBehavior Rounding behaviour when converting between units of `Size`. #### Members | **Name** | **Description** | | --- | --- | | FAIL | Fail the conversion if the result is not an integer. | | FLOOR | If the result is not an integer, round it to the closest integer less than the result. | | NONE | Don't round. | --- ##### `FAIL` Fail the conversion if the result is not an integer. --- ##### `FLOOR` If the result is not an integer, round it to the closest integer less than the result. --- ##### `NONE` Don't round. Return even if the result is a fraction. --- ### YamlOutputType The method to divide YAML output into files. #### Members | **Name** | **Description** | | --- | --- | | FILE_PER_APP | All resources are output into a single YAML file. | | FILE_PER_CHART | Resources are split into seperate files by chart. | | FILE_PER_RESOURCE | Each resource is output to its own file. | | FOLDER_PER_CHART_FILE_PER_RESOURCE | Each chart in its own folder and each resource in its own file. | --- ##### `FILE_PER_APP` All resources are output into a single YAML file. --- ##### `FILE_PER_CHART` Resources are split into seperate files by chart. --- ##### `FILE_PER_RESOURCE` Each resource is output to its own file. --- ##### `FOLDER_PER_CHART_FILE_PER_RESOURCE` Each chart in its own folder and each resource in its own file. ---