{ "author": { "name": "Amazon Web Services", "roles": [ "author" ], "url": "https://aws.amazon.com" }, "bundled": { "minimatch": "^3.1.2", "safe-stable-stringify": "*" }, "dependencies": { "cdk8s": "^2.3.2", "constructs": "^10.1.14" }, "dependencyClosure": { "cdk8s": { "targets": { "dotnet": { "namespace": "Org.Cdk8s", "packageId": "Org.Cdk8s" }, "go": { "moduleName": "github.com/cdk8s-team/cdk8s-core-go" }, "java": { "maven": { "artifactId": "cdk8s", "groupId": "org.cdk8s" }, "package": "org.cdk8s" }, "js": { "npm": "cdk8s" }, "python": { "distName": "cdk8s", "module": "cdk8s" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "cdk8s+ is a software development framework that provides high level abstractions for authoring Kubernetes applications. cdk8s-plus-21 synthesizes Kubernetes manifests for Kubernetes 1.21.0", "docs": { "stability": "stable" }, "homepage": "https://github.com/cdk8s-team/cdk8s-plus.git", "jsiiVersion": "1.59.0 (build eb02c92)", "keywords": [ "cdk", "configuration", "constructs", "containers", "k8s", "kubernetes", "microservices" ], "license": "Apache-2.0", "metadata": { "jsii": { "pacmak": { "hasDefaultInterfaces": true } }, "tscRootDir": "src" }, "name": "cdk8s-plus-21", "readme": { "markdown": "# cdk8s+ (cdk8s-plus)\n\n### High level constructs for Kubernetes\n\n![Stability:Beta](https://img.shields.io/badge/stability-beta-orange)\n[![cdk8s-plus-22](https://img.shields.io/github/workflow/status/cdk8s-team/cdk8s-plus/release-k8s.22?label=cdk8s-plus-22&logo=GitHub)](https://github.com/cdk8s-team/cdk8s-plus/actions/workflows/release-k8s.22.yml)\n[![cdk8s-plus-21](https://img.shields.io/github/workflow/status/cdk8s-team/cdk8s-plus/release-k8s.21?label=cdk8s-plus-21&logo=GitHub)](https://github.com/cdk8s-team/cdk8s-plus/actions/workflows/release-k8s.21.yml)\n[![cdk8s-plus-20](https://img.shields.io/github/workflow/status/cdk8s-team/cdk8s-plus/release-k8s.20?label=cdk8s-plus-20&logo=GitHub)](https://github.com/cdk8s-team/cdk8s-plus/actions/workflows/release-k8s.20.yml)\n\n| k8s version | npm (JS/TS) | PyPI (Python) | NuGet (C#) | Maven (Java) | Go |\n| --- | --- | --- | --- | --- | --- |\n| 1.20.0 | [Link](https://www.npmjs.com/package/cdk8s-plus-20) | [Link](https://pypi.org/project/cdk8s-plus-20/) | [Link](https://www.nuget.org/packages/Org.Cdk8s.Plus20) | [Link](https://search.maven.org/artifact/org.cdk8s/cdk8s-plus-20) | [Link](https://github.com/cdk8s-team/cdk8s-plus-go/tree/k8s.20) |\n| 1.21.0 | [Link](https://www.npmjs.com/package/cdk8s-plus-21) | [Link](https://pypi.org/project/cdk8s-plus-21/) | [Link](https://www.nuget.org/packages/Org.Cdk8s.Plus21) | [Link](https://search.maven.org/artifact/org.cdk8s/cdk8s-plus-21) | [Link](https://github.com/cdk8s-team/cdk8s-plus-go/tree/k8s.21) |\n| 1.22.0 | [Link](https://www.npmjs.com/package/cdk8s-plus-22) | [Link](https://pypi.org/project/cdk8s-plus-22/) | [Link](https://www.nuget.org/packages/Org.Cdk8s.Plus22) | [Link](https://search.maven.org/artifact/org.cdk8s/cdk8s-plus-22) | [Link](https://github.com/cdk8s-team/cdk8s-plus-go/tree/k8s.22) |\n\n**cdk8s+** is a software development framework that provides high level\nabstractions for authoring Kubernetes applications. Built on top of the auto\ngenerated building blocks provided by [cdk8s](../cdk8s), this library includes a\nhand crafted *construct* for each native kubernetes object, exposing richer\nAPI's with reduced complexity.\n\n## :books: Documentation\n\nSee [cdk8s.io](https://cdk8s.io/docs/latest/plus).\n\n## :raised_hand: Contributing\n\nIf you'd like to add a new feature or fix a bug, please visit\n[CONTRIBUTING.md](CONTRIBUTING.md)!\n\n## :balance_scale: License\n\nThis project is distributed under the [Apache License, Version 2.0](./LICENSE).\n\nThis module is part of the [cdk8s project](https://github.com/cdk8s-team).\n" }, "repository": { "type": "git", "url": "https://github.com/cdk8s-team/cdk8s-plus.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "namespace": "Org.Cdk8s.Plus21", "packageId": "Org.Cdk8s.Plus21" }, "go": { "moduleName": "github.com/cdk8s-team/cdk8s-plus-go" }, "java": { "maven": { "artifactId": "cdk8s-plus-21", "groupId": "org.cdk8s" }, "package": "org.cdk8s.plus21" }, "js": { "npm": "cdk8s-plus-21" }, "python": { "distName": "cdk8s-plus-21", "module": "cdk8s_plus_21" } }, "types": { "cdk8s-plus-21.AbstractPod": { "abstract": true, "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Resource", "docs": { "stability": "stable" }, "fqn": "cdk8s-plus-21.AbstractPod", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 28 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.AbstractPodProps" } } ] }, "interfaces": [ "cdk8s-plus-21.IPodSelector" ], "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 12 }, "methods": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 93 }, "name": "addContainer", "parameters": [ { "name": "cont", "type": { "fqn": "cdk8s-plus-21.ContainerProps" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Container" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 123 }, "name": "addHostAlias", "parameters": [ { "name": "hostAlias", "type": { "fqn": "cdk8s-plus-21.HostAlias" } } ] }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 99 }, "name": "addInitContainer", "parameters": [ { "name": "cont", "type": { "fqn": "cdk8s-plus-21.ContainerProps" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Container" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 127 }, "name": "addVolume", "parameters": [ { "name": "vol", "type": { "fqn": "cdk8s-plus-21.Volume" } } ] }, { "docs": { "see": "IPodSelector.toPodSelectorConfig()", "stability": "stable", "summary": "Return the configuration of this selector." }, "locationInModule": { "filename": "src/pod.ts", "line": 79 }, "name": "toPodSelectorConfig", "overrides": "cdk8s-plus-21.IPodSelector", "returns": { "type": { "fqn": "cdk8s-plus-21.PodSelectorConfig" } } } ], "name": "AbstractPod", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 19 }, "name": "automountServiceAccountToken", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 60 }, "name": "containers", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.Container" }, "kind": "array" } } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 17 }, "name": "dns", "type": { "fqn": "cdk8s-plus-21.PodDns" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 72 }, "name": "hostAliases", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.HostAlias" }, "kind": "array" } } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 64 }, "name": "initContainers", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.Container" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 26 }, "name": "podMetadata", "type": { "fqn": "cdk8s.ApiObjectMetadataDefinition" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 16 }, "name": "securityContext", "type": { "fqn": "cdk8s-plus-21.PodSecurityContext" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 68 }, "name": "volumes", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.Volume" }, "kind": "array" } } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 18 }, "name": "dockerRegistryAuth", "optional": true, "type": { "fqn": "cdk8s-plus-21.DockerConfigSecret" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 14 }, "name": "restartPolicy", "optional": true, "type": { "fqn": "cdk8s-plus-21.RestartPolicy" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 15 }, "name": "serviceAccount", "optional": true, "type": { "fqn": "cdk8s-plus-21.IServiceAccount" } } ], "symbolId": "src/pod:AbstractPod" }, "cdk8s-plus-21.AbstractPodProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `AbstractPod`." }, "fqn": "cdk8s-plus-21.AbstractPodProps", "interfaces": [ "cdk8s-plus-21.ResourceProps" ], "kind": "interface", "locationInModule": { "filename": "src/pod.ts", "line": 274 }, "name": "AbstractPodProps", "properties": [ { "abstract": true, "docs": { "default": "true", "see": "https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server", "stability": "stable", "summary": "Indicates whether a service account token should be automatically mounted." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 381 }, "name": "automountServiceAccountToken", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- No containers. Note that a pod spec must include at least one container.", "remarks": "Containers cannot currently be\nadded or removed. There must be at least one container in a Pod.\n\nYou can add additionnal containers using `podSpec.addContainer()`", "stability": "stable", "summary": "List of containers belonging to the pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 284 }, "name": "containers", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.ContainerProps" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": " policy: DnsPolicy.CLUSTER_FIRST\n hostnameAsFQDN: false", "see": "https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/", "stability": "stable", "summary": "DNS settings for the pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 366 }, "name": "dns", "optional": true, "type": { "fqn": "cdk8s-plus-21.PodDnsProps" } }, { "abstract": true, "docs": { "default": "- No auth. Images are assumed to be publicly available.", "stability": "stable", "summary": "A secret containing docker credentials for authenticating to a registry." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 373 }, "name": "dockerRegistryAuth", "optional": true, "type": { "fqn": "cdk8s-plus-21.DockerConfigSecret" } }, { "abstract": true, "docs": { "custom": { "schema": "io.k8s.api.core.v1.HostAlias" }, "stability": "stable", "summary": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 354 }, "name": "hostAliases", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.HostAlias" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No init containers.", "remarks": "Init containers are executed in order prior to containers being started.\nIf any init container fails, the pod is considered to have failed and is handled according to its restartPolicy.\nThe name for an init container or normal container must be unique among all containers.\nInit containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes.\nThe resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit\nfor each resource type, and then using the max of of that value or the sum of the normal containers.\nLimits are applied to init containers in a similar fashion.\n\nInit containers cannot currently be added ,removed or updated.", "see": "https://kubernetes.io/docs/concepts/workloads/pods/init-containers/", "stability": "stable", "summary": "List of initialization containers belonging to the pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 301 }, "name": "initContainers", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.ContainerProps" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "RestartPolicy.ALWAYS", "see": "https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy", "stability": "stable", "summary": "Restart policy for all containers within the pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 321 }, "name": "restartPolicy", "optional": true, "type": { "fqn": "cdk8s-plus-21.RestartPolicy" } }, { "abstract": true, "docs": { "default": " fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS\n ensureNonRoot: false", "stability": "stable", "summary": "SecurityContext holds pod-level security attributes and common container settings." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 347 }, "name": "securityContext", "optional": true, "type": { "fqn": "cdk8s-plus-21.PodSecurityContextProps" } }, { "abstract": true, "docs": { "default": "- No service account.", "remarks": "When you (a human) access the cluster (for example, using kubectl), you are\nauthenticated by the apiserver as a particular User Account (currently this\nis usually admin, unless your cluster administrator has customized your\ncluster). Processes in containers inside pods can also contact the\napiserver. When they do, they are authenticated as a particular Service\nAccount (for example, default).", "see": "https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/", "stability": "stable", "summary": "A service account provides an identity for processes that run in a Pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 337 }, "name": "serviceAccount", "optional": true, "type": { "fqn": "cdk8s-plus-21.IServiceAccount" } }, { "abstract": true, "docs": { "default": "- No volumes.", "remarks": "You can also add volumes later using `podSpec.addVolume()`", "see": "https://kubernetes.io/docs/concepts/storage/volumes", "stability": "stable", "summary": "List of volumes that can be mounted by containers belonging to the pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 312 }, "name": "volumes", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.Volume" }, "kind": "array" } } } ], "symbolId": "src/pod:AbstractPodProps" }, "cdk8s-plus-21.AddDeploymentOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options to add a deployment to a service." }, "fqn": "cdk8s-plus-21.AddDeploymentOptions", "interfaces": [ "cdk8s-plus-21.ServicePortOptions" ], "kind": "interface", "locationInModule": { "filename": "src/service.ts", "line": 127 }, "name": "AddDeploymentOptions", "properties": [ { "abstract": true, "docs": { "default": "- Copied from the first container of the deployment.", "stability": "stable", "summary": "The port number the service will bind to." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 133 }, "name": "port", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/service:AddDeploymentOptions" }, "cdk8s-plus-21.AddDirectoryOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `configmap.addDirectory()`." }, "fqn": "cdk8s-plus-21.AddDirectoryOptions", "kind": "interface", "locationInModule": { "filename": "src/config-map.ts", "line": 219 }, "name": "AddDirectoryOptions", "properties": [ { "abstract": true, "docs": { "default": "- include all files", "stability": "stable", "summary": "Glob patterns to exclude when adding files." }, "immutable": true, "locationInModule": { "filename": "src/config-map.ts", "line": 230 }, "name": "exclude", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "\"\"", "stability": "stable", "summary": "A prefix to add to all keys in the config map." }, "immutable": true, "locationInModule": { "filename": "src/config-map.ts", "line": 224 }, "name": "keyPrefix", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/config-map:AddDirectoryOptions" }, "cdk8s-plus-21.ApiResource": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents information about an API resource type." }, "fqn": "cdk8s-plus-21.ApiResource", "interfaces": [ "cdk8s-plus-21.IApiResource", "cdk8s-plus-21.IApiEndpoint" ], "kind": "class", "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 64 }, "methods": [ { "docs": { "stability": "stable", "summary": "API resource information for a custom resource type." }, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 508 }, "name": "custom", "parameters": [ { "name": "options", "type": { "fqn": "cdk8s-plus-21.ApiResourceOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Return the IApiResource this object represents." }, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 524 }, "name": "asApiResource", "overrides": "cdk8s-plus-21.IApiEndpoint", "returns": { "optional": true, "type": { "fqn": "cdk8s-plus-21.IApiResource" } } }, { "docs": { "stability": "stable", "summary": "Return the non resource url this object represents." }, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 528 }, "name": "asNonApiResource", "overrides": "cdk8s-plus-21.IApiEndpoint", "returns": { "optional": true, "type": { "primitive": "string" } } } ], "name": "ApiResource", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "API resource information for APIService." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 228 }, "name": "API_SERVICES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for Binding." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 68 }, "name": "BINDINGS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for CertificateSigningRequest." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 340 }, "name": "CERTIFICATE_SIGNING_REQUESTS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for ClusterRoleBinding." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 428 }, "name": "CLUSTER_ROLE_BINDINGS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for ClusterRole." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 436 }, "name": "CLUSTER_ROLES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for ComponentStatus." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 76 }, "name": "COMPONENT_STATUSES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for ConfigMap." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 84 }, "name": "CONFIG_MAPS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for ControllerRevision." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 236 }, "name": "CONTROLLER_REVISIONS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for CronJob." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 324 }, "name": "CRON_JOBS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for CSIDriver." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 468 }, "name": "CSI_DRIVERS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for CSINode." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 476 }, "name": "CSI_NODES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for CSIStorageCapacity." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 484 }, "name": "CSI_STORAGE_CAPACITIES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for CustomResourceDefinition." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 220 }, "name": "CUSTOM_RESOURCE_DEFINITIONS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for DaemonSet." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 244 }, "name": "DAEMON_SETS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for Deployment." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 252 }, "name": "DEPLOYMENTS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for EndpointSlice." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 356 }, "name": "ENDPOINT_SLICES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for Endpoints." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 92 }, "name": "ENDPOINTS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for Event." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 100 }, "name": "EVENTS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for FlowSchema." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 364 }, "name": "FLOW_SCHEMAS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for HorizontalPodAutoscaler." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 316 }, "name": "HORIZONTAL_POD_AUTOSCALERS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for IngressClass." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 380 }, "name": "INGRESS_CLASSES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for Ingress." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 388 }, "name": "INGRESSES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for Job." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 332 }, "name": "JOBS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for Lease." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 348 }, "name": "LEASES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for LimitRange." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 108 }, "name": "LIMIT_RANGES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for LocalSubjectAccessReview." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 284 }, "name": "LOCAL_SUBJECT_ACCESS_REVIEWS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for MutatingWebhookConfiguration." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 204 }, "name": "MUTATING_WEBHOOK_CONFIGURATIONS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for Namespace." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 116 }, "name": "NAMESPACES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for NetworkPolicy." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 396 }, "name": "NETWORK_POLICIES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for Node." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 124 }, "name": "NODES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for PersistentVolumeClaim." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 132 }, "name": "PERSISTENT_VOLUME_CLAIMS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for PersistentVolume." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 140 }, "name": "PERSISTENT_VOLUMES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for PodDisruptionBudget." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 412 }, "name": "POD_DISRUPTION_BUDGETS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for PodSecurityPolicy." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 420 }, "name": "POD_SECURITY_POLICIES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for PodTemplate." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 156 }, "name": "POD_TEMPLATES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for Pod." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 148 }, "name": "PODS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for PriorityClass." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 460 }, "name": "PRIORITY_CLASSES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for PriorityLevelConfiguration." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 372 }, "name": "PRIORITY_LEVEL_CONFIGURATIONS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for ReplicaSet." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 260 }, "name": "REPLICA_SETS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for ReplicationController." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 164 }, "name": "REPLICATION_CONTROLLERS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for ResourceQuota." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 172 }, "name": "RESOURCE_QUOTAS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for RoleBinding." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 444 }, "name": "ROLE_BINDINGS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for Role." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 452 }, "name": "ROLES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for RuntimeClass." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 404 }, "name": "RUNTIME_CLASSES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for Secret." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 180 }, "name": "SECRETS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for SelfSubjectAccessReview." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 292 }, "name": "SELF_SUBJECT_ACCESS_REVIEWS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for SelfSubjectRulesReview." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 300 }, "name": "SELF_SUBJECT_RULES_REVIEWS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for ServiceAccount." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 188 }, "name": "SERVICE_ACCOUNTS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for Service." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 196 }, "name": "SERVICES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for StatefulSet." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 268 }, "name": "STATEFUL_SETS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for StorageClass." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 492 }, "name": "STORAGE_CLASSES", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for SubjectAccessReview." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 308 }, "name": "SUBJECT_ACCESS_REVIEWS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for TokenReview." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 276 }, "name": "TOKEN_REVIEWS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for ValidatingWebhookConfiguration." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 212 }, "name": "VALIDATING_WEBHOOK_CONFIGURATIONS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "const": true, "docs": { "stability": "stable", "summary": "API resource information for VolumeAttachment." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 500 }, "name": "VOLUME_ATTACHMENTS", "static": true, "type": { "fqn": "cdk8s-plus-21.ApiResource" } }, { "docs": { "stability": "stable", "summary": "The group portion of the API version (e.g. `authorization.k8s.io`)." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 515 }, "name": "apiGroup", "overrides": "cdk8s-plus-21.IApiResource", "type": { "primitive": "string" } }, { "docs": { "example": "- \"pods\" or \"pods/log\"", "see": "https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources", "stability": "stable", "summary": "The name of the resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 522 }, "name": "resourceType", "overrides": "cdk8s-plus-21.IApiResource", "type": { "primitive": "string" } } ], "symbolId": "src/api-resource.generated:ApiResource" }, "cdk8s-plus-21.ApiResourceOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `ApiResource`." }, "fqn": "cdk8s-plus-21.ApiResourceOptions", "kind": "interface", "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 47 }, "name": "ApiResourceOptions", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The group portion of the API version (e.g. `authorization.k8s.io`)." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 51 }, "name": "apiGroup", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "example": "- \"pods\" or \"pods/log\"", "see": "https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources", "stability": "stable", "summary": "The name of the resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 58 }, "name": "resourceType", "type": { "primitive": "string" } } ], "symbolId": "src/api-resource.generated:ApiResourceOptions" }, "cdk8s-plus-21.AwsElasticBlockStorePersistentVolume": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.PersistentVolume", "docs": { "see": "https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "stability": "stable", "summary": "Represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod." }, "fqn": "cdk8s-plus-21.AwsElasticBlockStorePersistentVolume", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pv.ts", "line": 339 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk8s-plus-21.AwsElasticBlockStorePersistentVolumeProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/pv.ts", "line": 317 }, "name": "AwsElasticBlockStorePersistentVolume", "properties": [ { "docs": { "stability": "stable", "summary": "File system type of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 332 }, "name": "fsType", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Whether or not it is mounted as a read-only volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 327 }, "name": "readOnly", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable", "summary": "Volume id of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 322 }, "name": "volumeId", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Partition of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 337 }, "name": "partition", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/pv:AwsElasticBlockStorePersistentVolume" }, "cdk8s-plus-21.AwsElasticBlockStorePersistentVolumeProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `AwsElasticBlockStorePersistentVolume`." }, "fqn": "cdk8s-plus-21.AwsElasticBlockStorePersistentVolumeProps", "interfaces": [ "cdk8s-plus-21.PersistentVolumeProps" ], "kind": "interface", "locationInModule": { "filename": "src/pv.ts", "line": 274 }, "name": "AwsElasticBlockStorePersistentVolumeProps", "properties": [ { "abstract": true, "docs": { "remarks": "More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "see": "https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "stability": "stable", "summary": "Unique ID of the persistent disk resource in AWS (Amazon EBS volume)." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 281 }, "name": "volumeId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "'ext4'", "remarks": "Tip: Ensure that the filesystem type is supported by the host operating system.", "see": "https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "stability": "stable", "summary": "Filesystem type of the volume that you want to mount." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 290 }, "name": "fsType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No partition.", "remarks": "If omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).", "stability": "stable", "summary": "The partition in the volume that you want to mount." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 299 }, "name": "partition", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "false", "see": "https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "stability": "stable", "summary": "Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\"." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 307 }, "name": "readOnly", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/pv:AwsElasticBlockStorePersistentVolumeProps" }, "cdk8s-plus-21.AwsElasticBlockStoreVolumeOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options of `Volume.fromAwsElasticBlockStore`." }, "fqn": "cdk8s-plus-21.AwsElasticBlockStoreVolumeOptions", "kind": "interface", "locationInModule": { "filename": "src/volume.ts", "line": 323 }, "name": "AwsElasticBlockStoreVolumeOptions", "properties": [ { "abstract": true, "docs": { "default": "'ext4'", "remarks": "Tip: Ensure that the filesystem type is supported by the host operating system.", "see": "https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "stability": "stable", "summary": "Filesystem type of the volume that you want to mount." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 338 }, "name": "fsType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- auto-generated", "stability": "stable", "summary": "The volume name." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 329 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No partition.", "remarks": "If omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).", "stability": "stable", "summary": "The partition in the volume that you want to mount." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 347 }, "name": "partition", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "false", "see": "https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "stability": "stable", "summary": "Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\"." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 355 }, "name": "readOnly", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/volume:AwsElasticBlockStoreVolumeOptions" }, "cdk8s-plus-21.AzureDiskPersistentVolume": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.PersistentVolume", "docs": { "stability": "stable", "summary": "AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod." }, "fqn": "cdk8s-plus-21.AzureDiskPersistentVolume", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pv.ts", "line": 445 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk8s-plus-21.AzureDiskPersistentVolumeProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/pv.ts", "line": 413 }, "name": "AzureDiskPersistentVolume", "properties": [ { "docs": { "stability": "stable", "summary": "Azure kind of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 443 }, "name": "azureKind", "type": { "fqn": "cdk8s-plus-21.AzureDiskPersistentVolumeKind" } }, { "docs": { "stability": "stable", "summary": "Caching mode of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 433 }, "name": "cachingMode", "type": { "fqn": "cdk8s-plus-21.AzureDiskPersistentVolumeCachingMode" } }, { "docs": { "stability": "stable", "summary": "Disk name of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 418 }, "name": "diskName", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Disk URI of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 423 }, "name": "diskUri", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "File system type of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 438 }, "name": "fsType", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Whether or not it is mounted as a read-only volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 428 }, "name": "readOnly", "type": { "primitive": "boolean" } } ], "symbolId": "src/pv:AzureDiskPersistentVolume" }, "cdk8s-plus-21.AzureDiskPersistentVolumeCachingMode": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Azure disk caching modes." }, "fqn": "cdk8s-plus-21.AzureDiskPersistentVolumeCachingMode", "kind": "enum", "locationInModule": { "filename": "src/volume.ts", "line": 554 }, "members": [ { "docs": { "stability": "stable", "summary": "None." }, "name": "NONE" }, { "docs": { "stability": "stable", "summary": "ReadOnly." }, "name": "READ_ONLY" }, { "docs": { "stability": "stable", "summary": "ReadWrite." }, "name": "READ_WRITE" } ], "name": "AzureDiskPersistentVolumeCachingMode", "symbolId": "src/volume:AzureDiskPersistentVolumeCachingMode" }, "cdk8s-plus-21.AzureDiskPersistentVolumeKind": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Azure Disk kinds." }, "fqn": "cdk8s-plus-21.AzureDiskPersistentVolumeKind", "kind": "enum", "locationInModule": { "filename": "src/volume.ts", "line": 533 }, "members": [ { "docs": { "stability": "stable", "summary": "Multiple blob disks per storage account." }, "name": "SHARED" }, { "docs": { "stability": "stable", "summary": "Single blob disk per storage account." }, "name": "DEDICATED" }, { "docs": { "stability": "stable", "summary": "Azure managed data disk." }, "name": "MANAGED" } ], "name": "AzureDiskPersistentVolumeKind", "symbolId": "src/volume:AzureDiskPersistentVolumeKind" }, "cdk8s-plus-21.AzureDiskPersistentVolumeProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `AzureDiskPersistentVolume`." }, "fqn": "cdk8s-plus-21.AzureDiskPersistentVolumeProps", "interfaces": [ "cdk8s-plus-21.PersistentVolumeProps" ], "kind": "interface", "locationInModule": { "filename": "src/pv.ts", "line": 368 }, "name": "AzureDiskPersistentVolumeProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The Name of the data disk in the blob storage." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 373 }, "name": "diskName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The URI the data disk in the blob storage." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 378 }, "name": "diskUri", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- AzureDiskPersistentVolumeCachingMode.NONE.", "stability": "stable", "summary": "Host Caching mode." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 385 }, "name": "cachingMode", "optional": true, "type": { "fqn": "cdk8s-plus-21.AzureDiskPersistentVolumeCachingMode" } }, { "abstract": true, "docs": { "default": "'ext4'", "remarks": "Must be a filesystem type supported by the host operating system.", "stability": "stable", "summary": "Filesystem type to mount." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 392 }, "name": "fsType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "AzureDiskPersistentVolumeKind.SHARED", "stability": "stable", "summary": "Kind of disk." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 399 }, "name": "kind", "optional": true, "type": { "fqn": "cdk8s-plus-21.AzureDiskPersistentVolumeKind" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Force the ReadOnly setting in VolumeMounts." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 406 }, "name": "readOnly", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/pv:AzureDiskPersistentVolumeProps" }, "cdk8s-plus-21.AzureDiskVolumeOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options of `Volume.fromAzureDisk`." }, "fqn": "cdk8s-plus-21.AzureDiskVolumeOptions", "kind": "interface", "locationInModule": { "filename": "src/volume.ts", "line": 283 }, "name": "AzureDiskVolumeOptions", "properties": [ { "abstract": true, "docs": { "default": "- AzureDiskPersistentVolumeCachingMode.NONE.", "stability": "stable", "summary": "Host Caching mode." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 296 }, "name": "cachingMode", "optional": true, "type": { "fqn": "cdk8s-plus-21.AzureDiskPersistentVolumeCachingMode" } }, { "abstract": true, "docs": { "default": "'ext4'", "remarks": "Must be a filesystem type supported by the host operating system.", "stability": "stable", "summary": "Filesystem type to mount." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 303 }, "name": "fsType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "AzureDiskPersistentVolumeKind.SHARED", "stability": "stable", "summary": "Kind of disk." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 310 }, "name": "kind", "optional": true, "type": { "fqn": "cdk8s-plus-21.AzureDiskPersistentVolumeKind" } }, { "abstract": true, "docs": { "default": "- auto-generated", "stability": "stable", "summary": "The volume name." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 289 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Force the ReadOnly setting in VolumeMounts." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 317 }, "name": "readOnly", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/volume:AzureDiskVolumeOptions" }, "cdk8s-plus-21.BasicAuthSecret": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Secret", "docs": { "see": "https://kubernetes.io/docs/concepts/configuration/secret/#basic-authentication-secret", "stability": "stable", "summary": "Create a secret for basic authentication." }, "fqn": "cdk8s-plus-21.BasicAuthSecret", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/secret.ts", "line": 152 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk8s-plus-21.BasicAuthSecretProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/secret.ts", "line": 151 }, "name": "BasicAuthSecret", "symbolId": "src/secret:BasicAuthSecret" }, "cdk8s-plus-21.BasicAuthSecretProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `BasicAuthSecret`." }, "fqn": "cdk8s-plus-21.BasicAuthSecretProps", "interfaces": [ "cdk8s-plus-21.CommonSecretProps" ], "kind": "interface", "locationInModule": { "filename": "src/secret.ts", "line": 134 }, "name": "BasicAuthSecretProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The password or token for authentication." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 143 }, "name": "password", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The user name for authentication." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 138 }, "name": "username", "type": { "primitive": "string" } } ], "symbolId": "src/secret:BasicAuthSecretProps" }, "cdk8s-plus-21.ClusterRole": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Resource", "docs": { "stability": "stable", "summary": "ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding." }, "fqn": "cdk8s-plus-21.ClusterRole", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/role.ts", "line": 284 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.ClusterRoleProps" } } ] }, "interfaces": [ "cdk8s-plus-21.IClusterRole", "cdk8s-plus-21.IRole" ], "kind": "class", "locationInModule": { "filename": "src/role.ts", "line": 260 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports a role from the cluster as a reference." }, "locationInModule": { "filename": "src/role.ts", "line": 266 }, "name": "fromClusterRoleName", "parameters": [ { "docs": { "summary": "The name of the role resource." }, "name": "name", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.IClusterRole" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Aggregate rules from roles matching this label selector." }, "locationInModule": { "filename": "src/role.ts", "line": 406 }, "name": "aggregate", "parameters": [ { "name": "key", "type": { "primitive": "string" } }, { "name": "value", "type": { "primitive": "string" } } ] }, { "docs": { "see": "https://kubernetes.io/docs/reference/access-authn-authz/authorization/#determine-the-request-verb", "stability": "stable", "summary": "Add permission to perform a list of HTTP verbs on a collection of resources." }, "locationInModule": { "filename": "src/role.ts", "line": 317 }, "name": "allow", "parameters": [ { "name": "verbs", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "summary": "The endpoints(s) to apply to." }, "name": "endpoints", "type": { "fqn": "cdk8s-plus-21.IApiEndpoint" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"create\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 325 }, "name": "allowCreate", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "endpoints", "type": { "fqn": "cdk8s-plus-21.IApiEndpoint" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"delete\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 373 }, "name": "allowDelete", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "endpoints", "type": { "fqn": "cdk8s-plus-21.IApiEndpoint" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"deletecollection\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 381 }, "name": "allowDeleteCollection", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "endpoints", "type": { "fqn": "cdk8s-plus-21.IApiEndpoint" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"get\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 333 }, "name": "allowGet", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "endpoints", "type": { "fqn": "cdk8s-plus-21.IApiEndpoint" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"list\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 341 }, "name": "allowList", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "endpoints", "type": { "fqn": "cdk8s-plus-21.IApiEndpoint" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"patch\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 365 }, "name": "allowPatch", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "endpoints", "type": { "fqn": "cdk8s-plus-21.IApiEndpoint" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"get\", \"list\", and \"watch\" permissions for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 389 }, "name": "allowRead", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "endpoints", "type": { "fqn": "cdk8s-plus-21.IApiEndpoint" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"get\", \"list\", \"watch\", \"create\", \"update\", \"patch\", \"delete\", and \"deletecollection\" permissions for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 399 }, "name": "allowReadWrite", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "endpoints", "type": { "fqn": "cdk8s-plus-21.IApiEndpoint" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"update\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 357 }, "name": "allowUpdate", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "endpoints", "type": { "fqn": "cdk8s-plus-21.IApiEndpoint" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"watch\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 349 }, "name": "allowWatch", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "endpoints", "type": { "fqn": "cdk8s-plus-21.IApiEndpoint" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Create a ClusterRoleBinding that binds the permissions in this ClusterRole to a list of subjects, without namespace restrictions." }, "locationInModule": { "filename": "src/role.ts", "line": 444 }, "name": "bind", "parameters": [ { "docs": { "summary": "a list of subjects to bind to." }, "name": "subjects", "type": { "fqn": "cdk8s-plus-21.ISubject" }, "variadic": true } ], "returns": { "type": { "fqn": "cdk8s-plus-21.ClusterRoleBinding" } }, "variadic": true }, { "docs": { "stability": "stable", "summary": "Create a RoleBinding that binds the permissions in this ClusterRole to a list of subjects, that will only apply to the given namespace." }, "locationInModule": { "filename": "src/role.ts", "line": 428 }, "name": "bindInNamespace", "parameters": [ { "docs": { "summary": "the namespace to limit permissions to." }, "name": "namespace", "type": { "primitive": "string" } }, { "docs": { "summary": "a list of subjects to bind to." }, "name": "subjects", "type": { "fqn": "cdk8s-plus-21.ISubject" }, "variadic": true } ], "returns": { "type": { "fqn": "cdk8s-plus-21.RoleBinding" } }, "variadic": true }, { "docs": { "stability": "stable", "summary": "Combines the rules of the argument ClusterRole into this ClusterRole using aggregation labels." }, "locationInModule": { "filename": "src/role.ts", "line": 415 }, "name": "combine", "parameters": [ { "name": "rol", "type": { "fqn": "cdk8s-plus-21.ClusterRole" } } ] } ], "name": "ClusterRole", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/role.ts", "line": 277 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/role.ts", "line": 279 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } }, { "docs": { "remarks": "Returns a copy, use `allow` to add rules.", "stability": "stable", "summary": "Rules associaated with this Role." }, "immutable": true, "locationInModule": { "filename": "src/role.ts", "line": 306 }, "name": "rules", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.ClusterRolePolicyRule" }, "kind": "array" } } } ], "symbolId": "src/role:ClusterRole" }, "cdk8s-plus-21.ClusterRoleBinding": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Resource", "docs": { "stability": "stable", "summary": "A ClusterRoleBinding grants permissions cluster-wide to a user or set of users." }, "fqn": "cdk8s-plus-21.ClusterRoleBinding", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/role-binding.ts", "line": 139 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk8s-plus-21.ClusterRoleBindingProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/role-binding.ts", "line": 127 }, "methods": [ { "docs": { "stability": "stable", "summary": "Adds a subject to the role." }, "locationInModule": { "filename": "src/role-binding.ts", "line": 157 }, "name": "addSubjects", "parameters": [ { "docs": { "summary": "The subjects to add." }, "name": "subjects", "type": { "fqn": "cdk8s-plus-21.ISubject" }, "variadic": true } ], "variadic": true } ], "name": "ClusterRoleBinding", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 131 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 133 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 135 }, "name": "role", "type": { "fqn": "cdk8s-plus-21.IClusterRole" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 163 }, "name": "subjects", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.ISubject" }, "kind": "array" } } } ], "symbolId": "src/role-binding:ClusterRoleBinding" }, "cdk8s-plus-21.ClusterRoleBindingProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `ClusterRoleBinding`." }, "fqn": "cdk8s-plus-21.ClusterRoleBindingProps", "interfaces": [ "cdk8s-plus-21.ResourceProps" ], "kind": "interface", "locationInModule": { "filename": "src/role-binding.ts", "line": 116 }, "name": "ClusterRoleBindingProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The role to bind to." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 120 }, "name": "role", "type": { "fqn": "cdk8s-plus-21.IClusterRole" } } ], "symbolId": "src/role-binding:ClusterRoleBindingProps" }, "cdk8s-plus-21.ClusterRolePolicyRule": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Policy rule of a `ClusterRole." }, "fqn": "cdk8s-plus-21.ClusterRolePolicyRule", "kind": "interface", "locationInModule": { "filename": "src/role.ts", "line": 242 }, "name": "ClusterRolePolicyRule", "properties": [ { "abstract": true, "docs": { "remarks": "Can be either api resources\nor non api resources.", "stability": "stable", "summary": "Endpoints this rule applies to." }, "immutable": true, "locationInModule": { "filename": "src/role.ts", "line": 253 }, "name": "endpoints", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.IApiEndpoint" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "(e.g ['get', 'watch'])", "stability": "stable", "summary": "Verbs to allow." }, "immutable": true, "locationInModule": { "filename": "src/role.ts", "line": 247 }, "name": "verbs", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/role:ClusterRolePolicyRule" }, "cdk8s-plus-21.ClusterRoleProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `ClusterRole`." }, "fqn": "cdk8s-plus-21.ClusterRoleProps", "interfaces": [ "cdk8s-plus-21.ResourceProps" ], "kind": "interface", "locationInModule": { "filename": "src/role.ts", "line": 223 }, "name": "ClusterRoleProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Specify labels that should be used to locate ClusterRoles, whose rules will be automatically filled into this ClusterRole's rules." }, "immutable": true, "locationInModule": { "filename": "src/role.ts", "line": 236 }, "name": "aggregationLabels", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "[]", "stability": "stable", "summary": "A list of rules the role should allow." }, "immutable": true, "locationInModule": { "filename": "src/role.ts", "line": 230 }, "name": "rules", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.ClusterRolePolicyRule" }, "kind": "array" } } } ], "symbolId": "src/role:ClusterRoleProps" }, "cdk8s-plus-21.CommandProbeOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `Probe.fromCommand()`." }, "fqn": "cdk8s-plus-21.CommandProbeOptions", "interfaces": [ "cdk8s-plus-21.ProbeOptions" ], "kind": "interface", "locationInModule": { "filename": "src/probe.ts", "line": 74 }, "name": "CommandProbeOptions", "symbolId": "src/probe:CommandProbeOptions" }, "cdk8s-plus-21.CommonSecretProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Common properties for `Secret`." }, "fqn": "cdk8s-plus-21.CommonSecretProps", "interfaces": [ "cdk8s-plus-21.ResourceProps" ], "kind": "interface", "locationInModule": { "filename": "src/secret.ts", "line": 10 }, "name": "CommonSecretProps", "properties": [ { "abstract": true, "docs": { "default": "false", "remarks": "If not set to true, the field can be modified at any time.", "stability": "stable", "summary": "If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified)." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 18 }, "name": "immutable", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/secret:CommonSecretProps" }, "cdk8s-plus-21.ConfigMap": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Resource", "docs": { "stability": "stable", "summary": "ConfigMap holds configuration data for pods to consume." }, "fqn": "cdk8s-plus-21.ConfigMap", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/config-map.ts", "line": 86 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.ConfigMapProps" } } ] }, "interfaces": [ "cdk8s-plus-21.IConfigMap" ], "kind": "class", "locationInModule": { "filename": "src/config-map.ts", "line": 58 }, "methods": [ { "docs": { "stability": "stable", "summary": "Represents a ConfigMap created elsewhere." }, "locationInModule": { "filename": "src/config-map.ts", "line": 63 }, "name": "fromConfigMapName", "parameters": [ { "docs": { "summary": "The name of the config map to import." }, "name": "name", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.IConfigMap" } }, "static": true }, { "docs": { "custom": { "throws": "if there is either a `data` or `binaryData` entry with the same key" }, "remarks": "BinaryData can contain byte\nsequences that are not in the UTF-8 range.", "stability": "stable", "summary": "Adds a binary data entry to the config map." }, "locationInModule": { "filename": "src/config-map.ts", "line": 139 }, "name": "addBinaryData", "parameters": [ { "docs": { "summary": "The key." }, "name": "key", "type": { "primitive": "string" } }, { "docs": { "summary": "The value." }, "name": "value", "type": { "primitive": "string" } } ] }, { "docs": { "custom": { "throws": "if there is either a `data` or `binaryData` entry with the same key" }, "stability": "stable", "summary": "Adds a data entry to the config map." }, "locationInModule": { "filename": "src/config-map.ts", "line": 116 }, "name": "addData", "parameters": [ { "docs": { "summary": "The key." }, "name": "key", "type": { "primitive": "string" } }, { "docs": { "summary": "The value." }, "name": "value", "type": { "primitive": "string" } } ] }, { "docs": { "stability": "stable", "summary": "Adds a directory to the ConfigMap." }, "locationInModule": { "filename": "src/config-map.ts", "line": 171 }, "name": "addDirectory", "parameters": [ { "docs": { "summary": "A path to a local directory." }, "name": "localDir", "type": { "primitive": "string" } }, { "docs": { "summary": "Options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.AddDirectoryOptions" } } ] }, { "docs": { "stability": "stable", "summary": "Adds a file to the ConfigMap." }, "locationInModule": { "filename": "src/config-map.ts", "line": 159 }, "name": "addFile", "parameters": [ { "docs": { "summary": "The path to the local file." }, "name": "localFile", "type": { "primitive": "string" } }, { "docs": { "summary": "The ConfigMap key (default to the file name)." }, "name": "key", "optional": true, "type": { "primitive": "string" } } ] } ], "name": "ConfigMap", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/config-map.ts", "line": 74 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "remarks": "Returns a copy. To add data records, use `addBinaryData()` or `addData()`.", "stability": "stable", "summary": "The binary data associated with this config map." }, "immutable": true, "locationInModule": { "filename": "src/config-map.ts", "line": 150 }, "name": "binaryData", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "remarks": "Returns an copy. To add data records, use `addData()` or `addBinaryData()`.", "stability": "stable", "summary": "The data associated with this config map." }, "immutable": true, "locationInModule": { "filename": "src/config-map.ts", "line": 127 }, "name": "data", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "stable", "summary": "Whether or not this config map is immutable." }, "immutable": true, "locationInModule": { "filename": "src/config-map.ts", "line": 84 }, "name": "immutable", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/config-map.ts", "line": 76 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } } ], "symbolId": "src/config-map:ConfigMap" }, "cdk8s-plus-21.ConfigMapProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for initialization of `ConfigMap`." }, "fqn": "cdk8s-plus-21.ConfigMapProps", "interfaces": [ "cdk8s-plus-21.ResourceProps" ], "kind": "interface", "locationInModule": { "filename": "src/config-map.ts", "line": 13 }, "name": "ConfigMapProps", "properties": [ { "abstract": true, "docs": { "remarks": "Each key must consist of alphanumeric characters, '-', '_' or '.'.\nBinaryData can contain byte sequences that are not in the UTF-8 range. The\nkeys stored in BinaryData must not overlap with the ones in the Data field,\nthis is enforced during validation process.\n\nYou can also add binary data using `configMap.addBinaryData()`.", "stability": "stable", "summary": "BinaryData contains the binary data." }, "immutable": true, "locationInModule": { "filename": "src/config-map.ts", "line": 24 }, "name": "binaryData", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "remarks": "Each key must consist of alphanumeric characters, '-', '_' or '.'. Values\nwith non-UTF-8 byte sequences must use the BinaryData field. The keys\nstored in Data must not overlap with the keys in the BinaryData field, this\nis enforced during validation process.\n\nYou can also add data using `configMap.addData()`.", "stability": "stable", "summary": "Data contains the configuration data." }, "immutable": true, "locationInModule": { "filename": "src/config-map.ts", "line": 36 }, "name": "data", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "false", "remarks": "If not set to true, the field can be modified at any time.", "stability": "stable", "summary": "If set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified)." }, "immutable": true, "locationInModule": { "filename": "src/config-map.ts", "line": 44 }, "name": "immutable", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/config-map:ConfigMapProps" }, "cdk8s-plus-21.ConfigMapVolumeOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for the ConfigMap-based volume." }, "fqn": "cdk8s-plus-21.ConfigMapVolumeOptions", "kind": "interface", "locationInModule": { "filename": "src/volume.ts", "line": 361 }, "name": "ConfigMapVolumeOptions", "properties": [ { "abstract": true, "docs": { "default": "0644. Directories within the path are not affected by this\nsetting. This might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.", "remarks": "Must be a value between 0 and\n0777. Defaults to 0644. Directories within the path are not affected by\nthis setting. This might be in conflict with other options that affect the\nfile mode, like fsGroup, and the result can be other mode bits set.", "stability": "stable", "summary": "Mode bits to use on created files by default." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 379 }, "name": "defaultMode", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no mapping", "remarks": "If specified, the listed keys will be projected\ninto the specified paths, and unlisted keys will not be present. If a key\nis specified which is not present in the ConfigMap, the volume setup will\nerror unless it is marked optional. Paths must be relative and may not\ncontain the '..' path or start with '..'.", "stability": "stable", "summary": "If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 398 }, "name": "items", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.PathMapping" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- auto-generated", "stability": "stable", "summary": "The volume name." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 367 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- undocumented", "stability": "stable", "summary": "Specify whether the ConfigMap or its keys must be defined." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 385 }, "name": "optional", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/volume:ConfigMapVolumeOptions" }, "cdk8s-plus-21.Container": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "A single application container that you want to run within a pod." }, "fqn": "cdk8s-plus-21.Container", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/container.ts", "line": 607 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk8s-plus-21.ContainerProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/container.ts", "line": 552 }, "methods": [ { "docs": { "remarks": "Every pod that is configured to use this container will autmoatically have access to the volume.", "stability": "stable", "summary": "Mount a volume to a specific path so that it is accessible by the container." }, "locationInModule": { "filename": "src/container.ts", "line": 653 }, "name": "mount", "parameters": [ { "docs": { "summary": "- The desired path in the container." }, "name": "path", "type": { "primitive": "string" } }, { "docs": { "summary": "- The storage to mount." }, "name": "storage", "type": { "fqn": "cdk8s-plus-21.IStorage" } }, { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.MountOptions" } } ] } ], "name": "Container", "properties": [ { "docs": { "stability": "stable", "summary": "The environment of the container." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 598 }, "name": "env", "type": { "fqn": "cdk8s-plus-21.Env" } }, { "docs": { "stability": "stable", "summary": "The container image." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 572 }, "name": "image", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Image pull policy for this container." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 567 }, "name": "imagePullPolicy", "type": { "fqn": "cdk8s-plus-21.ImagePullPolicy" } }, { "docs": { "stability": "stable", "summary": "Volume mounts configured for this container." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 562 }, "name": "mounts", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.VolumeMount" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "The name of the container." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 577 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The security context of the container." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 593 }, "name": "securityContext", "type": { "fqn": "cdk8s-plus-21.ContainerSecurityContext" } }, { "docs": { "returns": "a copy of the arguments array, cannot be modified.", "stability": "stable", "summary": "Arguments to the entrypoint." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 642 }, "name": "args", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "returns": "a copy of the entrypoint array, cannot be modified", "stability": "stable", "summary": "Entrypoint array (the command to execute when the container starts)." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 633 }, "name": "command", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "The port this container exposes." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 557 }, "name": "port", "optional": true, "type": { "primitive": "number" } }, { "docs": { "see": "https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "stability": "stable", "summary": "Compute resources (CPU and memory requests and limits) required by the container." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 588 }, "name": "resources", "optional": true, "type": { "fqn": "cdk8s-plus-21.ContainerResources" } }, { "docs": { "stability": "stable", "summary": "The working directory inside the container." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 582 }, "name": "workingDir", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/container:Container" }, "cdk8s-plus-21.ContainerLifecycle": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Container lifecycle properties." }, "fqn": "cdk8s-plus-21.ContainerLifecycle", "kind": "interface", "locationInModule": { "filename": "src/container.ts", "line": 389 }, "name": "ContainerLifecycle", "properties": [ { "abstract": true, "docs": { "default": "- No post start handler.", "remarks": "However,\nthere is no guarantee that the hook will execute before the container ENTRYPOINT.", "stability": "stable", "summary": "This hook is executed immediately after a container is created." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 397 }, "name": "postStart", "optional": true, "type": { "fqn": "cdk8s-plus-21.Handler" } }, { "abstract": true, "docs": { "default": "- No pre stop handler.", "remarks": "A call to the PreStop hook fails if the container is already in a terminated or completed state\nand the hook must complete before the TERM signal to stop the container can be sent.\nThe Pod's termination grace period countdown begins before the PreStop hook is executed,\nso regardless of the outcome of the handler, the container will eventually terminate\nwithin the Pod's termination grace period. No parameters are passed to the handler.", "see": "https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination", "stability": "stable", "summary": "This hook is called immediately before a container is terminated due to an API request or management event such as a liveness/startup probe failure, preemption, resource contention and others." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 412 }, "name": "preStop", "optional": true, "type": { "fqn": "cdk8s-plus-21.Handler" } } ], "symbolId": "src/container:ContainerLifecycle" }, "cdk8s-plus-21.ContainerProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for creating a container." }, "fqn": "cdk8s-plus-21.ContainerProps", "kind": "interface", "locationInModule": { "filename": "src/container.ts", "line": 419 }, "name": "ContainerProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Docker image name." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 424 }, "name": "image", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "[]", "remarks": "Variable references $(VAR_NAME) are expanded using the container's\nenvironment. If a variable cannot be resolved, the reference in the input\nstring will be unchanged. The $(VAR_NAME) syntax can be escaped with a\ndouble $$, ie: $$(VAR_NAME). Escaped references will never be expanded,\nregardless of whether the variable exists or not.\n\nCannot be updated.", "see": "https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", "stability": "stable", "summary": "Arguments to the entrypoint. The docker image's CMD is used if `command` is not provided." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 465 }, "name": "args", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- The docker image's ENTRYPOINT.", "remarks": "Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment.\nIf a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME).\nEscaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", "stability": "stable", "summary": "Entrypoint array." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 448 }, "name": "command", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No sources.", "remarks": "When a key exists in multiple sources, the value associated with\nthe last source will take precedence. Values defined by the `envVariables` property\nwith a duplicate key will take precedence.", "stability": "stable", "summary": "List of sources to populate environment variables in the container." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 489 }, "name": "envFrom", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.EnvFrom" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No environment variables.", "stability": "stable", "summary": "Environment variables to set in the container." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 479 }, "name": "envVariables", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.EnvValue" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "ImagePullPolicy.ALWAYS", "stability": "stable", "summary": "Image pull policy for this container." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 500 }, "name": "imagePullPolicy", "optional": true, "type": { "fqn": "cdk8s-plus-21.ImagePullPolicy" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Describes actions that the management system should take in response to container lifecycle events." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 527 }, "name": "lifecycle", "optional": true, "type": { "fqn": "cdk8s-plus-21.ContainerLifecycle" } }, { "abstract": true, "docs": { "default": "- no liveness probe is defined", "remarks": "Container will be restarted if the probe fails.", "stability": "stable", "summary": "Periodic probe of container liveness." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 514 }, "name": "liveness", "optional": true, "type": { "fqn": "cdk8s-plus-21.Probe" } }, { "abstract": true, "docs": { "default": "'main'", "remarks": "Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.", "stability": "stable", "summary": "Name of the container specified as a DNS_LABEL." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 431 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No port is exposed.", "remarks": "This must be a valid port number, 0 < x < 65536.", "stability": "stable", "summary": "Number of port to expose on the pod's IP address." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 438 }, "name": "port", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no readiness probe is defined", "stability": "stable", "summary": "Determines when the container is ready to serve traffic." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 507 }, "name": "readiness", "optional": true, "type": { "fqn": "cdk8s-plus-21.Probe" } }, { "abstract": true, "docs": { "see": "https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "stability": "stable", "summary": "Compute resources (CPU and memory requests and limits) required by the container." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 533 }, "name": "resources", "optional": true, "type": { "fqn": "cdk8s-plus-21.ContainerResources" } }, { "abstract": true, "docs": { "default": " ensureNonRoot: false\n privileged: false\n readOnlyRootFilesystem: false", "remarks": "If set, the fields override equivalent fields of the pod's security context.", "see": "https://kubernetes.io/docs/tasks/configure-pod-container/security-context/", "stability": "stable", "summary": "SecurityContext defines the security options the container should be run with." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 546 }, "name": "securityContext", "optional": true, "type": { "fqn": "cdk8s-plus-21.ContainerSecurityContextProps" } }, { "abstract": true, "docs": { "default": "- no startup probe is defined.", "remarks": "If specified, no other probes are executed until this completes successfully", "stability": "stable", "summary": "StartupProbe indicates that the Pod has successfully initialized." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 522 }, "name": "startup", "optional": true, "type": { "fqn": "cdk8s-plus-21.Probe" } }, { "abstract": true, "docs": { "remarks": "Cannot be updated.", "stability": "stable", "summary": "Pod volumes to mount into the container's filesystem." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 494 }, "name": "volumeMounts", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.VolumeMount" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- The container runtime's default.", "remarks": "If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.", "stability": "stable", "summary": "Container's working directory." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 472 }, "name": "workingDir", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/container:ContainerProps" }, "cdk8s-plus-21.ContainerResources": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "CPU and memory compute resources." }, "fqn": "cdk8s-plus-21.ContainerResources", "kind": "interface", "locationInModule": { "filename": "src/container.ts", "line": 850 }, "name": "ContainerResources", "properties": [ { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 851 }, "name": "cpu", "type": { "fqn": "cdk8s-plus-21.CpuResources" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 852 }, "name": "memory", "type": { "fqn": "cdk8s-plus-21.MemoryResources" } } ], "symbolId": "src/container:ContainerResources" }, "cdk8s-plus-21.ContainerSecurityContext": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Container security attributes and settings." }, "fqn": "cdk8s-plus-21.ContainerSecurityContext", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/container.ts", "line": 65 }, "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.ContainerSecurityContextProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/container.ts", "line": 57 }, "name": "ContainerSecurityContext", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 59 }, "name": "ensureNonRoot", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 60 }, "name": "privileged", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 61 }, "name": "readOnlyRootFilesystem", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 63 }, "name": "group", "optional": true, "type": { "primitive": "number" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 62 }, "name": "user", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/container:ContainerSecurityContext" }, "cdk8s-plus-21.ContainerSecurityContextProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `ContainerSecurityContext`." }, "fqn": "cdk8s-plus-21.ContainerSecurityContextProps", "kind": "interface", "locationInModule": { "filename": "src/container.ts", "line": 13 }, "name": "ContainerSecurityContextProps", "properties": [ { "abstract": true, "docs": { "default": "false", "remarks": "If true, the Kubelet will validate the image at runtime to ensure that it does\nnot run as UID 0 (root) and fail to start the container if it does.", "stability": "stable", "summary": "Indicates that the container must run as a non-root user." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 36 }, "name": "ensureNonRoot", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Group configured by container runtime", "stability": "stable", "summary": "The GID to run the entrypoint of the container process." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 27 }, "name": "group", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Processes in privileged containers are essentially equivalent to root on the host.", "stability": "stable", "summary": "Run container in privileged mode." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 43 }, "name": "privileged", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether this container has a read-only root filesystem." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 50 }, "name": "readOnlyRootFilesystem", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- User specified in image metadata", "stability": "stable", "summary": "The UID to run the entrypoint of the container process." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 20 }, "name": "user", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/container:ContainerSecurityContextProps" }, "cdk8s-plus-21.Cpu": { "assembly": "cdk8s-plus-21", "docs": { "remarks": "The amount can be passed as millis or units.", "stability": "stable", "summary": "Represents the amount of CPU." }, "fqn": "cdk8s-plus-21.Cpu", "kind": "class", "locationInModule": { "filename": "src/container.ts", "line": 867 }, "methods": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/container.ts", "line": 868 }, "name": "millis", "parameters": [ { "name": "amount", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Cpu" } }, "static": true }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/container.ts", "line": 871 }, "name": "units", "parameters": [ { "name": "amount", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Cpu" } }, "static": true } ], "name": "Cpu", "properties": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/container.ts", "line": 874 }, "name": "amount", "type": { "primitive": "string" } } ], "symbolId": "src/container:Cpu" }, "cdk8s-plus-21.CpuResources": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "CPU request and limit." }, "fqn": "cdk8s-plus-21.CpuResources", "kind": "interface", "locationInModule": { "filename": "src/container.ts", "line": 858 }, "name": "CpuResources", "properties": [ { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 860 }, "name": "limit", "type": { "fqn": "cdk8s-plus-21.Cpu" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 859 }, "name": "request", "type": { "fqn": "cdk8s-plus-21.Cpu" } } ], "symbolId": "src/container:CpuResources" }, "cdk8s-plus-21.DaemonSet": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Workload", "docs": { "remarks": "As nodes are added to the cluster, Pods are added to them.\nAs nodes are removed from the cluster, those Pods are garbage collected.\nDeleting a DaemonSet will clean up the Pods it created.\n\nSome typical uses of a DaemonSet are:\n\n- running a cluster storage daemon on every node\n- running a logs collection daemon on every node\n- running a node monitoring daemon on every node\n\nIn a simple case, one DaemonSet, covering all nodes, would be used for each type of daemon.\nA more complex setup might use multiple DaemonSets for a single type of daemon,\nbut with different flags and/or different memory and cpu requests for different hardware types.", "stability": "stable", "summary": "A DaemonSet ensures that all (or some) Nodes run a copy of a Pod." }, "fqn": "cdk8s-plus-21.DaemonSet", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/daemon-set.ts", "line": 48 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.DaemonSetProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/daemon-set.ts", "line": 37 }, "name": "DaemonSet", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/daemon-set.ts", "line": 42 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/daemon-set.ts", "line": 46 }, "name": "minReadySeconds", "type": { "primitive": "number" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/daemon-set.ts", "line": 44 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } } ], "symbolId": "src/daemon-set:DaemonSet" }, "cdk8s-plus-21.DaemonSetProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `DaemonSet`." }, "fqn": "cdk8s-plus-21.DaemonSetProps", "interfaces": [ "cdk8s-plus-21.WorkloadProps" ], "kind": "interface", "locationInModule": { "filename": "src/daemon-set.ts", "line": 9 }, "name": "DaemonSetProps", "properties": [ { "abstract": true, "docs": { "default": "0", "stability": "stable", "summary": "Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available." }, "immutable": true, "locationInModule": { "filename": "src/daemon-set.ts", "line": 17 }, "name": "minReadySeconds", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/daemon-set:DaemonSetProps" }, "cdk8s-plus-21.Deployment": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Workload", "docs": { "remarks": "You describe a desired state in a Deployment, and the Deployment Controller changes the actual\nstate to the desired state at a controlled rate. You can define Deployments to create new ReplicaSets, or to remove\nexisting Deployments and adopt all their resources with new Deployments.\n\n> Note: Do not manage ReplicaSets owned by a Deployment. Consider opening an issue in the main Kubernetes repository if your use case is not covered below.\n\nUse Case\n---------\n\nThe following are typical use cases for Deployments:\n\n- Create a Deployment to rollout a ReplicaSet. The ReplicaSet creates Pods in the background.\n Check the status of the rollout to see if it succeeds or not.\n- Declare the new state of the Pods by updating the PodTemplateSpec of the Deployment.\n A new ReplicaSet is created and the Deployment manages moving the Pods from the old ReplicaSet to the new one at a controlled rate.\n Each new ReplicaSet updates the revision of the Deployment.\n- Rollback to an earlier Deployment revision if the current state of the Deployment is not stable.\n Each rollback updates the revision of the Deployment.\n- Scale up the Deployment to facilitate more load.\n- Pause the Deployment to apply multiple fixes to its PodTemplateSpec and then resume it to start a new rollout.\n- Use the status of the Deployment as an indicator that a rollout has stuck.\n- Clean up older ReplicaSets that you don't need anymore.", "stability": "stable", "summary": "A Deployment provides declarative updates for Pods and ReplicaSets." }, "fqn": "cdk8s-plus-21.Deployment", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/deployment.ts", "line": 158 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.DeploymentProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/deployment.ts", "line": 128 }, "methods": [ { "docs": { "remarks": "This will first expose the deployment with a service, and then expose the service via an ingress.", "stability": "stable", "summary": "Expose a deployment via an ingress." }, "locationInModule": { "filename": "src/deployment.ts", "line": 201 }, "name": "exposeViaIngress", "parameters": [ { "docs": { "summary": "The ingress path to register under." }, "name": "path", "type": { "primitive": "string" } }, { "docs": { "summary": "Additional options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.ExposeDeploymentViaIngressOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.IngressV1Beta1" } } }, { "docs": { "remarks": "This is equivalent to running `kubectl expose deployment `.", "stability": "stable", "summary": "Expose a deployment via a service." }, "locationInModule": { "filename": "src/deployment.ts", "line": 184 }, "name": "exposeViaService", "parameters": [ { "docs": { "summary": "Options to determine details of the service and port exposed." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.ExposeDeploymentViaServiceOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Service" } } } ], "name": "Deployment", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 154 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable", "summary": "Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 139 }, "name": "minReady", "type": { "fqn": "cdk8s.Duration" } }, { "docs": { "stability": "stable", "summary": "The maximum duration for a deployment to make progress before it is considered to be failed." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 144 }, "name": "progressDeadline", "type": { "fqn": "cdk8s.Duration" } }, { "docs": { "stability": "stable", "summary": "Number of desired pods." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 133 }, "name": "replicas", "type": { "primitive": "number" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 156 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 149 }, "name": "strategy", "type": { "fqn": "cdk8s-plus-21.DeploymentStrategy" } } ], "symbolId": "src/deployment:Deployment" }, "cdk8s-plus-21.DeploymentProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `Deployment`." }, "fqn": "cdk8s-plus-21.DeploymentProps", "interfaces": [ "cdk8s-plus-21.WorkloadProps" ], "kind": "interface", "locationInModule": { "filename": "src/deployment.ts", "line": 11 }, "name": "DeploymentProps", "properties": [ { "abstract": true, "docs": { "default": "Duration.seconds(0)", "remarks": "Zero means the pod will be considered available as soon as it is ready.", "see": "https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#min-ready-seconds", "stability": "stable", "summary": "Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 36 }, "name": "minReady", "optional": true, "type": { "fqn": "cdk8s.Duration" } }, { "abstract": true, "docs": { "default": "Duration.seconds(600)", "remarks": "The deployment controller will continue\nto process failed deployments and a condition with a ProgressDeadlineExceeded\nreason will be surfaced in the deployment status.\n\nNote that progress will not be estimated during the time a deployment is paused.", "see": "https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#progress-deadline-seconds", "stability": "stable", "summary": "The maximum duration for a deployment to make progress before it is considered to be failed." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 49 }, "name": "progressDeadline", "optional": true, "type": { "fqn": "cdk8s.Duration" } }, { "abstract": true, "docs": { "default": "1", "stability": "stable", "summary": "Number of desired pods." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 18 }, "name": "replicas", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- RollingUpdate with maxSurge and maxUnavailable set to 25%.", "stability": "stable", "summary": "Specifies the strategy used to replace old Pods by new ones." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 25 }, "name": "strategy", "optional": true, "type": { "fqn": "cdk8s-plus-21.DeploymentStrategy" } } ], "symbolId": "src/deployment:DeploymentProps" }, "cdk8s-plus-21.DeploymentStrategy": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Deployment strategies." }, "fqn": "cdk8s-plus-21.DeploymentStrategy", "kind": "class", "locationInModule": { "filename": "src/deployment.ts", "line": 293 }, "methods": [ { "docs": { "see": "https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#recreate-deployment", "stability": "stable", "summary": "All existing Pods are killed before new ones are created." }, "locationInModule": { "filename": "src/deployment.ts", "line": 300 }, "name": "recreate", "returns": { "type": { "fqn": "cdk8s-plus-21.DeploymentStrategy" } }, "static": true }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/deployment.ts", "line": 306 }, "name": "rollingUpdate", "parameters": [ { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.DeploymentStrategyRollingUpdateOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.DeploymentStrategy" } }, "static": true } ], "name": "DeploymentStrategy", "symbolId": "src/deployment:DeploymentStrategy" }, "cdk8s-plus-21.DeploymentStrategyRollingUpdateOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `DeploymentStrategy.rollingUpdate`." }, "fqn": "cdk8s-plus-21.DeploymentStrategyRollingUpdateOptions", "kind": "interface", "locationInModule": { "filename": "src/deployment.ts", "line": 228 }, "name": "DeploymentStrategyRollingUpdateOptions", "properties": [ { "abstract": true, "docs": { "default": "'25%'", "remarks": "Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).\nAbsolute number is calculated from percentage by rounding up.\nThis can not be 0 if `maxUnavailable` is 0.\n\nExample: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update\nstarts, such that the total number of old and new pods do not exceed 130% of desired pods.\nOnce old pods have been killed, new ReplicaSet can be scaled up further, ensuring that\ntotal number of pods running at any time during the update is at most 130% of desired pods.", "stability": "stable", "summary": "The maximum number of pods that can be scheduled above the desired number of pods." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 243 }, "name": "maxSurge", "optional": true, "type": { "fqn": "cdk8s-plus-21.PercentOrAbsolute" } }, { "abstract": true, "docs": { "default": "'25%'", "remarks": "Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).\nAbsolute number is calculated from percentage by rounding down.\nThis can not be 0 if `maxSurge` is 0.\n\nExample: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired\npods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can\nbe scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total\nnumber of pods available at all times during the update is at least 70% of desired pods.", "stability": "stable", "summary": "The maximum number of pods that can be unavailable during the update." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 258 }, "name": "maxUnavailable", "optional": true, "type": { "fqn": "cdk8s-plus-21.PercentOrAbsolute" } } ], "symbolId": "src/deployment:DeploymentStrategyRollingUpdateOptions" }, "cdk8s-plus-21.DnsOption": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Custom DNS option." }, "fqn": "cdk8s-plus-21.DnsOption", "kind": "interface", "locationInModule": { "filename": "src/pod.ts", "line": 778 }, "name": "DnsOption", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Option name." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 783 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No value.", "stability": "stable", "summary": "Option value." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 790 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/pod:DnsOption" }, "cdk8s-plus-21.DnsPolicy": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Pod DNS policies." }, "fqn": "cdk8s-plus-21.DnsPolicy", "kind": "enum", "locationInModule": { "filename": "src/pod.ts", "line": 796 }, "members": [ { "docs": { "stability": "stable", "summary": "Any DNS query that does not match the configured cluster domain suffix, such as \"www.kubernetes.io\", is forwarded to the upstream nameserver inherited from the node. Cluster administrators may have extra stub-domain and upstream DNS servers configured." }, "name": "CLUSTER_FIRST" }, { "docs": { "stability": "stable", "summary": "For Pods running with hostNetwork, you should explicitly set its DNS policy \"ClusterFirstWithHostNet\"." }, "name": "CLUSTER_FIRST_WITH_HOST_NET" }, { "docs": { "stability": "stable", "summary": "The Pod inherits the name resolution configuration from the node that the pods run on." }, "name": "DEFAULT" }, { "docs": { "remarks": "All DNS settings are supposed to be provided using the dnsConfig\nfield in the Pod Spec.", "stability": "stable", "summary": "It allows a Pod to ignore DNS settings from the Kubernetes environment." }, "name": "NONE" } ], "name": "DnsPolicy", "symbolId": "src/pod:DnsPolicy" }, "cdk8s-plus-21.DockerConfigSecret": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Secret", "docs": { "see": "https://kubernetes.io/docs/concepts/configuration/secret/#docker-config-secrets", "stability": "stable", "summary": "Create a secret for storing credentials for accessing a container image registry." }, "fqn": "cdk8s-plus-21.DockerConfigSecret", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/secret.ts", "line": 273 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk8s-plus-21.DockerConfigSecretProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/secret.ts", "line": 272 }, "name": "DockerConfigSecret", "symbolId": "src/secret:DockerConfigSecret" }, "cdk8s-plus-21.DockerConfigSecretProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `DockerConfigSecret`." }, "fqn": "cdk8s-plus-21.DockerConfigSecretProps", "interfaces": [ "cdk8s-plus-21.CommonSecretProps" ], "kind": "interface", "locationInModule": { "filename": "src/secret.ts", "line": 256 }, "name": "DockerConfigSecretProps", "properties": [ { "abstract": true, "docs": { "see": "https://docs.docker.com/engine/reference/commandline/cli/#sample-configuration-file", "stability": "stable", "summary": "JSON content to provide for the `~/.docker/config.json` file. This will be stringified and inserted as stringData." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 263 }, "name": "data", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "symbolId": "src/secret:DockerConfigSecretProps" }, "cdk8s-plus-21.EmptyDirMedium": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "The medium on which to store the volume." }, "fqn": "cdk8s-plus-21.EmptyDirMedium", "kind": "enum", "locationInModule": { "filename": "src/volume.ts", "line": 452 }, "members": [ { "docs": { "stability": "stable", "summary": "The default volume of the backing node." }, "name": "DEFAULT" }, { "docs": { "remarks": "While tmpfs is very\nfast, be aware that unlike disks, tmpfs is cleared on node reboot and any\nfiles you write will count against your Container's memory limit.", "stability": "stable", "summary": "Mount a tmpfs (RAM-backed filesystem) for you instead." }, "name": "MEMORY" } ], "name": "EmptyDirMedium", "symbolId": "src/volume:EmptyDirMedium" }, "cdk8s-plus-21.EmptyDirVolumeOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for volumes populated with an empty directory." }, "fqn": "cdk8s-plus-21.EmptyDirVolumeOptions", "kind": "interface", "locationInModule": { "filename": "src/volume.ts", "line": 424 }, "name": "EmptyDirVolumeOptions", "properties": [ { "abstract": true, "docs": { "default": "EmptyDirMedium.DEFAULT", "remarks": "However, you can set the emptyDir.medium field to\n`EmptyDirMedium.MEMORY` to tell Kubernetes to mount a tmpfs (RAM-backed\nfilesystem) for you instead. While tmpfs is very fast, be aware that unlike\ndisks, tmpfs is cleared on node reboot and any files you write will count\nagainst your Container's memory limit.", "stability": "stable", "summary": "By default, emptyDir volumes are stored on whatever medium is backing the node - that might be disk or SSD or network storage, depending on your environment." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 436 }, "name": "medium", "optional": true, "type": { "fqn": "cdk8s-plus-21.EmptyDirMedium" } }, { "abstract": true, "docs": { "default": "- limit is undefined", "remarks": "The size\nlimit is also applicable for memory medium. The maximum usage on memory\nmedium EmptyDir would be the minimum value between the SizeLimit specified\nhere and the sum of memory limits of all containers in a pod.", "stability": "stable", "summary": "Total amount of local storage required for this EmptyDir volume." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 446 }, "name": "sizeLimit", "optional": true, "type": { "fqn": "cdk8s.Size" } } ], "symbolId": "src/volume:EmptyDirVolumeOptions" }, "cdk8s-plus-21.Env": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Container environment variables." }, "fqn": "cdk8s-plus-21.Env", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/container.ts", "line": 941 }, "parameters": [ { "name": "sources", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.EnvFrom" }, "kind": "array" } } }, { "name": "variables", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.EnvValue" }, "kind": "map" } } } ] }, "kind": "class", "locationInModule": { "filename": "src/container.ts", "line": 918 }, "methods": [ { "docs": { "remarks": "The contents of the target ConfigMap's Data field will represent\nthe key-value pairs as environment variables.", "stability": "stable", "summary": "Selects a ConfigMap to populate the environment variables with." }, "locationInModule": { "filename": "src/container.ts", "line": 925 }, "name": "fromConfigMap", "parameters": [ { "name": "configMap", "type": { "fqn": "cdk8s-plus-21.IConfigMap" } }, { "name": "prefix", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.EnvFrom" } }, "static": true }, { "docs": { "remarks": "The contents of the target Secret's Data field will represent\nthe key-value pairs as environment variables.", "stability": "stable", "summary": "Selects a Secret to populate the environment variables with." }, "locationInModule": { "filename": "src/container.ts", "line": 934 }, "name": "fromSecret", "parameters": [ { "name": "secr", "type": { "fqn": "cdk8s-plus-21.ISecret" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.EnvFrom" } }, "static": true }, { "docs": { "remarks": "The variable value can come from various dynamic sources such a secrets of config maps.\nUse `EnvValue.fromXXX` to select sources.", "stability": "stable", "summary": "Add a single variable by name and value." }, "locationInModule": { "filename": "src/container.ts", "line": 951 }, "name": "addVariable", "parameters": [ { "name": "name", "type": { "primitive": "string" } }, { "name": "value", "type": { "fqn": "cdk8s-plus-21.EnvValue" } } ] }, { "docs": { "remarks": "Use `Env.fromXXX` functions to select sources.", "stability": "stable", "summary": "Add a collection of variables by copying from another source." }, "locationInModule": { "filename": "src/container.ts", "line": 967 }, "name": "copyFrom", "parameters": [ { "name": "from", "type": { "fqn": "cdk8s-plus-21.EnvFrom" } } ] } ], "name": "Env", "properties": [ { "docs": { "remarks": "Returns a copy. To add a source use `container.env.copyFrom()`.", "stability": "stable", "summary": "The list of sources used to populate the container environment, in addition to the `variables`." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 977 }, "name": "sources", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.EnvFrom" }, "kind": "array" } } }, { "docs": { "remarks": "Returns a copy. To add environment variables use `container.env.addVariable()`.", "stability": "stable", "summary": "The environment variables for this container." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 959 }, "name": "variables", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.EnvValue" }, "kind": "map" } } } ], "symbolId": "src/container:Env" }, "cdk8s-plus-21.EnvFieldPaths": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable" }, "fqn": "cdk8s-plus-21.EnvFieldPaths", "kind": "enum", "locationInModule": { "filename": "src/container.ts", "line": 88 }, "members": [ { "docs": { "stability": "stable", "summary": "The name of the pod." }, "name": "POD_NAME" }, { "docs": { "stability": "stable", "summary": "The namespace of the pod." }, "name": "POD_NAMESPACE" }, { "docs": { "stability": "stable", "summary": "The uid of the pod." }, "name": "POD_UID" }, { "docs": { "stability": "stable", "summary": "The labels of the pod." }, "name": "POD_LABEL" }, { "docs": { "stability": "stable", "summary": "The annotations of the pod." }, "name": "POD_ANNOTATION" }, { "docs": { "stability": "stable", "summary": "The ipAddress of the pod." }, "name": "POD_IP" }, { "docs": { "stability": "stable", "summary": "The service account name of the pod." }, "name": "SERVICE_ACCOUNT_NAME" }, { "docs": { "stability": "stable", "summary": "The name of the node." }, "name": "NODE_NAME" }, { "docs": { "stability": "stable", "summary": "The ipAddress of the node." }, "name": "NODE_IP" }, { "docs": { "stability": "stable", "summary": "The ipAddresess of the pod." }, "name": "POD_IPS" } ], "name": "EnvFieldPaths", "symbolId": "src/container:EnvFieldPaths" }, "cdk8s-plus-21.EnvFrom": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "A collection of env variables defined in other resources." }, "fqn": "cdk8s-plus-21.EnvFrom", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/container.ts", "line": 893 }, "parameters": [ { "name": "configMap", "optional": true, "type": { "fqn": "cdk8s-plus-21.IConfigMap" } }, { "name": "prefix", "optional": true, "type": { "primitive": "string" } }, { "name": "sec", "optional": true, "type": { "fqn": "cdk8s-plus-21.ISecret" } } ] }, "kind": "class", "locationInModule": { "filename": "src/container.ts", "line": 891 }, "name": "EnvFrom", "symbolId": "src/container:EnvFrom" }, "cdk8s-plus-21.EnvValue": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Utility class for creating reading env values from various sources." }, "fqn": "cdk8s-plus-21.EnvValue", "kind": "class", "locationInModule": { "filename": "src/container.ts", "line": 246 }, "methods": [ { "docs": { "stability": "stable", "summary": "Create a value by reading a specific key inside a config map." }, "locationInModule": { "filename": "src/container.ts", "line": 255 }, "name": "fromConfigMap", "parameters": [ { "docs": { "summary": "- The config map." }, "name": "configMap", "type": { "fqn": "cdk8s-plus-21.IConfigMap" } }, { "docs": { "summary": "- The key to extract the value from." }, "name": "key", "type": { "primitive": "string" } }, { "docs": { "summary": "- Additional options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.EnvValueFromConfigMapOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.EnvValue" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Create a value from a field reference." }, "locationInModule": { "filename": "src/container.ts", "line": 301 }, "name": "fromFieldRef", "parameters": [ { "docs": { "summary": ": The field reference." }, "name": "fieldPath", "type": { "fqn": "cdk8s-plus-21.EnvFieldPaths" } }, { "docs": { "summary": ": Additional options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.EnvValueFromFieldRefOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.EnvValue" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Create a value from a key in the current process environment." }, "locationInModule": { "filename": "src/container.ts", "line": 346 }, "name": "fromProcess", "parameters": [ { "docs": { "summary": "- The key to read." }, "name": "key", "type": { "primitive": "string" } }, { "docs": { "summary": "- Additional options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.EnvValueFromProcessOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.EnvValue" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Create a value from a resource." }, "locationInModule": { "filename": "src/container.ts", "line": 328 }, "name": "fromResource", "parameters": [ { "docs": { "summary": ": Resource to select the value from." }, "name": "resource", "type": { "fqn": "cdk8s-plus-21.ResourceFieldPaths" } }, { "docs": { "summary": ": Additional options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.EnvValueFromResourceOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.EnvValue" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Defines an environment value from a secret JSON value." }, "locationInModule": { "filename": "src/container.ts", "line": 273 }, "name": "fromSecretValue", "parameters": [ { "docs": { "summary": "The secret value (secrent + key)." }, "name": "secretValue", "type": { "fqn": "cdk8s-plus-21.SecretValue" } }, { "docs": { "summary": "Additional options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.EnvValueFromSecretOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.EnvValue" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Create a value from the given argument." }, "locationInModule": { "filename": "src/container.ts", "line": 290 }, "name": "fromValue", "parameters": [ { "docs": { "summary": "- The value." }, "name": "value", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.EnvValue" } }, "static": true } ], "name": "EnvValue", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 357 }, "name": "value", "optional": true, "type": { "primitive": "any" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 357 }, "name": "valueFrom", "optional": true, "type": { "primitive": "any" } } ], "symbolId": "src/container:EnvValue" }, "cdk8s-plus-21.EnvValueFromConfigMapOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options to specify an envionment variable value from a ConfigMap key." }, "fqn": "cdk8s-plus-21.EnvValueFromConfigMapOptions", "kind": "interface", "locationInModule": { "filename": "src/container.ts", "line": 175 }, "name": "EnvValueFromConfigMapOptions", "properties": [ { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Specify whether the ConfigMap or its key must be defined." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 182 }, "name": "optional", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/container:EnvValueFromConfigMapOptions" }, "cdk8s-plus-21.EnvValueFromFieldRefOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options to specify an environment variable value from a field reference." }, "fqn": "cdk8s-plus-21.EnvValueFromFieldRefOptions", "kind": "interface", "locationInModule": { "filename": "src/container.ts", "line": 216 }, "name": "EnvValueFromFieldRefOptions", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Version of the schema the FieldPath is written in terms of." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 220 }, "name": "apiVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The key to select the pod label or annotation." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 225 }, "name": "key", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/container:EnvValueFromFieldRefOptions" }, "cdk8s-plus-21.EnvValueFromProcessOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options to specify an environment variable value from the process environment." }, "fqn": "cdk8s-plus-21.EnvValueFromProcessOptions", "kind": "interface", "locationInModule": { "filename": "src/container.ts", "line": 202 }, "name": "EnvValueFromProcessOptions", "properties": [ { "abstract": true, "docs": { "default": "false", "remarks": "If this is set to true, and the key does not exist, an error will thrown.", "stability": "stable", "summary": "Specify whether the key must exist in the environment." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 210 }, "name": "required", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/container:EnvValueFromProcessOptions" }, "cdk8s-plus-21.EnvValueFromResourceOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options to specify an environment variable value from a resource." }, "fqn": "cdk8s-plus-21.EnvValueFromResourceOptions", "kind": "interface", "locationInModule": { "filename": "src/container.ts", "line": 231 }, "name": "EnvValueFromResourceOptions", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The container to select the value from." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 235 }, "name": "container", "optional": true, "type": { "fqn": "cdk8s-plus-21.Container" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The output format of the exposed resource." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 240 }, "name": "divisor", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/container:EnvValueFromResourceOptions" }, "cdk8s-plus-21.EnvValueFromSecretOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options to specify an environment variable value from a Secret." }, "fqn": "cdk8s-plus-21.EnvValueFromSecretOptions", "kind": "interface", "locationInModule": { "filename": "src/container.ts", "line": 188 }, "name": "EnvValueFromSecretOptions", "properties": [ { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Specify whether the Secret or its key must be defined." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 195 }, "name": "optional", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/container:EnvValueFromSecretOptions" }, "cdk8s-plus-21.ExposeDeploymentViaIngressOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for exposing a deployment via an ingress." }, "fqn": "cdk8s-plus-21.ExposeDeploymentViaIngressOptions", "interfaces": [ "cdk8s-plus-21.ExposeDeploymentViaServiceOptions", "cdk8s-plus-21.ExposeServiceViaIngressOptions" ], "kind": "interface", "locationInModule": { "filename": "src/deployment.ts", "line": 98 }, "name": "ExposeDeploymentViaIngressOptions", "symbolId": "src/deployment:ExposeDeploymentViaIngressOptions" }, "cdk8s-plus-21.ExposeDeploymentViaServiceOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for exposing a deployment via a service." }, "fqn": "cdk8s-plus-21.ExposeDeploymentViaServiceOptions", "kind": "interface", "locationInModule": { "filename": "src/deployment.ts", "line": 56 }, "name": "ExposeDeploymentViaServiceOptions", "properties": [ { "abstract": true, "docs": { "default": "undefined Uses the system generated name.", "remarks": "This will be set on the Service.metadata and must be a DNS_LABEL", "stability": "stable", "summary": "The name of the service to expose." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 78 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Copied from the container of the deployment. If a port could not be determined, throws an error.", "stability": "stable", "summary": "The port that the service should serve on." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 63 }, "name": "port", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "Protocol.TCP", "remarks": "Supports \"TCP\", \"UDP\", and \"SCTP\". Default is TCP.", "stability": "stable", "summary": "The IP protocol for this port." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 85 }, "name": "protocol", "optional": true, "type": { "fqn": "cdk8s-plus-21.Protocol" } }, { "abstract": true, "docs": { "default": "- ClusterIP.", "stability": "stable", "summary": "The type of the exposed service." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 70 }, "name": "serviceType", "optional": true, "type": { "fqn": "cdk8s-plus-21.ServiceType" } }, { "abstract": true, "docs": { "default": "- The port of the first container in the deployment (ie. containers[0].port)", "stability": "stable", "summary": "The port number the service will redirect to." }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 92 }, "name": "targetPort", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/deployment:ExposeDeploymentViaServiceOptions" }, "cdk8s-plus-21.ExposeServiceViaIngressOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for exposing a service using an ingress." }, "fqn": "cdk8s-plus-21.ExposeServiceViaIngressOptions", "kind": "interface", "locationInModule": { "filename": "src/service.ts", "line": 75 }, "name": "ExposeServiceViaIngressOptions", "properties": [ { "abstract": true, "docs": { "default": "- An ingress will be automatically created.", "stability": "stable", "summary": "The ingress to add rules to." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 82 }, "name": "ingress", "optional": true, "type": { "fqn": "cdk8s-plus-21.IngressV1Beta1" } } ], "symbolId": "src/service:ExposeServiceViaIngressOptions" }, "cdk8s-plus-21.FsGroupChangePolicy": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable" }, "fqn": "cdk8s-plus-21.FsGroupChangePolicy", "kind": "enum", "locationInModule": { "filename": "src/pod.ts", "line": 760 }, "members": [ { "docs": { "remarks": "This could help shorten the time it takes to change ownership and permission of a volume", "stability": "stable", "summary": "Only change permissions and ownership if permission and ownership of root directory does not match with expected permissions of the volume." }, "name": "ON_ROOT_MISMATCH" }, { "docs": { "stability": "stable", "summary": "Always change permission and ownership of the volume when volume is mounted." }, "name": "ALWAYS" } ], "name": "FsGroupChangePolicy", "symbolId": "src/pod:FsGroupChangePolicy" }, "cdk8s-plus-21.GCEPersistentDiskPersistentVolume": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.PersistentVolume", "docs": { "remarks": "Provisioned by an admin.", "see": "https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "stability": "stable", "summary": "GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod." }, "fqn": "cdk8s-plus-21.GCEPersistentDiskPersistentVolume", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pv.ts", "line": 545 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk8s-plus-21.GCEPersistentDiskPersistentVolumeProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/pv.ts", "line": 523 }, "name": "GCEPersistentDiskPersistentVolume", "properties": [ { "docs": { "stability": "stable", "summary": "File system type of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 538 }, "name": "fsType", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "PD resource in GCE of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 528 }, "name": "pdName", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Whether or not it is mounted as a read-only volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 533 }, "name": "readOnly", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable", "summary": "Partition of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 543 }, "name": "partition", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/pv:GCEPersistentDiskPersistentVolume" }, "cdk8s-plus-21.GCEPersistentDiskPersistentVolumeProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `GCEPersistentDiskPersistentVolume`." }, "fqn": "cdk8s-plus-21.GCEPersistentDiskPersistentVolumeProps", "interfaces": [ "cdk8s-plus-21.PersistentVolumeProps" ], "kind": "interface", "locationInModule": { "filename": "src/pv.ts", "line": 480 }, "name": "GCEPersistentDiskPersistentVolumeProps", "properties": [ { "abstract": true, "docs": { "remarks": "Used to identify the disk in GCE.", "see": "https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "stability": "stable", "summary": "Unique name of the PD resource in GCE." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 487 }, "name": "pdName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "'ext4'", "remarks": "Tip: Ensure that the filesystem type is supported by the host operating system.", "see": "https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "stability": "stable", "summary": "Filesystem type of the volume that you want to mount." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 496 }, "name": "fsType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No partition.", "remarks": "If omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).", "stability": "stable", "summary": "The partition in the volume that you want to mount." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 505 }, "name": "partition", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "false", "see": "https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "stability": "stable", "summary": "Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\"." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 513 }, "name": "readOnly", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/pv:GCEPersistentDiskPersistentVolumeProps" }, "cdk8s-plus-21.GCEPersistentDiskVolumeOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options of `Volume.fromGcePersistentDisk`." }, "fqn": "cdk8s-plus-21.GCEPersistentDiskVolumeOptions", "kind": "interface", "locationInModule": { "filename": "src/volume.ts", "line": 244 }, "name": "GCEPersistentDiskVolumeOptions", "properties": [ { "abstract": true, "docs": { "default": "'ext4'", "remarks": "Tip: Ensure that the filesystem type is supported by the host operating system.", "see": "https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "stability": "stable", "summary": "Filesystem type of the volume that you want to mount." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 259 }, "name": "fsType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- auto-generated", "stability": "stable", "summary": "The volume name." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 250 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No partition.", "remarks": "If omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).", "stability": "stable", "summary": "The partition in the volume that you want to mount." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 268 }, "name": "partition", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "false", "see": "https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "stability": "stable", "summary": "Specify \"true\" to force and set the ReadOnly property in VolumeMounts to \"true\"." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 276 }, "name": "readOnly", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/volume:GCEPersistentDiskVolumeOptions" }, "cdk8s-plus-21.Group": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents a group." }, "fqn": "cdk8s-plus-21.Group", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/role-binding.ts", "line": 224 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk8s-plus-21.GroupProps" } } ] }, "interfaces": [ "cdk8s-plus-21.ISubject" ], "kind": "class", "locationInModule": { "filename": "src/role-binding.ts", "line": 220 }, "name": "Group", "properties": [ { "docs": { "remarks": "Values defined by this API group are\n\"User\", \"Group\", and \"ServiceAccount\". If the Authorizer does not\nrecognized the kind value, the Authorizer should report an error.", "stability": "stable", "summary": "Kind of object being referenced." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 222 }, "name": "kind", "overrides": "cdk8s-plus-21.ISubject", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Name of the object being referenced." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 223 }, "name": "name", "overrides": "cdk8s-plus-21.ISubject", "type": { "primitive": "string" } }, { "docs": { "remarks": "Defaults to \"\" for\nServiceAccount subjects. Defaults to \"rbac.authorization.k8s.io\" for User\nand Group subjects.", "stability": "stable", "summary": "APIGroup holds the API group of the referenced subject." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 221 }, "name": "apiGroup", "optional": true, "overrides": "cdk8s-plus-21.ISubject", "type": { "primitive": "string" } } ], "symbolId": "src/role-binding:Group" }, "cdk8s-plus-21.GroupProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `Group`." }, "fqn": "cdk8s-plus-21.GroupProps", "kind": "interface", "locationInModule": { "filename": "src/role-binding.ts", "line": 210 }, "name": "GroupProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The name of the group." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 214 }, "name": "name", "type": { "primitive": "string" } } ], "symbolId": "src/role-binding:GroupProps" }, "cdk8s-plus-21.Handler": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Defines a specific action that should be taken." }, "fqn": "cdk8s-plus-21.Handler", "kind": "class", "locationInModule": { "filename": "src/handler.ts", "line": 42 }, "methods": [ { "docs": { "stability": "stable", "summary": "Defines a handler based on a command which is executed within the container." }, "locationInModule": { "filename": "src/handler.ts", "line": 59 }, "name": "fromCommand", "parameters": [ { "docs": { "summary": "The command to execute." }, "name": "command", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Handler" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Defines a handler based on an HTTP GET request to the IP address of the container." }, "locationInModule": { "filename": "src/handler.ts", "line": 50 }, "name": "fromHttpGet", "parameters": [ { "docs": { "summary": "The URL path to hit." }, "name": "path", "type": { "primitive": "string" } }, { "docs": { "summary": "Options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.HandlerFromHttpGetOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Handler" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Defines a handler based opening a connection to a TCP socket on the container." }, "locationInModule": { "filename": "src/handler.ts", "line": 68 }, "name": "fromTcpSocket", "parameters": [ { "docs": { "summary": "Options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.HandlerFromTcpSocketOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Handler" } }, "static": true } ], "name": "Handler", "symbolId": "src/handler:Handler" }, "cdk8s-plus-21.HandlerFromHttpGetOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `Handler.fromHttpGet`." }, "fqn": "cdk8s-plus-21.HandlerFromHttpGetOptions", "kind": "interface", "locationInModule": { "filename": "src/handler.ts", "line": 28 }, "name": "HandlerFromHttpGetOptions", "properties": [ { "abstract": true, "docs": { "default": "- defaults to `container.port`.", "stability": "stable", "summary": "The TCP port to use when sending the GET request." }, "immutable": true, "locationInModule": { "filename": "src/handler.ts", "line": 35 }, "name": "port", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/handler:HandlerFromHttpGetOptions" }, "cdk8s-plus-21.HandlerFromTcpSocketOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `Handler.fromTcpSocket`." }, "fqn": "cdk8s-plus-21.HandlerFromTcpSocketOptions", "kind": "interface", "locationInModule": { "filename": "src/handler.ts", "line": 8 }, "name": "HandlerFromTcpSocketOptions", "properties": [ { "abstract": true, "docs": { "default": "- defaults to the pod IP", "stability": "stable", "summary": "The host name to connect to on the container." }, "immutable": true, "locationInModule": { "filename": "src/handler.ts", "line": 21 }, "name": "host", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- defaults to `container.port`.", "stability": "stable", "summary": "The TCP port to connect to on the container." }, "immutable": true, "locationInModule": { "filename": "src/handler.ts", "line": 14 }, "name": "port", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/handler:HandlerFromTcpSocketOptions" }, "cdk8s-plus-21.HostAlias": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's /etc/hosts file." }, "fqn": "cdk8s-plus-21.HostAlias", "kind": "interface", "locationInModule": { "filename": "src/pod.ts", "line": 831 }, "name": "HostAlias", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Hostnames for the chosen IP address." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 835 }, "name": "hostnames", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "IP address of the host file entry." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 840 }, "name": "ip", "type": { "primitive": "string" } } ], "symbolId": "src/pod:HostAlias" }, "cdk8s-plus-21.HttpGetProbeOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `Probe.fromHttpGet()`." }, "fqn": "cdk8s-plus-21.HttpGetProbeOptions", "interfaces": [ "cdk8s-plus-21.ProbeOptions" ], "kind": "interface", "locationInModule": { "filename": "src/probe.ts", "line": 62 }, "name": "HttpGetProbeOptions", "properties": [ { "abstract": true, "docs": { "default": "- defaults to `container.port`.", "stability": "stable", "summary": "The TCP port to use when sending the GET request." }, "immutable": true, "locationInModule": { "filename": "src/probe.ts", "line": 68 }, "name": "port", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/probe:HttpGetProbeOptions" }, "cdk8s-plus-21.IApiEndpoint": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "An API Endpoint can either be a resource descriptor (e.g /pods) or a non resource url (e.g /healthz). It must be one or the other, and not both." }, "fqn": "cdk8s-plus-21.IApiEndpoint", "kind": "interface", "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 30 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Return the IApiResource this object represents." }, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 35 }, "name": "asApiResource", "returns": { "optional": true, "type": { "fqn": "cdk8s-plus-21.IApiResource" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Return the non resource url this object represents." }, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 40 }, "name": "asNonApiResource", "returns": { "optional": true, "type": { "primitive": "string" } } } ], "name": "IApiEndpoint", "symbolId": "src/api-resource.generated:IApiEndpoint" }, "cdk8s-plus-21.IApiResource": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents a resource or collection of resources." }, "fqn": "cdk8s-plus-21.IApiResource", "kind": "interface", "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 6 }, "name": "IApiResource", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The group portion of the API version (e.g. `authorization.k8s.io`)." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 10 }, "name": "apiGroup", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "example": "- \"pods\" or \"pods/log\"", "see": "https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources", "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 17 }, "name": "resourceType", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "If this is omitted, the ApiResource should represent all objects of the given type.", "stability": "stable", "summary": "The unique, namespace-global, name of an object inside the Kubernetes cluster." }, "immutable": true, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 24 }, "name": "resourceName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/api-resource.generated:IApiResource" }, "cdk8s-plus-21.IClusterRole": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents a cluster-level role." }, "fqn": "cdk8s-plus-21.IClusterRole", "interfaces": [ "cdk8s-plus-21.IResource" ], "kind": "interface", "locationInModule": { "filename": "src/role.ts", "line": 216 }, "name": "IClusterRole", "symbolId": "src/role:IClusterRole" }, "cdk8s-plus-21.IConfigMap": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents a config map." }, "fqn": "cdk8s-plus-21.IConfigMap", "interfaces": [ "cdk8s-plus-21.IResource" ], "kind": "interface", "locationInModule": { "filename": "src/config-map.ts", "line": 51 }, "name": "IConfigMap", "symbolId": "src/config-map:IConfigMap" }, "cdk8s-plus-21.INamespaceSelector": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents an object that can select namespaces." }, "fqn": "cdk8s-plus-21.INamespaceSelector", "kind": "interface", "locationInModule": { "filename": "src/namespace.ts", "line": 26 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Return the configuration of this selector." }, "locationInModule": { "filename": "src/namespace.ts", "line": 30 }, "name": "toNamespaceSelectorConfig", "returns": { "type": { "fqn": "cdk8s-plus-21.NamespaceSelectorConfig" } } } ], "name": "INamespaceSelector", "symbolId": "src/namespace:INamespaceSelector" }, "cdk8s-plus-21.IPersistentVolume": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Contract of a `PersistentVolumeClaim`." }, "fqn": "cdk8s-plus-21.IPersistentVolume", "interfaces": [ "cdk8s-plus-21.IResource" ], "kind": "interface", "locationInModule": { "filename": "src/pv.ts", "line": 11 }, "name": "IPersistentVolume", "symbolId": "src/pv:IPersistentVolume" }, "cdk8s-plus-21.IPersistentVolumeClaim": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Contract of a `PersistentVolumeClaim`." }, "fqn": "cdk8s-plus-21.IPersistentVolumeClaim", "interfaces": [ "cdk8s-plus-21.IResource" ], "kind": "interface", "locationInModule": { "filename": "src/pvc.ts", "line": 10 }, "name": "IPersistentVolumeClaim", "symbolId": "src/pvc:IPersistentVolumeClaim" }, "cdk8s-plus-21.IPodSelector": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents an object that can select pods." }, "fqn": "cdk8s-plus-21.IPodSelector", "kind": "interface", "locationInModule": { "filename": "src/pod.ts", "line": 453 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Return the configuration of this selector." }, "locationInModule": { "filename": "src/pod.ts", "line": 457 }, "name": "toPodSelectorConfig", "returns": { "type": { "fqn": "cdk8s-plus-21.PodSelectorConfig" } } } ], "name": "IPodSelector", "symbolId": "src/pod:IPodSelector" }, "cdk8s-plus-21.IResource": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents a resource." }, "fqn": "cdk8s-plus-21.IResource", "kind": "interface", "locationInModule": { "filename": "src/base.ts", "line": 19 }, "name": "IResource", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The group portion of the API version (e.g. \"authorization.k8s.io\")." }, "immutable": true, "locationInModule": { "filename": "src/base.ts", "line": 33 }, "name": "apiGroup", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The object's API version (e.g. \"authorization.k8s.io/v1\")." }, "immutable": true, "locationInModule": { "filename": "src/base.ts", "line": 28 }, "name": "apiVersion", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The object kind (e.g. \"Deployment\")." }, "immutable": true, "locationInModule": { "filename": "src/base.ts", "line": 38 }, "name": "kind", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The Kubernetes name of this resource." }, "immutable": true, "locationInModule": { "filename": "src/base.ts", "line": 23 }, "name": "name", "type": { "primitive": "string" } } ], "symbolId": "src/base:IResource" }, "cdk8s-plus-21.IRole": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "A reference to any Role or ClusterRole." }, "fqn": "cdk8s-plus-21.IRole", "interfaces": [ "cdk8s-plus-21.IResource" ], "kind": "interface", "locationInModule": { "filename": "src/role.ts", "line": 11 }, "name": "IRole", "symbolId": "src/role:IRole" }, "cdk8s-plus-21.ISecret": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable" }, "fqn": "cdk8s-plus-21.ISecret", "interfaces": [ "cdk8s-plus-21.IResource" ], "kind": "interface", "locationInModule": { "filename": "src/secret.ts", "line": 44 }, "name": "ISecret", "symbolId": "src/secret:ISecret" }, "cdk8s-plus-21.IServiceAccount": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable" }, "fqn": "cdk8s-plus-21.IServiceAccount", "interfaces": [ "cdk8s-plus-21.IResource" ], "kind": "interface", "locationInModule": { "filename": "src/service-account.ts", "line": 10 }, "name": "IServiceAccount", "symbolId": "src/service-account:IServiceAccount" }, "cdk8s-plus-21.IStorage": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents a piece of storage in the cluster." }, "fqn": "cdk8s-plus-21.IStorage", "kind": "interface", "locationInModule": { "filename": "src/volume.ts", "line": 10 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Convert the piece of storage into a concrete volume." }, "locationInModule": { "filename": "src/volume.ts", "line": 15 }, "name": "asVolume", "returns": { "type": { "fqn": "cdk8s-plus-21.Volume" } } } ], "name": "IStorage", "symbolId": "src/volume:IStorage" }, "cdk8s-plus-21.ISubject": { "assembly": "cdk8s-plus-21", "docs": { "remarks": "This can either hold a direct API object reference, or a value\nfor non-objects such as user and group names.", "stability": "stable", "summary": "Subject contains a reference to the object or user identities a role binding applies to." }, "fqn": "cdk8s-plus-21.ISubject", "kind": "interface", "locationInModule": { "filename": "src/role-binding.ts", "line": 13 }, "name": "ISubject", "properties": [ { "abstract": true, "docs": { "remarks": "Values defined by this API group are\n\"User\", \"Group\", and \"ServiceAccount\". If the Authorizer does not\nrecognized the kind value, the Authorizer should report an error.", "stability": "stable", "summary": "Kind of object being referenced." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 26 }, "name": "kind", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Name of the object being referenced." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 31 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Defaults to \"\" for\nServiceAccount subjects. Defaults to \"rbac.authorization.k8s.io\" for User\nand Group subjects.", "stability": "stable", "summary": "APIGroup holds the API group of the referenced subject." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 19 }, "name": "apiGroup", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "If the object kind is non-namespace,\nsuch as \"User\" or \"Group\", and this value is not empty the Authorizer\nshould report an error.", "stability": "stable", "summary": "Namespace of the referenced object." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 38 }, "name": "namespace", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/role-binding:ISubject" }, "cdk8s-plus-21.ImagePullPolicy": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable" }, "fqn": "cdk8s-plus-21.ImagePullPolicy", "kind": "enum", "locationInModule": { "filename": "src/container.ts", "line": 360 }, "members": [ { "docs": { "remarks": "If the kubelet has a container image with that exact\ndigest cached locally, the kubelet uses its cached image; otherwise, the kubelet downloads\n(pulls) the image with the resolved digest, and uses that image to launch the container.\n\nDefault is Always if ImagePullPolicy is omitted and either the image tag is :latest or\nthe image tag is omitted.", "stability": "stable", "summary": "Every time the kubelet launches a container, the kubelet queries the container image registry to resolve the name to an image digest." }, "name": "ALWAYS" }, { "docs": { "remarks": "Default is IfNotPresent if ImagePullPolicy is omitted and the image tag is present but\nnot :latest", "stability": "stable", "summary": "The image is pulled only if it is not already present locally." }, "name": "IF_NOT_PRESENT" }, { "docs": { "remarks": "No attempt is made to pull the image.", "stability": "stable", "summary": "The image is assumed to exist locally." }, "name": "NEVER" } ], "name": "ImagePullPolicy", "symbolId": "src/container:ImagePullPolicy" }, "cdk8s-plus-21.IngressV1Beta1": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Resource", "docs": { "remarks": "An Ingress can be configured to give services\nexternally-reachable urls, load balance traffic, terminate SSL, offer name\nbased virtual hosting etc.", "stability": "stable", "summary": "Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend." }, "fqn": "cdk8s-plus-21.IngressV1Beta1", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 64 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.IngressV1Beta1Props" } } ] }, "kind": "class", "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 51 }, "methods": [ { "docs": { "remarks": "A default backend capable of\nservicing requests that don't match any rule.", "stability": "stable", "summary": "Defines the default backend for this ingress." }, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 102 }, "name": "addDefaultBackend", "parameters": [ { "docs": { "summary": "The backend to use for requests that do not match any rule." }, "name": "backend", "type": { "fqn": "cdk8s-plus-21.IngressV1Beta1Backend" } } ] }, { "docs": { "remarks": "This backend will be used as a catch-all for requests\ntargeted to this host name (the `Host` header matches this value).", "stability": "stable", "summary": "Specify a default backend for a specific host name." }, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 113 }, "name": "addHostDefaultBackend", "parameters": [ { "docs": { "summary": "The host name to match." }, "name": "host", "type": { "primitive": "string" } }, { "docs": { "summary": "The backend to route to." }, "name": "backend", "type": { "fqn": "cdk8s-plus-21.IngressV1Beta1Backend" } } ] }, { "docs": { "stability": "stable", "summary": "Adds an ingress rule applied to requests to a specific host and a specific HTTP path (the `Host` header matches this value)." }, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 126 }, "name": "addHostRule", "parameters": [ { "docs": { "summary": "The host name." }, "name": "host", "type": { "primitive": "string" } }, { "docs": { "summary": "The HTTP path." }, "name": "path", "type": { "primitive": "string" } }, { "docs": { "summary": "The backend to route requests to." }, "name": "backend", "type": { "fqn": "cdk8s-plus-21.IngressV1Beta1Backend" } } ] }, { "docs": { "stability": "stable", "summary": "Adds an ingress rule applied to requests sent to a specific HTTP path." }, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 137 }, "name": "addRule", "parameters": [ { "docs": { "summary": "The HTTP path." }, "name": "path", "type": { "primitive": "string" } }, { "docs": { "summary": "The backend to route requests to." }, "name": "backend", "type": { "fqn": "cdk8s-plus-21.IngressV1Beta1Backend" } } ] }, { "docs": { "stability": "stable", "summary": "Adds rules to this ingress." }, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 145 }, "name": "addRules", "parameters": [ { "docs": { "summary": "The rules to add." }, "name": "rules", "type": { "fqn": "cdk8s-plus-21.IngressV1Beta1Rule" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 189 }, "name": "addTls", "parameters": [ { "name": "tls", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.IngressV1Beta1Tls" }, "kind": "array" } } } ] } ], "name": "IngressV1Beta1", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 56 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 62 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } } ], "symbolId": "src/ingress-v1beta1:IngressV1Beta1" }, "cdk8s-plus-21.IngressV1Beta1Backend": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "The backend for an ingress path." }, "fqn": "cdk8s-plus-21.IngressV1Beta1Backend", "kind": "class", "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 230 }, "methods": [ { "docs": { "remarks": "A common usage for a Resource backend is to ingress data to an object\nstorage backend with static assets.", "stability": "stable", "summary": "A Resource backend is an ObjectRef to another Kubernetes resource within the same namespace as the Ingress object." }, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 272 }, "name": "fromResource", "parameters": [ { "name": "resource", "type": { "fqn": "cdk8s-plus-21.IResource" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.IngressV1Beta1Backend" } }, "static": true }, { "docs": { "stability": "stable", "summary": "A Kubernetes `Service` to use as the backend for this path." }, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 235 }, "name": "fromService", "parameters": [ { "docs": { "summary": "The service object." }, "name": "serv", "type": { "fqn": "cdk8s-plus-21.Service" } }, { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.ServiceIngressV1BetaBackendOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.IngressV1Beta1Backend" } }, "static": true } ], "name": "IngressV1Beta1Backend", "symbolId": "src/ingress-v1beta1:IngressV1Beta1Backend" }, "cdk8s-plus-21.IngressV1Beta1Props": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `Ingress`." }, "fqn": "cdk8s-plus-21.IngressV1Beta1Props", "interfaces": [ "cdk8s-plus-21.ResourceProps" ], "kind": "interface", "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 11 }, "name": "IngressV1Beta1Props", "properties": [ { "abstract": true, "docs": { "remarks": "Using this option or the `addDefaultBackend()` method is equivalent to\nadding a rule with both `path` and `host` undefined.", "stability": "stable", "summary": "The default backend services requests that do not match any rule." }, "immutable": true, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 18 }, "name": "defaultBackend", "optional": true, "type": { "fqn": "cdk8s-plus-21.IngressV1Beta1Backend" } }, { "abstract": true, "docs": { "remarks": "Each rule must define an `IngressBackend` that will receive the requests\nthat match this rule. If both `host` and `path` are not specifiec, this\nbackend will be used as the default backend of the ingress.\n\nYou can also add rules later using `addRule()`, `addHostRule()`,\n`addDefaultBackend()` and `addHostDefaultBackend()`.", "stability": "stable", "summary": "Routing rules for this ingress." }, "immutable": true, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 30 }, "name": "rules", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.IngressV1Beta1Rule" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "Using this option tells the ingress controller to expose a TLS endpoint.\nCurrently the Ingress only supports a single TLS port, 443. If multiple\nmembers of this list specify different hosts, they will be multiplexed on\nthe same port according to the hostname specified through the SNI TLS\nextension, if the ingress controller fulfilling the ingress supports SNI.", "stability": "stable", "summary": "TLS settings for this ingress." }, "immutable": true, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 42 }, "name": "tls", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.IngressV1Beta1Tls" }, "kind": "array" } } } ], "symbolId": "src/ingress-v1beta1:IngressV1Beta1Props" }, "cdk8s-plus-21.IngressV1Beta1Rule": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "remarks": "Incoming requests are first evaluated for a host match,\nthen routed to the backend associated with the matching path.", "stability": "stable", "summary": "Represents the rules mapping the paths under a specified host to the related backend services." }, "fqn": "cdk8s-plus-21.IngressV1Beta1Rule", "kind": "interface", "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 297 }, "name": "IngressV1Beta1Rule", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Backend defines the referenced service endpoint to which the traffic will be forwarded to." }, "immutable": true, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 302 }, "name": "backend", "type": { "fqn": "cdk8s-plus-21.IngressV1Beta1Backend" } }, { "abstract": true, "docs": { "default": "- If the host is unspecified, the Ingress routes all traffic based\non the specified IngressRuleValue.", "remarks": "Note the following deviations from the \"host\" part of the URI as\ndefined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue\ncan only apply to the IP in the Spec of the parent Ingress. 2. The `:`\ndelimiter is not respected because ports are not allowed. Currently the\nport of an Ingress is implicitly :80 for http and :443 for https. Both\nthese may change in the future. Incoming requests are matched against the\nhost before the IngressRuleValue.", "stability": "stable", "summary": "Host is the fully qualified domain name of a network host, as defined by RFC 3986." }, "immutable": true, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 317 }, "name": "host", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- If unspecified, the path defaults to a catch all sending traffic\nto the backend.", "stability": "stable", "summary": "Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional \"path\" part of a URL as defined by RFC 3986. Paths must begin with a '/'." }, "immutable": true, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 329 }, "name": "path", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/ingress-v1beta1:IngressV1Beta1Rule" }, "cdk8s-plus-21.IngressV1Beta1Tls": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Represents the TLS configuration mapping that is passed to the ingress controller for SSL termination." }, "fqn": "cdk8s-plus-21.IngressV1Beta1Tls", "kind": "interface", "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 336 }, "name": "IngressV1Beta1Tls", "properties": [ { "abstract": true, "docs": { "default": "- If unspecified, it defaults to the wildcard host setting for\nthe loadbalancer controller fulfilling this Ingress.", "remarks": "The values in\nthis list must match the name/s used in the TLS Secret.", "stability": "stable", "summary": "Hosts are a list of hosts included in the TLS certificate." }, "immutable": true, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 345 }, "name": "hosts", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- If unspecified, it allows SSL routing based on SNI hostname.", "remarks": "If the SNI host in a listener conflicts with\nthe \"Host\" header field used by an IngressRule, the SNI host is used for\ntermination and value of the Host header is used for routing.", "stability": "stable", "summary": "Secret is the secret that contains the certificate and key used to terminate SSL traffic on 443." }, "immutable": true, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 355 }, "name": "secret", "optional": true, "type": { "fqn": "cdk8s-plus-21.ISecret" } } ], "symbolId": "src/ingress-v1beta1:IngressV1Beta1Tls" }, "cdk8s-plus-21.Job": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Workload", "docs": { "remarks": "As pods successfully complete,\nthe Job tracks the successful completions. When a specified number of successful completions is reached, the task (ie, Job) is complete.\nDeleting a Job will clean up the Pods it created. A simple case is to create one Job object in order to reliably run one Pod to completion.\nThe Job object will start a new Pod if the first Pod fails or is deleted (for example due to a node hardware failure or a node reboot).\nYou can also use a Job to run multiple Pods in parallel.", "stability": "stable", "summary": "A Job creates one or more Pods and ensures that a specified number of them successfully terminate." }, "fqn": "cdk8s-plus-21.Job", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/job.ts", "line": 72 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.JobProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/job.ts", "line": 48 }, "name": "Job", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/job.ts", "line": 68 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/job.ts", "line": 70 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } }, { "docs": { "remarks": "If undefined, there is no deadline.", "stability": "stable", "summary": "Duration before job is terminated." }, "immutable": true, "locationInModule": { "filename": "src/job.ts", "line": 53 }, "name": "activeDeadline", "optional": true, "type": { "fqn": "cdk8s.Duration" } }, { "docs": { "stability": "stable", "summary": "Number of retries before marking failed." }, "immutable": true, "locationInModule": { "filename": "src/job.ts", "line": 58 }, "name": "backoffLimit", "optional": true, "type": { "primitive": "number" } }, { "docs": { "stability": "stable", "summary": "TTL before the job is deleted after it is finished." }, "immutable": true, "locationInModule": { "filename": "src/job.ts", "line": 63 }, "name": "ttlAfterFinished", "optional": true, "type": { "fqn": "cdk8s.Duration" } } ], "symbolId": "src/job:Job" }, "cdk8s-plus-21.JobProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `Job`." }, "fqn": "cdk8s-plus-21.JobProps", "interfaces": [ "cdk8s-plus-21.WorkloadProps" ], "kind": "interface", "locationInModule": { "filename": "src/job.ts", "line": 10 }, "name": "JobProps", "properties": [ { "abstract": true, "docs": { "default": "- If unset, then there is no deadline.", "stability": "stable", "summary": "Specifies the duration the job may be active before the system tries to terminate it." }, "immutable": true, "locationInModule": { "filename": "src/job.ts", "line": 17 }, "name": "activeDeadline", "optional": true, "type": { "fqn": "cdk8s.Duration" } }, { "abstract": true, "docs": { "default": "- If not set, system defaults to 6.", "stability": "stable", "summary": "Specifies the number of retries before marking this job failed." }, "immutable": true, "locationInModule": { "filename": "src/job.ts", "line": 24 }, "name": "backoffLimit", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- If this field is unset, the Job won't be automatically deleted.", "remarks": "If this field is set, after the Job finishes, it is eligible to\nbe automatically deleted. When the Job is being deleted, its lifecycle\nguarantees (e.g. finalizers) will be honored. If this field is set to zero,\nthe Job becomes eligible to be deleted immediately after it finishes. This\nfield is alpha-level and is only honored by servers that enable the\n`TTLAfterFinished` feature.", "stability": "stable", "summary": "Limits the lifetime of a Job that has finished execution (either Complete or Failed)." }, "immutable": true, "locationInModule": { "filename": "src/job.ts", "line": 37 }, "name": "ttlAfterFinished", "optional": true, "type": { "fqn": "cdk8s.Duration" } } ], "symbolId": "src/job:JobProps" }, "cdk8s-plus-21.LabelExpression": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents a query that can be performed against resources with labels." }, "fqn": "cdk8s-plus-21.LabelExpression", "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 907 }, "methods": [ { "docs": { "stability": "stable", "summary": "Requires label `key` to not exist." }, "locationInModule": { "filename": "src/pod.ts", "line": 933 }, "name": "doesNotExist", "parameters": [ { "name": "key", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.LabelExpression" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Requires label `key` to exist." }, "locationInModule": { "filename": "src/pod.ts", "line": 926 }, "name": "exists", "parameters": [ { "name": "key", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.LabelExpression" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Requires value of label `key` to be one of `values`." }, "locationInModule": { "filename": "src/pod.ts", "line": 912 }, "name": "in", "parameters": [ { "name": "key", "type": { "primitive": "string" } }, { "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.LabelExpression" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Requires value of label `key` to be none of `values`." }, "locationInModule": { "filename": "src/pod.ts", "line": 919 }, "name": "notIn", "parameters": [ { "name": "key", "type": { "primitive": "string" } }, { "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.LabelExpression" } }, "static": true } ], "name": "LabelExpression", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 938 }, "name": "key", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 939 }, "name": "operator", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 940 }, "name": "values", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/pod:LabelExpression" }, "cdk8s-plus-21.LabelSelector": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Match a resource by labels." }, "fqn": "cdk8s-plus-21.LabelSelector", "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 409 }, "methods": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 411 }, "name": "of", "parameters": [ { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.LabelSelectorOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.LabelSelector" } }, "static": true } ], "name": "LabelSelector", "symbolId": "src/pod:LabelSelector" }, "cdk8s-plus-21.LabelSelectorOptions": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Options for `LabelSelector.of`." }, "fqn": "cdk8s-plus-21.LabelSelectorOptions", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 393 }, "name": "LabelSelectorOptions", "properties": [ { "docs": { "stability": "stable", "summary": "Expression based label matchers." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 403 }, "name": "expressions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.LabelExpression" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Strict label matchers." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 398 }, "name": "labels", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "src/pod:LabelSelectorOptions" }, "cdk8s-plus-21.LabelSelectorRequirement": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values." }, "fqn": "cdk8s-plus-21.LabelSelectorRequirement", "kind": "interface", "locationInModule": { "filename": "src/workload.ts", "line": 32 }, "name": "LabelSelectorRequirement", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The label key that the selector applies to." }, "immutable": true, "locationInModule": { "filename": "src/workload.ts", "line": 36 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Represents a key's relationship to a set of values." }, "immutable": true, "locationInModule": { "filename": "src/workload.ts", "line": 41 }, "name": "operator", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "If the operator is In or NotIn, the values array\nmust be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic merge patch.", "stability": "stable", "summary": "An array of string values." }, "immutable": true, "locationInModule": { "filename": "src/workload.ts", "line": 48 }, "name": "values", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/workload:LabelSelectorRequirement" }, "cdk8s-plus-21.LabeledNode": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "A node that is matched by label selectors." }, "fqn": "cdk8s-plus-21.LabeledNode", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 1090 }, "parameters": [ { "name": "labelSelector", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.NodeLabelQuery" }, "kind": "array" } } } ] }, "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 1089 }, "name": "LabeledNode", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1090 }, "name": "labelSelector", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.NodeLabelQuery" }, "kind": "array" } } } ], "symbolId": "src/pod:LabeledNode" }, "cdk8s-plus-21.MemoryResources": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Memory request and limit." }, "fqn": "cdk8s-plus-21.MemoryResources", "kind": "interface", "locationInModule": { "filename": "src/container.ts", "line": 883 }, "name": "MemoryResources", "properties": [ { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 885 }, "name": "limit", "type": { "fqn": "cdk8s.Size" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 884 }, "name": "request", "type": { "fqn": "cdk8s.Size" } } ], "symbolId": "src/container:MemoryResources" }, "cdk8s-plus-21.MountOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for mounts." }, "fqn": "cdk8s-plus-21.MountOptions", "kind": "interface", "locationInModule": { "filename": "src/container.ts", "line": 741 }, "name": "MountOptions", "properties": [ { "abstract": true, "docs": { "default": "MountPropagation.NONE", "remarks": "When not set, MountPropagationNone is used.\n\nMount propagation allows for sharing volumes mounted by a Container to\nother Containers in the same Pod, or even to other Pods on the same node.", "stability": "stable", "summary": "Determines how mounts are propagated from the host to container and the other way around." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 751 }, "name": "propagation", "optional": true, "type": { "fqn": "cdk8s-plus-21.MountPropagation" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Defaults to false.", "stability": "stable", "summary": "Mounted read-only if true, read-write otherwise (false or unspecified)." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 759 }, "name": "readOnly", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"\" the volume's root", "stability": "stable", "summary": "Path within the volume from which the container's volume should be mounted.)." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 766 }, "name": "subPath", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"\" volume's root.", "remarks": "Behaves similarly to SubPath but environment variable references\n$(VAR_NAME) are expanded using the container's environment. Defaults to \"\"\n(volume's root).\n\n`subPathExpr` and `subPath` are mutually exclusive.", "stability": "stable", "summary": "Expanded path within the volume from which the container's volume should be mounted." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 778 }, "name": "subPathExpr", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/container:MountOptions" }, "cdk8s-plus-21.MountPropagation": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable" }, "fqn": "cdk8s-plus-21.MountPropagation", "kind": "enum", "locationInModule": { "filename": "src/container.ts", "line": 797 }, "members": [ { "docs": { "remarks": "In similar\nfashion, no mounts created by the Container will be visible on the host.\n\nThis is the default mode.\n\nThis mode is equal to `private` mount propagation as described in the Linux\nkernel documentation", "stability": "stable", "summary": "This volume mount will not receive any subsequent mounts that are mounted to this volume or any of its subdirectories by the host." }, "name": "NONE" }, { "docs": { "remarks": "In other words, if the host mounts anything inside the volume mount, the\nContainer will see it mounted there.\n\nSimilarly, if any Pod with Bidirectional mount propagation to the same\nvolume mounts anything there, the Container with HostToContainer mount\npropagation will see it.\n\nThis mode is equal to `rslave` mount propagation as described in the Linux\nkernel documentation", "stability": "stable", "summary": "This volume mount will receive all subsequent mounts that are mounted to this volume or any of its subdirectories." }, "name": "HOST_TO_CONTAINER" }, { "docs": { "remarks": "In addition,\nall volume mounts created by the Container will be propagated back to the\nhost and to all Containers of all Pods that use the same volume\n\nA typical use case for this mode is a Pod with a FlexVolume or CSI driver\nor a Pod that needs to mount something on the host using a hostPath volume.\n\nThis mode is equal to `rshared` mount propagation as described in the Linux\nkernel documentation\n\nCaution: Bidirectional mount propagation can be dangerous. It can damage\nthe host operating system and therefore it is allowed only in privileged\nContainers. Familiarity with Linux kernel behavior is strongly recommended.\nIn addition, any volume mounts created by Containers in Pods must be\ndestroyed (unmounted) by the Containers on termination.", "stability": "stable", "summary": "This volume mount behaves the same the HostToContainer mount." }, "name": "BIDIRECTIONAL" } ], "name": "MountPropagation", "symbolId": "src/container:MountPropagation" }, "cdk8s-plus-21.NamedNode": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "A node that is matched by its name." }, "fqn": "cdk8s-plus-21.NamedNode", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 1104 }, "parameters": [ { "name": "name", "type": { "primitive": "string" } } ] }, "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 1103 }, "name": "NamedNode", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1104 }, "name": "name", "type": { "primitive": "string" } } ], "symbolId": "src/pod:NamedNode" }, "cdk8s-plus-21.Namespace": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Resource", "docs": { "remarks": "Names of resources need to be unique within a namespace, but not across namespaces.\nNamespace-based scoping is applicable only for namespaced objects (e.g. Deployments, Services, etc) and\nnot for cluster-wide objects (e.g. StorageClass, Nodes, PersistentVolumes, etc).", "stability": "stable", "summary": "In Kubernetes, namespaces provides a mechanism for isolating groups of resources within a single cluster." }, "fqn": "cdk8s-plus-21.Namespace", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/namespace.ts", "line": 58 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.NamespaceProps" } } ] }, "interfaces": [ "cdk8s-plus-21.INamespaceSelector" ], "kind": "class", "locationInModule": { "filename": "src/namespace.ts", "line": 44 }, "methods": [ { "docs": { "see": "INamespaceSelector.toNamespaceSelectorConfig()", "stability": "stable", "summary": "Return the configuration of this selector." }, "locationInModule": { "filename": "src/namespace.ts", "line": 70 }, "name": "toNamespaceSelectorConfig", "overrides": "cdk8s-plus-21.INamespaceSelector", "returns": { "type": { "fqn": "cdk8s-plus-21.NamespaceSelectorConfig" } } } ], "name": "Namespace", "properties": [ { "const": true, "docs": { "see": "https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/#automatic-labelling", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/namespace.ts", "line": 49 }, "name": "NAME_LABEL", "static": true, "type": { "primitive": "string" } }, { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/namespace.ts", "line": 54 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/namespace.ts", "line": 56 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } } ], "symbolId": "src/namespace:Namespace" }, "cdk8s-plus-21.NamespaceProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `Namespace`." }, "fqn": "cdk8s-plus-21.NamespaceProps", "interfaces": [ "cdk8s-plus-21.ResourceProps" ], "kind": "interface", "locationInModule": { "filename": "src/namespace.ts", "line": 36 }, "name": "NamespaceProps", "symbolId": "src/namespace:NamespaceProps" }, "cdk8s-plus-21.NamespaceSelectorConfig": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Configuration for selecting namespaces." }, "fqn": "cdk8s-plus-21.NamespaceSelectorConfig", "kind": "interface", "locationInModule": { "filename": "src/namespace.ts", "line": 10 }, "name": "NamespaceSelectorConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "A selector to select namespaces by labels." }, "immutable": true, "locationInModule": { "filename": "src/namespace.ts", "line": 15 }, "name": "labelSelector", "optional": true, "type": { "fqn": "cdk8s-plus-21.LabelSelector" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "A list of names to select namespaces by names." }, "immutable": true, "locationInModule": { "filename": "src/namespace.ts", "line": 20 }, "name": "names", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/namespace:NamespaceSelectorConfig" }, "cdk8s-plus-21.Namespaces": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents a group of namespaces." }, "fqn": "cdk8s-plus-21.Namespaces", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/namespace.ts", "line": 133 }, "parameters": [ { "name": "expressions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.LabelExpression" }, "kind": "array" } } }, { "name": "names", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "name": "labels", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ] }, "interfaces": [ "cdk8s-plus-21.INamespaceSelector" ], "kind": "class", "locationInModule": { "filename": "src/namespace.ts", "line": 117 }, "methods": [ { "docs": { "stability": "stable", "summary": "Select all namespaces." }, "locationInModule": { "filename": "src/namespace.ts", "line": 129 }, "name": "all", "returns": { "type": { "fqn": "cdk8s-plus-21.Namespaces" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Select specific namespaces." }, "locationInModule": { "filename": "src/namespace.ts", "line": 122 }, "name": "select", "parameters": [ { "name": "options", "type": { "fqn": "cdk8s-plus-21.NamespacesSelectOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Namespaces" } }, "static": true }, { "docs": { "see": "INamespaceSelector.toNamespaceSelectorConfig()", "stability": "stable", "summary": "Return the configuration of this selector." }, "locationInModule": { "filename": "src/namespace.ts", "line": 141 }, "name": "toNamespaceSelectorConfig", "overrides": "cdk8s-plus-21.INamespaceSelector", "returns": { "type": { "fqn": "cdk8s-plus-21.NamespaceSelectorConfig" } } } ], "name": "Namespaces", "symbolId": "src/namespace:Namespaces" }, "cdk8s-plus-21.NamespacesSelectOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `Namespaces.select`." }, "fqn": "cdk8s-plus-21.NamespacesSelectOptions", "kind": "interface", "locationInModule": { "filename": "src/namespace.ts", "line": 86 }, "name": "NamespacesSelectOptions", "properties": [ { "abstract": true, "docs": { "default": "- no selector requirements.", "remarks": "The selectors query labels, just like the `labels` property, but they\nprovide a more advanced matching mechanism.", "stability": "stable", "summary": "Namespaces must satisfy these selectors." }, "immutable": true, "locationInModule": { "filename": "src/namespace.ts", "line": 103 }, "name": "expressions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.LabelExpression" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- no strict labels requirements.", "remarks": "This is equivalent to using an 'Is' selector.", "stability": "stable", "summary": "Labels the namespaces must have." }, "immutable": true, "locationInModule": { "filename": "src/namespace.ts", "line": 94 }, "name": "labels", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no name requirements.", "stability": "stable", "summary": "Namespaces names must be one of these." }, "immutable": true, "locationInModule": { "filename": "src/namespace.ts", "line": 110 }, "name": "names", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/namespace:NamespacesSelectOptions" }, "cdk8s-plus-21.Node": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents a node in the cluster." }, "fqn": "cdk8s-plus-21.Node", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 1110 }, "methods": [ { "docs": { "stability": "stable", "summary": "Match a node by its labels." }, "locationInModule": { "filename": "src/pod.ts", "line": 1115 }, "name": "labeled", "parameters": [ { "name": "labelSelector", "type": { "fqn": "cdk8s-plus-21.NodeLabelQuery" }, "variadic": true } ], "returns": { "type": { "fqn": "cdk8s-plus-21.LabeledNode" } }, "static": true, "variadic": true }, { "docs": { "stability": "stable", "summary": "Match a node by its name." }, "locationInModule": { "filename": "src/pod.ts", "line": 1122 }, "name": "named", "parameters": [ { "name": "nodeName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.NamedNode" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Match a node by its taints." }, "locationInModule": { "filename": "src/pod.ts", "line": 1129 }, "name": "tainted", "parameters": [ { "name": "taintSelector", "type": { "fqn": "cdk8s-plus-21.NodeTaintQuery" }, "variadic": true } ], "returns": { "type": { "fqn": "cdk8s-plus-21.TaintedNode" } }, "static": true, "variadic": true } ], "name": "Node", "symbolId": "src/pod:Node" }, "cdk8s-plus-21.NodeLabelQuery": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents a query that can be performed against nodes with labels." }, "fqn": "cdk8s-plus-21.NodeLabelQuery", "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 846 }, "methods": [ { "docs": { "stability": "stable", "summary": "Requires label `key` to not exist." }, "locationInModule": { "filename": "src/pod.ts", "line": 879 }, "name": "doesNotExist", "parameters": [ { "name": "key", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.NodeLabelQuery" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Requires label `key` to exist." }, "locationInModule": { "filename": "src/pod.ts", "line": 872 }, "name": "exists", "parameters": [ { "name": "key", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.NodeLabelQuery" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Requires value of label `key` to greater than all elements in `values`." }, "locationInModule": { "filename": "src/pod.ts", "line": 886 }, "name": "gt", "parameters": [ { "name": "key", "type": { "primitive": "string" } }, { "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.NodeLabelQuery" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Requires value of label `key` to be one of `values`." }, "locationInModule": { "filename": "src/pod.ts", "line": 858 }, "name": "in", "parameters": [ { "name": "key", "type": { "primitive": "string" } }, { "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.NodeLabelQuery" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Requires value of label `key` to equal `value`." }, "locationInModule": { "filename": "src/pod.ts", "line": 851 }, "name": "is", "parameters": [ { "name": "key", "type": { "primitive": "string" } }, { "name": "value", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.NodeLabelQuery" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Requires value of label `key` to less than all elements in `values`." }, "locationInModule": { "filename": "src/pod.ts", "line": 893 }, "name": "lt", "parameters": [ { "name": "key", "type": { "primitive": "string" } }, { "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.NodeLabelQuery" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Requires value of label `key` to be none of `values`." }, "locationInModule": { "filename": "src/pod.ts", "line": 865 }, "name": "notIn", "parameters": [ { "name": "key", "type": { "primitive": "string" } }, { "name": "values", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.NodeLabelQuery" } }, "static": true } ], "name": "NodeLabelQuery", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 898 }, "name": "key", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 899 }, "name": "operator", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 900 }, "name": "values", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/pod:NodeLabelQuery" }, "cdk8s-plus-21.NodeTaintQuery": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Taint queries that can be perfomed against nodes." }, "fqn": "cdk8s-plus-21.NodeTaintQuery", "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 996 }, "methods": [ { "docs": { "stability": "stable", "summary": "Matches any taint." }, "locationInModule": { "filename": "src/pod.ts", "line": 1015 }, "name": "any", "returns": { "type": { "fqn": "cdk8s-plus-21.NodeTaintQuery" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Matches a tain with any value of a specific key." }, "locationInModule": { "filename": "src/pod.ts", "line": 1008 }, "name": "exists", "parameters": [ { "name": "key", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.NodeTaintQueryOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.NodeTaintQuery" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Matches a taint with a specific key and value." }, "locationInModule": { "filename": "src/pod.ts", "line": 1001 }, "name": "is", "parameters": [ { "name": "key", "type": { "primitive": "string" } }, { "name": "value", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.NodeTaintQueryOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.NodeTaintQuery" } }, "static": true } ], "name": "NodeTaintQuery", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1020 }, "name": "operator", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1023 }, "name": "effect", "optional": true, "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1024 }, "name": "evictAfter", "optional": true, "type": { "fqn": "cdk8s.Duration" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1021 }, "name": "key", "optional": true, "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1022 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/pod:NodeTaintQuery" }, "cdk8s-plus-21.NodeTaintQueryOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `NodeTaintQuery`." }, "fqn": "cdk8s-plus-21.NodeTaintQueryOptions", "kind": "interface", "locationInModule": { "filename": "src/pod.ts", "line": 976 }, "name": "NodeTaintQueryOptions", "properties": [ { "abstract": true, "docs": { "default": "- all effects are matched.", "stability": "stable", "summary": "The taint effect to match." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 982 }, "name": "effect", "optional": true, "type": { "fqn": "cdk8s-plus-21.TaintEffect" } }, { "abstract": true, "docs": { "default": "- bound forever.", "remarks": "Only applies for the `NO_EXECUTE` effect.", "stability": "stable", "summary": "How much time should a pod that tolerates the `NO_EXECUTE` effect be bound to the node." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 990 }, "name": "evictAfter", "optional": true, "type": { "fqn": "cdk8s.Duration" } } ], "symbolId": "src/pod:NodeTaintQueryOptions" }, "cdk8s-plus-21.NonApiResource": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Factory for creating non api resources." }, "fqn": "cdk8s-plus-21.NonApiResource", "interfaces": [ "cdk8s-plus-21.IApiEndpoint" ], "kind": "class", "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 540 }, "methods": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 542 }, "name": "of", "parameters": [ { "name": "url", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.NonApiResource" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Return the IApiResource this object represents." }, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 548 }, "name": "asApiResource", "overrides": "cdk8s-plus-21.IApiEndpoint", "returns": { "optional": true, "type": { "fqn": "cdk8s-plus-21.IApiResource" } } }, { "docs": { "stability": "stable", "summary": "Return the non resource url this object represents." }, "locationInModule": { "filename": "src/api-resource.generated.ts", "line": 552 }, "name": "asNonApiResource", "overrides": "cdk8s-plus-21.IApiEndpoint", "returns": { "optional": true, "type": { "primitive": "string" } } } ], "name": "NonApiResource", "symbolId": "src/api-resource.generated:NonApiResource" }, "cdk8s-plus-21.PathMapping": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Maps a string key to a path within a volume." }, "fqn": "cdk8s-plus-21.PathMapping", "kind": "interface", "locationInModule": { "filename": "src/volume.ts", "line": 404 }, "name": "PathMapping", "properties": [ { "abstract": true, "docs": { "remarks": "May not be an absolute\npath. May not contain the path element '..'. May not start with the string\n'..'.", "stability": "stable", "summary": "The relative path of the file to map the key to." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 410 }, "name": "path", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "If not specified, the volume defaultMode will be used. This might be\nin conflict with other options that affect the file mode, like fsGroup, and\nthe result can be other mode bits set.", "stability": "stable", "summary": "Optional: mode bits to use on this file, must be a value between 0 and 0777." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 418 }, "name": "mode", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/volume:PathMapping" }, "cdk8s-plus-21.PercentOrAbsolute": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Union like class repsenting either a ration in percents or an absolute number." }, "fqn": "cdk8s-plus-21.PercentOrAbsolute", "kind": "class", "locationInModule": { "filename": "src/deployment.ts", "line": 266 }, "methods": [ { "docs": { "stability": "stable", "summary": "Absolute number." }, "locationInModule": { "filename": "src/deployment.ts", "line": 278 }, "name": "absolute", "parameters": [ { "name": "num", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.PercentOrAbsolute" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Percent ratio." }, "locationInModule": { "filename": "src/deployment.ts", "line": 271 }, "name": "percent", "parameters": [ { "name": "percent", "type": { "primitive": "number" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.PercentOrAbsolute" } }, "static": true }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/deployment.ts", "line": 284 }, "name": "isZero", "returns": { "type": { "primitive": "boolean" } } } ], "name": "PercentOrAbsolute", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/deployment.ts", "line": 282 }, "name": "value", "type": { "primitive": "any" } } ], "symbolId": "src/deployment:PercentOrAbsolute" }, "cdk8s-plus-21.PersistentVolume": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Resource", "docs": { "remarks": "It is a resource in the cluster just like a node is a cluster resource.\nPVs are volume plugins like Volumes, but have a lifecycle independent of any\nindividual Pod that uses the PV. This API object captures the details of the\nimplementation of the storage, be that NFS, iSCSI, or a\ncloud-provider-specific storage system.", "stability": "stable", "summary": "A PersistentVolume (PV) is a piece of storage in the cluster that has been provisioned by an administrator or dynamically provisioned using Storage Classes." }, "fqn": "cdk8s-plus-21.PersistentVolume", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pv.ts", "line": 140 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.PersistentVolumeProps" } } ], "protected": true }, "interfaces": [ "cdk8s-plus-21.IPersistentVolume", "cdk8s-plus-21.IStorage" ], "kind": "class", "locationInModule": { "filename": "src/pv.ts", "line": 87 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports a pv from the cluster as a reference." }, "locationInModule": { "filename": "src/pv.ts", "line": 93 }, "name": "fromPersistentVolumeName", "parameters": [ { "docs": { "summary": "The name of the pv to reference." }, "name": "volumeName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.IPersistentVolume" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Convert the piece of storage into a concrete volume." }, "locationInModule": { "filename": "src/pv.ts", "line": 215 }, "name": "asVolume", "overrides": "cdk8s-plus-21.IStorage", "returns": { "type": { "fqn": "cdk8s-plus-21.Volume" } } }, { "docs": { "remarks": "Note that you must also bind the claim to the volume.", "see": "https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding", "stability": "stable", "summary": "Bind a volume to a specific claim." }, "locationInModule": { "filename": "src/pv.ts", "line": 208 }, "name": "bind", "parameters": [ { "docs": { "summary": "The PVC to bind to." }, "name": "claim", "type": { "fqn": "cdk8s-plus-21.IPersistentVolumeClaim" } } ] }, { "docs": { "remarks": "Note that this method will throw in case the volume is already claimed.", "see": "https://kubernetes.io/docs/concepts/storage/persistent-volumes/#reserving-a-persistentvolume", "stability": "stable", "summary": "Reserve a `PersistentVolume` by creating a `PersistentVolumeClaim` that is wired to claim this volume." }, "locationInModule": { "filename": "src/pv.ts", "line": 183 }, "name": "reserve", "returns": { "type": { "fqn": "cdk8s-plus-21.PersistentVolumeClaim" } } } ], "name": "PersistentVolume", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 104 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable", "summary": "Volume mode of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 118 }, "name": "mode", "type": { "fqn": "cdk8s-plus-21.PersistentVolumeMode" } }, { "docs": { "stability": "stable", "summary": "Reclaim policy of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 138 }, "name": "reclaimPolicy", "type": { "fqn": "cdk8s-plus-21.PersistentVolumeReclaimPolicy" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 106 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Access modes requirement of this claim." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 163 }, "name": "accessModes", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.PersistentVolumeAccessMode" }, "kind": "array" } } }, { "docs": { "remarks": "Undefined means this volume is not yet\nclaimed by any PVC.", "stability": "stable", "summary": "PVC this volume is bound to." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 171 }, "name": "claim", "optional": true, "type": { "fqn": "cdk8s-plus-21.IPersistentVolumeClaim" } }, { "docs": { "stability": "stable", "summary": "Mount options of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 133 }, "name": "mountOptions", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Storage size of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 113 }, "name": "storage", "optional": true, "type": { "fqn": "cdk8s.Size" } }, { "docs": { "stability": "stable", "summary": "Storage class this volume belongs to." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 123 }, "name": "storageClassName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/pv:PersistentVolume" }, "cdk8s-plus-21.PersistentVolumeAccessMode": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Access Modes." }, "fqn": "cdk8s-plus-21.PersistentVolumeAccessMode", "kind": "enum", "locationInModule": { "filename": "src/pvc.ts", "line": 187 }, "members": [ { "docs": { "remarks": "ReadWriteOnce access mode still can allow multiple pods to access\nthe volume when the pods are running on the same node.", "stability": "stable", "summary": "The volume can be mounted as read-write by a single node." }, "name": "READ_WRITE_ONCE" }, { "docs": { "stability": "stable", "summary": "The volume can be mounted as read-only by many nodes." }, "name": "READ_ONLY_MANY" }, { "docs": { "stability": "stable", "summary": "The volume can be mounted as read-write by many nodes." }, "name": "READ_WRITE_MANY" }, { "docs": { "remarks": "Use ReadWriteOncePod access mode if you want to ensure that\nonly one pod across whole cluster can read that PVC or write to it.\nThis is only supported for CSI volumes and Kubernetes version 1.22+.", "stability": "stable", "summary": "The volume can be mounted as read-write by a single Pod." }, "name": "READ_WRITE_ONCE_POD" } ], "name": "PersistentVolumeAccessMode", "symbolId": "src/pvc:PersistentVolumeAccessMode" }, "cdk8s-plus-21.PersistentVolumeClaim": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Resource", "docs": { "remarks": "It is similar to a Pod. Pods consume node resources and PVCs consume PV resources.\nPods can request specific levels of resources (CPU and Memory).\nClaims can request specific size and access modes", "stability": "stable", "summary": "A PersistentVolumeClaim (PVC) is a request for storage by a user." }, "fqn": "cdk8s-plus-21.PersistentVolumeClaim", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pvc.ts", "line": 120 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.PersistentVolumeClaimProps" } } ] }, "interfaces": [ "cdk8s-plus-21.IPersistentVolumeClaim" ], "kind": "class", "locationInModule": { "filename": "src/pvc.ts", "line": 80 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports a pvc from the cluster as a reference." }, "locationInModule": { "filename": "src/pvc.ts", "line": 86 }, "name": "fromClaimName", "parameters": [ { "docs": { "summary": "The name of the pvc to reference." }, "name": "claimName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.IPersistentVolumeClaim" } }, "static": true }, { "docs": { "remarks": "Note that you must also bind the volume to the claim.", "see": "https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding", "stability": "stable", "summary": "Bind a claim to a specific volume." }, "locationInModule": { "filename": "src/pvc.ts", "line": 161 }, "name": "bind", "parameters": [ { "docs": { "summary": "The PV to bind to." }, "name": "vol", "type": { "fqn": "cdk8s-plus-21.IPersistentVolume" } } ] } ], "name": "PersistentVolumeClaim", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/pvc.ts", "line": 97 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/pvc.ts", "line": 99 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Volume mode requirement of this claim." }, "immutable": true, "locationInModule": { "filename": "src/pvc.ts", "line": 109 }, "name": "volumeMode", "type": { "fqn": "cdk8s-plus-21.PersistentVolumeMode" } }, { "docs": { "stability": "stable", "summary": "Access modes requirement of this claim." }, "immutable": true, "locationInModule": { "filename": "src/pvc.ts", "line": 141 }, "name": "accessModes", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.PersistentVolumeAccessMode" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Storage requirement of this claim." }, "immutable": true, "locationInModule": { "filename": "src/pvc.ts", "line": 104 }, "name": "storage", "optional": true, "type": { "fqn": "cdk8s.Size" } }, { "docs": { "stability": "stable", "summary": "Storage class requirment of this claim." }, "immutable": true, "locationInModule": { "filename": "src/pvc.ts", "line": 114 }, "name": "storageClassName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "remarks": "Undefined means the claim is not bound\nto any specific volume.", "stability": "stable", "summary": "PV this claim is bound to." }, "immutable": true, "locationInModule": { "filename": "src/pvc.ts", "line": 149 }, "name": "volume", "optional": true, "type": { "fqn": "cdk8s-plus-21.IPersistentVolume" } } ], "symbolId": "src/pvc:PersistentVolumeClaim" }, "cdk8s-plus-21.PersistentVolumeClaimProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `PersistentVolumeClaim`." }, "fqn": "cdk8s-plus-21.PersistentVolumeClaimProps", "interfaces": [ "cdk8s-plus-21.ResourceProps" ], "kind": "interface", "locationInModule": { "filename": "src/pvc.ts", "line": 17 }, "name": "PersistentVolumeClaimProps", "properties": [ { "abstract": true, "docs": { "default": "- No access modes requirement.", "see": "https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", "stability": "stable", "summary": "Contains the access modes the volume should support." }, "immutable": true, "locationInModule": { "filename": "src/pvc.ts", "line": 25 }, "name": "accessModes", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.PersistentVolumeAccessMode" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No storage requirement.", "see": "https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources", "stability": "stable", "summary": "Minimum storage size the volume should have." }, "immutable": true, "locationInModule": { "filename": "src/pvc.ts", "line": 33 }, "name": "storage", "optional": true, "type": { "fqn": "cdk8s.Size" } }, { "abstract": true, "docs": { "default": "- Not set.", "remarks": "- If the admission plugin is turned on, the storage class marked as default will be used.\n- If the admission plugin is turned off, the pvc can only be bound to volumes without a storage class.", "see": "https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1", "stability": "stable", "summary": "Name of the StorageClass required by the claim. When this property is not set, the behavior is as follows:." }, "immutable": true, "locationInModule": { "filename": "src/pvc.ts", "line": 45 }, "name": "storageClassName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No specific volume binding.", "remarks": "The control plane still checks that storage class, access modes,\nand requested storage size on the volume are valid.\n\nNote that in order to guarantee a proper binding, the volume should\nalso define a `claimRef` referring to this claim. Otherwise, the volume may be\nclaimed be other pvc's before it gets a chance to bind to this one.\n\nIf the volume is managed (i.e not imported), you can use `pv.claim()` to easily\ncreate a bi-directional bounded claim.", "see": "https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding.", "stability": "stable", "summary": "The PersistentVolume backing this claim." }, "immutable": true, "locationInModule": { "filename": "src/pvc.ts", "line": 70 }, "name": "volume", "optional": true, "type": { "fqn": "cdk8s-plus-21.IPersistentVolume" } }, { "abstract": true, "docs": { "default": "VolumeMode.FILE_SYSTEM", "stability": "stable", "summary": "Defines what type of volume is required by the claim." }, "immutable": true, "locationInModule": { "filename": "src/pvc.ts", "line": 52 }, "name": "volumeMode", "optional": true, "type": { "fqn": "cdk8s-plus-21.PersistentVolumeMode" } } ], "symbolId": "src/pvc:PersistentVolumeClaimProps" }, "cdk8s-plus-21.PersistentVolumeClaimVolumeOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for a PersistentVolumeClaim-based volume." }, "fqn": "cdk8s-plus-21.PersistentVolumeClaimVolumeOptions", "kind": "interface", "locationInModule": { "filename": "src/volume.ts", "line": 469 }, "name": "PersistentVolumeClaimVolumeOptions", "properties": [ { "abstract": true, "docs": { "default": "- Derived from the PVC name.", "stability": "stable", "summary": "The volume name." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 475 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Will force the ReadOnly setting in VolumeMounts." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 482 }, "name": "readOnly", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/volume:PersistentVolumeClaimVolumeOptions" }, "cdk8s-plus-21.PersistentVolumeMode": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Volume Modes." }, "fqn": "cdk8s-plus-21.PersistentVolumeMode", "kind": "enum", "locationInModule": { "filename": "src/pvc.ts", "line": 219 }, "members": [ { "docs": { "remarks": "If the volume is backed by a block device and the device is empty,\nKubernetes creates a filesystem on the device before mounting it\nfor the first time.", "stability": "stable", "summary": "Volume is ounted into Pods into a directory." }, "name": "FILE_SYSTEM" }, { "docs": { "remarks": "Such volume is presented into a Pod as a block device,\nwithout any filesystem on it. This mode is useful to provide a Pod the fastest possible way\nto access a volume, without any filesystem layer between the Pod\nand the volume. On the other hand, the application running in\nthe Pod must know how to handle a raw block device", "stability": "stable", "summary": "Use a volume as a raw block device." }, "name": "BLOCK" } ], "name": "PersistentVolumeMode", "symbolId": "src/pvc:PersistentVolumeMode" }, "cdk8s-plus-21.PersistentVolumeProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `PersistentVolume`." }, "fqn": "cdk8s-plus-21.PersistentVolumeProps", "interfaces": [ "cdk8s-plus-21.ResourceProps" ], "kind": "interface", "locationInModule": { "filename": "src/pv.ts", "line": 17 }, "name": "PersistentVolumeProps", "properties": [ { "abstract": true, "docs": { "default": "- No access modes.", "see": "https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes", "stability": "stable", "summary": "Contains all ways the volume can be mounted." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 25 }, "name": "accessModes", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.PersistentVolumeAccessMode" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- Not bound to a specific claim.", "remarks": "Expected to be non-nil when bound.", "see": "https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding", "stability": "stable", "summary": "Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 42 }, "name": "claim", "optional": true, "type": { "fqn": "cdk8s-plus-21.IPersistentVolumeClaim" } }, { "abstract": true, "docs": { "default": "- No options.", "see": "https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options", "stability": "stable", "summary": "A list of mount options, e.g. [\"ro\", \"soft\"]. Not validated - mount will simply fail if one is invalid." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 50 }, "name": "mountOptions", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "PersistentVolumeReclaimPolicy.RETAIN", "remarks": "The reclaim policy tells the cluster what to do with\nthe volume after it has been released of its claim.", "see": "https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming", "stability": "stable", "summary": "When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 60 }, "name": "reclaimPolicy", "optional": true, "type": { "fqn": "cdk8s-plus-21.PersistentVolumeReclaimPolicy" } }, { "abstract": true, "docs": { "default": "- No specified.", "see": "https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources", "stability": "stable", "summary": "What is the storage capacity of this volume." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 33 }, "name": "storage", "optional": true, "type": { "fqn": "cdk8s.Size" } }, { "abstract": true, "docs": { "default": "- Volume does not belong to any storage class.", "stability": "stable", "summary": "Name of StorageClass to which this persistent volume belongs." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 67 }, "name": "storageClassName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "VolumeMode.FILE_SYSTEM", "stability": "stable", "summary": "Defines what type of volume is required by the claim." }, "immutable": true, "locationInModule": { "filename": "src/pv.ts", "line": 74 }, "name": "volumeMode", "optional": true, "type": { "fqn": "cdk8s-plus-21.PersistentVolumeMode" } } ], "symbolId": "src/pv:PersistentVolumeProps" }, "cdk8s-plus-21.PersistentVolumeReclaimPolicy": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Reclaim Policies." }, "fqn": "cdk8s-plus-21.PersistentVolumeReclaimPolicy", "kind": "enum", "locationInModule": { "filename": "src/pv.ts", "line": 240 }, "members": [ { "docs": { "remarks": "When the PersistentVolumeClaim is deleted, the PersistentVolume still exists and the\nvolume is considered \"released\". But it is not yet available for another claim\nbecause the previous claimant's data remains on the volume.\nAn administrator can manually reclaim the volume with the following steps:\n\n1. Delete the PersistentVolume. The associated storage asset in external\n infrastructure (such as an AWS EBS, GCE PD, Azure Disk, or Cinder volume) still exists after the PV is deleted.\n2. Manually clean up the data on the associated storage asset accordingly.\n3. Manually delete the associated storage asset.\n\nIf you want to reuse the same storage asset, create a new PersistentVolume\nwith the same storage asset definition.", "stability": "stable", "summary": "The Retain reclaim policy allows for manual reclamation of the resource." }, "name": "RETAIN" }, { "docs": { "remarks": "Volumes that were dynamically provisioned inherit the reclaim policy of their StorageClass, which defaults to Delete.\nThe administrator should configure the StorageClass according to users' expectations; otherwise,\nthe PV must be edited or patched after it is created", "stability": "stable", "summary": "For volume plugins that support the Delete reclaim policy, deletion removes both the PersistentVolume object from Kubernetes, as well as the associated storage asset in the external infrastructure, such as an AWS EBS, GCE PD, Azure Disk, or Cinder volume." }, "name": "DELETE" } ], "name": "PersistentVolumeReclaimPolicy", "symbolId": "src/pv:PersistentVolumeReclaimPolicy" }, "cdk8s-plus-21.Pod": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.AbstractPod", "docs": { "remarks": "This resource is\ncreated by clients and scheduled onto hosts.", "stability": "stable", "summary": "Pod is a collection of containers that can run on a host." }, "fqn": "cdk8s-plus-21.Pod", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 481 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.PodProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 464 }, "name": "Pod", "properties": [ { "const": true, "docs": { "remarks": "It provides\na unique and stable identifier for the pod.", "stability": "stable", "summary": "This label is autoamtically added by cdk8s to any pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 470 }, "name": "ADDRESS_LABEL", "static": true, "type": { "primitive": "string" } }, { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 475 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 495 }, "name": "podMetadata", "overrides": "cdk8s-plus-21.AbstractPod", "type": { "fqn": "cdk8s.ApiObjectMetadataDefinition" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 477 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 479 }, "name": "scheduling", "type": { "fqn": "cdk8s-plus-21.PodScheduling" } } ], "symbolId": "src/pod:Pod" }, "cdk8s-plus-21.PodDns": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Holds dns settings of the pod." }, "fqn": "cdk8s-plus-21.PodDns", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 610 }, "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.PodDnsProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 584 }, "methods": [ { "docs": { "stability": "stable", "summary": "Add a nameserver." }, "locationInModule": { "filename": "src/pod.ts", "line": 644 }, "name": "addNameserver", "parameters": [ { "name": "nameservers", "type": { "primitive": "string" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add a custom option." }, "locationInModule": { "filename": "src/pod.ts", "line": 658 }, "name": "addOption", "parameters": [ { "name": "options", "type": { "fqn": "cdk8s-plus-21.DnsOption" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add a search domain." }, "locationInModule": { "filename": "src/pod.ts", "line": 651 }, "name": "addSearch", "parameters": [ { "name": "searches", "type": { "primitive": "string" }, "variadic": true } ], "variadic": true } ], "name": "PodDns", "properties": [ { "docs": { "stability": "stable", "summary": "Whether or not the pods hostname is set to its FQDN." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 604 }, "name": "hostnameAsFQDN", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable", "summary": "Nameservers defined for this pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 623 }, "name": "nameservers", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Custom dns options defined for this pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 637 }, "name": "options", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.DnsOption" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "The DNS policy of this pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 589 }, "name": "policy", "type": { "fqn": "cdk8s-plus-21.DnsPolicy" } }, { "docs": { "stability": "stable", "summary": "Search domains defined for this pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 630 }, "name": "searches", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "remarks": "Undefined means its set to a system-defined value.", "stability": "stable", "summary": "The configured hostname of the pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 594 }, "name": "hostname", "optional": true, "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The configured subdomain of the pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 599 }, "name": "subdomain", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/pod:PodDns" }, "cdk8s-plus-21.PodDnsProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `PodDns`." }, "fqn": "cdk8s-plus-21.PodDnsProps", "kind": "interface", "locationInModule": { "filename": "src/pod.ts", "line": 517 }, "name": "PodDnsProps", "properties": [ { "abstract": true, "docs": { "default": "- Set to a system-defined value.", "stability": "stable", "summary": "Specifies the hostname of the Pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 524 }, "name": "hostname", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "remarks": "In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname).\nIn Windows containers, this means setting the registry value of hostname for the registry\nkey HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN.\nIf a pod does not have FQDN, this has no effect.", "stability": "stable", "summary": "If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default)." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 542 }, "name": "hostnameAsFQDN", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "There can be at most 3 IP addresses specified.\nWhen the policy is set to \"NONE\", the list must contain at least one IP address,\notherwise this property is optional.\nThe servers listed will be combined to the base nameservers generated from\nthe specified DNS policy with duplicate addresses removed.", "stability": "stable", "summary": "A list of IP addresses that will be used as DNS servers for the Pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 560 }, "name": "nameservers", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "The contents in this property\nwill be merged to the options generated from the specified DNS policy.\nDuplicate entries are removed.", "stability": "stable", "summary": "List of objects where each object may have a name property (required) and a value property (optional)." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 578 }, "name": "options", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.DnsOption" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "DnsPolicy.CLUSTER_FIRST", "remarks": "If policy is set to `None`, other configuration must be supplied.", "stability": "stable", "summary": "Set DNS policy for the pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 551 }, "name": "policy", "optional": true, "type": { "fqn": "cdk8s-plus-21.DnsPolicy" } }, { "abstract": true, "docs": { "remarks": "When specified, the provided list will be merged into the base\nsearch domain names generated from the chosen DNS policy.\nDuplicate domain names are removed.\n\nKubernetes allows for at most 6 search domains.", "stability": "stable", "summary": "A list of DNS search domains for hostname lookup in the Pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 570 }, "name": "searches", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No subdomain.", "stability": "stable", "summary": "If specified, the fully qualified Pod hostname will be \"...svc.\"." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 531 }, "name": "subdomain", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/pod:PodDnsProps" }, "cdk8s-plus-21.PodManagementPolicy": { "assembly": "cdk8s-plus-21", "docs": { "remarks": "The default policy is `OrderedReady`, where pods are created in increasing order\n(pod-0, then pod-1, etc) and the controller will wait until each pod is ready before\ncontinuing. When scaling down, the pods are removed in the opposite order.\n\nThe alternative policy is `Parallel` which will create pods in parallel to match the\ndesired scale without waiting, and on scale down will delete all pods at once.", "stability": "stable", "summary": "Controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down." }, "fqn": "cdk8s-plus-21.PodManagementPolicy", "kind": "enum", "locationInModule": { "filename": "src/stateful-set.ts", "line": 18 }, "members": [ { "docs": { "stability": "stable" }, "name": "ORDERED_READY" }, { "docs": { "stability": "stable" }, "name": "PARALLEL" } ], "name": "PodManagementPolicy", "symbolId": "src/stateful-set:PodManagementPolicy" }, "cdk8s-plus-21.PodProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `Pod`." }, "fqn": "cdk8s-plus-21.PodProps", "interfaces": [ "cdk8s-plus-21.AbstractPodProps" ], "kind": "interface", "locationInModule": { "filename": "src/pod.ts", "line": 388 }, "name": "PodProps", "symbolId": "src/pod:PodProps" }, "cdk8s-plus-21.PodScheduling": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Controls the pod scheduling strategy." }, "fqn": "cdk8s-plus-21.PodScheduling", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 1247 }, "parameters": [ { "name": "instance", "type": { "fqn": "cdk8s-plus-21.AbstractPod" } } ] }, "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 1236 }, "methods": [ { "docs": { "remarks": "The scheduler ignores the Pod, and the kubelet on the named node\ntries to place the Pod on that node. Overrules any affinity rules of the pod.\n\nSome limitations of static assignment are:\n\n- If the named node does not exist, the Pod will not run, and in some\n cases may be automatically deleted.\n- If the named node does not have the resources to accommodate the Pod,\n the Pod will fail and its reason will indicate why, for example OutOfmemory or OutOfcpu.\n- Node names in cloud environments are not always predictable or stable.\n\nWill throw is the pod is already assigned to named node.\n\nUnder the hood, this method utilizes the `nodeName` property.", "stability": "stable", "summary": "Assign this pod a specific node by name." }, "locationInModule": { "filename": "src/pod.ts", "line": 1267 }, "name": "assign", "parameters": [ { "name": "node", "type": { "fqn": "cdk8s-plus-21.NamedNode" } } ] }, { "docs": { "remarks": "Attracting to multiple nodes (i.e invoking this method multiple times) acts as\nan OR condition, meaning the pod will be assigned to either one of the nodes.\n\nUnder the hood, this method utilizes the `nodeAffinity` property.", "see": "https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity", "stability": "stable", "summary": "Attract this pod to a node matched by selectors. You can select a node by using `Node.labeled()`." }, "locationInModule": { "filename": "src/pod.ts", "line": 1321 }, "name": "attract", "parameters": [ { "name": "node", "type": { "fqn": "cdk8s-plus-21.LabeledNode" } }, { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.PodSchedulingAttractOptions" } } ] }, { "docs": { "remarks": "A selection can be one of:\n\n- An instance of a `Pod`.\n- An instance of a `Workload` (e.g `Deployment`, `StatefulSet`).\n- An un-managed pod that can be selected via `Pod.select()`.\n\nCo-locating with multiple selections ((i.e invoking this method multiple times)) acts as\nan AND condition. meaning the pod will be assigned to a node that satisfies all\nselections (i.e runs at least one pod that satisifies each selection).\n\nUnder the hood, this method utilizes the `podAffinity` property.", "see": "https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity", "stability": "stable", "summary": "Co-locate this pod with a scheduling selection." }, "locationInModule": { "filename": "src/pod.ts", "line": 1350 }, "name": "colocate", "parameters": [ { "name": "selector", "type": { "fqn": "cdk8s-plus-21.IPodSelector" } }, { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.PodSchedulingColocateOptions" } } ] }, { "docs": { "remarks": "A selection can be one of:\n\n- An instance of a `Pod`.\n- An instance of a `Workload` (e.g `Deployment`, `StatefulSet`).\n- An un-managed pod that can be selected via `Pod.select()`.\n\nSeperating from multiple selections acts as an AND condition. meaning the pod\nwill not be assigned to a node that satisfies all selections (i.e runs at least one pod that satisifies each selection).\n\nUnder the hood, this method utilizes the `podAntiAffinity` property.", "see": "https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#inter-pod-affinity-and-anti-affinity", "stability": "stable", "summary": "Seperate this pod from a scheduling selection." }, "locationInModule": { "filename": "src/pod.ts", "line": 1379 }, "name": "separate", "parameters": [ { "name": "selector", "type": { "fqn": "cdk8s-plus-21.IPodSelector" } }, { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.PodSchedulingSeparateOptions" } } ] }, { "docs": { "remarks": "You can put multiple taints on the same node and multiple tolerations on the same pod.\nThe way Kubernetes processes multiple taints and tolerations is like a filter: start with\nall of a node's taints, then ignore the ones for which the pod has a matching toleration;\nthe remaining un-ignored taints have the indicated effects on the pod. In particular:\n\n- if there is at least one un-ignored taint with effect NoSchedule then Kubernetes will\n not schedule the pod onto that node\n- if there is no un-ignored taint with effect NoSchedule but there is at least one un-ignored\n taint with effect PreferNoSchedule then Kubernetes will try to not schedule the pod onto the node\n- if there is at least one un-ignored taint with effect NoExecute then the pod will be evicted from\n the node (if it is already running on the node), and will not be scheduled onto the node (if it is\n not yet running on the node).\n\nUnder the hood, this method utilizes the `tolerations` property.", "see": "https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/", "stability": "stable", "summary": "Allow this pod to tolerate taints matching these tolerations." }, "locationInModule": { "filename": "src/pod.ts", "line": 1297 }, "name": "tolerate", "parameters": [ { "name": "node", "type": { "fqn": "cdk8s-plus-21.TaintedNode" } } ] } ], "name": "PodScheduling", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1247 }, "name": "instance", "protected": true, "type": { "fqn": "cdk8s-plus-21.AbstractPod" } } ], "symbolId": "src/pod:PodScheduling" }, "cdk8s-plus-21.PodSchedulingAttractOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `PodScheduling.attract`." }, "fqn": "cdk8s-plus-21.PodSchedulingAttractOptions", "kind": "interface", "locationInModule": { "filename": "src/pod.ts", "line": 1224 }, "name": "PodSchedulingAttractOptions", "properties": [ { "abstract": true, "docs": { "default": "- no weight. assignment is assumed to be required (hard).", "stability": "stable", "summary": "Indicates the attraction is optional (soft), with this weight score." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1230 }, "name": "weight", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/pod:PodSchedulingAttractOptions" }, "cdk8s-plus-21.PodSchedulingColocateOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `PodScheduling.colocate`." }, "fqn": "cdk8s-plus-21.PodSchedulingColocateOptions", "kind": "interface", "locationInModule": { "filename": "src/pod.ts", "line": 1186 }, "name": "PodSchedulingColocateOptions", "properties": [ { "abstract": true, "docs": { "default": "- Topology.HOSTNAME", "stability": "stable", "summary": "Which topology to coloate on." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1192 }, "name": "topology", "optional": true, "type": { "fqn": "cdk8s-plus-21.Topology" } }, { "abstract": true, "docs": { "default": "- no weight. co-location is assumed to be required (hard).", "stability": "stable", "summary": "Indicates the co-location is optional (soft), with this weight score." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1199 }, "name": "weight", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/pod:PodSchedulingColocateOptions" }, "cdk8s-plus-21.PodSchedulingSeparateOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `PodScheduling.separate`." }, "fqn": "cdk8s-plus-21.PodSchedulingSeparateOptions", "kind": "interface", "locationInModule": { "filename": "src/pod.ts", "line": 1205 }, "name": "PodSchedulingSeparateOptions", "properties": [ { "abstract": true, "docs": { "default": "- Topology.HOSTNAME", "stability": "stable", "summary": "Which topology to separate on." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1211 }, "name": "topology", "optional": true, "type": { "fqn": "cdk8s-plus-21.Topology" } }, { "abstract": true, "docs": { "default": "- no weight. separation is assumed to be required (hard).", "stability": "stable", "summary": "Indicates the separation is optional (soft), with this weight score." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1218 }, "name": "weight", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/pod:PodSchedulingSeparateOptions" }, "cdk8s-plus-21.PodSecurityContext": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Holds pod-level security attributes and common container settings." }, "fqn": "cdk8s-plus-21.PodSecurityContext", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 707 }, "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.PodSecurityContextProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 697 }, "name": "PodSecurityContext", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 699 }, "name": "ensureNonRoot", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 703 }, "name": "fsGroupChangePolicy", "type": { "fqn": "cdk8s-plus-21.FsGroupChangePolicy" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 720 }, "name": "sysctls", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.Sysctl" }, "kind": "array" } } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 702 }, "name": "fsGroup", "optional": true, "type": { "primitive": "number" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 701 }, "name": "group", "optional": true, "type": { "primitive": "number" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 700 }, "name": "user", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/pod:PodSecurityContext" }, "cdk8s-plus-21.PodSecurityContextProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `PodSecurityContext`." }, "fqn": "cdk8s-plus-21.PodSecurityContextProps", "kind": "interface", "locationInModule": { "filename": "src/pod.ts", "line": 221 }, "name": "PodSecurityContextProps", "properties": [ { "abstract": true, "docs": { "default": "false", "remarks": "If true, the Kubelet will validate the image at runtime to ensure that it does\nnot run as UID 0 (root) and fail to start the container if it does.", "stability": "stable", "summary": "Indicates that the container must run as a non-root user." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 260 }, "name": "ensureNonRoot", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Volume ownership is not changed.", "stability": "stable", "summary": "Modify the ownership and permissions of pod volumes to this GID." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 228 }, "name": "fsGroup", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "FsGroupChangePolicy.ALWAYS", "remarks": "This field will only apply to volume types which support fsGroup based ownership(and permissions).\nIt will have no effect on ephemeral volume types such as: secret, configmaps and emptydir.", "stability": "stable", "summary": "Defines behavior of changing ownership and permission of the volume before being exposed inside Pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 237 }, "name": "fsGroupChangePolicy", "optional": true, "type": { "fqn": "cdk8s-plus-21.FsGroupChangePolicy" } }, { "abstract": true, "docs": { "default": "- Group configured by container runtime", "stability": "stable", "summary": "The GID to run the entrypoint of the container process." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 251 }, "name": "group", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- No sysctls", "remarks": "Pods with unsupported sysctls (by the container runtime) might fail to launch.", "stability": "stable", "summary": "Sysctls hold a list of namespaced sysctls used for the pod." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 268 }, "name": "sysctls", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.Sysctl" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- User specified in image metadata", "stability": "stable", "summary": "The UID to run the entrypoint of the container process." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 244 }, "name": "user", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/pod:PodSecurityContextProps" }, "cdk8s-plus-21.PodSelectOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `Pods.select`." }, "fqn": "cdk8s-plus-21.PodSelectOptions", "kind": "interface", "locationInModule": { "filename": "src/pod.ts", "line": 1035 }, "name": "PodSelectOptions", "properties": [ { "abstract": true, "docs": { "default": "- no expressions requirements.", "stability": "stable", "summary": "Expressions the pods must satisify." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1049 }, "name": "expressions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.LabelExpression" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- no strict labels requirements.", "stability": "stable", "summary": "Labels the pods must have." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1042 }, "name": "labels", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- unset, implies the namespace of the resource this selection is used in.", "remarks": "Use `Namespaces.all()` to allow all namespaces.", "stability": "stable", "summary": "Namespaces the pods are allowed to be in." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1057 }, "name": "namespaces", "optional": true, "type": { "fqn": "cdk8s-plus-21.Namespaces" } } ], "symbolId": "src/pod:PodSelectOptions" }, "cdk8s-plus-21.PodSelectorConfig": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Configuration for selecting pods, optionally in particular namespaces." }, "fqn": "cdk8s-plus-21.PodSelectorConfig", "kind": "interface", "locationInModule": { "filename": "src/pod.ts", "line": 436 }, "name": "PodSelectorConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "A selector to select pods by labels." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 441 }, "name": "labelSelector", "type": { "fqn": "cdk8s-plus-21.LabelSelector" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configuration for selecting which namepsaces are the pods allowed to be in." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 446 }, "name": "namespaces", "optional": true, "type": { "fqn": "cdk8s-plus-21.NamespaceSelectorConfig" } } ], "symbolId": "src/pod:PodSelectorConfig" }, "cdk8s-plus-21.Pods": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents a group of pods." }, "fqn": "cdk8s-plus-21.Pods", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 1073 }, "parameters": [ { "name": "expressions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.LabelExpression" }, "kind": "array" } } }, { "name": "labels", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "name": "namespaces", "optional": true, "type": { "fqn": "cdk8s-plus-21.INamespaceSelector" } } ] }, "interfaces": [ "cdk8s-plus-21.IPodSelector" ], "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 1064 }, "methods": [ { "docs": { "stability": "stable", "summary": "Select pods in the cluster with various selectors." }, "locationInModule": { "filename": "src/pod.ts", "line": 1069 }, "name": "select", "parameters": [ { "name": "options", "type": { "fqn": "cdk8s-plus-21.PodSelectOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Pods" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Return the configuration of this selector." }, "locationInModule": { "filename": "src/pod.ts", "line": 1078 }, "name": "toPodSelectorConfig", "overrides": "cdk8s-plus-21.IPodSelector", "returns": { "type": { "fqn": "cdk8s-plus-21.PodSelectorConfig" } } } ], "name": "Pods", "symbolId": "src/pod:Pods" }, "cdk8s-plus-21.Probe": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic." }, "fqn": "cdk8s-plus-21.Probe", "kind": "class", "locationInModule": { "filename": "src/probe.ts", "line": 101 }, "methods": [ { "docs": { "stability": "stable", "summary": "Defines a probe based on a command which is executed within the container." }, "locationInModule": { "filename": "src/probe.ts", "line": 119 }, "name": "fromCommand", "parameters": [ { "docs": { "summary": "The command to execute." }, "name": "command", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "summary": "Options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.CommandProbeOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Probe" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Defines a probe based on an HTTP GET request to the IP address of the container." }, "locationInModule": { "filename": "src/probe.ts", "line": 109 }, "name": "fromHttpGet", "parameters": [ { "docs": { "summary": "The URL path to hit." }, "name": "path", "type": { "primitive": "string" } }, { "docs": { "summary": "Options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.HttpGetProbeOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Probe" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Defines a probe based opening a connection to a TCP socket on the container." }, "locationInModule": { "filename": "src/probe.ts", "line": 128 }, "name": "fromTcpSocket", "parameters": [ { "docs": { "summary": "Options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.TcpSocketProbeOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Probe" } }, "static": true } ], "name": "Probe", "symbolId": "src/probe:Probe" }, "cdk8s-plus-21.ProbeOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Probe options." }, "fqn": "cdk8s-plus-21.ProbeOptions", "kind": "interface", "locationInModule": { "filename": "src/probe.ts", "line": 9 }, "name": "ProbeOptions", "properties": [ { "abstract": true, "docs": { "default": "3", "remarks": "Defaults to 3. Minimum value is 1.", "stability": "stable", "summary": "Minimum consecutive failures for the probe to be considered failed after having succeeded." }, "immutable": true, "locationInModule": { "filename": "src/probe.ts", "line": 18 }, "name": "failureThreshold", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- immediate", "see": "https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "stability": "stable", "summary": "Number of seconds after the container has started before liveness probes are initiated." }, "immutable": true, "locationInModule": { "filename": "src/probe.ts", "line": 27 }, "name": "initialDelaySeconds", "optional": true, "type": { "fqn": "cdk8s.Duration" } }, { "abstract": true, "docs": { "default": "Duration.seconds(10) Minimum value is 1.", "remarks": "Default to 10 seconds. Minimum value is 1.", "stability": "stable", "summary": "How often (in seconds) to perform the probe." }, "immutable": true, "locationInModule": { "filename": "src/probe.ts", "line": 36 }, "name": "periodSeconds", "optional": true, "type": { "fqn": "cdk8s.Duration" } }, { "abstract": true, "docs": { "default": "1 Must be 1 for liveness and startup. Minimum value is 1.", "remarks": "Must be 1 for liveness and startup. Minimum value is 1.", "stability": "stable", "summary": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1." }, "immutable": true, "locationInModule": { "filename": "src/probe.ts", "line": 46 }, "name": "successThreshold", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "Duration.seconds(1)", "remarks": "Defaults to 1 second. Minimum value is 1.", "see": "https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "stability": "stable", "summary": "Number of seconds after which the probe times out." }, "immutable": true, "locationInModule": { "filename": "src/probe.ts", "line": 56 }, "name": "timeoutSeconds", "optional": true, "type": { "fqn": "cdk8s.Duration" } } ], "symbolId": "src/probe:ProbeOptions" }, "cdk8s-plus-21.Protocol": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable" }, "fqn": "cdk8s-plus-21.Protocol", "kind": "enum", "locationInModule": { "filename": "src/service.ts", "line": 339 }, "members": [ { "docs": { "stability": "stable" }, "name": "TCP" }, { "docs": { "stability": "stable" }, "name": "UDP" }, { "docs": { "stability": "stable" }, "name": "SCTP" } ], "name": "Protocol", "symbolId": "src/service:Protocol" }, "cdk8s-plus-21.Resource": { "abstract": true, "assembly": "cdk8s-plus-21", "base": "constructs.Construct", "docs": { "remarks": "Represents a single\nresource.", "stability": "stable", "summary": "Base class for all Kubernetes objects in stdk8s." }, "fqn": "cdk8s-plus-21.Resource", "initializer": { "docs": { "stability": "stable", "summary": "Creates a new construct node." }, "locationInModule": { "filename": "src/construct.ts", "line": 463 }, "parameters": [ { "docs": { "summary": "The scope in which to define this construct." }, "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "docs": { "remarks": "Must be unique amongst siblings. If\nthe ID includes a path separator (`/`), then it will be replaced by double\ndash `--`.", "summary": "The scoped construct ID." }, "name": "id", "type": { "primitive": "string" } } ] }, "interfaces": [ "cdk8s-plus-21.IResource", "cdk8s-plus-21.IApiResource", "cdk8s-plus-21.IApiEndpoint" ], "kind": "class", "locationInModule": { "filename": "src/base.ts", "line": 45 }, "methods": [ { "docs": { "stability": "stable", "summary": "Return the IApiResource this object represents." }, "locationInModule": { "filename": "src/base.ts", "line": 90 }, "name": "asApiResource", "overrides": "cdk8s-plus-21.IApiEndpoint", "returns": { "optional": true, "type": { "fqn": "cdk8s-plus-21.IApiResource" } } }, { "docs": { "stability": "stable", "summary": "Return the non resource url this object represents." }, "locationInModule": { "filename": "src/base.ts", "line": 94 }, "name": "asNonApiResource", "overrides": "cdk8s-plus-21.IApiEndpoint", "returns": { "optional": true, "type": { "primitive": "string" } } } ], "name": "Resource", "properties": [ { "docs": { "stability": "stable", "summary": "The group portion of the API version (e.g. \"authorization.k8s.io\")." }, "immutable": true, "locationInModule": { "filename": "src/base.ts", "line": 73 }, "name": "apiGroup", "overrides": "cdk8s-plus-21.IResource", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/base.ts", "line": 50 }, "name": "apiObject", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable", "summary": "The object's API version (e.g. \"authorization.k8s.io/v1\")." }, "immutable": true, "locationInModule": { "filename": "src/base.ts", "line": 66 }, "name": "apiVersion", "overrides": "cdk8s-plus-21.IResource", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The object kind (e.g. \"Deployment\")." }, "immutable": true, "locationInModule": { "filename": "src/base.ts", "line": 80 }, "name": "kind", "overrides": "cdk8s-plus-21.IResource", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/base.ts", "line": 52 }, "name": "metadata", "type": { "fqn": "cdk8s.ApiObjectMetadataDefinition" } }, { "docs": { "stability": "stable", "summary": "The name of this API object." }, "immutable": true, "locationInModule": { "filename": "src/base.ts", "line": 59 }, "name": "name", "overrides": "cdk8s-plus-21.IResource", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/base.ts", "line": 88 }, "name": "resourceType", "overrides": "cdk8s-plus-21.IApiResource", "type": { "primitive": "string" } }, { "docs": { "remarks": "If this is omitted, the ApiResource should represent all objects of the given type.", "stability": "stable", "summary": "The unique, namespace-global, name of an object inside the Kubernetes cluster." }, "immutable": true, "locationInModule": { "filename": "src/base.ts", "line": 84 }, "name": "resourceName", "optional": true, "overrides": "cdk8s-plus-21.IApiResource", "type": { "primitive": "string" } } ], "symbolId": "src/base:Resource" }, "cdk8s-plus-21.ResourceFieldPaths": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable" }, "fqn": "cdk8s-plus-21.ResourceFieldPaths", "kind": "enum", "locationInModule": { "filename": "src/container.ts", "line": 140 }, "members": [ { "docs": { "stability": "stable", "summary": "CPU limit of the container." }, "name": "CPU_LIMIT" }, { "docs": { "stability": "stable", "summary": "Memory limit of the container." }, "name": "MEMORY_LIMIT" }, { "docs": { "stability": "stable", "summary": "CPU request of the container." }, "name": "CPU_REQUEST" }, { "docs": { "stability": "stable", "summary": "Memory request of the container." }, "name": "MEMORY_REQUEST" }, { "docs": { "stability": "stable", "summary": "Ephemeral storage limit of the container." }, "name": "STORAGE_LIMIT" }, { "docs": { "stability": "stable", "summary": "Ephemeral storage request of the container." }, "name": "STORAGE_REQUEST" } ], "name": "ResourceFieldPaths", "symbolId": "src/container:ResourceFieldPaths" }, "cdk8s-plus-21.ResourceProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Initialization properties for resources." }, "fqn": "cdk8s-plus-21.ResourceProps", "kind": "interface", "locationInModule": { "filename": "src/base.ts", "line": 8 }, "name": "ResourceProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Metadata that all persisted resources must have, which includes all objects users must create." }, "immutable": true, "locationInModule": { "filename": "src/base.ts", "line": 13 }, "name": "metadata", "optional": true, "type": { "fqn": "cdk8s.ApiObjectMetadata" } } ], "symbolId": "src/base:ResourceProps" }, "cdk8s-plus-21.RestartPolicy": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Restart policy for all containers within the pod." }, "fqn": "cdk8s-plus-21.RestartPolicy", "kind": "enum", "locationInModule": { "filename": "src/pod.ts", "line": 743 }, "members": [ { "docs": { "stability": "stable", "summary": "Always restart the pod after it exits." }, "name": "ALWAYS" }, { "docs": { "stability": "stable", "summary": "Only restart if the pod exits with a non-zero exit code." }, "name": "ON_FAILURE" }, { "docs": { "stability": "stable", "summary": "Never restart the pod." }, "name": "NEVER" } ], "name": "RestartPolicy", "symbolId": "src/pod:RestartPolicy" }, "cdk8s-plus-21.Role": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Resource", "docs": { "stability": "stable", "summary": "Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding." }, "fqn": "cdk8s-plus-21.Role", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/role.ts", "line": 71 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.RoleProps" } } ] }, "interfaces": [ "cdk8s-plus-21.IRole" ], "kind": "class", "locationInModule": { "filename": "src/role.ts", "line": 48 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports a role from the cluster as a reference." }, "locationInModule": { "filename": "src/role.ts", "line": 54 }, "name": "fromRoleName", "parameters": [ { "docs": { "summary": "The name of the role resource." }, "name": "name", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.IRole" } }, "static": true }, { "docs": { "see": "https://kubernetes.io/docs/reference/access-authn-authz/authorization/#determine-the-request-verb", "stability": "stable", "summary": "Add permission to perform a list of HTTP verbs on a collection of resources." }, "locationInModule": { "filename": "src/role.ts", "line": 95 }, "name": "allow", "parameters": [ { "name": "verbs", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "summary": "The resource(s) to apply to." }, "name": "resources", "type": { "fqn": "cdk8s-plus-21.IApiResource" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"create\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 103 }, "name": "allowCreate", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "resources", "type": { "fqn": "cdk8s-plus-21.IApiResource" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"delete\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 151 }, "name": "allowDelete", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "resources", "type": { "fqn": "cdk8s-plus-21.IApiResource" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"deletecollection\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 159 }, "name": "allowDeleteCollection", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "resources", "type": { "fqn": "cdk8s-plus-21.IApiResource" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"get\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 111 }, "name": "allowGet", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "resources", "type": { "fqn": "cdk8s-plus-21.IApiResource" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"list\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 119 }, "name": "allowList", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "resources", "type": { "fqn": "cdk8s-plus-21.IApiResource" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"patch\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 143 }, "name": "allowPatch", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "resources", "type": { "fqn": "cdk8s-plus-21.IApiResource" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"get\", \"list\", and \"watch\" permissions for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 167 }, "name": "allowRead", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "resources", "type": { "fqn": "cdk8s-plus-21.IApiResource" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"get\", \"list\", \"watch\", \"create\", \"update\", \"patch\", \"delete\", and \"deletecollection\" permissions for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 177 }, "name": "allowReadWrite", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "resources", "type": { "fqn": "cdk8s-plus-21.IApiResource" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"update\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 135 }, "name": "allowUpdate", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "resources", "type": { "fqn": "cdk8s-plus-21.IApiResource" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Add \"watch\" permission for the resources." }, "locationInModule": { "filename": "src/role.ts", "line": 127 }, "name": "allowWatch", "parameters": [ { "docs": { "summary": "The resource(s) to apply to." }, "name": "resources", "type": { "fqn": "cdk8s-plus-21.IApiResource" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Create a RoleBinding that binds the permissions in this Role to a list of subjects, that will only apply this role's namespace." }, "locationInModule": { "filename": "src/role.ts", "line": 186 }, "name": "bind", "parameters": [ { "docs": { "summary": "a list of subjects to bind to." }, "name": "subjects", "type": { "fqn": "cdk8s-plus-21.ISubject" }, "variadic": true } ], "returns": { "type": { "fqn": "cdk8s-plus-21.RoleBinding" } }, "variadic": true } ], "name": "Role", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/role.ts", "line": 65 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/role.ts", "line": 67 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } }, { "docs": { "remarks": "Returns a copy, use `allow` to add rules.", "stability": "stable", "summary": "Rules associaated with this Role." }, "immutable": true, "locationInModule": { "filename": "src/role.ts", "line": 84 }, "name": "rules", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.RolePolicyRule" }, "kind": "array" } } } ], "symbolId": "src/role:Role" }, "cdk8s-plus-21.RoleBinding": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Resource", "docs": { "stability": "stable", "summary": "A RoleBinding grants permissions within a specific namespace to a user or set of users." }, "fqn": "cdk8s-plus-21.RoleBinding", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/role-binding.ts", "line": 67 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk8s-plus-21.RoleBindingProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/role-binding.ts", "line": 55 }, "methods": [ { "docs": { "stability": "stable", "summary": "Adds a subject to the role." }, "locationInModule": { "filename": "src/role-binding.ts", "line": 85 }, "name": "addSubjects", "parameters": [ { "docs": { "summary": "The subjects to add." }, "name": "subjects", "type": { "fqn": "cdk8s-plus-21.ISubject" }, "variadic": true } ], "variadic": true } ], "name": "RoleBinding", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 59 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 61 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 63 }, "name": "role", "type": { "fqn": "cdk8s-plus-21.IRole" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 91 }, "name": "subjects", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.ISubject" }, "kind": "array" } } } ], "symbolId": "src/role-binding:RoleBinding" }, "cdk8s-plus-21.RoleBindingProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `RoleBinding`." }, "fqn": "cdk8s-plus-21.RoleBindingProps", "interfaces": [ "cdk8s-plus-21.ResourceProps" ], "kind": "interface", "locationInModule": { "filename": "src/role-binding.ts", "line": 44 }, "name": "RoleBindingProps", "properties": [ { "abstract": true, "docs": { "remarks": "A RoleBinding can reference a Role or a ClusterRole.", "stability": "stable", "summary": "The role to bind to." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 48 }, "name": "role", "type": { "fqn": "cdk8s-plus-21.IRole" } } ], "symbolId": "src/role-binding:RoleBindingProps" }, "cdk8s-plus-21.RolePolicyRule": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Policy rule of a `Role." }, "fqn": "cdk8s-plus-21.RolePolicyRule", "kind": "interface", "locationInModule": { "filename": "src/role.ts", "line": 31 }, "name": "RolePolicyRule", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Resources this rule applies to." }, "immutable": true, "locationInModule": { "filename": "src/role.ts", "line": 41 }, "name": "resources", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.IApiResource" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "(e.g ['get', 'watch'])", "stability": "stable", "summary": "Verbs to allow." }, "immutable": true, "locationInModule": { "filename": "src/role.ts", "line": 36 }, "name": "verbs", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/role:RolePolicyRule" }, "cdk8s-plus-21.RoleProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `Role`." }, "fqn": "cdk8s-plus-21.RoleProps", "interfaces": [ "cdk8s-plus-21.ResourceProps" ], "kind": "interface", "locationInModule": { "filename": "src/role.ts", "line": 18 }, "name": "RoleProps", "properties": [ { "abstract": true, "docs": { "default": "[]", "stability": "stable", "summary": "A list of rules the role should allow." }, "immutable": true, "locationInModule": { "filename": "src/role.ts", "line": 25 }, "name": "rules", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.RolePolicyRule" }, "kind": "array" } } } ], "symbolId": "src/role:RoleProps" }, "cdk8s-plus-21.Secret": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Resource", "docs": { "remarks": "Storing confidential information in a\nSecret is safer and more flexible than putting it verbatim in a Pod\ndefinition or in a container image.", "see": "https://kubernetes.io/docs/concepts/configuration/secret", "stability": "stable", "summary": "Kubernetes Secrets let you store and manage sensitive information, such as passwords, OAuth tokens, and ssh keys." }, "fqn": "cdk8s-plus-21.Secret", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/secret.ts", "line": 99 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.SecretProps" } } ] }, "interfaces": [ "cdk8s-plus-21.ISecret" ], "kind": "class", "locationInModule": { "filename": "src/secret.ts", "line": 71 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports a secret from the cluster as a reference." }, "locationInModule": { "filename": "src/secret.ts", "line": 77 }, "name": "fromSecretName", "parameters": [ { "docs": { "summary": "The name of the secret to reference." }, "name": "name", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.ISecret" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Adds a string data field to the secert." }, "locationInModule": { "filename": "src/secret.ts", "line": 118 }, "name": "addStringData", "parameters": [ { "docs": { "summary": "Key." }, "name": "key", "type": { "primitive": "string" } }, { "docs": { "summary": "Value." }, "name": "value", "type": { "primitive": "string" } } ] }, { "docs": { "stability": "stable", "summary": "Gets a string data by key or undefined." }, "locationInModule": { "filename": "src/secret.ts", "line": 126 }, "name": "getStringData", "parameters": [ { "docs": { "summary": "Key." }, "name": "key", "type": { "primitive": "string" } } ], "returns": { "optional": true, "type": { "primitive": "string" } } } ], "name": "Secret", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 88 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable", "summary": "Whether or not the secret is immutable." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 95 }, "name": "immutable", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 90 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } } ], "symbolId": "src/secret:Secret" }, "cdk8s-plus-21.SecretProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `Secret`." }, "fqn": "cdk8s-plus-21.SecretProps", "interfaces": [ "cdk8s-plus-21.CommonSecretProps" ], "kind": "interface", "locationInModule": { "filename": "src/secret.ts", "line": 25 }, "name": "SecretProps", "properties": [ { "abstract": true, "docs": { "remarks": "It is\nprovided as a write-only convenience method. All keys and values are merged\ninto the data field on write, overwriting any existing values. It is never\noutput when reading from the API.", "stability": "stable", "summary": "stringData allows specifying non-binary secret data in string form." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 32 }, "name": "stringData", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "undefined - Don't set a type.", "remarks": "Used to facilitate programmatic\nhandling of secret data by various controllers.", "stability": "stable", "summary": "Optional type associated with the secret." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 40 }, "name": "type", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/secret:SecretProps" }, "cdk8s-plus-21.SecretValue": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Represents a specific value in JSON secret." }, "fqn": "cdk8s-plus-21.SecretValue", "kind": "interface", "locationInModule": { "filename": "src/secret.ts", "line": 51 }, "name": "SecretValue", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The JSON key." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 60 }, "name": "key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The secret." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 55 }, "name": "secret", "type": { "fqn": "cdk8s-plus-21.ISecret" } } ], "symbolId": "src/secret:SecretValue" }, "cdk8s-plus-21.SecretVolumeOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for the Secret-based volume." }, "fqn": "cdk8s-plus-21.SecretVolumeOptions", "kind": "interface", "locationInModule": { "filename": "src/volume.ts", "line": 489 }, "name": "SecretVolumeOptions", "properties": [ { "abstract": true, "docs": { "default": "0644. Directories within the path are not affected by this\nsetting. This might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.", "remarks": "Must be a value between 0 and\n0777. Defaults to 0644. Directories within the path are not affected by\nthis setting. This might be in conflict with other options that affect the\nfile mode, like fsGroup, and the result can be other mode bits set.", "stability": "stable", "summary": "Mode bits to use on created files by default." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 507 }, "name": "defaultMode", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no mapping", "remarks": "If specified, the listed keys will be projected\ninto the specified paths, and unlisted keys will not be present. If a key\nis specified which is not present in the secret, the volume setup will\nerror unless it is marked optional. Paths must be relative and may not\ncontain the '..' path or start with '..'.", "stability": "stable", "summary": "If unspecified, each key-value pair in the Data field of the referenced secret will be projected into the volume as a file whose name is the key and content is the value." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 526 }, "name": "items", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.PathMapping" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- auto-generated", "stability": "stable", "summary": "The volume name." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 495 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- undocumented", "stability": "stable", "summary": "Specify whether the secret or its keys must be defined." }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 513 }, "name": "optional", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/volume:SecretVolumeOptions" }, "cdk8s-plus-21.Service": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Resource", "docs": { "remarks": "With Kubernetes you don't need to modify your application to use an unfamiliar service discovery mechanism.\nKubernetes gives Pods their own IP addresses and a single DNS name for a set of Pods, and can load-balance across them.\n\nFor example, consider a stateless image-processing backend which is running with 3 replicas. Those replicas are fungible—frontends do not care which backend they use.\nWhile the actual Pods that compose the backend set may change, the frontend clients should not need to be aware of that,\nnor should they need to keep track of the set of backends themselves.\nThe Service abstraction enables this decoupling.\n\nIf you're able to use Kubernetes APIs for service discovery in your application, you can query the API server for Endpoints,\nthat get updated whenever the set of Pods in a Service changes. For non-native applications, Kubernetes offers ways to place a network port\nor load balancer in between your application and the backend Pods.", "stability": "stable", "summary": "An abstract way to expose an application running on a set of Pods as a network service." }, "fqn": "cdk8s-plus-21.Service", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/service.ts", "line": 180 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.ServiceProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/service.ts", "line": 150 }, "methods": [ { "docs": { "remarks": "If not targetPort is specific in the portOptions, then requests will be routed\nto the port exposed by the first container in the deployment's pods.\nThe deployment's `labelSelector` will be used to select pods.", "stability": "stable", "summary": "Associate a deployment to this service." }, "locationInModule": { "filename": "src/service.ts", "line": 248 }, "name": "addDeployment", "parameters": [ { "docs": { "summary": "The deployment to expose." }, "name": "depl", "type": { "fqn": "cdk8s-plus-21.Deployment" } }, { "docs": { "summary": "Optional settings for the port." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.AddDeploymentOptions" } } ] }, { "docs": { "stability": "stable", "summary": "Services defined using this spec will select pods according the provided label." }, "locationInModule": { "filename": "src/service.ts", "line": 286 }, "name": "addSelector", "parameters": [ { "docs": { "summary": "The label key." }, "name": "label", "type": { "primitive": "string" } }, { "docs": { "summary": "The label value." }, "name": "value", "type": { "primitive": "string" } } ] }, { "docs": { "returns": "The `Ingress` resource that was used.", "stability": "stable", "summary": "Expose a service via an ingress using the specified path." }, "locationInModule": { "filename": "src/service.ts", "line": 216 }, "name": "exposeViaIngress", "parameters": [ { "docs": { "summary": "The path to expose the service under." }, "name": "path", "type": { "primitive": "string" } }, { "docs": { "summary": "Additional options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.ExposeServiceViaIngressOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.IngressV1Beta1" } } }, { "docs": { "remarks": "This method can be called multiple times.", "stability": "stable", "summary": "Configure a port the service will bind to." }, "locationInModule": { "filename": "src/service.ts", "line": 296 }, "name": "serve", "parameters": [ { "docs": { "summary": "The port definition." }, "name": "port", "type": { "primitive": "number" } }, { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.ServicePortOptions" } } ] } ], "name": "Service", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 171 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "remarks": "Use `serve()` to expose additional service ports.", "stability": "stable", "summary": "Ports for this service." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 234 }, "name": "ports", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.ServicePort" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 173 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Returns the labels which are used to select pods for this service." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 225 }, "name": "selector", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "stable", "summary": "Determines how the Service is exposed." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 161 }, "name": "type", "type": { "fqn": "cdk8s-plus-21.ServiceType" } }, { "docs": { "stability": "stable", "summary": "The IP address of the service and is usually assigned randomly by the master." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 156 }, "name": "clusterIP", "optional": true, "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The externalName to be used for EXTERNAL_NAME types." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 166 }, "name": "externalName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/service:Service" }, "cdk8s-plus-21.ServiceAccount": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Resource", "docs": { "remarks": "When you (a human) access the cluster (for example, using kubectl), you are\nauthenticated by the apiserver as a particular User Account (currently this\nis usually admin, unless your cluster administrator has customized your\ncluster). Processes in containers inside pods can also contact the apiserver.\nWhen they do, they are authenticated as a particular Service Account (for\nexample, default).", "see": "https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account", "stability": "stable", "summary": "A service account provides an identity for processes that run in a Pod." }, "fqn": "cdk8s-plus-21.ServiceAccount", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/service-account.ts", "line": 77 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.ServiceAccountProps" } } ] }, "interfaces": [ "cdk8s-plus-21.IServiceAccount", "cdk8s-plus-21.ISubject" ], "kind": "class", "locationInModule": { "filename": "src/service-account.ts", "line": 48 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports a service account from the cluster as a reference." }, "locationInModule": { "filename": "src/service-account.ts", "line": 54 }, "name": "fromServiceAccountName", "parameters": [ { "docs": { "summary": "The name of the service account resource." }, "name": "name", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.IServiceAccount" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Allow a secret to be accessed by pods using this service account." }, "locationInModule": { "filename": "src/service-account.ts", "line": 94 }, "name": "addSecret", "parameters": [ { "docs": { "summary": "The secret." }, "name": "secr", "type": { "fqn": "cdk8s-plus-21.ISecret" } } ] } ], "name": "ServiceAccount", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/service-account.ts", "line": 65 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable", "summary": "Whether or not a token is automatically mounted for this service account." }, "immutable": true, "locationInModule": { "filename": "src/service-account.ts", "line": 75 }, "name": "automountToken", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/service-account.ts", "line": 67 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } }, { "docs": { "remarks": "Returns a copy. To add a secret, use `addSecret()`.", "stability": "stable", "summary": "List of secrets allowed to be used by pods running using this service account." }, "immutable": true, "locationInModule": { "filename": "src/service-account.ts", "line": 104 }, "name": "secrets", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.ISecret" }, "kind": "array" } } } ], "symbolId": "src/service-account:ServiceAccount" }, "cdk8s-plus-21.ServiceAccountProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for initialization of `ServiceAccount`." }, "fqn": "cdk8s-plus-21.ServiceAccountProps", "interfaces": [ "cdk8s-plus-21.ResourceProps" ], "kind": "interface", "locationInModule": { "filename": "src/service-account.ts", "line": 17 }, "name": "ServiceAccountProps", "properties": [ { "abstract": true, "docs": { "default": "true", "remarks": "Can be overridden at the pod level.", "see": "https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server", "stability": "stable", "summary": "Indicates whether pods running as this service account should have an API token automatically mounted." }, "immutable": true, "locationInModule": { "filename": "src/service-account.ts", "line": 33 }, "name": "automountToken", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "see": "https://kubernetes.io/docs/concepts/configuration/secret", "stability": "stable", "summary": "List of secrets allowed to be used by pods running using this ServiceAccount." }, "immutable": true, "locationInModule": { "filename": "src/service-account.ts", "line": 24 }, "name": "secrets", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.ISecret" }, "kind": "array" } } } ], "symbolId": "src/service-account:ServiceAccountProps" }, "cdk8s-plus-21.ServiceAccountTokenSecret": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Secret", "docs": { "see": "https://kubernetes.io/docs/concepts/configuration/secret/#service-account-token-secrets", "stability": "stable", "summary": "Create a secret for a service account token." }, "fqn": "cdk8s-plus-21.ServiceAccountTokenSecret", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/secret.ts", "line": 207 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk8s-plus-21.ServiceAccountTokenSecretProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/secret.ts", "line": 206 }, "name": "ServiceAccountTokenSecret", "symbolId": "src/secret:ServiceAccountTokenSecret" }, "cdk8s-plus-21.ServiceAccountTokenSecretProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `ServiceAccountTokenSecret`." }, "fqn": "cdk8s-plus-21.ServiceAccountTokenSecretProps", "interfaces": [ "cdk8s-plus-21.CommonSecretProps" ], "kind": "interface", "locationInModule": { "filename": "src/secret.ts", "line": 194 }, "name": "ServiceAccountTokenSecretProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The service account to store a secret for." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 198 }, "name": "serviceAccount", "type": { "fqn": "cdk8s-plus-21.IServiceAccount" } } ], "symbolId": "src/secret:ServiceAccountTokenSecretProps" }, "cdk8s-plus-21.ServiceIngressV1BetaBackendOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for setting up backends for ingress rules." }, "fqn": "cdk8s-plus-21.ServiceIngressV1BetaBackendOptions", "kind": "interface", "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 213 }, "name": "ServiceIngressV1BetaBackendOptions", "properties": [ { "abstract": true, "docs": { "default": "- if the service exposes a single port, this port will be used.", "remarks": "- This option will fail if the service does not expose any ports.\n- If the service exposes multiple ports, this option must be specified.\n- If the service exposes a single port, this option is optional and if\n specified, it must be the same port exposed by the service.", "stability": "stable", "summary": "The port to use to access the service." }, "immutable": true, "locationInModule": { "filename": "src/ingress-v1beta1.ts", "line": 224 }, "name": "port", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/ingress-v1beta1:ServiceIngressV1BetaBackendOptions" }, "cdk8s-plus-21.ServicePort": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Definition of a service port." }, "fqn": "cdk8s-plus-21.ServicePort", "interfaces": [ "cdk8s-plus-21.ServicePortOptions" ], "kind": "interface", "locationInModule": { "filename": "src/service.ts", "line": 385 }, "name": "ServicePort", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The port number the service will bind to." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 390 }, "name": "port", "type": { "primitive": "number" } } ], "symbolId": "src/service:ServicePort" }, "cdk8s-plus-21.ServicePortOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable" }, "fqn": "cdk8s-plus-21.ServicePortOptions", "kind": "interface", "locationInModule": { "filename": "src/service.ts", "line": 345 }, "name": "ServicePortOptions", "properties": [ { "abstract": true, "docs": { "remarks": "This must be a DNS_LABEL. All\nports within a ServiceSpec must have unique names. This maps to the 'Name'\nfield in EndpointPort objects. Optional if only one ServicePort is defined\non this service.", "stability": "stable", "summary": "The name of this port within the service." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 352 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- auto-allocate a port if the ServiceType of this Service requires one.", "remarks": "Usually assigned by the system. If specified, it will be\nallocated to the service if unused or else creation of the service will\nfail. Default is to auto-allocate a port if the ServiceType of this Service\nrequires one.", "see": "https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport", "stability": "stable", "summary": "The port on each node on which this service is exposed when type=NodePort or LoadBalancer." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 365 }, "name": "nodePort", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "Protocol.TCP", "remarks": "Supports \"TCP\", \"UDP\", and \"SCTP\". Default is TCP.", "stability": "stable", "summary": "The IP protocol for this port." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 372 }, "name": "protocol", "optional": true, "type": { "fqn": "cdk8s-plus-21.Protocol" } }, { "abstract": true, "docs": { "default": "- The value of `port` will be used.", "stability": "stable", "summary": "The port number the service will redirect to." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 379 }, "name": "targetPort", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/service:ServicePortOptions" }, "cdk8s-plus-21.ServiceProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for initialization of `Service`." }, "fqn": "cdk8s-plus-21.ServiceProps", "interfaces": [ "cdk8s-plus-21.ResourceProps" ], "kind": "interface", "locationInModule": { "filename": "src/service.ts", "line": 11 }, "name": "ServiceProps", "properties": [ { "abstract": true, "docs": { "default": "- Automatically assigned.", "remarks": "If an address is specified manually and is not in use by others, it\nwill be allocated to the service; otherwise, creation of the service will\nfail. This field can not be changed through updates. Valid values are\n\"None\", empty string (\"\"), or a valid IP address. \"None\" can be specified\nfor headless services when proxying is not required. Only applies to types\nClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName.", "see": "https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies", "stability": "stable", "summary": "The IP address of the service and is usually assigned randomly by the master." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 26 }, "name": "clusterIP", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No external IPs.", "remarks": "These IPs are not managed by Kubernetes. The user\nis responsible for ensuring that traffic arrives at a node with this IP. A\ncommon example is external load-balancers that are not part of the\nKubernetes system.", "stability": "stable", "summary": "A list of IP addresses for which nodes in the cluster will also accept traffic for this service." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 37 }, "name": "externalIPs", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No external name.", "stability": "stable", "summary": "The externalName to be used when ServiceType.EXTERNAL_NAME is set." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 60 }, "name": "externalName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/", "stability": "stable", "summary": "A list of CIDR IP addresses, if specified and supported by the platform, will restrict traffic through the cloud-provider load-balancer to the specified client IPs." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 68 }, "name": "loadBalancerSourceRanges", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies", "stability": "stable", "summary": "The port exposed by this service." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 53 }, "name": "ports", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.ServicePort" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "ServiceType.ClusterIP", "remarks": "More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types", "stability": "stable", "summary": "Determines how the Service is exposed." }, "immutable": true, "locationInModule": { "filename": "src/service.ts", "line": 46 }, "name": "type", "optional": true, "type": { "fqn": "cdk8s-plus-21.ServiceType" } } ], "symbolId": "src/service:ServiceProps" }, "cdk8s-plus-21.ServiceType": { "assembly": "cdk8s-plus-21", "docs": { "remarks": "Kubernetes ServiceTypes allow you to specify what kind of Service you want.\nThe default is ClusterIP.", "stability": "stable", "summary": "For some parts of your application (for example, frontends) you may want to expose a Service onto an external IP address, that's outside of your cluster." }, "fqn": "cdk8s-plus-21.ServiceType", "kind": "enum", "locationInModule": { "filename": "src/service.ts", "line": 91 }, "members": [ { "docs": { "remarks": "Choosing this value makes the Service only reachable from within the cluster.\nThis is the default ServiceType", "stability": "stable", "summary": "Exposes the Service on a cluster-internal IP." }, "name": "CLUSTER_IP" }, { "docs": { "remarks": "A ClusterIP Service, to which the NodePort Service routes, is automatically created.\nYou'll be able to contact the NodePort Service, from outside the cluster,\nby requesting :.", "stability": "stable", "summary": "Exposes the Service on each Node's IP at a static port (the NodePort)." }, "name": "NODE_PORT" }, { "docs": { "remarks": "NodePort and ClusterIP Services, to which the external load balancer routes,\nare automatically created.", "stability": "stable", "summary": "Exposes the Service externally using a cloud provider's load balancer." }, "name": "LOAD_BALANCER" }, { "docs": { "remarks": "> Note: You need either kube-dns version 1.7 or CoreDNS version 0.0.8 or higher to use the ExternalName type.", "stability": "stable", "summary": "Maps the Service to the contents of the externalName field (e.g. foo.bar.example.com), by returning a CNAME record with its value. No proxying of any kind is set up." }, "name": "EXTERNAL_NAME" } ], "name": "ServiceType", "symbolId": "src/service:ServiceType" }, "cdk8s-plus-21.SshAuthSecret": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Secret", "docs": { "see": "https://kubernetes.io/docs/concepts/configuration/secret/#ssh-authentication-secrets", "stability": "stable", "summary": "Create a secret for ssh authentication." }, "fqn": "cdk8s-plus-21.SshAuthSecret", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/secret.ts", "line": 180 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk8s-plus-21.SshAuthSecretProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/secret.ts", "line": 179 }, "name": "SshAuthSecret", "symbolId": "src/secret:SshAuthSecret" }, "cdk8s-plus-21.SshAuthSecretProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `SshAuthSecret`." }, "fqn": "cdk8s-plus-21.SshAuthSecretProps", "interfaces": [ "cdk8s-plus-21.CommonSecretProps" ], "kind": "interface", "locationInModule": { "filename": "src/secret.ts", "line": 167 }, "name": "SshAuthSecretProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The SSH private key to use." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 171 }, "name": "sshPrivateKey", "type": { "primitive": "string" } } ], "symbolId": "src/secret:SshAuthSecretProps" }, "cdk8s-plus-21.StatefulSet": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Workload", "docs": { "remarks": "Manages the deployment and scaling of a set of Pods, and provides guarantees\nabout the ordering and uniqueness of these Pods.\n\nLike a Deployment, a StatefulSet manages Pods that are based on an identical\ncontainer spec. Unlike a Deployment, a StatefulSet maintains a sticky identity\nfor each of their Pods. These pods are created from the same spec, but are not\ninterchangeable: each has a persistent identifier that it maintains across any\nrescheduling.\n\nIf you want to use storage volumes to provide persistence for your workload, you\ncan use a StatefulSet as part of the solution. Although individual Pods in a StatefulSet\nare susceptible to failure, the persistent Pod identifiers make it easier to match existing\nvolumes to the new Pods that replace any that have failed.\n\nUsing StatefulSets\n------------------\nStatefulSets are valuable for applications that require one or more of the following.\n\n- Stable, unique network identifiers.\n- Stable, persistent storage.\n- Ordered, graceful deployment and scaling.\n- Ordered, automated rolling updates.", "stability": "stable", "summary": "StatefulSet is the workload API object used to manage stateful applications." }, "fqn": "cdk8s-plus-21.StatefulSet", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/stateful-set.ts", "line": 105 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk8s-plus-21.StatefulSetProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/stateful-set.ts", "line": 80 }, "name": "StatefulSet", "properties": [ { "docs": { "see": "base.Resource.apiObject", "stability": "stable", "summary": "The underlying cdk8s API object." }, "immutable": true, "locationInModule": { "filename": "src/stateful-set.ts", "line": 99 }, "name": "apiObject", "overrides": "cdk8s-plus-21.Resource", "protected": true, "type": { "fqn": "cdk8s.ApiObject" } }, { "docs": { "stability": "stable", "summary": "Management policy to use for the set." }, "immutable": true, "locationInModule": { "filename": "src/stateful-set.ts", "line": 89 }, "name": "podManagementPolicy", "type": { "fqn": "cdk8s-plus-21.PodManagementPolicy" } }, { "docs": { "stability": "stable", "summary": "Number of desired pods." }, "immutable": true, "locationInModule": { "filename": "src/stateful-set.ts", "line": 84 }, "name": "replicas", "type": { "primitive": "number" } }, { "docs": { "stability": "stable", "summary": "The name of a resource type as it appears in the relevant API endpoint." }, "immutable": true, "locationInModule": { "filename": "src/stateful-set.ts", "line": 101 }, "name": "resourceType", "overrides": "cdk8s-plus-21.Resource", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The update startegy of this stateful set." }, "immutable": true, "locationInModule": { "filename": "src/stateful-set.ts", "line": 94 }, "name": "strategy", "type": { "fqn": "cdk8s-plus-21.StatefulSetUpdateStrategy" } } ], "symbolId": "src/stateful-set:StatefulSet" }, "cdk8s-plus-21.StatefulSetProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for initialization of `StatefulSet`." }, "fqn": "cdk8s-plus-21.StatefulSetProps", "interfaces": [ "cdk8s-plus-21.WorkloadProps" ], "kind": "interface", "locationInModule": { "filename": "src/stateful-set.ts", "line": 26 }, "name": "StatefulSetProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Service to associate with the statefulset." }, "immutable": true, "locationInModule": { "filename": "src/stateful-set.ts", "line": 30 }, "name": "service", "type": { "fqn": "cdk8s-plus-21.Service" } }, { "abstract": true, "docs": { "default": "PodManagementPolicy.ORDERED_READY", "stability": "stable", "summary": "Pod management policy to use for this statefulset." }, "immutable": true, "locationInModule": { "filename": "src/stateful-set.ts", "line": 44 }, "name": "podManagementPolicy", "optional": true, "type": { "fqn": "cdk8s-plus-21.PodManagementPolicy" } }, { "abstract": true, "docs": { "default": "1", "stability": "stable", "summary": "Number of desired pods." }, "immutable": true, "locationInModule": { "filename": "src/stateful-set.ts", "line": 37 }, "name": "replicas", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- RollingUpdate with partition set to 0", "stability": "stable", "summary": "Indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template." }, "immutable": true, "locationInModule": { "filename": "src/stateful-set.ts", "line": 51 }, "name": "strategy", "optional": true, "type": { "fqn": "cdk8s-plus-21.StatefulSetUpdateStrategy" } } ], "symbolId": "src/stateful-set:StatefulSetProps" }, "cdk8s-plus-21.StatefulSetUpdateStrategy": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "StatefulSet update strategies." }, "fqn": "cdk8s-plus-21.StatefulSetUpdateStrategy", "kind": "class", "locationInModule": { "filename": "src/stateful-set.ts", "line": 169 }, "methods": [ { "docs": { "remarks": "Users must manually delete Pods to cause the controller to create new Pods\nthat reflect modifications.", "stability": "stable", "summary": "The controller will not automatically update the Pods in a StatefulSet." }, "locationInModule": { "filename": "src/stateful-set.ts", "line": 176 }, "name": "onDelete", "returns": { "type": { "fqn": "cdk8s-plus-21.StatefulSetUpdateStrategy" } }, "static": true }, { "docs": { "remarks": "It will proceed in the same order as Pod termination (from the largest ordinal to the smallest),\nupdating each Pod one at a time. The Kubernetes control plane waits until an updated\nPod is Running and Ready prior to updating its predecessor.", "stability": "stable", "summary": "The controller will delete and recreate each Pod in the StatefulSet." }, "locationInModule": { "filename": "src/stateful-set.ts", "line": 188 }, "name": "rollingUpdate", "parameters": [ { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.StatefulSetUpdateStrategyRollingUpdateOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.StatefulSetUpdateStrategy" } }, "static": true } ], "name": "StatefulSetUpdateStrategy", "symbolId": "src/stateful-set:StatefulSetUpdateStrategy" }, "cdk8s-plus-21.StatefulSetUpdateStrategyRollingUpdateOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `StatefulSetUpdateStrategy.rollingUpdate`." }, "fqn": "cdk8s-plus-21.StatefulSetUpdateStrategyRollingUpdateOptions", "kind": "interface", "locationInModule": { "filename": "src/stateful-set.ts", "line": 147 }, "name": "StatefulSetUpdateStrategyRollingUpdateOptions", "properties": [ { "abstract": true, "docs": { "default": "0", "remarks": "If the partition is greater than replicas, updates to the pod template will not be propagated to Pods.\nIn most cases you will not need to use a partition, but they are useful if you want to stage an\nupdate, roll out a canary, or perform a phased roll out.", "see": "https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#partitions", "stability": "stable", "summary": "If specified, all Pods with an ordinal that is greater than or equal to the partition will be updated when the StatefulSet's .spec.template is updated. All Pods with an ordinal that is less than the partition will not be updated, and, even if they are deleted, they will be recreated at the previous version." }, "immutable": true, "locationInModule": { "filename": "src/stateful-set.ts", "line": 162 }, "name": "partition", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/stateful-set:StatefulSetUpdateStrategyRollingUpdateOptions" }, "cdk8s-plus-21.Sysctl": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Sysctl defines a kernel parameter to be set." }, "fqn": "cdk8s-plus-21.Sysctl", "kind": "interface", "locationInModule": { "filename": "src/pod.ts", "line": 206 }, "name": "Sysctl", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Name of a property to set." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 210 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Value of a property to set." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 215 }, "name": "value", "type": { "primitive": "string" } } ], "symbolId": "src/pod:Sysctl" }, "cdk8s-plus-21.TaintEffect": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Taint effects." }, "fqn": "cdk8s-plus-21.TaintEffect", "kind": "enum", "locationInModule": { "filename": "src/pod.ts", "line": 948 }, "members": [ { "docs": { "stability": "stable", "summary": "This means that no pod will be able to schedule onto the node unless it has a matching toleration." }, "name": "NO_SCHEDULE" }, { "docs": { "stability": "stable", "summary": "This is a \"preference\" or \"soft\" version of `NO_SCHEDULE` -- the system will try to avoid placing a pod that does not tolerate the taint on the node, but it is not required." }, "name": "PREFER_NO_SCHEDULE" }, { "docs": { "remarks": "- Pods that do not tolerate the taint are evicted immediately.\n- Pods that tolerate the taint without specifying `duration` remain bound forever.\n- Pods that tolerate the taint with a specified `duration` remain bound for\n the specified amount of time.", "stability": "stable", "summary": "This affects pods that are already running on the node as follows:." }, "name": "NO_EXECUTE" } ], "name": "TaintEffect", "symbolId": "src/pod:TaintEffect" }, "cdk8s-plus-21.TaintedNode": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "A node that is matched by taint selectors." }, "fqn": "cdk8s-plus-21.TaintedNode", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 1097 }, "parameters": [ { "name": "taintSelector", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.NodeTaintQuery" }, "kind": "array" } } } ] }, "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 1096 }, "name": "TaintedNode", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1097 }, "name": "taintSelector", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.NodeTaintQuery" }, "kind": "array" } } } ], "symbolId": "src/pod:TaintedNode" }, "cdk8s-plus-21.TcpSocketProbeOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `Probe.fromTcpSocket()`." }, "fqn": "cdk8s-plus-21.TcpSocketProbeOptions", "interfaces": [ "cdk8s-plus-21.ProbeOptions" ], "kind": "interface", "locationInModule": { "filename": "src/probe.ts", "line": 81 }, "name": "TcpSocketProbeOptions", "properties": [ { "abstract": true, "docs": { "default": "- defaults to the pod IP", "stability": "stable", "summary": "The host name to connect to on the container." }, "immutable": true, "locationInModule": { "filename": "src/probe.ts", "line": 94 }, "name": "host", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- defaults to `container.port`.", "stability": "stable", "summary": "The TCP port to connect to on the container." }, "immutable": true, "locationInModule": { "filename": "src/probe.ts", "line": 87 }, "name": "port", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/probe:TcpSocketProbeOptions" }, "cdk8s-plus-21.TlsSecret": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.Secret", "docs": { "see": "https://kubernetes.io/docs/concepts/configuration/secret/#tls-secrets", "stability": "stable", "summary": "Create a secret for storing a TLS certificate and its associated key." }, "fqn": "cdk8s-plus-21.TlsSecret", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/secret.ts", "line": 241 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "cdk8s-plus-21.TlsSecretProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/secret.ts", "line": 240 }, "name": "TlsSecret", "symbolId": "src/secret:TlsSecret" }, "cdk8s-plus-21.TlsSecretProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `TlsSecret`." }, "fqn": "cdk8s-plus-21.TlsSecretProps", "interfaces": [ "cdk8s-plus-21.CommonSecretProps" ], "kind": "interface", "locationInModule": { "filename": "src/secret.ts", "line": 223 }, "name": "TlsSecretProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The TLS cert." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 227 }, "name": "tlsCert", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The TLS key." }, "immutable": true, "locationInModule": { "filename": "src/secret.ts", "line": 232 }, "name": "tlsKey", "type": { "primitive": "string" } } ], "symbolId": "src/secret:TlsSecretProps" }, "cdk8s-plus-21.Topology": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Available topology domains." }, "fqn": "cdk8s-plus-21.Topology", "kind": "class", "locationInModule": { "filename": "src/pod.ts", "line": 1138 }, "methods": [ { "docs": { "stability": "stable", "summary": "Custom key for the node label that the system uses to denote the topology domain." }, "locationInModule": { "filename": "src/pod.ts", "line": 1176 }, "name": "custom", "parameters": [ { "name": "key", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Topology" } }, "static": true } ], "name": "Topology", "properties": [ { "const": true, "docs": { "see": "https://kubernetes.io/docs/reference/labels-annotations-taints/#kubernetesiohostname", "stability": "stable", "summary": "A hostname represents a single node in the cluster." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1145 }, "name": "HOSTNAME", "static": true, "type": { "fqn": "cdk8s-plus-21.Topology" } }, { "const": true, "docs": { "remarks": "It is uncommon\nfor Kubernetes clusters to span multiple regions. While the exact definition of a\nzone or region is left to infrastructure implementations, common properties of a region\ninclude higher network latency between them than within them, non-zero cost for network\ntraffic between them, and failure independence from other zones or regions.\n\nFor example, nodes within a region might share power infrastructure (e.g. a UPS or generator), but\nnodes in different regions typically would not.", "see": "https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesioregion", "stability": "stable", "summary": "A region represents a larger domain, made up of one or more zones." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1171 }, "name": "REGION", "static": true, "type": { "fqn": "cdk8s-plus-21.Topology" } }, { "const": true, "docs": { "remarks": "It is common for Kubernetes clusters to\nspan multiple zones for increased availability. While the exact definition of a zone is\nleft to infrastructure implementations, common properties of a zone include very low\nnetwork latency within a zone, no-cost network traffic within a zone, and failure\nindependence from other zones. For example, nodes within a zone might share a network\nswitch, but nodes in different zones should not.", "see": "https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone", "stability": "stable", "summary": "A zone represents a logical failure domain." }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1157 }, "name": "ZONE", "static": true, "type": { "fqn": "cdk8s-plus-21.Topology" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/pod.ts", "line": 1180 }, "name": "key", "type": { "primitive": "string" } } ], "symbolId": "src/pod:Topology" }, "cdk8s-plus-21.User": { "assembly": "cdk8s-plus-21", "docs": { "stability": "stable", "summary": "Represents a user." }, "fqn": "cdk8s-plus-21.User", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/role-binding.ts", "line": 202 }, "parameters": [ { "name": "props", "type": { "fqn": "cdk8s-plus-21.UserProps" } } ] }, "interfaces": [ "cdk8s-plus-21.ISubject" ], "kind": "class", "locationInModule": { "filename": "src/role-binding.ts", "line": 198 }, "name": "User", "properties": [ { "docs": { "remarks": "Values defined by this API group are\n\"User\", \"Group\", and \"ServiceAccount\". If the Authorizer does not\nrecognized the kind value, the Authorizer should report an error.", "stability": "stable", "summary": "Kind of object being referenced." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 200 }, "name": "kind", "overrides": "cdk8s-plus-21.ISubject", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Name of the object being referenced." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 201 }, "name": "name", "overrides": "cdk8s-plus-21.ISubject", "type": { "primitive": "string" } }, { "docs": { "remarks": "Defaults to \"\" for\nServiceAccount subjects. Defaults to \"rbac.authorization.k8s.io\" for User\nand Group subjects.", "stability": "stable", "summary": "APIGroup holds the API group of the referenced subject." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 199 }, "name": "apiGroup", "optional": true, "overrides": "cdk8s-plus-21.ISubject", "type": { "primitive": "string" } } ], "symbolId": "src/role-binding:User" }, "cdk8s-plus-21.UserProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `User`." }, "fqn": "cdk8s-plus-21.UserProps", "kind": "interface", "locationInModule": { "filename": "src/role-binding.ts", "line": 188 }, "name": "UserProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The name of the user." }, "immutable": true, "locationInModule": { "filename": "src/role-binding.ts", "line": 192 }, "name": "name", "type": { "primitive": "string" } } ], "symbolId": "src/role-binding:UserProps" }, "cdk8s-plus-21.Volume": { "assembly": "cdk8s-plus-21", "docs": { "remarks": "Docker also has a concept of volumes, though it is somewhat looser and less\nmanaged. In Docker, a volume is simply a directory on disk or in another\nContainer. Lifetimes are not managed and until very recently there were only\nlocal-disk-backed volumes. Docker now provides volume drivers, but the\nfunctionality is very limited for now (e.g. as of Docker 1.7 only one volume\ndriver is allowed per Container and there is no way to pass parameters to\nvolumes).\n\nA Kubernetes volume, on the other hand, has an explicit lifetime - the same\nas the Pod that encloses it. Consequently, a volume outlives any Containers\nthat run within the Pod, and data is preserved across Container restarts. Of\ncourse, when a Pod ceases to exist, the volume will cease to exist, too.\nPerhaps more importantly than this, Kubernetes supports many types of\nvolumes, and a Pod can use any number of them simultaneously.\n\nAt its core, a volume is just a directory, possibly with some data in it,\nwhich is accessible to the Containers in a Pod. How that directory comes to\nbe, the medium that backs it, and the contents of it are determined by the\nparticular volume type used.\n\nTo use a volume, a Pod specifies what volumes to provide for the Pod (the\n.spec.volumes field) and where to mount those into Containers (the\n.spec.containers[*].volumeMounts field).\n\nA process in a container sees a filesystem view composed from their Docker\nimage and volumes. The Docker image is at the root of the filesystem\nhierarchy, and any volumes are mounted at the specified paths within the\nimage. Volumes can not mount onto other volumes", "stability": "stable", "summary": "Volume represents a named volume in a pod that may be accessed by any container in the pod." }, "fqn": "cdk8s-plus-21.Volume", "interfaces": [ "cdk8s-plus-21.IStorage" ], "kind": "class", "locationInModule": { "filename": "src/volume.ts", "line": 51 }, "methods": [ { "docs": { "remarks": "Unlike emptyDir, which is erased when a pod is removed, the contents of an EBS volume are\npersisted and the volume is unmounted. This means that an EBS volume can be pre-populated with data,\nand that data can be shared between pods.\n\nThere are some restrictions when using an awsElasticBlockStore volume:\n\n- the nodes on which pods are running must be AWS EC2 instances.\n- those instances need to be in the same region and availability zone as the EBS volume.\n- EBS only supports a single EC2 instance mounting a volume.", "stability": "stable", "summary": "Mounts an Amazon Web Services (AWS) EBS volume into your pod." }, "locationInModule": { "filename": "src/volume.ts", "line": 65 }, "name": "fromAwsElasticBlockStore", "parameters": [ { "name": "volumeId", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.AwsElasticBlockStoreVolumeOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Volume" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Mounts a Microsoft Azure Data Disk into a pod." }, "locationInModule": { "filename": "src/volume.ts", "line": 79 }, "name": "fromAzureDisk", "parameters": [ { "name": "diskName", "type": { "primitive": "string" } }, { "name": "diskUri", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.AzureDiskVolumeOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Volume" } }, "static": true }, { "docs": { "remarks": "The configMap resource provides a way to inject configuration data into\nPods. The data stored in a ConfigMap object can be referenced in a volume\nof type configMap and then consumed by containerized applications running\nin a Pod.\n\nWhen referencing a configMap object, you can simply provide its name in the\nvolume to reference it. You can also customize the path to use for a\nspecific entry in the ConfigMap.", "stability": "stable", "summary": "Populate the volume from a ConfigMap." }, "locationInModule": { "filename": "src/volume.ts", "line": 129 }, "name": "fromConfigMap", "parameters": [ { "docs": { "summary": "The config map to use to populate the volume." }, "name": "configMap", "type": { "fqn": "cdk8s-plus-21.IConfigMap" } }, { "docs": { "summary": "Options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.ConfigMapVolumeOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Volume" } }, "static": true }, { "docs": { "remarks": "As the name says, it is\ninitially empty. Containers in the Pod can all read and write the same\nfiles in the emptyDir volume, though that volume can be mounted at the same\nor different paths in each Container. When a Pod is removed from a node for\nany reason, the data in the emptyDir is deleted forever.", "see": "http://kubernetes.io/docs/user-guide/volumes#emptydir", "stability": "stable", "summary": "An emptyDir volume is first created when a Pod is assigned to a Node, and exists as long as that Pod is running on that node." }, "locationInModule": { "filename": "src/volume.ts", "line": 152 }, "name": "fromEmptyDir", "parameters": [ { "name": "name", "type": { "primitive": "string" } }, { "docs": { "summary": "- Additional options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.EmptyDirVolumeOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Volume" } }, "static": true }, { "docs": { "remarks": "Unlike emptyDir, which is erased when a pod is removed, the contents of a PD are\npreserved and the volume is merely unmounted. This means that a PD can be pre-populated\nwith data, and that data can be shared between pods.\n\nThere are some restrictions when using a gcePersistentDisk:\n\n- the nodes on which Pods are running must be GCE VMs\n- those VMs need to be in the same GCE project and zone as the persistent disk", "stability": "stable", "summary": "Mounts a Google Compute Engine (GCE) persistent disk (PD) into your Pod." }, "locationInModule": { "filename": "src/volume.ts", "line": 103 }, "name": "fromGcePersistentDisk", "parameters": [ { "name": "pdName", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.GCEPersistentDiskVolumeOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Volume" } }, "static": true }, { "docs": { "remarks": "PersistentVolumeClaims are a way for users to \"claim\" durable storage (such as a GCE PersistentDisk or an iSCSI volume)\nwithout knowing the details of the particular cloud environment.", "see": "https://kubernetes.io/docs/concepts/storage/persistent-volumes/", "stability": "stable", "summary": "Used to mount a PersistentVolume into a Pod." }, "locationInModule": { "filename": "src/volume.ts", "line": 196 }, "name": "fromPersistentVolumeClaim", "parameters": [ { "name": "claim", "type": { "fqn": "cdk8s-plus-21.IPersistentVolumeClaim" } }, { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.PersistentVolumeClaimVolumeOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Volume" } }, "static": true }, { "docs": { "remarks": "A secret volume is used to pass sensitive information, such as passwords, to Pods.\nYou can store secrets in the Kubernetes API and mount them as files for use by pods\nwithout coupling to Kubernetes directly.\n\nsecret volumes are backed by tmpfs (a RAM-backed filesystem)\nso they are never written to non-volatile storage.", "see": "https://kubernetes.io/docs/concepts/storage/volumes/#secret", "stability": "stable", "summary": "Populate the volume from a Secret." }, "locationInModule": { "filename": "src/volume.ts", "line": 178 }, "name": "fromSecret", "parameters": [ { "docs": { "summary": "The secret to use to populate the volume." }, "name": "secr", "type": { "fqn": "cdk8s-plus-21.ISecret" } }, { "docs": { "summary": "Options." }, "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.SecretVolumeOptions" } } ], "returns": { "type": { "fqn": "cdk8s-plus-21.Volume" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Convert the piece of storage into a concrete volume." }, "locationInModule": { "filename": "src/volume.ts", "line": 226 }, "name": "asVolume", "overrides": "cdk8s-plus-21.IStorage", "returns": { "type": { "fqn": "cdk8s-plus-21.Volume" } } } ], "name": "Volume", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/volume.ts", "line": 222 }, "name": "name", "type": { "primitive": "string" } } ], "symbolId": "src/volume:Volume" }, "cdk8s-plus-21.VolumeMount": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Mount a volume from the pod to the container." }, "fqn": "cdk8s-plus-21.VolumeMount", "interfaces": [ "cdk8s-plus-21.MountOptions" ], "kind": "interface", "locationInModule": { "filename": "src/container.ts", "line": 784 }, "name": "VolumeMount", "properties": [ { "abstract": true, "docs": { "remarks": "Must not\ncontain ':'.", "stability": "stable", "summary": "Path within the container at which the volume should be mounted." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 794 }, "name": "path", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The volume to mount." }, "immutable": true, "locationInModule": { "filename": "src/container.ts", "line": 788 }, "name": "volume", "type": { "fqn": "cdk8s-plus-21.Volume" } } ], "symbolId": "src/container:VolumeMount" }, "cdk8s-plus-21.Workload": { "abstract": true, "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.AbstractPod", "docs": { "remarks": "Whether your workload is a single\ncomponent or several that work together, on Kubernetes you run it inside a set of pods.\nIn Kubernetes, a Pod represents a set of running containers on your cluster.", "stability": "stable", "summary": "A workload is an application running on Kubernetes." }, "fqn": "cdk8s-plus-21.Workload", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/workload.ts", "line": 67 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "cdk8s-plus-21.WorkloadProps" } } ] }, "kind": "class", "locationInModule": { "filename": "src/workload.ts", "line": 56 }, "methods": [ { "docs": { "stability": "stable", "summary": "Configure selectors for this workload." }, "locationInModule": { "filename": "src/workload.ts", "line": 85 }, "name": "select", "parameters": [ { "name": "selectors", "type": { "fqn": "cdk8s-plus-21.LabelSelector" }, "variadic": true } ], "variadic": true } ], "name": "Workload", "properties": [ { "docs": { "remarks": "Returns a a copy. Use `select()` to add expression matchers.", "stability": "stable", "summary": "The expression matchers this workload will use in order to select pods." }, "immutable": true, "locationInModule": { "filename": "src/workload.ts", "line": 109 }, "name": "matchExpressions", "type": { "collection": { "elementtype": { "fqn": "cdk8s-plus-21.LabelSelectorRequirement" }, "kind": "array" } } }, { "docs": { "remarks": "Returns a a copy. Use `select()` to add label matchers.", "stability": "stable", "summary": "The label matchers this workload will use in order to select pods." }, "immutable": true, "locationInModule": { "filename": "src/workload.ts", "line": 94 }, "name": "matchLabels", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "docs": { "stability": "stable", "summary": "The metadata of pods in this workload." }, "immutable": true, "locationInModule": { "filename": "src/workload.ts", "line": 61 }, "name": "podMetadata", "overrides": "cdk8s-plus-21.AbstractPod", "type": { "fqn": "cdk8s.ApiObjectMetadataDefinition" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/workload.ts", "line": 63 }, "name": "scheduling", "type": { "fqn": "cdk8s-plus-21.WorkloadScheduling" } } ], "symbolId": "src/workload:Workload" }, "cdk8s-plus-21.WorkloadProps": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for `Workload`." }, "fqn": "cdk8s-plus-21.WorkloadProps", "interfaces": [ "cdk8s-plus-21.AbstractPodProps" ], "kind": "interface", "locationInModule": { "filename": "src/workload.ts", "line": 10 }, "name": "WorkloadProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The pod metadata of this workload." }, "immutable": true, "locationInModule": { "filename": "src/workload.ts", "line": 15 }, "name": "podMetadata", "optional": true, "type": { "fqn": "cdk8s.ApiObjectMetadata" } }, { "abstract": true, "docs": { "default": "true", "remarks": "This ensures this workload manages pods created by\nits pod template.", "stability": "stable", "summary": "Automatically allocates a pod label selector for this workload and add it to the pod metadata." }, "immutable": true, "locationInModule": { "filename": "src/workload.ts", "line": 24 }, "name": "select", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/workload:WorkloadProps" }, "cdk8s-plus-21.WorkloadScheduling": { "assembly": "cdk8s-plus-21", "base": "cdk8s-plus-21.PodScheduling", "docs": { "remarks": "It offers some additional API's on top of the core pod scheduling.", "stability": "stable", "summary": "Controls the pod scheduling strategy of this workload." }, "fqn": "cdk8s-plus-21.WorkloadScheduling", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/pod.ts", "line": 1247 }, "parameters": [ { "name": "instance", "type": { "fqn": "cdk8s-plus-21.AbstractPod" } } ] }, "kind": "class", "locationInModule": { "filename": "src/workload.ts", "line": 169 }, "methods": [ { "docs": { "remarks": "A spread is a separation of the pod from itself and is used to\nbalance out pod replicas across a given topology.", "stability": "stable", "summary": "Spread the pods in this workload by the topology key." }, "locationInModule": { "filename": "src/workload.ts", "line": 176 }, "name": "spread", "parameters": [ { "name": "options", "optional": true, "type": { "fqn": "cdk8s-plus-21.WorkloadSchedulingSpreadOptions" } } ] } ], "name": "WorkloadScheduling", "symbolId": "src/workload:WorkloadScheduling" }, "cdk8s-plus-21.WorkloadSchedulingSpreadOptions": { "assembly": "cdk8s-plus-21", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `WorkloadScheduling.spread`." }, "fqn": "cdk8s-plus-21.WorkloadSchedulingSpreadOptions", "kind": "interface", "locationInModule": { "filename": "src/workload.ts", "line": 147 }, "name": "WorkloadSchedulingSpreadOptions", "properties": [ { "abstract": true, "docs": { "default": "- Topology.HOSTNAME", "stability": "stable", "summary": "Which topology to spread on." }, "immutable": true, "locationInModule": { "filename": "src/workload.ts", "line": 161 }, "name": "topology", "optional": true, "type": { "fqn": "cdk8s-plus-21.Topology" } }, { "abstract": true, "docs": { "default": "- no weight. spread is assumed to be required.", "stability": "stable", "summary": "Indicates the spread is optional, with this weight score." }, "immutable": true, "locationInModule": { "filename": "src/workload.ts", "line": 154 }, "name": "weight", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "src/workload:WorkloadSchedulingSpreadOptions" } }, "version": "2.0.0-beta.12", "fingerprint": "hoSTdJ6OshO+JwPYdS8nUorNlphrxLWFZaMyB/HuAoY=" }