diff --git a/.eslintrc.json b/.eslintrc.json new file mode 100644 index 0000000..f7cd225 --- /dev/null +++ b/.eslintrc.json @@ -0,0 +1,231 @@ +{ + "env": { + "jest": true, + "node": true + }, + "root": true, + "plugins": [ + "@typescript-eslint", + "import" + ], + "parser": "@typescript-eslint/parser", + "parserOptions": { + "ecmaVersion": 2018, + "sourceType": "module", + "project": "./tsconfig.dev.json" + }, + "extends": [ + "plugin:import/typescript" + ], + "settings": { + "import/parsers": { + "@typescript-eslint/parser": [ + ".ts", + ".tsx" + ] + }, + "import/resolver": { + "node": {}, + "typescript": { + "project": "./tsconfig.dev.json", + "alwaysTryTypes": true + } + } + }, + "ignorePatterns": [ + "*.js", + "!.projenrc.js", + "*.d.ts", + "node_modules/", + "*.generated.ts", + "coverage" + ], + "rules": { + "indent": [ + "off" + ], + "@typescript-eslint/indent": [ + "error", + 2 + ], + "quotes": [ + "error", + "single", + { + "avoidEscape": true + } + ], + "comma-dangle": [ + "error", + "always-multiline" + ], + "comma-spacing": [ + "error", + { + "before": false, + "after": true + } + ], + "no-multi-spaces": [ + "error", + { + "ignoreEOLComments": false + } + ], + "array-bracket-spacing": [ + "error", + "never" + ], + "array-bracket-newline": [ + "error", + "consistent" + ], + "object-curly-spacing": [ + "error", + "always" + ], + "object-curly-newline": [ + "error", + { + "multiline": true, + "consistent": true + } + ], + "object-property-newline": [ + "error", + { + "allowAllPropertiesOnSameLine": true + } + ], + "keyword-spacing": [ + "error" + ], + "brace-style": [ + "error", + "1tbs", + { + "allowSingleLine": true + } + ], + "space-before-blocks": [ + "error" + ], + "curly": [ + "error", + "multi-line", + "consistent" + ], + "@typescript-eslint/member-delimiter-style": [ + "error" + ], + "semi": [ + "error", + "always" + ], + "max-len": [ + "error", + { + "code": 150, + "ignoreUrls": true, + "ignoreStrings": true, + "ignoreTemplateLiterals": true, + "ignoreComments": true, + "ignoreRegExpLiterals": true + } + ], + "quote-props": [ + "error", + "consistent-as-needed" + ], + "@typescript-eslint/no-require-imports": [ + "error" + ], + "import/no-extraneous-dependencies": [ + "error", + { + "devDependencies": [ + "**/test/**", + "**/build-tools/**" + ], + "optionalDependencies": false, + "peerDependencies": true + } + ], + "import/no-unresolved": [ + "error" + ], + "import/order": [ + "warn", + { + "groups": [ + "builtin", + "external" + ], + "alphabetize": { + "order": "asc", + "caseInsensitive": true + } + } + ], + "no-duplicate-imports": [ + "error" + ], + "no-shadow": [ + "off" + ], + "@typescript-eslint/no-shadow": [ + "error" + ], + "key-spacing": [ + "error" + ], + "no-multiple-empty-lines": [ + "error" + ], + "@typescript-eslint/no-floating-promises": [ + "error" + ], + "no-return-await": [ + "off" + ], + "@typescript-eslint/return-await": [ + "error" + ], + "no-trailing-spaces": [ + "error" + ], + "dot-notation": [ + "error" + ], + "no-bitwise": [ + "error" + ], + "@typescript-eslint/member-ordering": [ + "error", + { + "default": [ + "public-static-field", + "public-static-method", + "protected-static-field", + "protected-static-method", + "private-static-field", + "private-static-method", + "field", + "constructor", + "method" + ] + } + ] + }, + "overrides": [ + { + "files": [ + ".projenrc.js" + ], + "rules": { + "@typescript-eslint/no-require-imports": "off", + "import/no-extraneous-dependencies": "off" + } + } + ] +} diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..829e37b --- /dev/null +++ b/.gitattributes @@ -0,0 +1,21 @@ +# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen". + +*.snap linguist-generated +/.eslintrc.json linguist-generated +/.gitattributes linguist-generated +/.github/pull_request_template.md linguist-generated +/.github/workflows/build.yml linguist-generated +/.github/workflows/pull-request-lint.yml linguist-generated +/.github/workflows/release.yml linguist-generated +/.github/workflows/upgrade-main.yml linguist-generated +/.gitignore linguist-generated +/.mergify.yml linguist-generated +/.npmignore linguist-generated +/.projen/** linguist-generated +/.projen/deps.json linguist-generated +/.projen/files.json linguist-generated +/.projen/tasks.json linguist-generated +/LICENSE linguist-generated +/package.json linguist-generated +/tsconfig.dev.json linguist-generated +/yarn.lock linguist-generated \ No newline at end of file diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..9df5170 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +* @majordwarf +* @Hunter-Thompson \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..11d479b --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1 @@ +Fixes # \ No newline at end of file diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..f4bb983 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,98 @@ +# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen". + +name: build +on: + pull_request: {} + workflow_dispatch: {} +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: write + outputs: + self_mutation_happened: ${{ steps.self_mutation.outputs.self_mutation_happened }} + env: + CI: "true" + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + ref: ${{ github.event.pull_request.head.ref }} + repository: ${{ github.event.pull_request.head.repo.full_name }} + - name: Install dependencies + run: yarn install --check-files + - name: build + run: npx projen build + - id: self_mutation + name: Find mutations + run: |- + git add . + git diff --staged --patch --exit-code > .repo.patch || echo "::set-output name=self_mutation_happened::true" + - if: steps.self_mutation.outputs.self_mutation_happened + name: Upload patch + uses: actions/upload-artifact@v2 + with: + name: .repo.patch + path: .repo.patch + - name: Fail build on mutation + if: steps.self_mutation.outputs.self_mutation_happened + run: |- + echo "::error::Files were changed during build (see build log). If this was triggered from a fork, you will need to update your branch." + cat .repo.patch + exit 1 + - name: Upload artifact + uses: actions/upload-artifact@v2.1.1 + with: + name: build-artifact + path: dist + self-mutation: + needs: build + runs-on: ubuntu-latest + permissions: + contents: write + if: always() && needs.build.outputs.self_mutation_happened && !(github.event.pull_request.head.repo.full_name != github.repository) + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + token: ${{ secrets.PROJEN_GITHUB_TOKEN }} + ref: ${{ github.event.pull_request.head.ref }} + repository: ${{ github.event.pull_request.head.repo.full_name }} + - name: Download patch + uses: actions/download-artifact@v2 + with: + name: .repo.patch + path: ${{ runner.temp }} + - name: Apply patch + run: '[ -s ${{ runner.temp }}/.repo.patch ] && git apply ${{ runner.temp }}/.repo.patch || echo "Empty patch. Skipping."' + - name: Set git identity + run: |- + git config user.name "github-actions" + git config user.email "github-actions@github.com" + - name: Push changes + run: |2- + git add . + git commit -s -m "chore: self mutation" + git push origin HEAD:${{ github.event.pull_request.head.ref }} + package-js: + needs: build + runs-on: ubuntu-latest + permissions: {} + if: "! needs.build.outputs.self_mutation_happened" + steps: + - uses: actions/setup-node@v2 + with: + node-version: 14.x + - name: Download build artifacts + uses: actions/download-artifact@v2 + with: + name: build-artifact + path: dist + - name: Prepare Repository + run: mv dist .repo + - name: Install Dependencies + run: cd .repo && yarn install --check-files --frozen-lockfile + - name: Create js artifact + run: cd .repo && npx projen package:js + - name: Collect js Artifact + run: mv .repo/dist dist diff --git a/.github/workflows/pull-request-lint.yml b/.github/workflows/pull-request-lint.yml new file mode 100644 index 0000000..2945378 --- /dev/null +++ b/.github/workflows/pull-request-lint.yml @@ -0,0 +1,28 @@ +# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen". + +name: pull-request-lint +on: + pull_request_target: + types: + - labeled + - opened + - synchronize + - reopened + - ready_for_review + - edited +jobs: + validate: + name: Validate PR title + runs-on: ubuntu-latest + permissions: + pull-requests: write + steps: + - uses: amannn/action-semantic-pull-request@v3.4.6 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + types: |- + feat + fix + chore + requireScope: false diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..479a9d0 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,95 @@ +# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen". + +name: release +on: + push: + branches: + - main + workflow_dispatch: {} +jobs: + release: + runs-on: ubuntu-latest + permissions: + contents: write + outputs: + latest_commit: ${{ steps.git_remote.outputs.latest_commit }} + env: + CI: "true" + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + fetch-depth: 0 + - name: Set git identity + run: |- + git config user.name "github-actions" + git config user.email "github-actions@github.com" + - name: Install dependencies + run: yarn install --check-files --frozen-lockfile + - name: release + run: npx projen release + - name: Check for new commits + id: git_remote + run: echo ::set-output name=latest_commit::"$(git ls-remote origin -h ${{ github.ref }} | cut -f1)" + - name: Upload artifact + if: ${{ steps.git_remote.outputs.latest_commit == github.sha }} + uses: actions/upload-artifact@v2.1.1 + with: + name: build-artifact + path: dist + release_github: + name: Publish to GitHub Releases + needs: release + runs-on: ubuntu-latest + permissions: + contents: write + if: needs.release.outputs.latest_commit == github.sha + steps: + - uses: actions/setup-node@v2 + with: + node-version: 14.x + - name: Download build artifacts + uses: actions/download-artifact@v2 + with: + name: build-artifact + path: dist + - name: Prepare Repository + run: mv dist .repo + - name: Collect GitHub Metadata + run: mv .repo/dist dist + - name: Release + run: errout=$(mktemp); gh release create $(cat dist/releasetag.txt) -R $GITHUB_REPOSITORY -F dist/changelog.md -t $(cat dist/releasetag.txt) --target $GITHUB_REF 2> $errout && true; exitcode=$?; if [ $exitcode -ne 0 ] && ! grep -q "Release.tag_name already exists" $errout; then cat $errout; exit $exitcode; fi + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GITHUB_REPOSITORY: ${{ github.repository }} + GITHUB_REF: ${{ github.ref }} + release_npm: + name: Publish to npm + needs: release + runs-on: ubuntu-latest + permissions: + contents: read + if: needs.release.outputs.latest_commit == github.sha + steps: + - uses: actions/setup-node@v2 + with: + node-version: 14.x + - name: Download build artifacts + uses: actions/download-artifact@v2 + with: + name: build-artifact + path: dist + - name: Prepare Repository + run: mv dist .repo + - name: Install Dependencies + run: cd .repo && yarn install --check-files --frozen-lockfile + - name: Create js artifact + run: cd .repo && npx projen package:js + - name: Collect js Artifact + run: mv .repo/dist dist + - name: Release + run: npx -p publib@latest publib-npm + env: + NPM_DIST_TAG: latest + NPM_REGISTRY: registry.npmjs.org + NPM_TOKEN: ${{ secrets.NPM_TOKEN }} diff --git a/.github/workflows/upgrade-main.yml b/.github/workflows/upgrade-main.yml new file mode 100644 index 0000000..4202da9 --- /dev/null +++ b/.github/workflows/upgrade-main.yml @@ -0,0 +1,88 @@ +# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen". + +name: upgrade-main +on: + workflow_dispatch: {} + schedule: + - cron: 0 0 * * * +jobs: + upgrade: + name: Upgrade + runs-on: ubuntu-latest + permissions: + contents: read + outputs: + patch_created: ${{ steps.create_patch.outputs.patch_created }} + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + ref: main + - name: Install dependencies + run: yarn install --check-files --frozen-lockfile + - name: Upgrade dependencies + run: npx projen upgrade + - id: create_patch + name: Find mutations + run: |- + git add . + git diff --staged --patch --exit-code > .repo.patch || echo "::set-output name=patch_created::true" + - if: steps.create_patch.outputs.patch_created + name: Upload patch + uses: actions/upload-artifact@v2 + with: + name: .repo.patch + path: .repo.patch + pr: + name: Create Pull Request + needs: upgrade + runs-on: ubuntu-latest + permissions: + contents: write + pull-requests: write + if: ${{ needs.upgrade.outputs.patch_created }} + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + token: ${{ secrets.PROJEN_GITHUB_TOKEN }} + ref: main + - name: Download patch + uses: actions/download-artifact@v2 + with: + name: .repo.patch + path: ${{ runner.temp }} + - name: Apply patch + run: '[ -s ${{ runner.temp }}/.repo.patch ] && git apply ${{ runner.temp }}/.repo.patch || echo "Empty patch. Skipping."' + - name: Set git identity + run: |- + git config user.name "github-actions" + git config user.email "github-actions@github.com" + - name: Create Pull Request + id: create-pr + uses: peter-evans/create-pull-request@v3 + with: + token: ${{ secrets.PROJEN_GITHUB_TOKEN }} + commit-message: |- + chore(deps): upgrade dependencies + + Upgrades project dependencies. See details in [workflow run]. + + [Workflow Run]: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }} + + ------ + + *Automatically created by projen via the "upgrade-main" workflow* + branch: github-actions/upgrade-main + title: "chore(deps): upgrade dependencies" + body: |- + Upgrades project dependencies. See details in [workflow run]. + + [Workflow Run]: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }} + + ------ + + *Automatically created by projen via the "upgrade-main" workflow* + author: github-actions + committer: github-actions + signoff: true diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e31dd32 --- /dev/null +++ b/.gitignore @@ -0,0 +1,52 @@ +# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen". +!/.gitattributes +!/.projen/tasks.json +!/.projen/deps.json +!/.projen/files.json +!/.github/workflows/pull-request-lint.yml +!/package.json +!/LICENSE +!/.npmignore +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +lerna-debug.log* +report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json +pids +*.pid +*.seed +*.pid.lock +lib-cov +coverage +*.lcov +.nyc_output +build/Release +node_modules/ +jspm_packages/ +*.tsbuildinfo +.eslintcache +*.tgz +.yarn-integrity +.cache +!/.projenrc.js +/test-reports/ +junit.xml +/coverage/ +!/.github/workflows/build.yml +/dist/changelog.md +/dist/version.txt +!/.github/workflows/release.yml +!/.mergify.yml +!/.github/workflows/upgrade-main.yml +!/.github/pull_request_template.md +!/test/ +!/tsconfig.dev.json +!/src/ +/lib +/dist/ +!/.eslintrc.json +.jsii +tsconfig.json +!/API.md diff --git a/.mergify.yml b/.mergify.yml new file mode 100644 index 0000000..fa09059 --- /dev/null +++ b/.mergify.yml @@ -0,0 +1,25 @@ +# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen". + +queue_rules: + - name: default + conditions: + - "#approved-reviews-by>=1" + - -label~=(do-not-merge) + - status-success=build + - status-success=package-js +pull_request_rules: + - name: Automatic merge on approval and successful build + actions: + delete_head_branch: {} + queue: + method: squash + name: default + commit_message_template: |- + {{ title }} (#{{ number }}) + + {{ body }} + conditions: + - "#approved-reviews-by>=1" + - -label~=(do-not-merge) + - status-success=build + - status-success=package-js diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..263c319 --- /dev/null +++ b/.npmignore @@ -0,0 +1,24 @@ +# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen". +!configmap.yaml +/.projen/ +/test-reports/ +junit.xml +/coverage/ +/dist/changelog.md +/dist/version.txt +/.mergify.yml +/test/ +/tsconfig.dev.json +/src/ +!/lib/ +!/lib/**/*.js +!/lib/**/*.d.ts +dist +/tsconfig.json +/.github/ +/.vscode/ +/.idea/ +/.projenrc.js +tsconfig.tsbuildinfo +/.eslintrc.json +!.jsii diff --git a/.projen/deps.json b/.projen/deps.json new file mode 100644 index 0000000..cf78c65 --- /dev/null +++ b/.projen/deps.json @@ -0,0 +1,112 @@ +{ + "dependencies": [ + { + "name": "@types/jest", + "type": "build" + }, + { + "name": "@types/node", + "version": "^12", + "type": "build" + }, + { + "name": "@typescript-eslint/eslint-plugin", + "version": "^5", + "type": "build" + }, + { + "name": "@typescript-eslint/parser", + "version": "^5", + "type": "build" + }, + { + "name": "cdk8s", + "version": "1.4.10", + "type": "build" + }, + { + "name": "constructs", + "version": "3.3.196", + "type": "build" + }, + { + "name": "eslint-import-resolver-node", + "type": "build" + }, + { + "name": "eslint-import-resolver-typescript", + "type": "build" + }, + { + "name": "eslint-plugin-import", + "type": "build" + }, + { + "name": "eslint", + "version": "^8", + "type": "build" + }, + { + "name": "jest", + "type": "build" + }, + { + "name": "jest-junit", + "version": "^13", + "type": "build" + }, + { + "name": "jsii", + "type": "build" + }, + { + "name": "jsii-diff", + "type": "build" + }, + { + "name": "jsii-docgen", + "type": "build" + }, + { + "name": "jsii-pacmak", + "type": "build" + }, + { + "name": "json-schema", + "type": "build" + }, + { + "name": "npm-check-updates", + "version": "^12", + "type": "build" + }, + { + "name": "projen", + "type": "build" + }, + { + "name": "standard-version", + "version": "^9", + "type": "build" + }, + { + "name": "ts-jest", + "type": "build" + }, + { + "name": "typescript", + "type": "build" + }, + { + "name": "cdk8s", + "version": "^1.4.10", + "type": "peer" + }, + { + "name": "constructs", + "version": "^3.3.196", + "type": "peer" + } + ], + "//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"npx projen\"." +} diff --git a/.projen/files.json b/.projen/files.json new file mode 100644 index 0000000..ffcd5fd --- /dev/null +++ b/.projen/files.json @@ -0,0 +1,19 @@ +{ + "files": [ + ".eslintrc.json", + ".gitattributes", + ".github/pull_request_template.md", + ".github/workflows/build.yml", + ".github/workflows/pull-request-lint.yml", + ".github/workflows/release.yml", + ".github/workflows/upgrade-main.yml", + ".gitignore", + ".mergify.yml", + ".projen/deps.json", + ".projen/files.json", + ".projen/tasks.json", + "LICENSE", + "tsconfig.dev.json" + ], + "//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"npx projen\"." +} diff --git a/.projen/tasks.json b/.projen/tasks.json new file mode 100644 index 0000000..9f49ddb --- /dev/null +++ b/.projen/tasks.json @@ -0,0 +1,339 @@ +{ + "tasks": { + "build": { + "name": "build", + "description": "Full release build", + "steps": [ + { + "spawn": "default" + }, + { + "spawn": "pre-compile" + }, + { + "spawn": "compile" + }, + { + "spawn": "post-compile" + }, + { + "spawn": "test" + }, + { + "spawn": "package" + } + ] + }, + "bump": { + "name": "bump", + "description": "Bumps version based on latest git tag and generates a changelog entry", + "env": { + "OUTFILE": "package.json", + "CHANGELOG": "dist/changelog.md", + "BUMPFILE": "dist/version.txt", + "RELEASETAG": "dist/releasetag.txt", + "RELEASE_TAG_PREFIX": "" + }, + "steps": [ + { + "builtin": "release/bump-version" + } + ], + "condition": "! git log --oneline -1 | grep -q \"chore(release):\"" + }, + "clobber": { + "name": "clobber", + "description": "hard resets to HEAD of origin and cleans the local repo", + "env": { + "BRANCH": "$(git branch --show-current)" + }, + "steps": [ + { + "exec": "git checkout -b scratch", + "name": "save current HEAD in \"scratch\" branch" + }, + { + "exec": "git checkout $BRANCH" + }, + { + "exec": "git fetch origin", + "name": "fetch latest changes from origin" + }, + { + "exec": "git reset --hard origin/$BRANCH", + "name": "hard reset to origin commit" + }, + { + "exec": "git clean -fdx", + "name": "clean all untracked files" + }, + { + "say": "ready to rock! (unpushed commits are under the \"scratch\" branch)" + } + ], + "condition": "git diff --exit-code > /dev/null" + }, + "compat": { + "name": "compat", + "description": "Perform API compatibility check against latest version", + "steps": [ + { + "exec": "jsii-diff npm:$(node -p \"require('./package.json').name\") -k --ignore-file .compatignore || (echo \"\nUNEXPECTED BREAKING CHANGES: add keys such as 'removed:constructs.Node.of' to .compatignore to skip.\n\" && exit 1)" + } + ] + }, + "compile": { + "name": "compile", + "description": "Only compile", + "steps": [ + { + "exec": "jsii --silence-warnings=reserved-word --no-fix-peer-dependencies" + } + ] + }, + "default": { + "name": "default", + "description": "Synthesize project files", + "steps": [ + { + "exec": "node .projenrc.js" + } + ] + }, + "docgen": { + "name": "docgen", + "description": "Generate API.md from .jsii manifest", + "steps": [ + { + "exec": "jsii-docgen -o API.md" + } + ] + }, + "eject": { + "name": "eject", + "description": "Remove projen from the project", + "env": { + "PROJEN_EJECTING": "true" + }, + "steps": [ + { + "spawn": "default" + } + ] + }, + "eslint": { + "name": "eslint", + "description": "Runs eslint against the codebase", + "steps": [ + { + "exec": "eslint --ext .ts,.tsx --fix --no-error-on-unmatched-pattern src test build-tools .projenrc.js" + } + ] + }, + "package": { + "name": "package", + "description": "Creates the distribution package", + "steps": [ + { + "exec": "if [ ! -z ${CI} ]; then mkdir -p dist && rsync -a . dist --exclude .git --exclude node_modules; else npx projen package-all; fi" + } + ] + }, + "package-all": { + "name": "package-all", + "description": "Packages artifacts for all target languages", + "steps": [ + { + "spawn": "package:js" + } + ] + }, + "package:js": { + "name": "package:js", + "description": "Create js language bindings", + "steps": [ + { + "exec": "jsii-pacmak -v --target js" + } + ] + }, + "post-compile": { + "name": "post-compile", + "description": "Runs after successful compilation", + "steps": [ + { + "spawn": "docgen" + } + ] + }, + "post-upgrade": { + "name": "post-upgrade", + "description": "Runs after upgrading dependencies" + }, + "pre-compile": { + "name": "pre-compile", + "description": "Prepare the project for compilation" + }, + "release": { + "name": "release", + "description": "Prepare a release from \"main\" branch", + "env": { + "RELEASE": "true" + }, + "steps": [ + { + "exec": "rm -fr dist" + }, + { + "spawn": "bump" + }, + { + "spawn": "build" + }, + { + "spawn": "unbump" + }, + { + "exec": "git diff --ignore-space-at-eol --exit-code" + } + ] + }, + "test": { + "name": "test", + "description": "Run tests", + "steps": [ + { + "exec": "jest --passWithNoTests --all --updateSnapshot" + }, + { + "spawn": "eslint" + } + ] + }, + "test:update": { + "name": "test:update", + "description": "Update jest snapshots", + "steps": [ + { + "exec": "jest --updateSnapshot" + } + ] + }, + "test:watch": { + "name": "test:watch", + "description": "Run jest in watch mode", + "steps": [ + { + "exec": "jest --watch" + } + ] + }, + "unbump": { + "name": "unbump", + "description": "Restores version to 0.0.0", + "env": { + "OUTFILE": "package.json", + "CHANGELOG": "dist/changelog.md", + "BUMPFILE": "dist/version.txt", + "RELEASETAG": "dist/releasetag.txt", + "RELEASE_TAG_PREFIX": "" + }, + "steps": [ + { + "builtin": "release/reset-version" + } + ] + }, + "upgrade": { + "name": "upgrade", + "description": "upgrade dependencies", + "env": { + "CI": "0" + }, + "steps": [ + { + "exec": "yarn upgrade npm-check-updates" + }, + { + "exec": "npm-check-updates --dep dev --upgrade --target=minor --reject='cdk8s,constructs,projen'" + }, + { + "exec": "npm-check-updates --dep optional --upgrade --target=minor --reject='cdk8s,constructs,projen'" + }, + { + "exec": "npm-check-updates --dep peer --upgrade --target=minor --reject='cdk8s,constructs,projen'" + }, + { + "exec": "npm-check-updates --dep prod --upgrade --target=minor --reject='cdk8s,constructs,projen'" + }, + { + "exec": "npm-check-updates --dep bundle --upgrade --target=minor --reject='cdk8s,constructs,projen'" + }, + { + "exec": "yarn install --check-files" + }, + { + "exec": "yarn upgrade @types/jest @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser cdk8s constructs eslint-import-resolver-node eslint-import-resolver-typescript eslint-plugin-import eslint jest jest-junit jsii jsii-diff jsii-docgen jsii-pacmak json-schema npm-check-updates standard-version ts-jest typescript cdk8s constructs" + }, + { + "exec": "npx projen" + }, + { + "spawn": "post-upgrade" + } + ] + }, + "upgrade-projen": { + "name": "upgrade-projen", + "description": "upgrade projen", + "env": { + "CI": "0" + }, + "steps": [ + { + "exec": "yarn upgrade npm-check-updates" + }, + { + "exec": "npm-check-updates --dep dev --upgrade --target=minor --filter='projen'" + }, + { + "exec": "npm-check-updates --dep optional --upgrade --target=minor --filter='projen'" + }, + { + "exec": "npm-check-updates --dep peer --upgrade --target=minor --filter='projen'" + }, + { + "exec": "npm-check-updates --dep prod --upgrade --target=minor --filter='projen'" + }, + { + "exec": "npm-check-updates --dep bundle --upgrade --target=minor --filter='projen'" + }, + { + "exec": "yarn install --check-files" + }, + { + "exec": "yarn upgrade projen" + }, + { + "exec": "npx projen" + }, + { + "spawn": "post-upgrade" + } + ] + }, + "watch": { + "name": "watch", + "description": "Watch & compile in the background", + "steps": [ + { + "exec": "jsii -w --silence-warnings=reserved-word --no-fix-peer-dependencies" + } + ] + } + }, + "env": { + "PATH": "$(npx -c \"node -e \\\"console.log(process.env.PATH)\\\"\")" + }, + "//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"npx projen\"." +} diff --git a/.projenrc.js b/.projenrc.js new file mode 100644 index 0000000..de0f378 --- /dev/null +++ b/.projenrc.js @@ -0,0 +1,20 @@ +const { cdk8s } = require('projen'); +const { NpmAccess } = require('projen/lib/javascript'); +const project = new cdk8s.ConstructLibraryCdk8s({ + author: 'majordwarf', + authorAddress: 'tejas.tank@smallcase.com', + cdk8sVersion: '1.4.10', + defaultReleaseBranch: 'main', + name: '@smallcase/cdk8s-botkube', + repositoryUrl: 'https://github.com/smallcase/cdk8s-botkube.git', + release: true, + npmAccess: NpmAccess.PUBLIC, + npmignore: [ + '!configmap.yaml', + ], + // deps: [], /* Runtime dependencies of this module. */ + // description: undefined, /* The description is just a string that helps people understand the purpose of the package. */ + // devDeps: [], /* Build dependencies for this module. */ + // packageName: undefined, /* The "name" in package.json. */ +}); +project.synth(); diff --git a/API.md b/API.md new file mode 100644 index 0000000..0e4b157 --- /dev/null +++ b/API.md @@ -0,0 +1,85658 @@ +# API Reference + +## Constructs + +### BotKube + +#### Initializers + +```typescript +import { BotKube } from '@smallcase/cdk8s-botkube' + +new BotKube(scope: Construct, id: string, options?: BotKubeOptions) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| options | BotKubeOptions | *No description.* | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +--- + +##### `id`Required + +- *Type:* string + +--- + +##### `options`Optional + +- *Type:* BotKubeOptions + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + + + + +### KubeApiService + +APIService represents a server for a particular GroupVersion. + +Name must be "version.group". + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeApiService(scope: Construct, id: string, props?: KubeApiServiceProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeApiServiceProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeApiServiceProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeApiService.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeApiService.manifest(props?: KubeApiServiceProps) +``` + +Renders a Kubernetes manifest for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeApiServiceProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService". + +--- + +### KubeApiServiceList + +APIServiceList is a list of APIService objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeApiServiceList(scope: Construct, id: string, props: KubeApiServiceListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeApiServiceListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeApiServiceListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeApiServiceList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeApiServiceList.manifest(props: KubeApiServiceListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeApiServiceListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList". + +--- + +### KubeApiServiceListV1Beta1 + +APIServiceList is a list of APIService objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeApiServiceListV1Beta1(scope: Construct, id: string, props: KubeApiServiceListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeApiServiceListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeApiServiceListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeApiServiceListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeApiServiceListV1Beta1.manifest(props: KubeApiServiceListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeApiServiceListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceList". + +--- + +### KubeApiServiceV1Beta1 + +APIService represents a server for a particular GroupVersion. + +Name must be "version.group". + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeApiServiceV1Beta1(scope: Construct, id: string, props?: KubeApiServiceV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeApiServiceV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeApiServiceV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIService". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeApiServiceV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeApiServiceV1Beta1.manifest(props?: KubeApiServiceV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIService". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeApiServiceV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIService". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIService". + +--- + +### KubeBinding + +Binding ties one object to another; + +for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeBinding(scope: Construct, id: string, props: KubeBindingProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeBindingProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeBindingProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.Binding". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeBinding.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeBinding.manifest(props: KubeBindingProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.Binding". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeBindingProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.Binding". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.Binding". + +--- + +### KubeCertificateSigningRequest + +CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request, and having it asynchronously approved and issued. + +Kubelets use this API to obtain: +1. client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client-kubelet" signerName). +2. serving certificates for TLS endpoints kube-apiserver can connect to securely (with the "kubernetes.io/kubelet-serving" signerName). + +This API can be used to request client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client" signerName), or to obtain certificates from custom non-Kubernetes signers. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCertificateSigningRequest(scope: Construct, id: string, props: KubeCertificateSigningRequestProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.certificates.v1.CertificateSigningRequest". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCertificateSigningRequest.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCertificateSigningRequest.manifest(props: KubeCertificateSigningRequestProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.certificates.v1.CertificateSigningRequest". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.certificates.v1.CertificateSigningRequest". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.certificates.v1.CertificateSigningRequest". + +--- + +### KubeCertificateSigningRequestList + +CertificateSigningRequestList is a collection of CertificateSigningRequest objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCertificateSigningRequestList(scope: Construct, id: string, props: KubeCertificateSigningRequestListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.certificates.v1.CertificateSigningRequestList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCertificateSigningRequestList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCertificateSigningRequestList.manifest(props: KubeCertificateSigningRequestListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.certificates.v1.CertificateSigningRequestList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.certificates.v1.CertificateSigningRequestList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.certificates.v1.CertificateSigningRequestList". + +--- + +### KubeCertificateSigningRequestListV1Beta1 + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCertificateSigningRequestListV1Beta1(scope: Construct, id: string, props: KubeCertificateSigningRequestListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.certificates.v1beta1.CertificateSigningRequestList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCertificateSigningRequestListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCertificateSigningRequestListV1Beta1.manifest(props: KubeCertificateSigningRequestListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.certificates.v1beta1.CertificateSigningRequestList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.certificates.v1beta1.CertificateSigningRequestList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.certificates.v1beta1.CertificateSigningRequestList". + +--- + +### KubeCertificateSigningRequestV1Beta1 + +Describes a certificate signing request. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCertificateSigningRequestV1Beta1(scope: Construct, id: string, props?: KubeCertificateSigningRequestV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.certificates.v1beta1.CertificateSigningRequest". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCertificateSigningRequestV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCertificateSigningRequestV1Beta1.manifest(props?: KubeCertificateSigningRequestV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.certificates.v1beta1.CertificateSigningRequest". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.certificates.v1beta1.CertificateSigningRequest". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.certificates.v1beta1.CertificateSigningRequest". + +--- + +### KubeClusterRole + +ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeClusterRole(scope: Construct, id: string, props?: KubeClusterRoleProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.ClusterRole". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRole.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRole.manifest(props?: KubeClusterRoleProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.ClusterRole". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRole". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRole". + +--- + +### KubeClusterRoleBinding + +ClusterRoleBinding references a ClusterRole, but not contain it. + +It can reference a ClusterRole in the global namespace, and adds who information via Subject. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeClusterRoleBinding(scope: Construct, id: string, props: KubeClusterRoleBindingProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.ClusterRoleBinding". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleBinding.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleBinding.manifest(props: KubeClusterRoleBindingProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.ClusterRoleBinding". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleBinding". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleBinding". + +--- + +### KubeClusterRoleBindingList + +ClusterRoleBindingList is a collection of ClusterRoleBindings. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeClusterRoleBindingList(scope: Construct, id: string, props: KubeClusterRoleBindingListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.ClusterRoleBindingList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleBindingList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleBindingList.manifest(props: KubeClusterRoleBindingListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.ClusterRoleBindingList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleBindingList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleBindingList". + +--- + +### KubeClusterRoleBindingListV1Alpha1 + +ClusterRoleBindingList is a collection of ClusterRoleBindings. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBindings, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeClusterRoleBindingListV1Alpha1(scope: Construct, id: string, props: KubeClusterRoleBindingListV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingListV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingListV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.ClusterRoleBindingList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleBindingListV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleBindingListV1Alpha1.manifest(props: KubeClusterRoleBindingListV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.ClusterRoleBindingList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingListV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.ClusterRoleBindingList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.ClusterRoleBindingList". + +--- + +### KubeClusterRoleBindingListV1Beta1 + +ClusterRoleBindingList is a collection of ClusterRoleBindings. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBindingList, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeClusterRoleBindingListV1Beta1(scope: Construct, id: string, props: KubeClusterRoleBindingListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.ClusterRoleBindingList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleBindingListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleBindingListV1Beta1.manifest(props: KubeClusterRoleBindingListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.ClusterRoleBindingList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.ClusterRoleBindingList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.ClusterRoleBindingList". + +--- + +### KubeClusterRoleBindingV1Alpha1 + +ClusterRoleBinding references a ClusterRole, but not contain it. + +It can reference a ClusterRole in the global namespace, and adds who information via Subject. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBinding, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeClusterRoleBindingV1Alpha1(scope: Construct, id: string, props: KubeClusterRoleBindingV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.ClusterRoleBinding". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleBindingV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleBindingV1Alpha1.manifest(props: KubeClusterRoleBindingV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.ClusterRoleBinding". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.ClusterRoleBinding". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.ClusterRoleBinding". + +--- + +### KubeClusterRoleBindingV1Beta1 + +ClusterRoleBinding references a ClusterRole, but not contain it. + +It can reference a ClusterRole in the global namespace, and adds who information via Subject. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBinding, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeClusterRoleBindingV1Beta1(scope: Construct, id: string, props: KubeClusterRoleBindingV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.ClusterRoleBinding". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleBindingV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleBindingV1Beta1.manifest(props: KubeClusterRoleBindingV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.ClusterRoleBinding". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.ClusterRoleBinding". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.ClusterRoleBinding". + +--- + +### KubeClusterRoleList + +ClusterRoleList is a collection of ClusterRoles. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeClusterRoleList(scope: Construct, id: string, props: KubeClusterRoleListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.ClusterRoleList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleList.manifest(props: KubeClusterRoleListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.ClusterRoleList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleList". + +--- + +### KubeClusterRoleListV1Alpha1 + +ClusterRoleList is a collection of ClusterRoles. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoles, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeClusterRoleListV1Alpha1(scope: Construct, id: string, props: KubeClusterRoleListV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleListV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleListV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.ClusterRoleList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleListV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleListV1Alpha1.manifest(props: KubeClusterRoleListV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.ClusterRoleList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleListV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.ClusterRoleList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.ClusterRoleList". + +--- + +### KubeClusterRoleListV1Beta1 + +ClusterRoleList is a collection of ClusterRoles. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoles, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeClusterRoleListV1Beta1(scope: Construct, id: string, props: KubeClusterRoleListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.ClusterRoleList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleListV1Beta1.manifest(props: KubeClusterRoleListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.ClusterRoleList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.ClusterRoleList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.ClusterRoleList". + +--- + +### KubeClusterRoleV1Alpha1 + +ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRole, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeClusterRoleV1Alpha1(scope: Construct, id: string, props?: KubeClusterRoleV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.ClusterRole". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleV1Alpha1.manifest(props?: KubeClusterRoleV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.ClusterRole". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.ClusterRole". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.ClusterRole". + +--- + +### KubeClusterRoleV1Beta1 + +ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRole, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeClusterRoleV1Beta1(scope: Construct, id: string, props?: KubeClusterRoleV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.ClusterRole". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeClusterRoleV1Beta1.manifest(props?: KubeClusterRoleV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.ClusterRole". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.ClusterRole". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.ClusterRole". + +--- + +### KubeComponentStatus + +ComponentStatus (and ComponentStatusList) holds the cluster validation info. + +Deprecated: This API is deprecated in v1.19+ + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeComponentStatus(scope: Construct, id: string, props?: KubeComponentStatusProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeComponentStatusProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeComponentStatusProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.ComponentStatus". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeComponentStatus.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeComponentStatus.manifest(props?: KubeComponentStatusProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.ComponentStatus". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeComponentStatusProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ComponentStatus". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.ComponentStatus". + +--- + +### KubeComponentStatusList + +Status of all the conditions for the component as a list of ComponentStatus objects. + +Deprecated: This API is deprecated in v1.19+ + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeComponentStatusList(scope: Construct, id: string, props: KubeComponentStatusListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeComponentStatusListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeComponentStatusListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.ComponentStatusList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeComponentStatusList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeComponentStatusList.manifest(props: KubeComponentStatusListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.ComponentStatusList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeComponentStatusListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ComponentStatusList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.ComponentStatusList". + +--- + +### KubeConfigMap + +ConfigMap holds configuration data for pods to consume. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeConfigMap(scope: Construct, id: string, props?: KubeConfigMapProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeConfigMapProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeConfigMapProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.ConfigMap". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeConfigMap.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeConfigMap.manifest(props?: KubeConfigMapProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.ConfigMap". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeConfigMapProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ConfigMap". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.ConfigMap". + +--- + +### KubeConfigMapList + +ConfigMapList is a resource containing a list of ConfigMap objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeConfigMapList(scope: Construct, id: string, props: KubeConfigMapListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeConfigMapListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeConfigMapListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.ConfigMapList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeConfigMapList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeConfigMapList.manifest(props: KubeConfigMapListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.ConfigMapList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeConfigMapListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ConfigMapList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.ConfigMapList". + +--- + +### KubeControllerRevision + +ControllerRevision implements an immutable snapshot of state data. + +Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeControllerRevision(scope: Construct, id: string, props: KubeControllerRevisionProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeControllerRevisionProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeControllerRevisionProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.apps.v1.ControllerRevision". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeControllerRevision.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeControllerRevision.manifest(props: KubeControllerRevisionProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.apps.v1.ControllerRevision". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeControllerRevisionProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.ControllerRevision". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.apps.v1.ControllerRevision". + +--- + +### KubeControllerRevisionList + +ControllerRevisionList is a resource containing a list of ControllerRevision objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeControllerRevisionList(scope: Construct, id: string, props: KubeControllerRevisionListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeControllerRevisionListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeControllerRevisionListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.apps.v1.ControllerRevisionList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeControllerRevisionList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeControllerRevisionList.manifest(props: KubeControllerRevisionListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.apps.v1.ControllerRevisionList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeControllerRevisionListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.ControllerRevisionList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.apps.v1.ControllerRevisionList". + +--- + +### KubeCronJob + +CronJob represents the configuration of a single cron job. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCronJob(scope: Construct, id: string, props?: KubeCronJobProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCronJobProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCronJobProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.batch.v1.CronJob". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCronJob.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCronJob.manifest(props?: KubeCronJobProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.batch.v1.CronJob". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCronJobProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.batch.v1.CronJob". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.batch.v1.CronJob". + +--- + +### KubeCronJobList + +CronJobList is a collection of cron jobs. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCronJobList(scope: Construct, id: string, props: KubeCronJobListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCronJobListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCronJobListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.batch.v1.CronJobList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCronJobList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCronJobList.manifest(props: KubeCronJobListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.batch.v1.CronJobList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCronJobListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.batch.v1.CronJobList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.batch.v1.CronJobList". + +--- + +### KubeCronJobListV1Beta1 + +CronJobList is a collection of cron jobs. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCronJobListV1Beta1(scope: Construct, id: string, props: KubeCronJobListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCronJobListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCronJobListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.batch.v1beta1.CronJobList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCronJobListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCronJobListV1Beta1.manifest(props: KubeCronJobListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.batch.v1beta1.CronJobList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCronJobListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.batch.v1beta1.CronJobList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.batch.v1beta1.CronJobList". + +--- + +### KubeCronJobV1Beta1 + +CronJob represents the configuration of a single cron job. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCronJobV1Beta1(scope: Construct, id: string, props?: KubeCronJobV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCronJobV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCronJobV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.batch.v1beta1.CronJob". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCronJobV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCronJobV1Beta1.manifest(props?: KubeCronJobV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.batch.v1beta1.CronJob". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCronJobV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.batch.v1beta1.CronJob". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.batch.v1beta1.CronJob". + +--- + +### KubeCsiDriver + +CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. + +Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCsiDriver(scope: Construct, id: string, props: KubeCsiDriverProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCsiDriverProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiDriverProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1.CSIDriver". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiDriver.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiDriver.manifest(props: KubeCsiDriverProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1.CSIDriver". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiDriverProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSIDriver". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSIDriver". + +--- + +### KubeCsiDriverList + +CSIDriverList is a collection of CSIDriver objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCsiDriverList(scope: Construct, id: string, props: KubeCsiDriverListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCsiDriverListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiDriverListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1.CSIDriverList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiDriverList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiDriverList.manifest(props: KubeCsiDriverListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1.CSIDriverList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiDriverListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSIDriverList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSIDriverList". + +--- + +### KubeCsiDriverListV1Beta1 + +CSIDriverList is a collection of CSIDriver objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCsiDriverListV1Beta1(scope: Construct, id: string, props: KubeCsiDriverListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCsiDriverListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiDriverListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSIDriverList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiDriverListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiDriverListV1Beta1.manifest(props: KubeCsiDriverListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSIDriverList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiDriverListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSIDriverList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSIDriverList". + +--- + +### KubeCsiDriverV1Beta1 + +CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. + +CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCsiDriverV1Beta1(scope: Construct, id: string, props: KubeCsiDriverV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCsiDriverV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiDriverV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSIDriver". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiDriverV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiDriverV1Beta1.manifest(props: KubeCsiDriverV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSIDriver". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiDriverV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSIDriver". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSIDriver". + +--- + +### KubeCsiNode + +CSINode holds information about all CSI drivers installed on a node. + +CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCsiNode(scope: Construct, id: string, props: KubeCsiNodeProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCsiNodeProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiNodeProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1.CSINode". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiNode.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiNode.manifest(props: KubeCsiNodeProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1.CSINode". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiNodeProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSINode". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSINode". + +--- + +### KubeCsiNodeList + +CSINodeList is a collection of CSINode objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCsiNodeList(scope: Construct, id: string, props: KubeCsiNodeListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCsiNodeListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiNodeListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1.CSINodeList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiNodeList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiNodeList.manifest(props: KubeCsiNodeListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1.CSINodeList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiNodeListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSINodeList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSINodeList". + +--- + +### KubeCsiNodeListV1Beta1 + +CSINodeList is a collection of CSINode objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCsiNodeListV1Beta1(scope: Construct, id: string, props: KubeCsiNodeListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCsiNodeListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiNodeListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSINodeList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiNodeListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiNodeListV1Beta1.manifest(props: KubeCsiNodeListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSINodeList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiNodeListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSINodeList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSINodeList". + +--- + +### KubeCsiNodeV1Beta1 + +DEPRECATED - This group version of CSINode is deprecated by storage/v1/CSINode. + +See the release notes for more information. CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCsiNodeV1Beta1(scope: Construct, id: string, props: KubeCsiNodeV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCsiNodeV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiNodeV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSINode". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiNodeV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiNodeV1Beta1.manifest(props: KubeCsiNodeV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSINode". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiNodeV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSINode". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSINode". + +--- + +### KubeCsiStorageCapacityListV1Alpha1 + +CSIStorageCapacityList is a collection of CSIStorageCapacity objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCsiStorageCapacityListV1Alpha1(scope: Construct, id: string, props: KubeCsiStorageCapacityListV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityListV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityListV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1alpha1.CSIStorageCapacityList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiStorageCapacityListV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiStorageCapacityListV1Alpha1.manifest(props: KubeCsiStorageCapacityListV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1alpha1.CSIStorageCapacityList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityListV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.CSIStorageCapacityList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.CSIStorageCapacityList". + +--- + +### KubeCsiStorageCapacityListV1Beta1 + +CSIStorageCapacityList is a collection of CSIStorageCapacity objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCsiStorageCapacityListV1Beta1(scope: Construct, id: string, props: KubeCsiStorageCapacityListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSIStorageCapacityList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiStorageCapacityListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiStorageCapacityListV1Beta1.manifest(props: KubeCsiStorageCapacityListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSIStorageCapacityList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSIStorageCapacityList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSIStorageCapacityList". + +--- + +### KubeCsiStorageCapacityV1Alpha1 + +CSIStorageCapacity stores the result of one CSI GetCapacity call. + +For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes. + +For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123" + +The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero + +The producer of these objects can decide which approach is more suitable. + +They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCsiStorageCapacityV1Alpha1(scope: Construct, id: string, props: KubeCsiStorageCapacityV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1alpha1.CSIStorageCapacity". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiStorageCapacityV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiStorageCapacityV1Alpha1.manifest(props: KubeCsiStorageCapacityV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1alpha1.CSIStorageCapacity". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.CSIStorageCapacity". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.CSIStorageCapacity". + +--- + +### KubeCsiStorageCapacityV1Beta1 + +CSIStorageCapacity stores the result of one CSI GetCapacity call. + +For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes. + +For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123" + +The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero + +The producer of these objects can decide which approach is more suitable. + +They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCsiStorageCapacityV1Beta1(scope: Construct, id: string, props: KubeCsiStorageCapacityV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSIStorageCapacity". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiStorageCapacityV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCsiStorageCapacityV1Beta1.manifest(props: KubeCsiStorageCapacityV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSIStorageCapacity". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSIStorageCapacity". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSIStorageCapacity". + +--- + +### KubeCustomResourceDefinition + +CustomResourceDefinition represents a resource that should be exposed on the API server. + +Its name MUST be in the format <.spec.name>.<.spec.group>. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCustomResourceDefinition(scope: Construct, id: string, props: KubeCustomResourceDefinitionProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCustomResourceDefinition.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCustomResourceDefinition.manifest(props: KubeCustomResourceDefinitionProps) +``` + +Renders a Kubernetes manifest for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition". + +--- + +### KubeCustomResourceDefinitionList + +CustomResourceDefinitionList is a list of CustomResourceDefinition objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCustomResourceDefinitionList(scope: Construct, id: string, props: KubeCustomResourceDefinitionListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCustomResourceDefinitionList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCustomResourceDefinitionList.manifest(props: KubeCustomResourceDefinitionListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList". + +--- + +### KubeCustomResourceDefinitionListV1Beta1 + +CustomResourceDefinitionList is a list of CustomResourceDefinition objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCustomResourceDefinitionListV1Beta1(scope: Construct, id: string, props: KubeCustomResourceDefinitionListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCustomResourceDefinitionListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCustomResourceDefinitionListV1Beta1.manifest(props: KubeCustomResourceDefinitionListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionList". + +--- + +### KubeCustomResourceDefinitionV1Beta1 + +CustomResourceDefinition represents a resource that should be exposed on the API server. + +Its name MUST be in the format <.spec.name>.<.spec.group>. Deprecated in v1.16, planned for removal in v1.22. Use apiextensions.k8s.io/v1 CustomResourceDefinition instead. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeCustomResourceDefinitionV1Beta1(scope: Construct, id: string, props: KubeCustomResourceDefinitionV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinition". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCustomResourceDefinitionV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeCustomResourceDefinitionV1Beta1.manifest(props: KubeCustomResourceDefinitionV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinition". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinition". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinition". + +--- + +### KubeDaemonSet + +DaemonSet represents the configuration of a daemon set. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeDaemonSet(scope: Construct, id: string, props?: KubeDaemonSetProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeDaemonSetProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeDaemonSetProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.apps.v1.DaemonSet". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeDaemonSet.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeDaemonSet.manifest(props?: KubeDaemonSetProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.apps.v1.DaemonSet". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeDaemonSetProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.DaemonSet". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.apps.v1.DaemonSet". + +--- + +### KubeDaemonSetList + +DaemonSetList is a collection of daemon sets. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeDaemonSetList(scope: Construct, id: string, props: KubeDaemonSetListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeDaemonSetListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeDaemonSetListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.apps.v1.DaemonSetList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeDaemonSetList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeDaemonSetList.manifest(props: KubeDaemonSetListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.apps.v1.DaemonSetList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeDaemonSetListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.DaemonSetList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.apps.v1.DaemonSetList". + +--- + +### KubeDeployment + +Deployment enables declarative updates for Pods and ReplicaSets. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeDeployment(scope: Construct, id: string, props?: KubeDeploymentProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeDeploymentProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeDeploymentProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.apps.v1.Deployment". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeDeployment.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeDeployment.manifest(props?: KubeDeploymentProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.apps.v1.Deployment". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeDeploymentProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.Deployment". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.apps.v1.Deployment". + +--- + +### KubeDeploymentList + +DeploymentList is a list of Deployments. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeDeploymentList(scope: Construct, id: string, props: KubeDeploymentListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeDeploymentListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeDeploymentListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.apps.v1.DeploymentList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeDeploymentList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeDeploymentList.manifest(props: KubeDeploymentListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.apps.v1.DeploymentList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeDeploymentListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.DeploymentList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.apps.v1.DeploymentList". + +--- + +### KubeEndpoints + +Endpoints is a collection of endpoints that implement the actual service. + +Example: +Name: "mysvc", +Subsets: [ + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + }, + { + Addresses: [{"ip": "10.10.3.3"}], + Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] + }, +] + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeEndpoints(scope: Construct, id: string, props?: KubeEndpointsProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeEndpointsProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointsProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.Endpoints". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEndpoints.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEndpoints.manifest(props?: KubeEndpointsProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.Endpoints". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointsProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.Endpoints". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.Endpoints". + +--- + +### KubeEndpointSlice + +EndpointSlice represents a subset of the endpoints that implement a service. + +For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeEndpointSlice(scope: Construct, id: string, props: KubeEndpointSliceProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.discovery.v1.EndpointSlice". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEndpointSlice.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEndpointSlice.manifest(props: KubeEndpointSliceProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.discovery.v1.EndpointSlice". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.discovery.v1.EndpointSlice". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.discovery.v1.EndpointSlice". + +--- + +### KubeEndpointSliceList + +EndpointSliceList represents a list of endpoint slices. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeEndpointSliceList(scope: Construct, id: string, props: KubeEndpointSliceListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.discovery.v1.EndpointSliceList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEndpointSliceList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEndpointSliceList.manifest(props: KubeEndpointSliceListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.discovery.v1.EndpointSliceList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.discovery.v1.EndpointSliceList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.discovery.v1.EndpointSliceList". + +--- + +### KubeEndpointSliceListV1Beta1 + +EndpointSliceList represents a list of endpoint slices. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeEndpointSliceListV1Beta1(scope: Construct, id: string, props: KubeEndpointSliceListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.discovery.v1beta1.EndpointSliceList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEndpointSliceListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEndpointSliceListV1Beta1.manifest(props: KubeEndpointSliceListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.discovery.v1beta1.EndpointSliceList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.discovery.v1beta1.EndpointSliceList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.discovery.v1beta1.EndpointSliceList". + +--- + +### KubeEndpointSliceV1Beta1 + +EndpointSlice represents a subset of the endpoints that implement a service. + +For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeEndpointSliceV1Beta1(scope: Construct, id: string, props: KubeEndpointSliceV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.discovery.v1beta1.EndpointSlice". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEndpointSliceV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEndpointSliceV1Beta1.manifest(props: KubeEndpointSliceV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.discovery.v1beta1.EndpointSlice". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.discovery.v1beta1.EndpointSlice". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.discovery.v1beta1.EndpointSlice". + +--- + +### KubeEndpointsList + +EndpointsList is a list of endpoints. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeEndpointsList(scope: Construct, id: string, props: KubeEndpointsListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeEndpointsListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointsListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.EndpointsList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEndpointsList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEndpointsList.manifest(props: KubeEndpointsListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.EndpointsList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointsListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.EndpointsList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.EndpointsList". + +--- + +### KubeEphemeralContainers + +A list of ephemeral containers used with the Pod ephemeralcontainers subresource. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeEphemeralContainers(scope: Construct, id: string, props: KubeEphemeralContainersProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeEphemeralContainersProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEphemeralContainersProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.EphemeralContainers". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEphemeralContainers.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEphemeralContainers.manifest(props: KubeEphemeralContainersProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.EphemeralContainers". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEphemeralContainersProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.EphemeralContainers". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.EphemeralContainers". + +--- + +### KubeEvent + +Event is a report of an event somewhere in the cluster. + +It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeEvent(scope: Construct, id: string, props: KubeEventProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeEventProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEventProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.events.v1.Event". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEvent.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEvent.manifest(props: KubeEventProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.events.v1.Event". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEventProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.events.v1.Event". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.events.v1.Event". + +--- + +### KubeEventList + +EventList is a list of Event objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeEventList(scope: Construct, id: string, props: KubeEventListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeEventListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEventListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.events.v1.EventList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEventList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEventList.manifest(props: KubeEventListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.events.v1.EventList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEventListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.events.v1.EventList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.events.v1.EventList". + +--- + +### KubeEventListV1Beta1 + +EventList is a list of Event objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeEventListV1Beta1(scope: Construct, id: string, props: KubeEventListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeEventListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEventListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.events.v1beta1.EventList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEventListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEventListV1Beta1.manifest(props: KubeEventListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.events.v1beta1.EventList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEventListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.events.v1beta1.EventList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.events.v1beta1.EventList". + +--- + +### KubeEventV1Beta1 + +Event is a report of an event somewhere in the cluster. + +It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeEventV1Beta1(scope: Construct, id: string, props: KubeEventV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeEventV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEventV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.events.v1beta1.Event". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEventV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEventV1Beta1.manifest(props: KubeEventV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.events.v1beta1.Event". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEventV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.events.v1beta1.Event". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.events.v1beta1.Event". + +--- + +### KubeEvictionV1Beta1 + +Eviction evicts a pod from its node subject to certain policies and safety constraints. + +This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods//evictions. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeEvictionV1Beta1(scope: Construct, id: string, props?: KubeEvictionV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeEvictionV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEvictionV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.Eviction". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEvictionV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeEvictionV1Beta1.manifest(props?: KubeEvictionV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.Eviction". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEvictionV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.Eviction". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.Eviction". + +--- + +### KubeFlowSchemaListV1Beta1 + +FlowSchemaList is a list of FlowSchema objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeFlowSchemaListV1Beta1(scope: Construct, id: string, props: KubeFlowSchemaListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeFlowSchemaListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeFlowSchemaListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.flowcontrol.v1beta1.FlowSchemaList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeFlowSchemaListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeFlowSchemaListV1Beta1.manifest(props: KubeFlowSchemaListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.flowcontrol.v1beta1.FlowSchemaList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeFlowSchemaListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1beta1.FlowSchemaList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1beta1.FlowSchemaList". + +--- + +### KubeFlowSchemaV1Beta1 + +FlowSchema defines the schema of a group of flows. + +Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher". + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeFlowSchemaV1Beta1(scope: Construct, id: string, props?: KubeFlowSchemaV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeFlowSchemaV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeFlowSchemaV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.flowcontrol.v1beta1.FlowSchema". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeFlowSchemaV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeFlowSchemaV1Beta1.manifest(props?: KubeFlowSchemaV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.flowcontrol.v1beta1.FlowSchema". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeFlowSchemaV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1beta1.FlowSchema". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1beta1.FlowSchema". + +--- + +### KubeHorizontalPodAutoscaler + +configuration of a horizontal pod autoscaler. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeHorizontalPodAutoscaler(scope: Construct, id: string, props?: KubeHorizontalPodAutoscalerProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeHorizontalPodAutoscaler.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeHorizontalPodAutoscaler.manifest(props?: KubeHorizontalPodAutoscalerProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler". + +--- + +### KubeHorizontalPodAutoscalerList + +list of horizontal pod autoscaler objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeHorizontalPodAutoscalerList(scope: Construct, id: string, props: KubeHorizontalPodAutoscalerListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeHorizontalPodAutoscalerList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeHorizontalPodAutoscalerList.manifest(props: KubeHorizontalPodAutoscalerListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList". + +--- + +### KubeHorizontalPodAutoscalerListV2Beta1 + +HorizontalPodAutoscaler is a list of horizontal pod autoscaler objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeHorizontalPodAutoscalerListV2Beta1(scope: Construct, id: string, props: KubeHorizontalPodAutoscalerListV2Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerListV2Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerListV2Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeHorizontalPodAutoscalerListV2Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeHorizontalPodAutoscalerListV2Beta1.manifest(props: KubeHorizontalPodAutoscalerListV2Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerListV2Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerList". + +--- + +### KubeHorizontalPodAutoscalerListV2Beta2 + +HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeHorizontalPodAutoscalerListV2Beta2(scope: Construct, id: string, props: KubeHorizontalPodAutoscalerListV2Beta2Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerListV2Beta2Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerListV2Beta2Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeHorizontalPodAutoscalerListV2Beta2.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeHorizontalPodAutoscalerListV2Beta2.manifest(props: KubeHorizontalPodAutoscalerListV2Beta2Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerListV2Beta2Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerList". + +--- + +### KubeHorizontalPodAutoscalerV2Beta1 + +HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeHorizontalPodAutoscalerV2Beta1(scope: Construct, id: string, props?: KubeHorizontalPodAutoscalerV2Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerV2Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerV2Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscaler". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeHorizontalPodAutoscalerV2Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeHorizontalPodAutoscalerV2Beta1.manifest(props?: KubeHorizontalPodAutoscalerV2Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscaler". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerV2Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscaler". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscaler". + +--- + +### KubeHorizontalPodAutoscalerV2Beta2 + +HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeHorizontalPodAutoscalerV2Beta2(scope: Construct, id: string, props?: KubeHorizontalPodAutoscalerV2Beta2Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerV2Beta2Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerV2Beta2Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscaler". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeHorizontalPodAutoscalerV2Beta2.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeHorizontalPodAutoscalerV2Beta2.manifest(props?: KubeHorizontalPodAutoscalerV2Beta2Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscaler". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerV2Beta2Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscaler". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscaler". + +--- + +### KubeIngress + +Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. + +An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeIngress(scope: Construct, id: string, props?: KubeIngressProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeIngressProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.networking.v1.Ingress". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngress.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngress.manifest(props?: KubeIngressProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.networking.v1.Ingress". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1.Ingress". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.networking.v1.Ingress". + +--- + +### KubeIngressClass + +IngressClass represents the class of the Ingress, referenced by the Ingress Spec. + +The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeIngressClass(scope: Construct, id: string, props?: KubeIngressClassProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeIngressClassProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressClassProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.networking.v1.IngressClass". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngressClass.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngressClass.manifest(props?: KubeIngressClassProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.networking.v1.IngressClass". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressClassProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressClass". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressClass". + +--- + +### KubeIngressClassList + +IngressClassList is a collection of IngressClasses. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeIngressClassList(scope: Construct, id: string, props: KubeIngressClassListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeIngressClassListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressClassListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.networking.v1.IngressClassList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngressClassList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngressClassList.manifest(props: KubeIngressClassListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.networking.v1.IngressClassList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressClassListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressClassList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressClassList". + +--- + +### KubeIngressClassListV1Beta1 + +IngressClassList is a collection of IngressClasses. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeIngressClassListV1Beta1(scope: Construct, id: string, props: KubeIngressClassListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeIngressClassListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressClassListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.networking.v1beta1.IngressClassList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngressClassListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngressClassListV1Beta1.manifest(props: KubeIngressClassListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.networking.v1beta1.IngressClassList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressClassListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.IngressClassList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.IngressClassList". + +--- + +### KubeIngressClassV1Beta1 + +IngressClass represents the class of the Ingress, referenced by the Ingress Spec. + +The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeIngressClassV1Beta1(scope: Construct, id: string, props?: KubeIngressClassV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeIngressClassV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressClassV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.networking.v1beta1.IngressClass". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngressClassV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngressClassV1Beta1.manifest(props?: KubeIngressClassV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.networking.v1beta1.IngressClass". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressClassV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.IngressClass". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.IngressClass". + +--- + +### KubeIngressList + +IngressList is a collection of Ingress. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeIngressList(scope: Construct, id: string, props: KubeIngressListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeIngressListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.networking.v1.IngressList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngressList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngressList.manifest(props: KubeIngressListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.networking.v1.IngressList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressList". + +--- + +### KubeIngressListV1Beta1 + +IngressList is a collection of Ingress. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeIngressListV1Beta1(scope: Construct, id: string, props: KubeIngressListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeIngressListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.networking.v1beta1.IngressList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngressListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngressListV1Beta1.manifest(props: KubeIngressListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.networking.v1beta1.IngressList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.IngressList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.IngressList". + +--- + +### KubeIngressV1Beta1 + +Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. + +An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeIngressV1Beta1(scope: Construct, id: string, props?: KubeIngressV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeIngressV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.networking.v1beta1.Ingress". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngressV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeIngressV1Beta1.manifest(props?: KubeIngressV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.networking.v1beta1.Ingress". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.Ingress". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.Ingress". + +--- + +### KubeJob + +Job represents the configuration of a single job. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeJob(scope: Construct, id: string, props?: KubeJobProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeJobProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeJobProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.batch.v1.Job". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeJob.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeJob.manifest(props?: KubeJobProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.batch.v1.Job". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeJobProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.batch.v1.Job". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.batch.v1.Job". + +--- + +### KubeJobList + +JobList is a collection of jobs. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeJobList(scope: Construct, id: string, props: KubeJobListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeJobListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeJobListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.batch.v1.JobList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeJobList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeJobList.manifest(props: KubeJobListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.batch.v1.JobList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeJobListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.batch.v1.JobList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.batch.v1.JobList". + +--- + +### KubeLease + +Lease defines a lease concept. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeLease(scope: Construct, id: string, props?: KubeLeaseProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeLeaseProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLeaseProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.coordination.v1.Lease". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLease.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLease.manifest(props?: KubeLeaseProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.coordination.v1.Lease". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLeaseProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.coordination.v1.Lease". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.coordination.v1.Lease". + +--- + +### KubeLeaseList + +LeaseList is a list of Lease objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeLeaseList(scope: Construct, id: string, props: KubeLeaseListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeLeaseListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLeaseListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.coordination.v1.LeaseList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLeaseList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLeaseList.manifest(props: KubeLeaseListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.coordination.v1.LeaseList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLeaseListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.coordination.v1.LeaseList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.coordination.v1.LeaseList". + +--- + +### KubeLeaseListV1Beta1 + +LeaseList is a list of Lease objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeLeaseListV1Beta1(scope: Construct, id: string, props: KubeLeaseListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeLeaseListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLeaseListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.coordination.v1beta1.LeaseList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLeaseListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLeaseListV1Beta1.manifest(props: KubeLeaseListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.coordination.v1beta1.LeaseList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLeaseListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.coordination.v1beta1.LeaseList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.coordination.v1beta1.LeaseList". + +--- + +### KubeLeaseV1Beta1 + +Lease defines a lease concept. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeLeaseV1Beta1(scope: Construct, id: string, props?: KubeLeaseV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeLeaseV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLeaseV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.coordination.v1beta1.Lease". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLeaseV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLeaseV1Beta1.manifest(props?: KubeLeaseV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.coordination.v1beta1.Lease". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLeaseV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.coordination.v1beta1.Lease". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.coordination.v1beta1.Lease". + +--- + +### KubeLimitRange + +LimitRange sets resource usage limits for each kind of resource in a Namespace. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeLimitRange(scope: Construct, id: string, props?: KubeLimitRangeProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeLimitRangeProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLimitRangeProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.LimitRange". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLimitRange.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLimitRange.manifest(props?: KubeLimitRangeProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.LimitRange". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLimitRangeProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.LimitRange". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.LimitRange". + +--- + +### KubeLimitRangeList + +LimitRangeList is a list of LimitRange items. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeLimitRangeList(scope: Construct, id: string, props: KubeLimitRangeListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeLimitRangeListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLimitRangeListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.LimitRangeList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLimitRangeList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLimitRangeList.manifest(props: KubeLimitRangeListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.LimitRangeList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLimitRangeListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.LimitRangeList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.LimitRangeList". + +--- + +### KubeLocalSubjectAccessReview + +LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. + +Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeLocalSubjectAccessReview(scope: Construct, id: string, props: KubeLocalSubjectAccessReviewProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeLocalSubjectAccessReviewProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLocalSubjectAccessReviewProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.authorization.v1.LocalSubjectAccessReview". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLocalSubjectAccessReview.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLocalSubjectAccessReview.manifest(props: KubeLocalSubjectAccessReviewProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.authorization.v1.LocalSubjectAccessReview". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLocalSubjectAccessReviewProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authorization.v1.LocalSubjectAccessReview". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.authorization.v1.LocalSubjectAccessReview". + +--- + +### KubeLocalSubjectAccessReviewV1Beta1 + +LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. + +Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeLocalSubjectAccessReviewV1Beta1(scope: Construct, id: string, props: KubeLocalSubjectAccessReviewV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeLocalSubjectAccessReviewV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLocalSubjectAccessReviewV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.authorization.v1beta1.LocalSubjectAccessReview". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLocalSubjectAccessReviewV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeLocalSubjectAccessReviewV1Beta1.manifest(props: KubeLocalSubjectAccessReviewV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.authorization.v1beta1.LocalSubjectAccessReview". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLocalSubjectAccessReviewV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authorization.v1beta1.LocalSubjectAccessReview". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.authorization.v1beta1.LocalSubjectAccessReview". + +--- + +### KubeMutatingWebhookConfiguration + +MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeMutatingWebhookConfiguration(scope: Construct, id: string, props?: KubeMutatingWebhookConfigurationProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeMutatingWebhookConfiguration.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeMutatingWebhookConfiguration.manifest(props?: KubeMutatingWebhookConfigurationProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration". + +--- + +### KubeMutatingWebhookConfigurationList + +MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeMutatingWebhookConfigurationList(scope: Construct, id: string, props: KubeMutatingWebhookConfigurationListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeMutatingWebhookConfigurationList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeMutatingWebhookConfigurationList.manifest(props: KubeMutatingWebhookConfigurationListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList". + +--- + +### KubeMutatingWebhookConfigurationListV1Beta1 + +MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeMutatingWebhookConfigurationListV1Beta1(scope: Construct, id: string, props: KubeMutatingWebhookConfigurationListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfigurationList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeMutatingWebhookConfigurationListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeMutatingWebhookConfigurationListV1Beta1.manifest(props: KubeMutatingWebhookConfigurationListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfigurationList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfigurationList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfigurationList". + +--- + +### KubeMutatingWebhookConfigurationV1Beta1 + +MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. + +Deprecated in v1.16, planned for removal in v1.19. Use admissionregistration.k8s.io/v1 MutatingWebhookConfiguration instead. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeMutatingWebhookConfigurationV1Beta1(scope: Construct, id: string, props?: KubeMutatingWebhookConfigurationV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfiguration". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeMutatingWebhookConfigurationV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeMutatingWebhookConfigurationV1Beta1.manifest(props?: KubeMutatingWebhookConfigurationV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfiguration". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfiguration". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfiguration". + +--- + +### KubeNamespace + +Namespace provides a scope for Names. + +Use of multiple namespaces is optional. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeNamespace(scope: Construct, id: string, props?: KubeNamespaceProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeNamespaceProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNamespaceProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.Namespace". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeNamespace.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeNamespace.manifest(props?: KubeNamespaceProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.Namespace". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNamespaceProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.Namespace". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.Namespace". + +--- + +### KubeNamespaceList + +NamespaceList is a list of Namespaces. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeNamespaceList(scope: Construct, id: string, props: KubeNamespaceListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeNamespaceListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNamespaceListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.NamespaceList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeNamespaceList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeNamespaceList.manifest(props: KubeNamespaceListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.NamespaceList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNamespaceListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.NamespaceList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.NamespaceList". + +--- + +### KubeNetworkPolicy + +NetworkPolicy describes what network traffic is allowed for a set of Pods. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeNetworkPolicy(scope: Construct, id: string, props?: KubeNetworkPolicyProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeNetworkPolicyProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNetworkPolicyProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.networking.v1.NetworkPolicy". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeNetworkPolicy.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeNetworkPolicy.manifest(props?: KubeNetworkPolicyProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.networking.v1.NetworkPolicy". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNetworkPolicyProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1.NetworkPolicy". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.networking.v1.NetworkPolicy". + +--- + +### KubeNetworkPolicyList + +NetworkPolicyList is a list of NetworkPolicy objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeNetworkPolicyList(scope: Construct, id: string, props: KubeNetworkPolicyListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeNetworkPolicyListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNetworkPolicyListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.networking.v1.NetworkPolicyList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeNetworkPolicyList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeNetworkPolicyList.manifest(props: KubeNetworkPolicyListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.networking.v1.NetworkPolicyList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNetworkPolicyListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.networking.v1.NetworkPolicyList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.networking.v1.NetworkPolicyList". + +--- + +### KubeNode + +Node is a worker node in Kubernetes. + +Each node will have a unique identifier in the cache (i.e. in etcd). + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeNode(scope: Construct, id: string, props?: KubeNodeProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeNodeProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNodeProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.Node". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeNode.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeNode.manifest(props?: KubeNodeProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.Node". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNodeProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.Node". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.Node". + +--- + +### KubeNodeList + +NodeList is the whole list of all Nodes which have been registered with master. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeNodeList(scope: Construct, id: string, props: KubeNodeListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeNodeListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNodeListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.NodeList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeNodeList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeNodeList.manifest(props: KubeNodeListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.NodeList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNodeListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.NodeList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.NodeList". + +--- + +### KubePersistentVolume + +PersistentVolume (PV) is a storage resource provisioned by an administrator. + +It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePersistentVolume(scope: Construct, id: string, props?: KubePersistentVolumeProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.PersistentVolume". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePersistentVolume.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePersistentVolume.manifest(props?: KubePersistentVolumeProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.PersistentVolume". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolume". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolume". + +--- + +### KubePersistentVolumeClaim + +PersistentVolumeClaim is a user's request for and claim to a persistent volume. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePersistentVolumeClaim(scope: Construct, id: string, props?: KubePersistentVolumeClaimProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeClaimProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeClaimProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.PersistentVolumeClaim". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePersistentVolumeClaim.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePersistentVolumeClaim.manifest(props?: KubePersistentVolumeClaimProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.PersistentVolumeClaim". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeClaimProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolumeClaim". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolumeClaim". + +--- + +### KubePersistentVolumeClaimList + +PersistentVolumeClaimList is a list of PersistentVolumeClaim items. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePersistentVolumeClaimList(scope: Construct, id: string, props: KubePersistentVolumeClaimListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeClaimListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeClaimListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.PersistentVolumeClaimList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePersistentVolumeClaimList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePersistentVolumeClaimList.manifest(props: KubePersistentVolumeClaimListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.PersistentVolumeClaimList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeClaimListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolumeClaimList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolumeClaimList". + +--- + +### KubePersistentVolumeList + +PersistentVolumeList is a list of PersistentVolume items. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePersistentVolumeList(scope: Construct, id: string, props: KubePersistentVolumeListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.PersistentVolumeList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePersistentVolumeList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePersistentVolumeList.manifest(props: KubePersistentVolumeListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.PersistentVolumeList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolumeList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolumeList". + +--- + +### KubePod + +Pod is a collection of containers that can run on a host. + +This resource is created by clients and scheduled onto hosts. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePod(scope: Construct, id: string, props?: KubePodProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePodProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.Pod". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePod.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePod.manifest(props?: KubePodProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.Pod". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.Pod". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.Pod". + +--- + +### KubePodDisruptionBudget + +PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePodDisruptionBudget(scope: Construct, id: string, props?: KubePodDisruptionBudgetProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.policy.v1.PodDisruptionBudget". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodDisruptionBudget.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodDisruptionBudget.manifest(props?: KubePodDisruptionBudgetProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.policy.v1.PodDisruptionBudget". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.policy.v1.PodDisruptionBudget". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.policy.v1.PodDisruptionBudget". + +--- + +### KubePodDisruptionBudgetList + +PodDisruptionBudgetList is a collection of PodDisruptionBudgets. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePodDisruptionBudgetList(scope: Construct, id: string, props: KubePodDisruptionBudgetListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.policy.v1.PodDisruptionBudgetList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodDisruptionBudgetList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodDisruptionBudgetList.manifest(props: KubePodDisruptionBudgetListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.policy.v1.PodDisruptionBudgetList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.policy.v1.PodDisruptionBudgetList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.policy.v1.PodDisruptionBudgetList". + +--- + +### KubePodDisruptionBudgetListV1Beta1 + +PodDisruptionBudgetList is a collection of PodDisruptionBudgets. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePodDisruptionBudgetListV1Beta1(scope: Construct, id: string, props: KubePodDisruptionBudgetListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.PodDisruptionBudgetList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodDisruptionBudgetListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodDisruptionBudgetListV1Beta1.manifest(props: KubePodDisruptionBudgetListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.PodDisruptionBudgetList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.PodDisruptionBudgetList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.PodDisruptionBudgetList". + +--- + +### KubePodDisruptionBudgetV1Beta1 + +PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePodDisruptionBudgetV1Beta1(scope: Construct, id: string, props?: KubePodDisruptionBudgetV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.PodDisruptionBudget". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodDisruptionBudgetV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodDisruptionBudgetV1Beta1.manifest(props?: KubePodDisruptionBudgetV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.PodDisruptionBudget". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.PodDisruptionBudget". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.PodDisruptionBudget". + +--- + +### KubePodList + +PodList is a list of Pods. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePodList(scope: Construct, id: string, props: KubePodListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePodListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.PodList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodList.manifest(props: KubePodListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.PodList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.PodList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.PodList". + +--- + +### KubePodSecurityPolicyListV1Beta1 + +PodSecurityPolicyList is a list of PodSecurityPolicy objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePodSecurityPolicyListV1Beta1(scope: Construct, id: string, props: KubePodSecurityPolicyListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePodSecurityPolicyListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodSecurityPolicyListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.PodSecurityPolicyList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodSecurityPolicyListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodSecurityPolicyListV1Beta1.manifest(props: KubePodSecurityPolicyListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.PodSecurityPolicyList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodSecurityPolicyListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.PodSecurityPolicyList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.PodSecurityPolicyList". + +--- + +### KubePodSecurityPolicyV1Beta1 + +PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. + +Deprecated in 1.21. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePodSecurityPolicyV1Beta1(scope: Construct, id: string, props?: KubePodSecurityPolicyV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePodSecurityPolicyV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodSecurityPolicyV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.PodSecurityPolicy". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodSecurityPolicyV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodSecurityPolicyV1Beta1.manifest(props?: KubePodSecurityPolicyV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.PodSecurityPolicy". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodSecurityPolicyV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.PodSecurityPolicy". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.PodSecurityPolicy". + +--- + +### KubePodTemplate + +PodTemplate describes a template for creating copies of a predefined pod. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePodTemplate(scope: Construct, id: string, props?: KubePodTemplateProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePodTemplateProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodTemplateProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.PodTemplate". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodTemplate.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodTemplate.manifest(props?: KubePodTemplateProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.PodTemplate". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodTemplateProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.PodTemplate". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.PodTemplate". + +--- + +### KubePodTemplateList + +PodTemplateList is a list of PodTemplates. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePodTemplateList(scope: Construct, id: string, props: KubePodTemplateListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePodTemplateListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodTemplateListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.PodTemplateList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodTemplateList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePodTemplateList.manifest(props: KubePodTemplateListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.PodTemplateList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodTemplateListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.PodTemplateList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.PodTemplateList". + +--- + +### KubePriorityClass + +PriorityClass defines mapping from a priority class name to the priority integer value. + +The value can be any valid integer. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePriorityClass(scope: Construct, id: string, props: KubePriorityClassProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePriorityClassProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1.PriorityClass". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityClass.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityClass.manifest(props: KubePriorityClassProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1.PriorityClass". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.scheduling.v1.PriorityClass". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.scheduling.v1.PriorityClass". + +--- + +### KubePriorityClassList + +PriorityClassList is a collection of priority classes. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePriorityClassList(scope: Construct, id: string, props: KubePriorityClassListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePriorityClassListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1.PriorityClassList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityClassList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityClassList.manifest(props: KubePriorityClassListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1.PriorityClassList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.scheduling.v1.PriorityClassList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.scheduling.v1.PriorityClassList". + +--- + +### KubePriorityClassListV1Alpha1 + +PriorityClassList is a collection of priority classes. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePriorityClassListV1Alpha1(scope: Construct, id: string, props: KubePriorityClassListV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePriorityClassListV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassListV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1alpha1.PriorityClassList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityClassListV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityClassListV1Alpha1.manifest(props: KubePriorityClassListV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1alpha1.PriorityClassList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassListV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.scheduling.v1alpha1.PriorityClassList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.scheduling.v1alpha1.PriorityClassList". + +--- + +### KubePriorityClassListV1Beta1 + +PriorityClassList is a collection of priority classes. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePriorityClassListV1Beta1(scope: Construct, id: string, props: KubePriorityClassListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePriorityClassListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1beta1.PriorityClassList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityClassListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityClassListV1Beta1.manifest(props: KubePriorityClassListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1beta1.PriorityClassList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.scheduling.v1beta1.PriorityClassList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.scheduling.v1beta1.PriorityClassList". + +--- + +### KubePriorityClassV1Alpha1 + +DEPRECATED - This group version of PriorityClass is deprecated by scheduling.k8s.io/v1/PriorityClass. PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePriorityClassV1Alpha1(scope: Construct, id: string, props: KubePriorityClassV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePriorityClassV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1alpha1.PriorityClass". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityClassV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityClassV1Alpha1.manifest(props: KubePriorityClassV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1alpha1.PriorityClass". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.scheduling.v1alpha1.PriorityClass". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.scheduling.v1alpha1.PriorityClass". + +--- + +### KubePriorityClassV1Beta1 + +DEPRECATED - This group version of PriorityClass is deprecated by scheduling.k8s.io/v1/PriorityClass. PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePriorityClassV1Beta1(scope: Construct, id: string, props: KubePriorityClassV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePriorityClassV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1beta1.PriorityClass". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityClassV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityClassV1Beta1.manifest(props: KubePriorityClassV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1beta1.PriorityClass". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.scheduling.v1beta1.PriorityClass". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.scheduling.v1beta1.PriorityClass". + +--- + +### KubePriorityLevelConfigurationListV1Beta1 + +PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePriorityLevelConfigurationListV1Beta1(scope: Construct, id: string, props: KubePriorityLevelConfigurationListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePriorityLevelConfigurationListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityLevelConfigurationListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityLevelConfigurationListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityLevelConfigurationListV1Beta1.manifest(props: KubePriorityLevelConfigurationListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityLevelConfigurationListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationList". + +--- + +### KubePriorityLevelConfigurationV1Beta1 + +PriorityLevelConfiguration represents the configuration of a priority level. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubePriorityLevelConfigurationV1Beta1(scope: Construct, id: string, props?: KubePriorityLevelConfigurationV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubePriorityLevelConfigurationV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityLevelConfigurationV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfiguration". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityLevelConfigurationV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubePriorityLevelConfigurationV1Beta1.manifest(props?: KubePriorityLevelConfigurationV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfiguration". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityLevelConfigurationV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfiguration". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfiguration". + +--- + +### KubeReplicaSet + +ReplicaSet ensures that a specified number of pod replicas are running at any given time. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeReplicaSet(scope: Construct, id: string, props?: KubeReplicaSetProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeReplicaSetProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeReplicaSetProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.apps.v1.ReplicaSet". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeReplicaSet.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeReplicaSet.manifest(props?: KubeReplicaSetProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.apps.v1.ReplicaSet". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeReplicaSetProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.ReplicaSet". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.apps.v1.ReplicaSet". + +--- + +### KubeReplicaSetList + +ReplicaSetList is a collection of ReplicaSets. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeReplicaSetList(scope: Construct, id: string, props: KubeReplicaSetListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeReplicaSetListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeReplicaSetListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.apps.v1.ReplicaSetList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeReplicaSetList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeReplicaSetList.manifest(props: KubeReplicaSetListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.apps.v1.ReplicaSetList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeReplicaSetListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.ReplicaSetList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.apps.v1.ReplicaSetList". + +--- + +### KubeReplicationController + +ReplicationController represents the configuration of a replication controller. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeReplicationController(scope: Construct, id: string, props?: KubeReplicationControllerProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeReplicationControllerProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeReplicationControllerProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.ReplicationController". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeReplicationController.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeReplicationController.manifest(props?: KubeReplicationControllerProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.ReplicationController". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeReplicationControllerProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ReplicationController". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.ReplicationController". + +--- + +### KubeReplicationControllerList + +ReplicationControllerList is a collection of replication controllers. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeReplicationControllerList(scope: Construct, id: string, props: KubeReplicationControllerListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeReplicationControllerListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeReplicationControllerListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.ReplicationControllerList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeReplicationControllerList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeReplicationControllerList.manifest(props: KubeReplicationControllerListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.ReplicationControllerList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeReplicationControllerListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ReplicationControllerList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.ReplicationControllerList". + +--- + +### KubeResourceQuota + +ResourceQuota sets aggregate quota restrictions enforced per namespace. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeResourceQuota(scope: Construct, id: string, props?: KubeResourceQuotaProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeResourceQuotaProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeResourceQuotaProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.ResourceQuota". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeResourceQuota.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeResourceQuota.manifest(props?: KubeResourceQuotaProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.ResourceQuota". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeResourceQuotaProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ResourceQuota". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.ResourceQuota". + +--- + +### KubeResourceQuotaList + +ResourceQuotaList is a list of ResourceQuota items. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeResourceQuotaList(scope: Construct, id: string, props: KubeResourceQuotaListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeResourceQuotaListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeResourceQuotaListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.ResourceQuotaList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeResourceQuotaList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeResourceQuotaList.manifest(props: KubeResourceQuotaListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.ResourceQuotaList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeResourceQuotaListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ResourceQuotaList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.ResourceQuotaList". + +--- + +### KubeRole + +Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRole(scope: Construct, id: string, props?: KubeRoleProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRoleProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.Role". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRole.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRole.manifest(props?: KubeRoleProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.Role". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.Role". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1.Role". + +--- + +### KubeRoleBinding + +RoleBinding references a role, but does not contain it. + +It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRoleBinding(scope: Construct, id: string, props: KubeRoleBindingProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRoleBindingProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.RoleBinding". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleBinding.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleBinding.manifest(props: KubeRoleBindingProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.RoleBinding". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.RoleBinding". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1.RoleBinding". + +--- + +### KubeRoleBindingList + +RoleBindingList is a collection of RoleBindings. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRoleBindingList(scope: Construct, id: string, props: KubeRoleBindingListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRoleBindingListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.RoleBindingList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleBindingList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleBindingList.manifest(props: KubeRoleBindingListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.RoleBindingList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.RoleBindingList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1.RoleBindingList". + +--- + +### KubeRoleBindingListV1Alpha1 + +RoleBindingList is a collection of RoleBindings Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBindingList, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRoleBindingListV1Alpha1(scope: Construct, id: string, props: KubeRoleBindingListV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRoleBindingListV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingListV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.RoleBindingList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleBindingListV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleBindingListV1Alpha1.manifest(props: KubeRoleBindingListV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.RoleBindingList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingListV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.RoleBindingList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.RoleBindingList". + +--- + +### KubeRoleBindingListV1Beta1 + +RoleBindingList is a collection of RoleBindings Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBindingList, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRoleBindingListV1Beta1(scope: Construct, id: string, props: KubeRoleBindingListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRoleBindingListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.RoleBindingList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleBindingListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleBindingListV1Beta1.manifest(props: KubeRoleBindingListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.RoleBindingList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.RoleBindingList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.RoleBindingList". + +--- + +### KubeRoleBindingV1Alpha1 + +RoleBinding references a role, but does not contain it. + +It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBinding, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRoleBindingV1Alpha1(scope: Construct, id: string, props: KubeRoleBindingV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRoleBindingV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.RoleBinding". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleBindingV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleBindingV1Alpha1.manifest(props: KubeRoleBindingV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.RoleBinding". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.RoleBinding". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.RoleBinding". + +--- + +### KubeRoleBindingV1Beta1 + +RoleBinding references a role, but does not contain it. + +It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBinding, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRoleBindingV1Beta1(scope: Construct, id: string, props: KubeRoleBindingV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRoleBindingV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.RoleBinding". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleBindingV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleBindingV1Beta1.manifest(props: KubeRoleBindingV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.RoleBinding". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.RoleBinding". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.RoleBinding". + +--- + +### KubeRoleList + +RoleList is a collection of Roles. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRoleList(scope: Construct, id: string, props: KubeRoleListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRoleListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.RoleList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleList.manifest(props: KubeRoleListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.RoleList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1.RoleList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1.RoleList". + +--- + +### KubeRoleListV1Alpha1 + +RoleList is a collection of Roles. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleList, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRoleListV1Alpha1(scope: Construct, id: string, props: KubeRoleListV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRoleListV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleListV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.RoleList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleListV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleListV1Alpha1.manifest(props: KubeRoleListV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.RoleList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleListV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.RoleList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.RoleList". + +--- + +### KubeRoleListV1Beta1 + +RoleList is a collection of Roles Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleList, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRoleListV1Beta1(scope: Construct, id: string, props: KubeRoleListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRoleListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.RoleList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleListV1Beta1.manifest(props: KubeRoleListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.RoleList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.RoleList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.RoleList". + +--- + +### KubeRoleV1Alpha1 + +Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 Role, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRoleV1Alpha1(scope: Construct, id: string, props?: KubeRoleV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRoleV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.Role". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleV1Alpha1.manifest(props?: KubeRoleV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.Role". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.Role". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.Role". + +--- + +### KubeRoleV1Beta1 + +Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 Role, and will no longer be served in v1.22. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRoleV1Beta1(scope: Construct, id: string, props?: KubeRoleV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRoleV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.Role". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRoleV1Beta1.manifest(props?: KubeRoleV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.Role". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.Role". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.Role". + +--- + +### KubeRuntimeClass + +RuntimeClass defines a class of container runtime supported in the cluster. + +The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://kubernetes.io/docs/concepts/containers/runtime-class/ + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRuntimeClass(scope: Construct, id: string, props: KubeRuntimeClassProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.node.v1.RuntimeClass". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRuntimeClass.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRuntimeClass.manifest(props: KubeRuntimeClassProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.node.v1.RuntimeClass". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.node.v1.RuntimeClass". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.node.v1.RuntimeClass". + +--- + +### KubeRuntimeClassList + +RuntimeClassList is a list of RuntimeClass objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRuntimeClassList(scope: Construct, id: string, props: KubeRuntimeClassListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.node.v1.RuntimeClassList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRuntimeClassList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRuntimeClassList.manifest(props: KubeRuntimeClassListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.node.v1.RuntimeClassList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.node.v1.RuntimeClassList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.node.v1.RuntimeClassList". + +--- + +### KubeRuntimeClassListV1Alpha1 + +RuntimeClassList is a list of RuntimeClass objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRuntimeClassListV1Alpha1(scope: Construct, id: string, props: KubeRuntimeClassListV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassListV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassListV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.node.v1alpha1.RuntimeClassList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRuntimeClassListV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRuntimeClassListV1Alpha1.manifest(props: KubeRuntimeClassListV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.node.v1alpha1.RuntimeClassList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassListV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.node.v1alpha1.RuntimeClassList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.node.v1alpha1.RuntimeClassList". + +--- + +### KubeRuntimeClassListV1Beta1 + +RuntimeClassList is a list of RuntimeClass objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRuntimeClassListV1Beta1(scope: Construct, id: string, props: KubeRuntimeClassListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.node.v1beta1.RuntimeClassList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRuntimeClassListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRuntimeClassListV1Beta1.manifest(props: KubeRuntimeClassListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.node.v1beta1.RuntimeClassList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.node.v1beta1.RuntimeClassList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.node.v1beta1.RuntimeClassList". + +--- + +### KubeRuntimeClassV1Alpha1 + +RuntimeClass defines a class of container runtime supported in the cluster. + +The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are (currently) manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRuntimeClassV1Alpha1(scope: Construct, id: string, props: KubeRuntimeClassV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.node.v1alpha1.RuntimeClass". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRuntimeClassV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRuntimeClassV1Alpha1.manifest(props: KubeRuntimeClassV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.node.v1alpha1.RuntimeClass". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.node.v1alpha1.RuntimeClass". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.node.v1alpha1.RuntimeClass". + +--- + +### KubeRuntimeClassV1Beta1 + +RuntimeClass defines a class of container runtime supported in the cluster. + +The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are (currently) manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeRuntimeClassV1Beta1(scope: Construct, id: string, props: KubeRuntimeClassV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.node.v1beta1.RuntimeClass". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRuntimeClassV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeRuntimeClassV1Beta1.manifest(props: KubeRuntimeClassV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.node.v1beta1.RuntimeClass". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.node.v1beta1.RuntimeClass". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.node.v1beta1.RuntimeClass". + +--- + +### KubeScale + +Scale represents a scaling request for a resource. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeScale(scope: Construct, id: string, props?: KubeScaleProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeScaleProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeScaleProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v1.Scale". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeScale.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeScale.manifest(props?: KubeScaleProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v1.Scale". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeScaleProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.autoscaling.v1.Scale". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.autoscaling.v1.Scale". + +--- + +### KubeSecret + +Secret holds secret data of a certain type. + +The total bytes of the values in the Data field must be less than MaxSecretSize bytes. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeSecret(scope: Construct, id: string, props?: KubeSecretProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeSecretProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSecretProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.Secret". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSecret.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSecret.manifest(props?: KubeSecretProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.Secret". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSecretProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.Secret". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.Secret". + +--- + +### KubeSecretList + +SecretList is a list of Secret. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeSecretList(scope: Construct, id: string, props: KubeSecretListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeSecretListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSecretListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.SecretList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSecretList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSecretList.manifest(props: KubeSecretListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.SecretList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSecretListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.SecretList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.SecretList". + +--- + +### KubeSelfSubjectAccessReview + +SelfSubjectAccessReview checks whether or the current user can perform an action. + +Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeSelfSubjectAccessReview(scope: Construct, id: string, props: KubeSelfSubjectAccessReviewProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeSelfSubjectAccessReviewProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSelfSubjectAccessReviewProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.authorization.v1.SelfSubjectAccessReview". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSelfSubjectAccessReview.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSelfSubjectAccessReview.manifest(props: KubeSelfSubjectAccessReviewProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.authorization.v1.SelfSubjectAccessReview". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSelfSubjectAccessReviewProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authorization.v1.SelfSubjectAccessReview". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.authorization.v1.SelfSubjectAccessReview". + +--- + +### KubeSelfSubjectAccessReviewV1Beta1 + +SelfSubjectAccessReview checks whether or the current user can perform an action. + +Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeSelfSubjectAccessReviewV1Beta1(scope: Construct, id: string, props: KubeSelfSubjectAccessReviewV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeSelfSubjectAccessReviewV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSelfSubjectAccessReviewV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.authorization.v1beta1.SelfSubjectAccessReview". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSelfSubjectAccessReviewV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSelfSubjectAccessReviewV1Beta1.manifest(props: KubeSelfSubjectAccessReviewV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.authorization.v1beta1.SelfSubjectAccessReview". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSelfSubjectAccessReviewV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authorization.v1beta1.SelfSubjectAccessReview". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.authorization.v1beta1.SelfSubjectAccessReview". + +--- + +### KubeSelfSubjectRulesReview + +SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. + +The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeSelfSubjectRulesReview(scope: Construct, id: string, props: KubeSelfSubjectRulesReviewProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeSelfSubjectRulesReviewProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSelfSubjectRulesReviewProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.authorization.v1.SelfSubjectRulesReview". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSelfSubjectRulesReview.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSelfSubjectRulesReview.manifest(props: KubeSelfSubjectRulesReviewProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.authorization.v1.SelfSubjectRulesReview". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSelfSubjectRulesReviewProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authorization.v1.SelfSubjectRulesReview". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.authorization.v1.SelfSubjectRulesReview". + +--- + +### KubeSelfSubjectRulesReviewV1Beta1 + +SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. + +The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeSelfSubjectRulesReviewV1Beta1(scope: Construct, id: string, props: KubeSelfSubjectRulesReviewV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeSelfSubjectRulesReviewV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSelfSubjectRulesReviewV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.authorization.v1beta1.SelfSubjectRulesReview". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSelfSubjectRulesReviewV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSelfSubjectRulesReviewV1Beta1.manifest(props: KubeSelfSubjectRulesReviewV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.authorization.v1beta1.SelfSubjectRulesReview". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSelfSubjectRulesReviewV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authorization.v1beta1.SelfSubjectRulesReview". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.authorization.v1beta1.SelfSubjectRulesReview". + +--- + +### KubeService + +Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeService(scope: Construct, id: string, props?: KubeServiceProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeServiceProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeServiceProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.Service". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeService.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeService.manifest(props?: KubeServiceProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.Service". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeServiceProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.Service". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.Service". + +--- + +### KubeServiceAccount + +ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeServiceAccount(scope: Construct, id: string, props?: KubeServiceAccountProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeServiceAccountProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeServiceAccountProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.ServiceAccount". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeServiceAccount.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeServiceAccount.manifest(props?: KubeServiceAccountProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.ServiceAccount". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeServiceAccountProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceAccount". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceAccount". + +--- + +### KubeServiceAccountList + +ServiceAccountList is a list of ServiceAccount objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeServiceAccountList(scope: Construct, id: string, props: KubeServiceAccountListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeServiceAccountListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeServiceAccountListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.ServiceAccountList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeServiceAccountList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeServiceAccountList.manifest(props: KubeServiceAccountListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.ServiceAccountList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeServiceAccountListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceAccountList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceAccountList". + +--- + +### KubeServiceList + +ServiceList holds a list of services. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeServiceList(scope: Construct, id: string, props: KubeServiceListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeServiceListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeServiceListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.core.v1.ServiceList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeServiceList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeServiceList.manifest(props: KubeServiceListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.core.v1.ServiceList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeServiceListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceList". + +--- + +### KubeStatefulSet + +StatefulSet represents a set of pods with consistent identities. + +Identities are defined as: +- Network: A single stable DNS and hostname. +- Storage: As many VolumeClaims as requested. +The StatefulSet guarantees that a given network identity will always map to the same storage identity. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeStatefulSet(scope: Construct, id: string, props?: KubeStatefulSetProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeStatefulSetProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStatefulSetProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.apps.v1.StatefulSet". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStatefulSet.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStatefulSet.manifest(props?: KubeStatefulSetProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.apps.v1.StatefulSet". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStatefulSetProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.StatefulSet". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.apps.v1.StatefulSet". + +--- + +### KubeStatefulSetList + +StatefulSetList is a collection of StatefulSets. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeStatefulSetList(scope: Construct, id: string, props: KubeStatefulSetListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeStatefulSetListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStatefulSetListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.apps.v1.StatefulSetList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStatefulSetList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStatefulSetList.manifest(props: KubeStatefulSetListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.apps.v1.StatefulSetList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStatefulSetListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apps.v1.StatefulSetList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.apps.v1.StatefulSetList". + +--- + +### KubeStatus + +Status is a return value for calls that don't return other objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeStatus(scope: Construct, id: string, props?: KubeStatusProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeStatusProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStatusProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.apimachinery.pkg.apis.meta.v1.Status". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStatus.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStatus.manifest(props?: KubeStatusProps) +``` + +Renders a Kubernetes manifest for "io.k8s.apimachinery.pkg.apis.meta.v1.Status". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStatusProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.apimachinery.pkg.apis.meta.v1.Status". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.apimachinery.pkg.apis.meta.v1.Status". + +--- + +### KubeStorageClass + +StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. + +StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeStorageClass(scope: Construct, id: string, props: KubeStorageClassProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeStorageClassProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageClassProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1.StorageClass". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStorageClass.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStorageClass.manifest(props: KubeStorageClassProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1.StorageClass". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageClassProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.StorageClass". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1.StorageClass". + +--- + +### KubeStorageClassList + +StorageClassList is a collection of storage classes. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeStorageClassList(scope: Construct, id: string, props: KubeStorageClassListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeStorageClassListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageClassListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1.StorageClassList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStorageClassList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStorageClassList.manifest(props: KubeStorageClassListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1.StorageClassList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageClassListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.StorageClassList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1.StorageClassList". + +--- + +### KubeStorageClassListV1Beta1 + +StorageClassList is a collection of storage classes. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeStorageClassListV1Beta1(scope: Construct, id: string, props: KubeStorageClassListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeStorageClassListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageClassListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.StorageClassList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStorageClassListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStorageClassListV1Beta1.manifest(props: KubeStorageClassListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.StorageClassList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageClassListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.StorageClassList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.StorageClassList". + +--- + +### KubeStorageClassV1Beta1 + +StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. + +StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeStorageClassV1Beta1(scope: Construct, id: string, props: KubeStorageClassV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeStorageClassV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageClassV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.StorageClass". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStorageClassV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStorageClassV1Beta1.manifest(props: KubeStorageClassV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.StorageClass". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageClassV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.StorageClass". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.StorageClass". + +--- + +### KubeStorageVersionListV1Alpha1 + +A list of StorageVersions. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeStorageVersionListV1Alpha1(scope: Construct, id: string, props: KubeStorageVersionListV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeStorageVersionListV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageVersionListV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStorageVersionListV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStorageVersionListV1Alpha1.manifest(props: KubeStorageVersionListV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageVersionListV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList". + +--- + +### KubeStorageVersionV1Alpha1 + +Storage version of a specific resource. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeStorageVersionV1Alpha1(scope: Construct, id: string, props: KubeStorageVersionV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeStorageVersionV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageVersionV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersion". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStorageVersionV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeStorageVersionV1Alpha1.manifest(props: KubeStorageVersionV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersion". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageVersionV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersion". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersion". + +--- + +### KubeSubjectAccessReview + +SubjectAccessReview checks whether or not a user or group can perform an action. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeSubjectAccessReview(scope: Construct, id: string, props: KubeSubjectAccessReviewProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeSubjectAccessReviewProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSubjectAccessReviewProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.authorization.v1.SubjectAccessReview". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSubjectAccessReview.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSubjectAccessReview.manifest(props: KubeSubjectAccessReviewProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.authorization.v1.SubjectAccessReview". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSubjectAccessReviewProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authorization.v1.SubjectAccessReview". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.authorization.v1.SubjectAccessReview". + +--- + +### KubeSubjectAccessReviewV1Beta1 + +SubjectAccessReview checks whether or not a user or group can perform an action. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeSubjectAccessReviewV1Beta1(scope: Construct, id: string, props: KubeSubjectAccessReviewV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeSubjectAccessReviewV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSubjectAccessReviewV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.authorization.v1beta1.SubjectAccessReview". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSubjectAccessReviewV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeSubjectAccessReviewV1Beta1.manifest(props: KubeSubjectAccessReviewV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.authorization.v1beta1.SubjectAccessReview". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSubjectAccessReviewV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authorization.v1beta1.SubjectAccessReview". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.authorization.v1beta1.SubjectAccessReview". + +--- + +### KubeTokenRequest + +TokenRequest requests a token for a given service account. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeTokenRequest(scope: Construct, id: string, props: KubeTokenRequestProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeTokenRequestProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeTokenRequestProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.authentication.v1.TokenRequest". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeTokenRequest.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeTokenRequest.manifest(props: KubeTokenRequestProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.authentication.v1.TokenRequest". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeTokenRequestProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authentication.v1.TokenRequest". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.authentication.v1.TokenRequest". + +--- + +### KubeTokenReview + +TokenReview attempts to authenticate a token to a known user. + +Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeTokenReview(scope: Construct, id: string, props: KubeTokenReviewProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeTokenReviewProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeTokenReviewProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.authentication.v1.TokenReview". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeTokenReview.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeTokenReview.manifest(props: KubeTokenReviewProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.authentication.v1.TokenReview". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeTokenReviewProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authentication.v1.TokenReview". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.authentication.v1.TokenReview". + +--- + +### KubeTokenReviewV1Beta1 + +TokenReview attempts to authenticate a token to a known user. + +Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeTokenReviewV1Beta1(scope: Construct, id: string, props: KubeTokenReviewV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeTokenReviewV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeTokenReviewV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.authentication.v1beta1.TokenReview". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeTokenReviewV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeTokenReviewV1Beta1.manifest(props: KubeTokenReviewV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.authentication.v1beta1.TokenReview". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeTokenReviewV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.authentication.v1beta1.TokenReview". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.authentication.v1beta1.TokenReview". + +--- + +### KubeValidatingWebhookConfiguration + +ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeValidatingWebhookConfiguration(scope: Construct, id: string, props?: KubeValidatingWebhookConfigurationProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeValidatingWebhookConfiguration.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeValidatingWebhookConfiguration.manifest(props?: KubeValidatingWebhookConfigurationProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration". + +--- + +### KubeValidatingWebhookConfigurationList + +ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeValidatingWebhookConfigurationList(scope: Construct, id: string, props: KubeValidatingWebhookConfigurationListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeValidatingWebhookConfigurationList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeValidatingWebhookConfigurationList.manifest(props: KubeValidatingWebhookConfigurationListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList". + +--- + +### KubeValidatingWebhookConfigurationListV1Beta1 + +ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeValidatingWebhookConfigurationListV1Beta1(scope: Construct, id: string, props: KubeValidatingWebhookConfigurationListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfigurationList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeValidatingWebhookConfigurationListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeValidatingWebhookConfigurationListV1Beta1.manifest(props: KubeValidatingWebhookConfigurationListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfigurationList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfigurationList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfigurationList". + +--- + +### KubeValidatingWebhookConfigurationV1Beta1 + +ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. + +Deprecated in v1.16, planned for removal in v1.19. Use admissionregistration.k8s.io/v1 ValidatingWebhookConfiguration instead. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeValidatingWebhookConfigurationV1Beta1(scope: Construct, id: string, props?: KubeValidatingWebhookConfigurationV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfiguration". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeValidatingWebhookConfigurationV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeValidatingWebhookConfigurationV1Beta1.manifest(props?: KubeValidatingWebhookConfigurationV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfiguration". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Optional + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfiguration". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfiguration". + +--- + +### KubeVolumeAttachment + +VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + +VolumeAttachment objects are non-namespaced. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeVolumeAttachment(scope: Construct, id: string, props: KubeVolumeAttachmentProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1.VolumeAttachment". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeVolumeAttachment.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeVolumeAttachment.manifest(props: KubeVolumeAttachmentProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1.VolumeAttachment". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.VolumeAttachment". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1.VolumeAttachment". + +--- + +### KubeVolumeAttachmentList + +VolumeAttachmentList is a collection of VolumeAttachment objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeVolumeAttachmentList(scope: Construct, id: string, props: KubeVolumeAttachmentListProps) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentListProps | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentListProps + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1.VolumeAttachmentList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeVolumeAttachmentList.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeVolumeAttachmentList.manifest(props: KubeVolumeAttachmentListProps) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1.VolumeAttachmentList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentListProps + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1.VolumeAttachmentList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1.VolumeAttachmentList". + +--- + +### KubeVolumeAttachmentListV1Alpha1 + +VolumeAttachmentList is a collection of VolumeAttachment objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeVolumeAttachmentListV1Alpha1(scope: Construct, id: string, props: KubeVolumeAttachmentListV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentListV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentListV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1alpha1.VolumeAttachmentList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeVolumeAttachmentListV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeVolumeAttachmentListV1Alpha1.manifest(props: KubeVolumeAttachmentListV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1alpha1.VolumeAttachmentList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentListV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.VolumeAttachmentList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.VolumeAttachmentList". + +--- + +### KubeVolumeAttachmentListV1Beta1 + +VolumeAttachmentList is a collection of VolumeAttachment objects. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeVolumeAttachmentListV1Beta1(scope: Construct, id: string, props: KubeVolumeAttachmentListV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentListV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentListV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.VolumeAttachmentList". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeVolumeAttachmentListV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeVolumeAttachmentListV1Beta1.manifest(props: KubeVolumeAttachmentListV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.VolumeAttachmentList". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentListV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.VolumeAttachmentList". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.VolumeAttachmentList". + +--- + +### KubeVolumeAttachmentV1Alpha1 + +VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + +VolumeAttachment objects are non-namespaced. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeVolumeAttachmentV1Alpha1(scope: Construct, id: string, props: KubeVolumeAttachmentV1Alpha1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentV1Alpha1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentV1Alpha1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1alpha1.VolumeAttachment". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeVolumeAttachmentV1Alpha1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeVolumeAttachmentV1Alpha1.manifest(props: KubeVolumeAttachmentV1Alpha1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1alpha1.VolumeAttachment". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentV1Alpha1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.VolumeAttachment". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.VolumeAttachment". + +--- + +### KubeVolumeAttachmentV1Beta1 + +VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + +VolumeAttachment objects are non-namespaced. + +#### Initializers + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +new k8s.KubeVolumeAttachmentV1Beta1(scope: Construct, id: string, props: KubeVolumeAttachmentV1Beta1Props) +``` + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scope | constructs.Construct | the scope in which to define this object. | +| id | string | a scope-local name for the object. | +| props | @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentV1Beta1Props | initialization props. | + +--- + +##### `scope`Required + +- *Type:* constructs.Construct + +the scope in which to define this object. + +--- + +##### `id`Required + +- *Type:* string + +a scope-local name for the object. + +--- + +##### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentV1Beta1Props + +initialization props. + +--- + +#### Methods + +| **Name** | **Description** | +| --- | --- | +| toString | Returns a string representation of this construct. | +| addDependency | Create a dependency between this ApiObject and other constructs. | +| addJsonPatch | Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. | +| toJson | Renders the object to Kubernetes JSON. | + +--- + +##### `toString` + +```typescript +public toString(): string +``` + +Returns a string representation of this construct. + +##### `addDependency` + +```typescript +public addDependency(dependencies: IConstruct): void +``` + +Create a dependency between this ApiObject and other constructs. + +These can be other ApiObjects, Charts, or custom. + +###### `dependencies`Required + +- *Type:* constructs.IConstruct + +the dependencies to add. + +--- + +##### `addJsonPatch` + +```typescript +public addJsonPatch(ops: JsonPatch): void +``` + +Applies a set of RFC-6902 JSON-Patch operations to the manifest synthesized for this API object. + +*Example* + +```typescript + kubePod.addJsonPatch(JsonPatch.replace('/spec/enableServiceLinks', true)); +``` + + +###### `ops`Required + +- *Type:* cdk8s.JsonPatch + +The JSON-Patch operations to apply. + +--- + +##### `toJson` + +```typescript +public toJson(): any +``` + +Renders the object to Kubernetes JSON. + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| of | Returns the `ApiObject` named `Resource` which is a child of the given construct. | +| manifest | Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.VolumeAttachment". | + +--- + +##### `of` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeVolumeAttachmentV1Beta1.of(c: IConstruct) +``` + +Returns the `ApiObject` named `Resource` which is a child of the given construct. + +If `c` is an `ApiObject`, it is returned directly. Throws an +exception if the construct does not have a child named `Default` _or_ if +this child is not an `ApiObject`. + +###### `c`Required + +- *Type:* constructs.IConstruct + +The higher-level construct. + +--- + +##### `manifest` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.KubeVolumeAttachmentV1Beta1.manifest(props: KubeVolumeAttachmentV1Beta1Props) +``` + +Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.VolumeAttachment". + +This can be used to inline resource manifests inside other objects (e.g. as templates). + +###### `props`Required + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentV1Beta1Props + +initialization props. + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | The group portion of the API version (e.g. `authorization.k8s.io`). | +| apiVersion | string | The object's API version (e.g. `authorization.k8s.io/v1`). | +| chart | cdk8s.Chart | The chart in which this object is defined. | +| kind | string | The object kind. | +| metadata | cdk8s.ApiObjectMetadataDefinition | Metadata associated with this API object. | +| name | string | The name of the API object. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +The group portion of the API version (e.g. `authorization.k8s.io`). + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +The object's API version (e.g. `authorization.k8s.io/v1`). + +--- + +##### `chart`Required + +```typescript +public readonly chart: Chart; +``` + +- *Type:* cdk8s.Chart + +The chart in which this object is defined. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The object kind. + +--- + +##### `metadata`Required + +```typescript +public readonly metadata: ApiObjectMetadataDefinition; +``` + +- *Type:* cdk8s.ApiObjectMetadataDefinition + +Metadata associated with this API object. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the API object. + +If a name is specified in `metadata.name` this will be the name returned. +Otherwise, a name will be generated by calling +`Chart.of(this).generatedObjectName(this)`, which by default uses the +construct path to generate a DNS-compatible name for the resource. + +--- + +#### Constants + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| GVK | cdk8s.GroupVersionKind | Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.VolumeAttachment". | + +--- + +##### `GVK`Required + +```typescript +public readonly GVK: GroupVersionKind; +``` + +- *Type:* cdk8s.GroupVersionKind + +Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.VolumeAttachment". + +--- + +## Structs + +### Affinity + +Affinity is a group of affinity scheduling rules. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const affinity: k8s.Affinity = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| nodeAffinity | @smallcase/cdk8s-botkube.k8s.NodeAffinity | Describes node affinity scheduling rules for the pod. | +| podAffinity | @smallcase/cdk8s-botkube.k8s.PodAffinity | Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). | +| podAntiAffinity | @smallcase/cdk8s-botkube.k8s.PodAntiAffinity | Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). | + +--- + +##### `nodeAffinity`Optional + +```typescript +public readonly nodeAffinity: NodeAffinity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NodeAffinity + +Describes node affinity scheduling rules for the pod. + +--- + +##### `podAffinity`Optional + +```typescript +public readonly podAffinity: PodAffinity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodAffinity + +Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + +--- + +##### `podAntiAffinity`Optional + +```typescript +public readonly podAntiAffinity: PodAntiAffinity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodAntiAffinity + +Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + +--- + +### AggregationRule + +AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const aggregationRule: k8s.AggregationRule = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| clusterRoleSelectors | @smallcase/cdk8s-botkube.k8s.LabelSelector[] | ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. | + +--- + +##### `clusterRoleSelectors`Optional + +```typescript +public readonly clusterRoleSelectors: LabelSelector[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector[] + +ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. + +If any of the selectors match, then the ClusterRole's permissions will be added + +--- + +### AggregationRuleV1Alpha1 + +AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const aggregationRuleV1Alpha1: k8s.AggregationRuleV1Alpha1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| clusterRoleSelectors | @smallcase/cdk8s-botkube.k8s.LabelSelector[] | ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. | + +--- + +##### `clusterRoleSelectors`Optional + +```typescript +public readonly clusterRoleSelectors: LabelSelector[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector[] + +ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. + +If any of the selectors match, then the ClusterRole's permissions will be added + +--- + +### AggregationRuleV1Beta1 + +AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const aggregationRuleV1Beta1: k8s.AggregationRuleV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| clusterRoleSelectors | @smallcase/cdk8s-botkube.k8s.LabelSelector[] | ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. | + +--- + +##### `clusterRoleSelectors`Optional + +```typescript +public readonly clusterRoleSelectors: LabelSelector[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector[] + +ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. + +If any of the selectors match, then the ClusterRole's permissions will be added + +--- + +### AllowedCsiDriverV1Beta1 + +AllowedCSIDriver represents a single inline CSI Driver that is allowed to be used. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const allowedCsiDriverV1Beta1: k8s.AllowedCsiDriverV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | Name is the registered name of the CSI driver. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name is the registered name of the CSI driver. + +--- + +### AllowedFlexVolumeV1Beta1 + +AllowedFlexVolume represents a single Flexvolume that is allowed to be used. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const allowedFlexVolumeV1Beta1: k8s.AllowedFlexVolumeV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| driver | string | driver is the name of the Flexvolume driver. | + +--- + +##### `driver`Required + +```typescript +public readonly driver: string; +``` + +- *Type:* string + +driver is the name of the Flexvolume driver. + +--- + +### AllowedHostPathV1Beta1 + +AllowedHostPath defines the host volume conditions that will be enabled by a policy for pods to use. + +It requires the path prefix to be defined. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const allowedHostPathV1Beta1: k8s.AllowedHostPathV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| pathPrefix | string | pathPrefix is the path prefix that the host volume must match. | +| readOnly | boolean | when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly. | + +--- + +##### `pathPrefix`Optional + +```typescript +public readonly pathPrefix: string; +``` + +- *Type:* string + +pathPrefix is the path prefix that the host volume must match. + +It does not support `*`. Trailing slashes are trimmed when validating the path prefix with a host path. + +Examples: `/foo` would allow `/foo`, `/foo/` and `/foo/bar` `/foo` would not allow `/food` or `/etc/foo` + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean + +when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly. + +--- + +### ApiServiceSpec + +APIServiceSpec contains information for locating and communicating with a server. + +Only https is supported, though you are able to disable certificate verification. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const apiServiceSpec: k8s.ApiServiceSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| groupPriorityMinimum | number | GroupPriorityMininum is the priority this group should have at least. | +| versionPriority | number | VersionPriority controls the ordering of this API version inside of its group. | +| caBundle | string | CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. | +| group | string | Group is the API group name this server hosts. | +| insecureSkipTlsVerify | boolean | InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. | +| service | @smallcase/cdk8s-botkube.k8s.ServiceReference | Service is a reference to the service for this API server. | +| version | string | Version is the API version this server hosts. | + +--- + +##### `groupPriorityMinimum`Required + +```typescript +public readonly groupPriorityMinimum: number; +``` + +- *Type:* number + +GroupPriorityMininum is the priority this group should have at least. + +Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s + +--- + +##### `versionPriority`Required + +```typescript +public readonly versionPriority: number; +``` + +- *Type:* number + +VersionPriority controls the ordering of this API version inside of its group. + +Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. + +--- + +##### `caBundle`Optional + +```typescript +public readonly caBundle: string; +``` + +- *Type:* string + +CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. + +If unspecified, system trust roots on the apiserver are used. + +--- + +##### `group`Optional + +```typescript +public readonly group: string; +``` + +- *Type:* string + +Group is the API group name this server hosts. + +--- + +##### `insecureSkipTlsVerify`Optional + +```typescript +public readonly insecureSkipTlsVerify: boolean; +``` + +- *Type:* boolean + +InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. + +This is strongly discouraged. You should use the CABundle instead. + +--- + +##### `service`Optional + +```typescript +public readonly service: ServiceReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ServiceReference + +Service is a reference to the service for this API server. + +It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled. + +--- + +##### `version`Optional + +```typescript +public readonly version: string; +``` + +- *Type:* string + +Version is the API version this server hosts. + +For example, "v1" + +--- + +### ApiServiceSpecV1Beta1 + +APIServiceSpec contains information for locating and communicating with a server. + +Only https is supported, though you are able to disable certificate verification. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const apiServiceSpecV1Beta1: k8s.ApiServiceSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| groupPriorityMinimum | number | GroupPriorityMininum is the priority this group should have at least. | +| versionPriority | number | VersionPriority controls the ordering of this API version inside of its group. | +| caBundle | string | CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. | +| group | string | Group is the API group name this server hosts. | +| insecureSkipTlsVerify | boolean | InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. | +| service | @smallcase/cdk8s-botkube.k8s.ServiceReferenceV1Beta1 | Service is a reference to the service for this API server. | +| version | string | Version is the API version this server hosts. | + +--- + +##### `groupPriorityMinimum`Required + +```typescript +public readonly groupPriorityMinimum: number; +``` + +- *Type:* number + +GroupPriorityMininum is the priority this group should have at least. + +Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s + +--- + +##### `versionPriority`Required + +```typescript +public readonly versionPriority: number; +``` + +- *Type:* number + +VersionPriority controls the ordering of this API version inside of its group. + +Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. + +--- + +##### `caBundle`Optional + +```typescript +public readonly caBundle: string; +``` + +- *Type:* string + +CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. + +If unspecified, system trust roots on the apiserver are used. + +--- + +##### `group`Optional + +```typescript +public readonly group: string; +``` + +- *Type:* string + +Group is the API group name this server hosts. + +--- + +##### `insecureSkipTlsVerify`Optional + +```typescript +public readonly insecureSkipTlsVerify: boolean; +``` + +- *Type:* boolean + +InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. + +This is strongly discouraged. You should use the CABundle instead. + +--- + +##### `service`Optional + +```typescript +public readonly service: ServiceReferenceV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ServiceReferenceV1Beta1 + +Service is a reference to the service for this API server. + +It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled. + +--- + +##### `version`Optional + +```typescript +public readonly version: string; +``` + +- *Type:* string + +Version is the API version this server hosts. + +For example, "v1" + +--- + +### AwsElasticBlockStoreVolumeSource + +Represents a Persistent Disk resource in AWS. + +An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const awsElasticBlockStoreVolumeSource: k8s.AwsElasticBlockStoreVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| volumeId | string | Unique ID of the persistent disk resource in AWS (Amazon EBS volume). | +| fsType | string | Filesystem type of the volume that you want to mount. | +| partition | number | The partition in the volume that you want to mount. | +| readOnly | boolean | Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". | + +--- + +##### `volumeId`Required + +```typescript +public readonly volumeId: string; +``` + +- *Type:* string + +Unique ID of the persistent disk resource in AWS (Amazon EBS volume). + +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type of the volume that you want to mount. + +Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +--- + +##### `partition`Optional + +```typescript +public readonly partition: number; +``` + +- *Type:* number + +The partition in the volume that you want to mount. + +If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean + +Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". + +If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +--- + +### AzureDiskVolumeSource + +AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const azureDiskVolumeSource: k8s.AzureDiskVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| diskName | string | The Name of the data disk in the blob storage. | +| diskUri | string | The URI the data disk in the blob storage. | +| cachingMode | string | Host Caching mode: None, Read Only, Read Write. | +| fsType | string | Filesystem type to mount. | +| kind | string | Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). | +| readOnly | boolean | Defaults to false (read/write). | + +--- + +##### `diskName`Required + +```typescript +public readonly diskName: string; +``` + +- *Type:* string + +The Name of the data disk in the blob storage. + +--- + +##### `diskUri`Required + +```typescript +public readonly diskUri: string; +``` + +- *Type:* string + +The URI the data disk in the blob storage. + +--- + +##### `cachingMode`Optional + +```typescript +public readonly cachingMode: string; +``` + +- *Type:* string + +Host Caching mode: None, Read Only, Read Write. + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type to mount. + +Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +--- + +##### `kind`Optional + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). + +defaults to shared + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +--- + +### AzureFilePersistentVolumeSource + +AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const azureFilePersistentVolumeSource: k8s.AzureFilePersistentVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| secretName | string | the name of secret that contains Azure Storage Account Name and Key. | +| shareName | string | Share Name. | +| readOnly | boolean | Defaults to false (read/write). | +| secretNamespace | string | the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod. | + +--- + +##### `secretName`Required + +```typescript +public readonly secretName: string; +``` + +- *Type:* string + +the name of secret that contains Azure Storage Account Name and Key. + +--- + +##### `shareName`Required + +```typescript +public readonly shareName: string; +``` + +- *Type:* string + +Share Name. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +--- + +##### `secretNamespace`Optional + +```typescript +public readonly secretNamespace: string; +``` + +- *Type:* string + +the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod. + +--- + +### AzureFileVolumeSource + +AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const azureFileVolumeSource: k8s.AzureFileVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| secretName | string | the name of secret that contains Azure Storage Account Name and Key. | +| shareName | string | Share Name. | +| readOnly | boolean | Defaults to false (read/write). | + +--- + +##### `secretName`Required + +```typescript +public readonly secretName: string; +``` + +- *Type:* string + +the name of secret that contains Azure Storage Account Name and Key. + +--- + +##### `shareName`Required + +```typescript +public readonly shareName: string; +``` + +- *Type:* string + +Share Name. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +--- + +### BotKubeOptions + +#### Initializer + +```typescript +import { BotKubeOptions } from '@smallcase/cdk8s-botkube' + +const botKubeOptions: BotKubeOptions = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| configMapData | string | String formatted in YAML format defining your BotKube monitoring configuration. | +| nodeSelector | {[ key: string ]: string} | Node selector value for the BotKube deployment. | +| replicas | number | Number of BotKubt replicas to be spawned. | +| secretName | string | Your BotKube communication secret name. | +| tolerations | @smallcase/cdk8s-botkube.k8s.Toleration[] | Tolerations value for the BotKube deployment. | + +--- + +##### `configMapData`Optional + +```typescript +public readonly configMapData: string; +``` + +- *Type:* string +- *Default:* botkube default + +String formatted in YAML format defining your BotKube monitoring configuration. + +--- + +##### `nodeSelector`Optional + +```typescript +public readonly nodeSelector: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} +- *Default:* empty object + +Node selector value for the BotKube deployment. + +--- + +##### `replicas`Optional + +```typescript +public readonly replicas: number; +``` + +- *Type:* number +- *Default:* 1 + +Number of BotKubt replicas to be spawned. + +--- + +##### `secretName`Optional + +```typescript +public readonly secretName: string; +``` + +- *Type:* string +- *Default:* botkube-communication-secret + +Your BotKube communication secret name. + +--- + +##### `tolerations`Optional + +```typescript +public readonly tolerations: Toleration[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Toleration[] +- *Default:* empty array + +Tolerations value for the BotKube deployment. + +--- + +### BoundObjectReference + +BoundObjectReference is a reference to an object that a token is bound to. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const boundObjectReference: k8s.BoundObjectReference = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiVersion | string | API version of the referent. | +| kind | string | Kind of the referent. | +| name | string | Name of the referent. | +| uid | string | UID of the referent. | + +--- + +##### `apiVersion`Optional + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +API version of the referent. + +--- + +##### `kind`Optional + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind of the referent. + +Valid kinds are 'Pod' and 'Secret'. + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the referent. + +--- + +##### `uid`Optional + +```typescript +public readonly uid: string; +``` + +- *Type:* string + +UID of the referent. + +--- + +### Capabilities + +Adds and removes POSIX capabilities from running containers. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const capabilities: k8s.Capabilities = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| add | string[] | Added capabilities. | +| drop | string[] | Removed capabilities. | + +--- + +##### `add`Optional + +```typescript +public readonly add: string[]; +``` + +- *Type:* string[] + +Added capabilities. + +--- + +##### `drop`Optional + +```typescript +public readonly drop: string[]; +``` + +- *Type:* string[] + +Removed capabilities. + +--- + +### CephFsPersistentVolumeSource + +Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const cephFsPersistentVolumeSource: k8s.CephFsPersistentVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| monitors | string[] | Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. | +| path | string | Optional: Used as the mounted root, rather than the full Ceph tree, default is /. | +| readOnly | boolean | Optional: Defaults to false (read/write). | +| secretFile | string | Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. | +| secretRef | @smallcase/cdk8s-botkube.k8s.SecretReference | Optional: SecretRef is reference to the authentication secret for User, default is empty. | +| user | string | Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. | + +--- + +##### `monitors`Required + +```typescript +public readonly monitors: string[]; +``` + +- *Type:* string[] + +Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. + +--- + +##### `path`Optional + +```typescript +public readonly path: string; +``` + +- *Type:* string + +Optional: Used as the mounted root, rather than the full Ceph tree, default is /. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +Optional: Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +--- + +##### `secretFile`Optional + +```typescript +public readonly secretFile: string; +``` + +- *Type:* string + +Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. + +--- + +##### `secretRef`Optional + +```typescript +public readonly secretRef: SecretReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecretReference + +Optional: SecretRef is reference to the authentication secret for User, default is empty. + +More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +--- + +##### `user`Optional + +```typescript +public readonly user: string; +``` + +- *Type:* string + +Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. + +--- + +### CephFsVolumeSource + +Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const cephFsVolumeSource: k8s.CephFsVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| monitors | string[] | Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. | +| path | string | Optional: Used as the mounted root, rather than the full Ceph tree, default is /. | +| readOnly | boolean | Optional: Defaults to false (read/write). | +| secretFile | string | Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. | +| secretRef | @smallcase/cdk8s-botkube.k8s.LocalObjectReference | Optional: SecretRef is reference to the authentication secret for User, default is empty. | +| user | string | Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. | + +--- + +##### `monitors`Required + +```typescript +public readonly monitors: string[]; +``` + +- *Type:* string[] + +Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. + +--- + +##### `path`Optional + +```typescript +public readonly path: string; +``` + +- *Type:* string + +Optional: Used as the mounted root, rather than the full Ceph tree, default is /. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +Optional: Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +--- + +##### `secretFile`Optional + +```typescript +public readonly secretFile: string; +``` + +- *Type:* string + +Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. + +--- + +##### `secretRef`Optional + +```typescript +public readonly secretRef: LocalObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LocalObjectReference + +Optional: SecretRef is reference to the authentication secret for User, default is empty. + +More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + +--- + +##### `user`Optional + +```typescript +public readonly user: string; +``` + +- *Type:* string + +Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it. + +--- + +### CertificateSigningRequestSpec + +CertificateSigningRequestSpec contains the certificate request. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const certificateSigningRequestSpec: k8s.CertificateSigningRequestSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| request | string | request contains an x509 certificate signing request encoded in a "CERTIFICATE REQUEST" PEM block. | +| signerName | string | signerName indicates the requested signer, and is a qualified name. | +| extra | {[ key: string ]: string[]} | extra contains extra attributes of the user that created the CertificateSigningRequest. | +| groups | string[] | groups contains group membership of the user that created the CertificateSigningRequest. | +| uid | string | uid contains the uid of the user that created the CertificateSigningRequest. | +| usages | string[] | usages specifies a set of key usages requested in the issued certificate. | +| username | string | username contains the name of the user that created the CertificateSigningRequest. | + +--- + +##### `request`Required + +```typescript +public readonly request: string; +``` + +- *Type:* string + +request contains an x509 certificate signing request encoded in a "CERTIFICATE REQUEST" PEM block. + +When serialized as JSON or YAML, the data is additionally base64-encoded. + +--- + +##### `signerName`Required + +```typescript +public readonly signerName: string; +``` + +- *Type:* string + +signerName indicates the requested signer, and is a qualified name. + +List/watch requests for CertificateSigningRequests can filter on this field using a "spec.signerName=NAME" fieldSelector. + +Well-known Kubernetes signers are: +1. "kubernetes.io/kube-apiserver-client": issues client certificates that can be used to authenticate to kube-apiserver. +Requests for this signer are never auto-approved by kube-controller-manager, can be issued by the "csrsigning" controller in kube-controller-manager. +2. "kubernetes.io/kube-apiserver-client-kubelet": issues client certificates that kubelets use to authenticate to kube-apiserver. +Requests for this signer can be auto-approved by the "csrapproving" controller in kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. +3. "kubernetes.io/kubelet-serving" issues serving certificates that kubelets use to serve TLS endpoints, which kube-apiserver can connect to securely. +Requests for this signer are never auto-approved by kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. + +More details are available at https://k8s.io/docs/reference/access-authn-authz/certificate-signing-requests/#kubernetes-signers + +Custom signerNames can also be specified. The signer defines: +1. Trust distribution: how trust (CA bundles) are distributed. +2. Permitted subjects: and behavior when a disallowed subject is requested. +3. Required, permitted, or forbidden x509 extensions in the request (including whether subjectAltNames are allowed, which types, restrictions on allowed values) and behavior when a disallowed extension is requested. +4. Required, permitted, or forbidden key usages / extended key usages. +5. Expiration/certificate lifetime: whether it is fixed by the signer, configurable by the admin. +6. Whether or not requests for CA certificates are allowed. + +--- + +##### `extra`Optional + +```typescript +public readonly extra: {[ key: string ]: string[]}; +``` + +- *Type:* {[ key: string ]: string[]} + +extra contains extra attributes of the user that created the CertificateSigningRequest. + +Populated by the API server on creation and immutable. + +--- + +##### `groups`Optional + +```typescript +public readonly groups: string[]; +``` + +- *Type:* string[] + +groups contains group membership of the user that created the CertificateSigningRequest. + +Populated by the API server on creation and immutable. + +--- + +##### `uid`Optional + +```typescript +public readonly uid: string; +``` + +- *Type:* string + +uid contains the uid of the user that created the CertificateSigningRequest. + +Populated by the API server on creation and immutable. + +--- + +##### `usages`Optional + +```typescript +public readonly usages: string[]; +``` + +- *Type:* string[] + +usages specifies a set of key usages requested in the issued certificate. + +Requests for TLS client certificates typically request: "digital signature", "key encipherment", "client auth". + +Requests for TLS serving certificates typically request: "key encipherment", "digital signature", "server auth". + +Valid values are: +"signing", "digital signature", "content commitment", +"key encipherment", "key agreement", "data encipherment", +"cert sign", "crl sign", "encipher only", "decipher only", "any", +"server auth", "client auth", +"code signing", "email protection", "s/mime", +"ipsec end system", "ipsec tunnel", "ipsec user", +"timestamping", "ocsp signing", "microsoft sgc", "netscape sgc" + +--- + +##### `username`Optional + +```typescript +public readonly username: string; +``` + +- *Type:* string + +username contains the name of the user that created the CertificateSigningRequest. + +Populated by the API server on creation and immutable. + +--- + +### CertificateSigningRequestSpecV1Beta1 + +This information is immutable after the request is created. + +Only the Request and Usages fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const certificateSigningRequestSpecV1Beta1: k8s.CertificateSigningRequestSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| request | string | Base64-encoded PKCS#10 CSR data. | +| extra | {[ key: string ]: string[]} | Extra information about the requesting user. | +| groups | string[] | Group information about the requesting user. | +| signerName | string | Requested signer for the request. | +| uid | string | UID information about the requesting user. | +| usages | string[] | allowedUsages specifies a set of usage contexts the key will be valid for. | +| username | string | Information about the requesting user. | + +--- + +##### `request`Required + +```typescript +public readonly request: string; +``` + +- *Type:* string + +Base64-encoded PKCS#10 CSR data. + +--- + +##### `extra`Optional + +```typescript +public readonly extra: {[ key: string ]: string[]}; +``` + +- *Type:* {[ key: string ]: string[]} + +Extra information about the requesting user. + +See user.Info interface for details. + +--- + +##### `groups`Optional + +```typescript +public readonly groups: string[]; +``` + +- *Type:* string[] + +Group information about the requesting user. + +See user.Info interface for details. + +--- + +##### `signerName`Optional + +```typescript +public readonly signerName: string; +``` + +- *Type:* string + +Requested signer for the request. + +It is a qualified name in the form: `scope-hostname.io/name`. If empty, it will be defaulted: +1. If it's a kubelet client certificate, it is assigned +"kubernetes.io/kube-apiserver-client-kubelet". +2. If it's a kubelet serving certificate, it is assigned +"kubernetes.io/kubelet-serving". +3. Otherwise, it is assigned "kubernetes.io/legacy-unknown". +Distribution of trust for signers happens out of band. You can select on this field using `spec.signerName`. + +--- + +##### `uid`Optional + +```typescript +public readonly uid: string; +``` + +- *Type:* string + +UID information about the requesting user. + +See user.Info interface for details. + +--- + +##### `usages`Optional + +```typescript +public readonly usages: string[]; +``` + +- *Type:* string[] + +allowedUsages specifies a set of usage contexts the key will be valid for. + +See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 +https://tools.ietf.org/html/rfc5280#section-4.2.1.12 +Valid values are: +"signing", +"digital signature", +"content commitment", +"key encipherment", +"key agreement", +"data encipherment", +"cert sign", +"crl sign", +"encipher only", +"decipher only", +"any", +"server auth", +"client auth", +"code signing", +"email protection", +"s/mime", +"ipsec end system", +"ipsec tunnel", +"ipsec user", +"timestamping", +"ocsp signing", +"microsoft sgc", +"netscape sgc" + +--- + +##### `username`Optional + +```typescript +public readonly username: string; +``` + +- *Type:* string + +Information about the requesting user. + +See user.Info interface for details. + +--- + +### CinderPersistentVolumeSource + +Represents a cinder volume resource in Openstack. + +A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const cinderPersistentVolumeSource: k8s.CinderPersistentVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| volumeId | string | volume id used to identify the volume in cinder. | +| fsType | string | Filesystem type to mount. | +| readOnly | boolean | Optional: Defaults to false (read/write). | +| secretRef | @smallcase/cdk8s-botkube.k8s.SecretReference | Optional: points to a secret object containing parameters used to connect to OpenStack. | + +--- + +##### `volumeId`Required + +```typescript +public readonly volumeId: string; +``` + +- *Type:* string + +volume id used to identify the volume in cinder. + +More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type to mount. + +Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +Optional: Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +--- + +##### `secretRef`Optional + +```typescript +public readonly secretRef: SecretReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecretReference + +Optional: points to a secret object containing parameters used to connect to OpenStack. + +--- + +### CinderVolumeSource + +Represents a cinder volume resource in Openstack. + +A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const cinderVolumeSource: k8s.CinderVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| volumeId | string | volume id used to identify the volume in cinder. | +| fsType | string | Filesystem type to mount. | +| readOnly | boolean | Optional: Defaults to false (read/write). | +| secretRef | @smallcase/cdk8s-botkube.k8s.LocalObjectReference | Optional: points to a secret object containing parameters used to connect to OpenStack. | + +--- + +##### `volumeId`Required + +```typescript +public readonly volumeId: string; +``` + +- *Type:* string + +volume id used to identify the volume in cinder. + +More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type to mount. + +Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +Optional: Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +--- + +##### `secretRef`Optional + +```typescript +public readonly secretRef: LocalObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LocalObjectReference + +Optional: points to a secret object containing parameters used to connect to OpenStack. + +--- + +### ClientIpConfig + +ClientIPConfig represents the configurations of Client IP based session affinity. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const clientIpConfig: k8s.ClientIpConfig = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| timeoutSeconds | number | timeoutSeconds specifies the seconds of ClientIP type session sticky time. | + +--- + +##### `timeoutSeconds`Optional + +```typescript +public readonly timeoutSeconds: number; +``` + +- *Type:* number + +timeoutSeconds specifies the seconds of ClientIP type session sticky time. + +The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). + +--- + +### ComponentCondition + +Information about the condition of a component. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const componentCondition: k8s.ComponentCondition = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| status | string | Status of the condition for a component. | +| type | string | Type of condition for a component. | +| error | string | Condition error code for a component. | +| message | string | Message about the condition for a component. | + +--- + +##### `status`Required + +```typescript +public readonly status: string; +``` + +- *Type:* string + +Status of the condition for a component. + +Valid values for "Healthy": "True", "False", or "Unknown". + +--- + +##### `type`Required + +```typescript +public readonly type: string; +``` + +- *Type:* string + +Type of condition for a component. + +Valid value: "Healthy" + +--- + +##### `error`Optional + +```typescript +public readonly error: string; +``` + +- *Type:* string + +Condition error code for a component. + +For example, a health check error code. + +--- + +##### `message`Optional + +```typescript +public readonly message: string; +``` + +- *Type:* string + +Message about the condition for a component. + +For example, information about a health check. + +--- + +### ConfigMapEnvSource + +ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + +The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const configMapEnvSource: k8s.ConfigMapEnvSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | Name of the referent. | +| optional | boolean | Specify whether the ConfigMap must be defined. | + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the referent. + +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +--- + +##### `optional`Optional + +```typescript +public readonly optional: boolean; +``` + +- *Type:* boolean + +Specify whether the ConfigMap must be defined. + +--- + +### ConfigMapKeySelector + +Selects a key from a ConfigMap. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const configMapKeySelector: k8s.ConfigMapKeySelector = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| key | string | The key to select. | +| name | string | Name of the referent. | +| optional | boolean | Specify whether the ConfigMap or its key must be defined. | + +--- + +##### `key`Required + +```typescript +public readonly key: string; +``` + +- *Type:* string + +The key to select. + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the referent. + +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +--- + +##### `optional`Optional + +```typescript +public readonly optional: boolean; +``` + +- *Type:* boolean + +Specify whether the ConfigMap or its key must be defined. + +--- + +### ConfigMapNodeConfigSource + +ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const configMapNodeConfigSource: k8s.ConfigMapNodeConfigSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| kubeletConfigKey | string | KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. | +| name | string | Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. | +| namespace | string | Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. | +| resourceVersion | string | ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. | +| uid | string | UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. | + +--- + +##### `kubeletConfigKey`Required + +```typescript +public readonly kubeletConfigKey: string; +``` + +- *Type:* string + +KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. + +--- + +##### `namespace`Required + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. + +--- + +##### `resourceVersion`Optional + +```typescript +public readonly resourceVersion: string; +``` + +- *Type:* string + +ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. + +--- + +##### `uid`Optional + +```typescript +public readonly uid: string; +``` + +- *Type:* string + +UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. + +--- + +### ConfigMapProjection + +Adapts a ConfigMap into a projected volume. + +The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const configMapProjection: k8s.ConfigMapProjection = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KeyToPath[] | 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. | +| name | string | Name of the referent. | +| optional | boolean | Specify whether the ConfigMap or its keys must be defined. | + +--- + +##### `items`Optional + +```typescript +public readonly items: KeyToPath[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KeyToPath[] + +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. + +If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the referent. + +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +--- + +##### `optional`Optional + +```typescript +public readonly optional: boolean; +``` + +- *Type:* boolean + +Specify whether the ConfigMap or its keys must be defined. + +--- + +### ConfigMapVolumeSource + +Adapts a ConfigMap into a volume. + +The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const configMapVolumeSource: k8s.ConfigMapVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| defaultMode | number | Optional: mode bits used to set permissions on created files by default. | +| items | @smallcase/cdk8s-botkube.k8s.KeyToPath[] | 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. | +| name | string | Name of the referent. | +| optional | boolean | Specify whether the ConfigMap or its keys must be defined. | + +--- + +##### `defaultMode`Optional + +```typescript +public readonly defaultMode: number; +``` + +- *Type:* number +- *Default:* 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +Optional: mode bits used to set permissions on created files by default. + +Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +--- + +##### `items`Optional + +```typescript +public readonly items: KeyToPath[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KeyToPath[] + +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. + +If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the referent. + +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +--- + +##### `optional`Optional + +```typescript +public readonly optional: boolean; +``` + +- *Type:* boolean + +Specify whether the ConfigMap or its keys must be defined. + +--- + +### Container + +A single application container that you want to run within a pod. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const container: k8s.Container = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | Name of the container specified as a DNS_LABEL. | +| args | string[] | Arguments to the entrypoint. | +| command | string[] | Entrypoint array. | +| env | @smallcase/cdk8s-botkube.k8s.EnvVar[] | List of environment variables to set in the container. | +| envFrom | @smallcase/cdk8s-botkube.k8s.EnvFromSource[] | List of sources to populate environment variables in the container. | +| image | string | Docker image name. | +| imagePullPolicy | string | Image pull policy. | +| lifecycle | @smallcase/cdk8s-botkube.k8s.Lifecycle | Actions that the management system should take in response to container lifecycle events. | +| livenessProbe | @smallcase/cdk8s-botkube.k8s.Probe | Periodic probe of container liveness. | +| ports | @smallcase/cdk8s-botkube.k8s.ContainerPort[] | List of ports to expose from the container. | +| readinessProbe | @smallcase/cdk8s-botkube.k8s.Probe | Periodic probe of container service readiness. | +| resources | @smallcase/cdk8s-botkube.k8s.ResourceRequirements | Compute Resources required by this container. | +| securityContext | @smallcase/cdk8s-botkube.k8s.SecurityContext | Security options the pod should run with. | +| startupProbe | @smallcase/cdk8s-botkube.k8s.Probe | StartupProbe indicates that the Pod has successfully initialized. | +| stdin | boolean | Whether this container should allocate a buffer for stdin in the container runtime. | +| stdinOnce | boolean | Whether the container runtime should close the stdin channel after it has been opened by a single attach. | +| terminationMessagePath | string | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. | +| terminationMessagePolicy | string | Indicate how the termination message should be populated. | +| tty | boolean | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. | +| volumeDevices | @smallcase/cdk8s-botkube.k8s.VolumeDevice[] | volumeDevices is the list of block devices to be used by the container. | +| volumeMounts | @smallcase/cdk8s-botkube.k8s.VolumeMount[] | Pod volumes to mount into the container's filesystem. | +| workingDir | string | Container's working directory. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the container specified as a DNS_LABEL. + +Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. + +--- + +##### `args`Optional + +```typescript +public readonly args: string[]; +``` + +- *Type:* string[] + +Arguments to the entrypoint. + +The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If 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). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +--- + +##### `command`Optional + +```typescript +public readonly command: string[]; +``` + +- *Type:* string[] + +Entrypoint array. + +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. If 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). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +--- + +##### `env`Optional + +```typescript +public readonly env: EnvVar[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EnvVar[] + +List of environment variables to set in the container. + +Cannot be updated. + +--- + +##### `envFrom`Optional + +```typescript +public readonly envFrom: EnvFromSource[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EnvFromSource[] + +List of sources to populate environment variables in the container. + +The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + +--- + +##### `image`Optional + +```typescript +public readonly image: string; +``` + +- *Type:* string + +Docker image name. + +More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. + +--- + +##### `imagePullPolicy`Optional + +```typescript +public readonly imagePullPolicy: string; +``` + +- *Type:* string +- *Default:* Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + +Image pull policy. + +One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + +--- + +##### `lifecycle`Optional + +```typescript +public readonly lifecycle: Lifecycle; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Lifecycle + +Actions that the management system should take in response to container lifecycle events. + +Cannot be updated. + +--- + +##### `livenessProbe`Optional + +```typescript +public readonly livenessProbe: Probe; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Probe + +Periodic probe of container liveness. + +Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +--- + +##### `ports`Optional + +```typescript +public readonly ports: ContainerPort[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ContainerPort[] + +List of ports to expose from the container. + +Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. + +--- + +##### `readinessProbe`Optional + +```typescript +public readonly readinessProbe: Probe; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Probe + +Periodic probe of container service readiness. + +Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +--- + +##### `resources`Optional + +```typescript +public readonly resources: ResourceRequirements; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ResourceRequirements + +Compute Resources required by this container. + +Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +--- + +##### `securityContext`Optional + +```typescript +public readonly securityContext: SecurityContext; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecurityContext + +Security options the pod should run with. + +More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ + +--- + +##### `startupProbe`Optional + +```typescript +public readonly startupProbe: Probe; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Probe + +StartupProbe indicates that the Pod has successfully initialized. + +If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +--- + +##### `stdin`Optional + +```typescript +public readonly stdin: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +Whether this container should allocate a buffer for stdin in the container runtime. + +If this is not set, reads from stdin in the container will always result in EOF. Default is false. + +--- + +##### `stdinOnce`Optional + +```typescript +public readonly stdinOnce: boolean; +``` + +- *Type:* boolean +- *Default:* false + +Whether the container runtime should close the stdin channel after it has been opened by a single attach. + +When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + +--- + +##### `terminationMessagePath`Optional + +```typescript +public readonly terminationMessagePath: string; +``` + +- *Type:* string +- *Default:* dev/termination-log. Cannot be updated. + +Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. + +Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + +--- + +##### `terminationMessagePolicy`Optional + +```typescript +public readonly terminationMessagePolicy: string; +``` + +- *Type:* string +- *Default:* File. Cannot be updated. + +Indicate how the termination message should be populated. + +File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + +--- + +##### `tty`Optional + +```typescript +public readonly tty: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. + +Default is false. + +--- + +##### `volumeDevices`Optional + +```typescript +public readonly volumeDevices: VolumeDevice[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VolumeDevice[] + +volumeDevices is the list of block devices to be used by the container. + +--- + +##### `volumeMounts`Optional + +```typescript +public readonly volumeMounts: VolumeMount[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VolumeMount[] + +Pod volumes to mount into the container's filesystem. + +Cannot be updated. + +--- + +##### `workingDir`Optional + +```typescript +public readonly workingDir: string; +``` + +- *Type:* string + +Container's working directory. + +If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + +--- + +### ContainerPort + +ContainerPort represents a network port in a single container. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const containerPort: k8s.ContainerPort = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| containerPort | number | Number of port to expose on the pod's IP address. | +| hostIp | string | What host IP to bind the external port to. | +| hostPort | number | Number of port to expose on the host. | +| name | string | If specified, this must be an IANA_SVC_NAME and unique within the pod. | +| protocol | string | Protocol for port. | + +--- + +##### `containerPort`Required + +```typescript +public readonly containerPort: number; +``` + +- *Type:* number + +Number of port to expose on the pod's IP address. + +This must be a valid port number, 0 < x < 65536. + +--- + +##### `hostIp`Optional + +```typescript +public readonly hostIp: string; +``` + +- *Type:* string + +What host IP to bind the external port to. + +--- + +##### `hostPort`Optional + +```typescript +public readonly hostPort: number; +``` + +- *Type:* number + +Number of port to expose on the host. + +If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +If specified, this must be an IANA_SVC_NAME and unique within the pod. + +Each named port in a pod must have a unique name. Name for the port that can be referred to by services. + +--- + +##### `protocol`Optional + +```typescript +public readonly protocol: string; +``` + +- *Type:* string +- *Default:* TCP". + +Protocol for port. + +Must be UDP, TCP, or SCTP. Defaults to "TCP". + +--- + +### ContainerResourceMetricSourceV2Beta1 + +ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const containerResourceMetricSourceV2Beta1: k8s.ContainerResourceMetricSourceV2Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| container | string | container is the name of the container in the pods of the scaling target. | +| name | string | name is the name of the resource in question. | +| targetAverageUtilization | number | targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. | +| targetAverageValue | @smallcase/cdk8s-botkube.k8s.Quantity | targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. | + +--- + +##### `container`Required + +```typescript +public readonly container: string; +``` + +- *Type:* string + +container is the name of the container in the pods of the scaling target. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +name is the name of the resource in question. + +--- + +##### `targetAverageUtilization`Optional + +```typescript +public readonly targetAverageUtilization: number; +``` + +- *Type:* number + +targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. + +--- + +##### `targetAverageValue`Optional + +```typescript +public readonly targetAverageValue: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. + +--- + +### ContainerResourceMetricSourceV2Beta2 + +ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const containerResourceMetricSourceV2Beta2: k8s.ContainerResourceMetricSourceV2Beta2 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| container | string | container is the name of the container in the pods of the scaling target. | +| name | string | name is the name of the resource in question. | +| target | @smallcase/cdk8s-botkube.k8s.MetricTargetV2Beta2 | target specifies the target value for the given metric. | + +--- + +##### `container`Required + +```typescript +public readonly container: string; +``` + +- *Type:* string + +container is the name of the container in the pods of the scaling target. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +name is the name of the resource in question. + +--- + +##### `target`Required + +```typescript +public readonly target: MetricTargetV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.MetricTargetV2Beta2 + +target specifies the target value for the given metric. + +--- + +### CronJobSpec + +CronJobSpec describes how the job execution will look like and when it will actually run. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const cronJobSpec: k8s.CronJobSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| jobTemplate | @smallcase/cdk8s-botkube.k8s.JobTemplateSpec | Specifies the job that will be created when executing a CronJob. | +| schedule | string | The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. | +| concurrencyPolicy | string | Specifies how to treat concurrent executions of a Job. | +| failedJobsHistoryLimit | number | The number of failed finished jobs to retain. | +| startingDeadlineSeconds | number | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. | +| successfulJobsHistoryLimit | number | The number of successful finished jobs to retain. | +| suspend | boolean | This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. | + +--- + +##### `jobTemplate`Required + +```typescript +public readonly jobTemplate: JobTemplateSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JobTemplateSpec + +Specifies the job that will be created when executing a CronJob. + +--- + +##### `schedule`Required + +```typescript +public readonly schedule: string; +``` + +- *Type:* string + +The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. + +--- + +##### `concurrencyPolicy`Optional + +```typescript +public readonly concurrencyPolicy: string; +``` + +- *Type:* string + +Specifies how to treat concurrent executions of a Job. + +Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one + +--- + +##### `failedJobsHistoryLimit`Optional + +```typescript +public readonly failedJobsHistoryLimit: number; +``` + +- *Type:* number +- *Default:* 1. + +The number of failed finished jobs to retain. + +Value must be non-negative integer. Defaults to 1. + +--- + +##### `startingDeadlineSeconds`Optional + +```typescript +public readonly startingDeadlineSeconds: number; +``` + +- *Type:* number + +Optional deadline in seconds for starting the job if it misses scheduled time for any reason. + +Missed jobs executions will be counted as failed ones. + +--- + +##### `successfulJobsHistoryLimit`Optional + +```typescript +public readonly successfulJobsHistoryLimit: number; +``` + +- *Type:* number +- *Default:* 3. + +The number of successful finished jobs to retain. + +Value must be non-negative integer. Defaults to 3. + +--- + +##### `suspend`Optional + +```typescript +public readonly suspend: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. + +Defaults to false. + +--- + +### CronJobSpecV1Beta1 + +CronJobSpec describes how the job execution will look like and when it will actually run. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const cronJobSpecV1Beta1: k8s.CronJobSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| jobTemplate | @smallcase/cdk8s-botkube.k8s.JobTemplateSpecV1Beta1 | Specifies the job that will be created when executing a CronJob. | +| schedule | string | The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. | +| concurrencyPolicy | string | Specifies how to treat concurrent executions of a Job. | +| failedJobsHistoryLimit | number | The number of failed finished jobs to retain. | +| startingDeadlineSeconds | number | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. | +| successfulJobsHistoryLimit | number | The number of successful finished jobs to retain. | +| suspend | boolean | This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. | + +--- + +##### `jobTemplate`Required + +```typescript +public readonly jobTemplate: JobTemplateSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JobTemplateSpecV1Beta1 + +Specifies the job that will be created when executing a CronJob. + +--- + +##### `schedule`Required + +```typescript +public readonly schedule: string; +``` + +- *Type:* string + +The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. + +--- + +##### `concurrencyPolicy`Optional + +```typescript +public readonly concurrencyPolicy: string; +``` + +- *Type:* string + +Specifies how to treat concurrent executions of a Job. + +Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one + +--- + +##### `failedJobsHistoryLimit`Optional + +```typescript +public readonly failedJobsHistoryLimit: number; +``` + +- *Type:* number +- *Default:* 1. + +The number of failed finished jobs to retain. + +This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. + +--- + +##### `startingDeadlineSeconds`Optional + +```typescript +public readonly startingDeadlineSeconds: number; +``` + +- *Type:* number + +Optional deadline in seconds for starting the job if it misses scheduled time for any reason. + +Missed jobs executions will be counted as failed ones. + +--- + +##### `successfulJobsHistoryLimit`Optional + +```typescript +public readonly successfulJobsHistoryLimit: number; +``` + +- *Type:* number +- *Default:* 3. + +The number of successful finished jobs to retain. + +This is a pointer to distinguish between explicit zero and not specified. Defaults to 3. + +--- + +##### `suspend`Optional + +```typescript +public readonly suspend: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. + +Defaults to false. + +--- + +### CrossVersionObjectReference + +CrossVersionObjectReference contains enough information to let you identify the referred resource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const crossVersionObjectReference: k8s.CrossVersionObjectReference = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| kind | string | Kind of the referent; | +| name | string | Name of the referent; | +| apiVersion | string | API version of the referent. | + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind of the referent; + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the referent; + +More info: http://kubernetes.io/docs/user-guide/identifiers#names + +--- + +##### `apiVersion`Optional + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +API version of the referent. + +--- + +### CrossVersionObjectReferenceV2Beta1 + +CrossVersionObjectReference contains enough information to let you identify the referred resource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const crossVersionObjectReferenceV2Beta1: k8s.CrossVersionObjectReferenceV2Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| kind | string | Kind of the referent; | +| name | string | Name of the referent; | +| apiVersion | string | API version of the referent. | + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind of the referent; + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the referent; + +More info: http://kubernetes.io/docs/user-guide/identifiers#names + +--- + +##### `apiVersion`Optional + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +API version of the referent. + +--- + +### CrossVersionObjectReferenceV2Beta2 + +CrossVersionObjectReference contains enough information to let you identify the referred resource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const crossVersionObjectReferenceV2Beta2: k8s.CrossVersionObjectReferenceV2Beta2 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| kind | string | Kind of the referent; | +| name | string | Name of the referent; | +| apiVersion | string | API version of the referent. | + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind of the referent; + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the referent; + +More info: http://kubernetes.io/docs/user-guide/identifiers#names + +--- + +##### `apiVersion`Optional + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +API version of the referent. + +--- + +### CsiDriverSpec + +CSIDriverSpec is the specification of a CSIDriver. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const csiDriverSpec: k8s.CsiDriverSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attachRequired | boolean | attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. | +| fsGroupPolicy | string | Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. | +| podInfoOnMount | boolean | If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume defined by a CSIVolumeSource, otherwise "false". | +| requiresRepublish | boolean | RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. | +| storageCapacity | boolean | If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information. | +| tokenRequests | @smallcase/cdk8s-botkube.k8s.TokenRequest[] | TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. | +| volumeLifecycleModes | string[] | volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. | + +--- + +##### `attachRequired`Optional + +```typescript +public readonly attachRequired: boolean; +``` + +- *Type:* boolean + +attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. + +The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. + +This field is immutable. + +--- + +##### `fsGroupPolicy`Optional + +```typescript +public readonly fsGroupPolicy: string; +``` + +- *Type:* string + +Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. + +Refer to the specific FSGroupPolicy values for additional details. This field is alpha-level, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate. + +This field is immutable. + +--- + +##### `podInfoOnMount`Optional + +```typescript +public readonly podInfoOnMount: boolean; +``` + +- *Type:* boolean +- *Default:* false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume + +If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume defined by a CSIVolumeSource, otherwise "false". + +"csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. + +This field is immutable. + +--- + +##### `requiresRepublish`Optional + +```typescript +public readonly requiresRepublish: boolean; +``` + +- *Type:* boolean + +RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. + +This field defaults to false. + +Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container. + +This is a beta feature and only available when the CSIServiceAccountToken feature is enabled. + +--- + +##### `storageCapacity`Optional + +```typescript +public readonly storageCapacity: boolean; +``` + +- *Type:* boolean + +If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information. + +The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object. + +Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published. + +This field is immutable. + +This is a beta field and only available when the CSIStorageCapacity feature is enabled. The default is false. + +--- + +##### `tokenRequests`Optional + +```typescript +public readonly tokenRequests: TokenRequest[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.TokenRequest[] + +TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. + +Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": { +"": { +"token": , +"expirationTimestamp": , +}, +... +} + +Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically. + +This is a beta feature and only available when the CSIServiceAccountToken feature is enabled. + +--- + +##### `volumeLifecycleModes`Optional + +```typescript +public readonly volumeLifecycleModes: string[]; +``` + +- *Type:* string[] + +volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. + +The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. This field is beta. + +This field is immutable. + +--- + +### CsiDriverSpecV1Beta1 + +CSIDriverSpec is the specification of a CSIDriver. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const csiDriverSpecV1Beta1: k8s.CsiDriverSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attachRequired | boolean | attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. | +| fsGroupPolicy | string | Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. | +| podInfoOnMount | boolean | If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume defined by a CSIVolumeSource, otherwise "false". | +| requiresRepublish | boolean | RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. | +| storageCapacity | boolean | If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information. | +| tokenRequests | @smallcase/cdk8s-botkube.k8s.TokenRequestV1Beta1[] | TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. | +| volumeLifecycleModes | string[] | VolumeLifecycleModes defines what kind of volumes this CSI volume driver supports. | + +--- + +##### `attachRequired`Optional + +```typescript +public readonly attachRequired: boolean; +``` + +- *Type:* boolean + +attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. + +The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. + +This field is immutable. + +--- + +##### `fsGroupPolicy`Optional + +```typescript +public readonly fsGroupPolicy: string; +``` + +- *Type:* string + +Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. + +Refer to the specific FSGroupPolicy values for additional details. This field is alpha-level, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate. + +This field is immutable. + +--- + +##### `podInfoOnMount`Optional + +```typescript +public readonly podInfoOnMount: boolean; +``` + +- *Type:* boolean +- *Default:* false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume + +If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume defined by a CSIVolumeSource, otherwise "false". + +"csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. + +This field is immutable. + +--- + +##### `requiresRepublish`Optional + +```typescript +public readonly requiresRepublish: boolean; +``` + +- *Type:* boolean + +RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. + +This field defaults to false. + +Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container. + +This is a beta feature and only available when the CSIServiceAccountToken feature is enabled. + +--- + +##### `storageCapacity`Optional + +```typescript +public readonly storageCapacity: boolean; +``` + +- *Type:* boolean + +If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information. + +The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object. + +Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published. + +This field is immutable. + +This is a beta field and only available when the CSIStorageCapacity feature is enabled. The default is false. + +--- + +##### `tokenRequests`Optional + +```typescript +public readonly tokenRequests: TokenRequestV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.TokenRequestV1Beta1[] + +TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. + +Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": { +"": { +"token": , +"expirationTimestamp": , +}, +... +} + +Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically. + +This is a beta feature and only available when the CSIServiceAccountToken feature is enabled. + +--- + +##### `volumeLifecycleModes`Optional + +```typescript +public readonly volumeLifecycleModes: string[]; +``` + +- *Type:* string[] + +VolumeLifecycleModes defines what kind of volumes this CSI volume driver supports. + +The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. + +This field is immutable. + +--- + +### CsiNodeDriver + +CSINodeDriver holds information about the specification of one CSI driver installed on a node. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const csiNodeDriver: k8s.CsiNodeDriver = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | This is the name of the CSI driver that this object refers to. | +| nodeId | string | nodeID of the node from the driver point of view. | +| allocatable | @smallcase/cdk8s-botkube.k8s.VolumeNodeResources | allocatable represents the volume resources of a node that are available for scheduling. | +| topologyKeys | string[] | topologyKeys is the list of keys supported by the driver. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +This is the name of the CSI driver that this object refers to. + +This MUST be the same name returned by the CSI GetPluginName() call for that driver. + +--- + +##### `nodeId`Required + +```typescript +public readonly nodeId: string; +``` + +- *Type:* string + +nodeID of the node from the driver point of view. + +This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required. + +--- + +##### `allocatable`Optional + +```typescript +public readonly allocatable: VolumeNodeResources; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VolumeNodeResources + +allocatable represents the volume resources of a node that are available for scheduling. + +This field is beta. + +--- + +##### `topologyKeys`Optional + +```typescript +public readonly topologyKeys: string[]; +``` + +- *Type:* string[] + +topologyKeys is the list of keys supported by the driver. + +When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology. + +--- + +### CsiNodeDriverV1Beta1 + +CSINodeDriver holds information about the specification of one CSI driver installed on a node. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const csiNodeDriverV1Beta1: k8s.CsiNodeDriverV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | This is the name of the CSI driver that this object refers to. | +| nodeId | string | nodeID of the node from the driver point of view. | +| allocatable | @smallcase/cdk8s-botkube.k8s.VolumeNodeResourcesV1Beta1 | allocatable represents the volume resources of a node that are available for scheduling. | +| topologyKeys | string[] | topologyKeys is the list of keys supported by the driver. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +This is the name of the CSI driver that this object refers to. + +This MUST be the same name returned by the CSI GetPluginName() call for that driver. + +--- + +##### `nodeId`Required + +```typescript +public readonly nodeId: string; +``` + +- *Type:* string + +nodeID of the node from the driver point of view. + +This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required. + +--- + +##### `allocatable`Optional + +```typescript +public readonly allocatable: VolumeNodeResourcesV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VolumeNodeResourcesV1Beta1 + +allocatable represents the volume resources of a node that are available for scheduling. + +--- + +##### `topologyKeys`Optional + +```typescript +public readonly topologyKeys: string[]; +``` + +- *Type:* string[] + +topologyKeys is the list of keys supported by the driver. + +When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology. + +--- + +### CsiNodeSpec + +CSINodeSpec holds information about the specification of all CSI drivers installed on a node. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const csiNodeSpec: k8s.CsiNodeSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| drivers | @smallcase/cdk8s-botkube.k8s.CsiNodeDriver[] | drivers is a list of information of all CSI Drivers existing on a node. | + +--- + +##### `drivers`Required + +```typescript +public readonly drivers: CsiNodeDriver[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CsiNodeDriver[] + +drivers is a list of information of all CSI Drivers existing on a node. + +If all drivers in the list are uninstalled, this can become empty. + +--- + +### CsiNodeSpecV1Beta1 + +CSINodeSpec holds information about the specification of all CSI drivers installed on a node. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const csiNodeSpecV1Beta1: k8s.CsiNodeSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| drivers | @smallcase/cdk8s-botkube.k8s.CsiNodeDriverV1Beta1[] | drivers is a list of information of all CSI Drivers existing on a node. | + +--- + +##### `drivers`Required + +```typescript +public readonly drivers: CsiNodeDriverV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CsiNodeDriverV1Beta1[] + +drivers is a list of information of all CSI Drivers existing on a node. + +If all drivers in the list are uninstalled, this can become empty. + +--- + +### CsiPersistentVolumeSource + +Represents storage that is managed by an external CSI volume driver (Beta feature). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const csiPersistentVolumeSource: k8s.CsiPersistentVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| driver | string | Driver is the name of the driver to use for this volume. | +| volumeHandle | string | VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. | +| controllerExpandSecretRef | @smallcase/cdk8s-botkube.k8s.SecretReference | ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. | +| controllerPublishSecretRef | @smallcase/cdk8s-botkube.k8s.SecretReference | ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. | +| fsType | string | Filesystem type to mount. | +| nodePublishSecretRef | @smallcase/cdk8s-botkube.k8s.SecretReference | NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. | +| nodeStageSecretRef | @smallcase/cdk8s-botkube.k8s.SecretReference | NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. | +| readOnly | boolean | Optional: The value to pass to ControllerPublishVolumeRequest. | +| volumeAttributes | {[ key: string ]: string} | Attributes of the volume to publish. | + +--- + +##### `driver`Required + +```typescript +public readonly driver: string; +``` + +- *Type:* string + +Driver is the name of the driver to use for this volume. + +Required. + +--- + +##### `volumeHandle`Required + +```typescript +public readonly volumeHandle: string; +``` + +- *Type:* string + +VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. + +Required. + +--- + +##### `controllerExpandSecretRef`Optional + +```typescript +public readonly controllerExpandSecretRef: SecretReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecretReference + +ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. + +This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. + +--- + +##### `controllerPublishSecretRef`Optional + +```typescript +public readonly controllerPublishSecretRef: SecretReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecretReference + +ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. + +This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type to mount. + +Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". + +--- + +##### `nodePublishSecretRef`Optional + +```typescript +public readonly nodePublishSecretRef: SecretReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecretReference + +NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. + +This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. + +--- + +##### `nodeStageSecretRef`Optional + +```typescript +public readonly nodeStageSecretRef: SecretReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecretReference + +NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. + +This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). + +Optional: The value to pass to ControllerPublishVolumeRequest. + +Defaults to false (read/write). + +--- + +##### `volumeAttributes`Optional + +```typescript +public readonly volumeAttributes: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +Attributes of the volume to publish. + +--- + +### CsiVolumeSource + +Represents a source location of a volume to mount, managed by an external CSI driver. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const csiVolumeSource: k8s.CsiVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| driver | string | Driver is the name of the CSI driver that handles this volume. | +| fsType | string | Filesystem type to mount. | +| nodePublishSecretRef | @smallcase/cdk8s-botkube.k8s.LocalObjectReference | NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. | +| readOnly | boolean | Specifies a read-only configuration for the volume. | +| volumeAttributes | {[ key: string ]: string} | VolumeAttributes stores driver-specific properties that are passed to the CSI driver. | + +--- + +##### `driver`Required + +```typescript +public readonly driver: string; +``` + +- *Type:* string + +Driver is the name of the CSI driver that handles this volume. + +Consult with your admin for the correct name as registered in the cluster. + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type to mount. + +Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. + +--- + +##### `nodePublishSecretRef`Optional + +```typescript +public readonly nodePublishSecretRef: LocalObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LocalObjectReference + +NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. + +This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). + +Specifies a read-only configuration for the volume. + +Defaults to false (read/write). + +--- + +##### `volumeAttributes`Optional + +```typescript +public readonly volumeAttributes: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +VolumeAttributes stores driver-specific properties that are passed to the CSI driver. + +Consult your driver's documentation for supported values. + +--- + +### CustomResourceColumnDefinition + +CustomResourceColumnDefinition specifies a column for server side printing. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceColumnDefinition: k8s.CustomResourceColumnDefinition = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| jsonPath | string | jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column. | +| name | string | name is a human readable name for the column. | +| type | string | type is an OpenAPI type definition for this column. | +| description | string | description is a human readable description of this column. | +| format | string | format is an optional OpenAPI type definition for this column. | +| priority | number | priority is an integer defining the relative importance of this column compared to others. | + +--- + +##### `jsonPath`Required + +```typescript +public readonly jsonPath: string; +``` + +- *Type:* string + +jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +name is a human readable name for the column. + +--- + +##### `type`Required + +```typescript +public readonly type: string; +``` + +- *Type:* string + +type is an OpenAPI type definition for this column. + +See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. + +--- + +##### `description`Optional + +```typescript +public readonly description: string; +``` + +- *Type:* string + +description is a human readable description of this column. + +--- + +##### `format`Optional + +```typescript +public readonly format: string; +``` + +- *Type:* string + +format is an optional OpenAPI type definition for this column. + +The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. + +--- + +##### `priority`Optional + +```typescript +public readonly priority: number; +``` + +- *Type:* number + +priority is an integer defining the relative importance of this column compared to others. + +Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0. + +--- + +### CustomResourceColumnDefinitionV1Beta1 + +CustomResourceColumnDefinition specifies a column for server side printing. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceColumnDefinitionV1Beta1: k8s.CustomResourceColumnDefinitionV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| jsonPath | string | JSONPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column. | +| name | string | name is a human readable name for the column. | +| type | string | type is an OpenAPI type definition for this column. | +| description | string | description is a human readable description of this column. | +| format | string | format is an optional OpenAPI type definition for this column. | +| priority | number | priority is an integer defining the relative importance of this column compared to others. | + +--- + +##### `jsonPath`Required + +```typescript +public readonly jsonPath: string; +``` + +- *Type:* string + +JSONPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +name is a human readable name for the column. + +--- + +##### `type`Required + +```typescript +public readonly type: string; +``` + +- *Type:* string + +type is an OpenAPI type definition for this column. + +See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. + +--- + +##### `description`Optional + +```typescript +public readonly description: string; +``` + +- *Type:* string + +description is a human readable description of this column. + +--- + +##### `format`Optional + +```typescript +public readonly format: string; +``` + +- *Type:* string + +format is an optional OpenAPI type definition for this column. + +The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. + +--- + +##### `priority`Optional + +```typescript +public readonly priority: number; +``` + +- *Type:* number + +priority is an integer defining the relative importance of this column compared to others. + +Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0. + +--- + +### CustomResourceConversion + +CustomResourceConversion describes how to convert different versions of a CR. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceConversion: k8s.CustomResourceConversion = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| strategy | string | strategy specifies how custom resources are converted between versions. | +| webhook | @smallcase/cdk8s-botkube.k8s.WebhookConversion | webhook describes how to call the conversion webhook. | + +--- + +##### `strategy`Required + +```typescript +public readonly strategy: string; +``` + +- *Type:* string + +strategy specifies how custom resources are converted between versions. + +Allowed values are: - `None`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `Webhook`: API Server will call to an external webhook to do the conversion. Additional information +is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set. + +--- + +##### `webhook`Optional + +```typescript +public readonly webhook: WebhookConversion; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.WebhookConversion + +webhook describes how to call the conversion webhook. + +Required when `strategy` is set to `Webhook`. + +--- + +### CustomResourceConversionV1Beta1 + +CustomResourceConversion describes how to convert different versions of a CR. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceConversionV1Beta1: k8s.CustomResourceConversionV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| strategy | string | strategy specifies how custom resources are converted between versions. | +| conversionReviewVersions | string[] | conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. | +| webhookClientConfig | @smallcase/cdk8s-botkube.k8s.WebhookClientConfigV1Beta1 | webhookClientConfig is the instructions for how to call the webhook if strategy is `Webhook`. | + +--- + +##### `strategy`Required + +```typescript +public readonly strategy: string; +``` + +- *Type:* string + +strategy specifies how custom resources are converted between versions. + +Allowed values are: - `None`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `Webhook`: API Server will call to an external webhook to do the conversion. Additional information +is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhookClientConfig to be set. + +--- + +##### `conversionReviewVersions`Optional + +```typescript +public readonly conversionReviewVersions: string[]; +``` + +- *Type:* string[] +- *Default:* v1beta1"]`. + +conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. + +The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. Defaults to `["v1beta1"]`. + +--- + +##### `webhookClientConfig`Optional + +```typescript +public readonly webhookClientConfig: WebhookClientConfigV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.WebhookClientConfigV1Beta1 + +webhookClientConfig is the instructions for how to call the webhook if strategy is `Webhook`. + +Required when `strategy` is set to `Webhook`. + +--- + +### CustomResourceDefinitionNames + +CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceDefinitionNames: k8s.CustomResourceDefinitionNames = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| kind | string | kind is the serialized kind of the resource. | +| plural | string | plural is the plural name of the resource to serve. | +| categories | string[] | categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`. | +| listKind | string | listKind is the serialized kind of the list for this resource. | +| shortNames | string[] | shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get `. | +| singular | string | singular is the singular name of the resource. | + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +kind is the serialized kind of the resource. + +It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls. + +--- + +##### `plural`Required + +```typescript +public readonly plural: string; +``` + +- *Type:* string + +plural is the plural name of the resource to serve. + +The custom resources are served under `/apis///.../`. Must match the name of the CustomResourceDefinition (in the form `.`). Must be all lowercase. + +--- + +##### `categories`Optional + +```typescript +public readonly categories: string[]; +``` + +- *Type:* string[] + +categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`. + +--- + +##### `listKind`Optional + +```typescript +public readonly listKind: string; +``` + +- *Type:* string +- *Default:* kind`List". + +listKind is the serialized kind of the list for this resource. + +Defaults to "`kind`List". + +--- + +##### `shortNames`Optional + +```typescript +public readonly shortNames: string[]; +``` + +- *Type:* string[] + +shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get `. + +It must be all lowercase. + +--- + +##### `singular`Optional + +```typescript +public readonly singular: string; +``` + +- *Type:* string +- *Default:* lowercased `kind`. + +singular is the singular name of the resource. + +It must be all lowercase. Defaults to lowercased `kind`. + +--- + +### CustomResourceDefinitionNamesV1Beta1 + +CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceDefinitionNamesV1Beta1: k8s.CustomResourceDefinitionNamesV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| kind | string | kind is the serialized kind of the resource. | +| plural | string | plural is the plural name of the resource to serve. | +| categories | string[] | categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`. | +| listKind | string | listKind is the serialized kind of the list for this resource. | +| shortNames | string[] | shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get `. | +| singular | string | singular is the singular name of the resource. | + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +kind is the serialized kind of the resource. + +It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls. + +--- + +##### `plural`Required + +```typescript +public readonly plural: string; +``` + +- *Type:* string + +plural is the plural name of the resource to serve. + +The custom resources are served under `/apis///.../`. Must match the name of the CustomResourceDefinition (in the form `.`). Must be all lowercase. + +--- + +##### `categories`Optional + +```typescript +public readonly categories: string[]; +``` + +- *Type:* string[] + +categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`. + +--- + +##### `listKind`Optional + +```typescript +public readonly listKind: string; +``` + +- *Type:* string +- *Default:* kind`List". + +listKind is the serialized kind of the list for this resource. + +Defaults to "`kind`List". + +--- + +##### `shortNames`Optional + +```typescript +public readonly shortNames: string[]; +``` + +- *Type:* string[] + +shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get `. + +It must be all lowercase. + +--- + +##### `singular`Optional + +```typescript +public readonly singular: string; +``` + +- *Type:* string +- *Default:* lowercased `kind`. + +singular is the singular name of the resource. + +It must be all lowercase. Defaults to lowercased `kind`. + +--- + +### CustomResourceDefinitionSpec + +CustomResourceDefinitionSpec describes how a user wants their resource to appear. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceDefinitionSpec: k8s.CustomResourceDefinitionSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| group | string | group is the API group of the defined custom resource. | +| names | @smallcase/cdk8s-botkube.k8s.CustomResourceDefinitionNames | names specify the resource and kind names for the custom resource. | +| scope | string | scope indicates whether the defined custom resource is cluster- or namespace-scoped. | +| versions | @smallcase/cdk8s-botkube.k8s.CustomResourceDefinitionVersion[] | versions is the list of all API versions of the defined custom resource. | +| conversion | @smallcase/cdk8s-botkube.k8s.CustomResourceConversion | conversion defines conversion settings for the CRD. | +| preserveUnknownFields | boolean | preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. | + +--- + +##### `group`Required + +```typescript +public readonly group: string; +``` + +- *Type:* string + +group is the API group of the defined custom resource. + +The custom resources are served under `/apis//...`. Must match the name of the CustomResourceDefinition (in the form `.`). + +--- + +##### `names`Required + +```typescript +public readonly names: CustomResourceDefinitionNames; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceDefinitionNames + +names specify the resource and kind names for the custom resource. + +--- + +##### `scope`Required + +```typescript +public readonly scope: string; +``` + +- *Type:* string + +scope indicates whether the defined custom resource is cluster- or namespace-scoped. + +Allowed values are `Cluster` and `Namespaced`. + +--- + +##### `versions`Required + +```typescript +public readonly versions: CustomResourceDefinitionVersion[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceDefinitionVersion[] + +versions is the list of all API versions of the defined custom resource. + +Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. + +--- + +##### `conversion`Optional + +```typescript +public readonly conversion: CustomResourceConversion; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceConversion + +conversion defines conversion settings for the CRD. + +--- + +##### `preserveUnknownFields`Optional + +```typescript +public readonly preserveUnknownFields: boolean; +``` + +- *Type:* boolean + +preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. + +apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting `x-preserve-unknown-fields` to true in `spec.versions[*].schema.openAPIV3Schema`. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details. + +--- + +### CustomResourceDefinitionSpecV1Beta1 + +CustomResourceDefinitionSpec describes how a user wants their resource to appear. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceDefinitionSpecV1Beta1: k8s.CustomResourceDefinitionSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| group | string | group is the API group of the defined custom resource. | +| names | @smallcase/cdk8s-botkube.k8s.CustomResourceDefinitionNamesV1Beta1 | names specify the resource and kind names for the custom resource. | +| scope | string | scope indicates whether the defined custom resource is cluster- or namespace-scoped. | +| additionalPrinterColumns | @smallcase/cdk8s-botkube.k8s.CustomResourceColumnDefinitionV1Beta1[] | additionalPrinterColumns specifies additional columns returned in Table output. | +| conversion | @smallcase/cdk8s-botkube.k8s.CustomResourceConversionV1Beta1 | conversion defines conversion settings for the CRD. | +| preserveUnknownFields | boolean | preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. | +| subresources | @smallcase/cdk8s-botkube.k8s.CustomResourceSubresourcesV1Beta1 | subresources specify what subresources the defined custom resource has. | +| validation | @smallcase/cdk8s-botkube.k8s.CustomResourceValidationV1Beta1 | validation describes the schema used for validation and pruning of the custom resource. | +| version | string | version is the API version of the defined custom resource. | +| versions | @smallcase/cdk8s-botkube.k8s.CustomResourceDefinitionVersionV1Beta1[] | versions is the list of all API versions of the defined custom resource. | + +--- + +##### `group`Required + +```typescript +public readonly group: string; +``` + +- *Type:* string + +group is the API group of the defined custom resource. + +The custom resources are served under `/apis//...`. Must match the name of the CustomResourceDefinition (in the form `.`). + +--- + +##### `names`Required + +```typescript +public readonly names: CustomResourceDefinitionNamesV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceDefinitionNamesV1Beta1 + +names specify the resource and kind names for the custom resource. + +--- + +##### `scope`Required + +```typescript +public readonly scope: string; +``` + +- *Type:* string +- *Default:* Namespaced`. + +scope indicates whether the defined custom resource is cluster- or namespace-scoped. + +Allowed values are `Cluster` and `Namespaced`. Default is `Namespaced`. + +--- + +##### `additionalPrinterColumns`Optional + +```typescript +public readonly additionalPrinterColumns: CustomResourceColumnDefinitionV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceColumnDefinitionV1Beta1[] + +additionalPrinterColumns specifies additional columns returned in Table output. + +See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If present, this field configures columns for all versions. Top-level and per-version columns are mutually exclusive. If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used. + +--- + +##### `conversion`Optional + +```typescript +public readonly conversion: CustomResourceConversionV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceConversionV1Beta1 + +conversion defines conversion settings for the CRD. + +--- + +##### `preserveUnknownFields`Optional + +```typescript +public readonly preserveUnknownFields: boolean; +``` + +- *Type:* boolean +- *Default:* true in v1beta for backwards compatibility. Deprecated: will be required to be false in v1. Preservation of unknown fields can be specified in the validation schema using the `x-kubernetes-preserve-unknown-fields: true` extension. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details. + +preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. + +apiVersion, kind, metadata and known fields inside metadata are always preserved. If false, schemas must be defined for all versions. Defaults to true in v1beta for backwards compatibility. Deprecated: will be required to be false in v1. Preservation of unknown fields can be specified in the validation schema using the `x-kubernetes-preserve-unknown-fields: true` extension. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details. + +--- + +##### `subresources`Optional + +```typescript +public readonly subresources: CustomResourceSubresourcesV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceSubresourcesV1Beta1 + +subresources specify what subresources the defined custom resource has. + +If present, this field configures subresources for all versions. Top-level and per-version subresources are mutually exclusive. + +--- + +##### `validation`Optional + +```typescript +public readonly validation: CustomResourceValidationV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceValidationV1Beta1 + +validation describes the schema used for validation and pruning of the custom resource. + +If present, this validation schema is used to validate all versions. Top-level and per-version schemas are mutually exclusive. + +--- + +##### `version`Optional + +```typescript +public readonly version: string; +``` + +- *Type:* string + +version is the API version of the defined custom resource. + +The custom resources are served under `/apis///...`. Must match the name of the first item in the `versions` list if `version` and `versions` are both specified. Optional if `versions` is specified. Deprecated: use `versions` instead. + +--- + +##### `versions`Optional + +```typescript +public readonly versions: CustomResourceDefinitionVersionV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceDefinitionVersionV1Beta1[] + +versions is the list of all API versions of the defined custom resource. + +Optional if `version` is specified. The name of the first item in the `versions` list must match the `version` field if `version` and `versions` are both specified. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. + +--- + +### CustomResourceDefinitionVersion + +CustomResourceDefinitionVersion describes a version for CRD. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceDefinitionVersion: k8s.CustomResourceDefinitionVersion = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis///...` if `served` is true. | +| served | boolean | served is a flag enabling/disabling this version from being served via REST APIs. | +| storage | boolean | storage indicates this version should be used when persisting custom resources to storage. | +| additionalPrinterColumns | @smallcase/cdk8s-botkube.k8s.CustomResourceColumnDefinition[] | additionalPrinterColumns specifies additional columns returned in Table output. | +| deprecated | boolean | deprecated indicates this version of the custom resource API is deprecated. | +| deprecationWarning | string | deprecationWarning overrides the default warning returned to API clients. | +| schema | @smallcase/cdk8s-botkube.k8s.CustomResourceValidation | schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource. | +| subresources | @smallcase/cdk8s-botkube.k8s.CustomResourceSubresources | subresources specify what subresources this version of the defined custom resource have. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis///...` if `served` is true. + +--- + +##### `served`Required + +```typescript +public readonly served: boolean; +``` + +- *Type:* boolean + +served is a flag enabling/disabling this version from being served via REST APIs. + +--- + +##### `storage`Required + +```typescript +public readonly storage: boolean; +``` + +- *Type:* boolean + +storage indicates this version should be used when persisting custom resources to storage. + +There must be exactly one version with storage=true. + +--- + +##### `additionalPrinterColumns`Optional + +```typescript +public readonly additionalPrinterColumns: CustomResourceColumnDefinition[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceColumnDefinition[] + +additionalPrinterColumns specifies additional columns returned in Table output. + +See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If no columns are specified, a single column displaying the age of the custom resource is used. + +--- + +##### `deprecated`Optional + +```typescript +public readonly deprecated: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +deprecated indicates this version of the custom resource API is deprecated. + +When set to true, API requests to this version receive a warning header in the server response. Defaults to false. + +--- + +##### `deprecationWarning`Optional + +```typescript +public readonly deprecationWarning: string; +``` + +- *Type:* string + +deprecationWarning overrides the default warning returned to API clients. + +May only be set when `deprecated` is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists. + +--- + +##### `schema`Optional + +```typescript +public readonly schema: CustomResourceValidation; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceValidation + +schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource. + +--- + +##### `subresources`Optional + +```typescript +public readonly subresources: CustomResourceSubresources; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceSubresources + +subresources specify what subresources this version of the defined custom resource have. + +--- + +### CustomResourceDefinitionVersionV1Beta1 + +CustomResourceDefinitionVersion describes a version for CRD. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceDefinitionVersionV1Beta1: k8s.CustomResourceDefinitionVersionV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis///...` if `served` is true. | +| served | boolean | served is a flag enabling/disabling this version from being served via REST APIs. | +| storage | boolean | storage indicates this version should be used when persisting custom resources to storage. | +| additionalPrinterColumns | @smallcase/cdk8s-botkube.k8s.CustomResourceColumnDefinitionV1Beta1[] | additionalPrinterColumns specifies additional columns returned in Table output. | +| deprecated | boolean | deprecated indicates this version of the custom resource API is deprecated. | +| deprecationWarning | string | deprecationWarning overrides the default warning returned to API clients. | +| schema | @smallcase/cdk8s-botkube.k8s.CustomResourceValidationV1Beta1 | schema describes the schema used for validation and pruning of this version of the custom resource. | +| subresources | @smallcase/cdk8s-botkube.k8s.CustomResourceSubresourcesV1Beta1 | subresources specify what subresources this version of the defined custom resource have. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis///...` if `served` is true. + +--- + +##### `served`Required + +```typescript +public readonly served: boolean; +``` + +- *Type:* boolean + +served is a flag enabling/disabling this version from being served via REST APIs. + +--- + +##### `storage`Required + +```typescript +public readonly storage: boolean; +``` + +- *Type:* boolean + +storage indicates this version should be used when persisting custom resources to storage. + +There must be exactly one version with storage=true. + +--- + +##### `additionalPrinterColumns`Optional + +```typescript +public readonly additionalPrinterColumns: CustomResourceColumnDefinitionV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceColumnDefinitionV1Beta1[] + +additionalPrinterColumns specifies additional columns returned in Table output. + +See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. Top-level and per-version columns are mutually exclusive. Per-version columns must not all be set to identical values (top-level columns should be used instead). If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used. + +--- + +##### `deprecated`Optional + +```typescript +public readonly deprecated: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +deprecated indicates this version of the custom resource API is deprecated. + +When set to true, API requests to this version receive a warning header in the server response. Defaults to false. + +--- + +##### `deprecationWarning`Optional + +```typescript +public readonly deprecationWarning: string; +``` + +- *Type:* string + +deprecationWarning overrides the default warning returned to API clients. + +May only be set when `deprecated` is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists. + +--- + +##### `schema`Optional + +```typescript +public readonly schema: CustomResourceValidationV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceValidationV1Beta1 + +schema describes the schema used for validation and pruning of this version of the custom resource. + +Top-level and per-version schemas are mutually exclusive. Per-version schemas must not all be set to identical values (top-level validation schema should be used instead). + +--- + +##### `subresources`Optional + +```typescript +public readonly subresources: CustomResourceSubresourcesV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceSubresourcesV1Beta1 + +subresources specify what subresources this version of the defined custom resource have. + +Top-level and per-version subresources are mutually exclusive. Per-version subresources must not all be set to identical values (top-level subresources should be used instead). + +--- + +### CustomResourceSubresources + +CustomResourceSubresources defines the status and scale subresources for CustomResources. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceSubresources: k8s.CustomResourceSubresources = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scale | @smallcase/cdk8s-botkube.k8s.CustomResourceSubresourceScale | scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object. | +| status | any | status indicates the custom resource should serve a `/status` subresource. | + +--- + +##### `scale`Optional + +```typescript +public readonly scale: CustomResourceSubresourceScale; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceSubresourceScale + +scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object. + +--- + +##### `status`Optional + +```typescript +public readonly status: any; +``` + +- *Type:* any + +status indicates the custom resource should serve a `/status` subresource. + +When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object. + +--- + +### CustomResourceSubresourceScale + +CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceSubresourceScale: k8s.CustomResourceSubresourceScale = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| specReplicasPath | string | specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET. | +| statusReplicasPath | string | statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0. | +| labelSelectorPath | string | labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string. | + +--- + +##### `specReplicasPath`Required + +```typescript +public readonly specReplicasPath: string; +``` + +- *Type:* string + +specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET. + +--- + +##### `statusReplicasPath`Required + +```typescript +public readonly statusReplicasPath: string; +``` + +- *Type:* string + +statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0. + +--- + +##### `labelSelectorPath`Optional + +```typescript +public readonly labelSelectorPath: string; +``` + +- *Type:* string + +labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string. + +--- + +### CustomResourceSubresourceScaleV1Beta1 + +CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceSubresourceScaleV1Beta1: k8s.CustomResourceSubresourceScaleV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| specReplicasPath | string | specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET. | +| statusReplicasPath | string | statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0. | +| labelSelectorPath | string | labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string. | + +--- + +##### `specReplicasPath`Required + +```typescript +public readonly specReplicasPath: string; +``` + +- *Type:* string + +specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET. + +--- + +##### `statusReplicasPath`Required + +```typescript +public readonly statusReplicasPath: string; +``` + +- *Type:* string + +statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0. + +--- + +##### `labelSelectorPath`Optional + +```typescript +public readonly labelSelectorPath: string; +``` + +- *Type:* string + +labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string. + +--- + +### CustomResourceSubresourcesV1Beta1 + +CustomResourceSubresources defines the status and scale subresources for CustomResources. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceSubresourcesV1Beta1: k8s.CustomResourceSubresourcesV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scale | @smallcase/cdk8s-botkube.k8s.CustomResourceSubresourceScaleV1Beta1 | scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object. | +| status | any | status indicates the custom resource should serve a `/status` subresource. | + +--- + +##### `scale`Optional + +```typescript +public readonly scale: CustomResourceSubresourceScaleV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceSubresourceScaleV1Beta1 + +scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object. + +--- + +##### `status`Optional + +```typescript +public readonly status: any; +``` + +- *Type:* any + +status indicates the custom resource should serve a `/status` subresource. + +When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object. + +--- + +### CustomResourceValidation + +CustomResourceValidation is a list of validation methods for CustomResources. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceValidation: k8s.CustomResourceValidation = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| openApiv3Schema | @smallcase/cdk8s-botkube.k8s.JsonSchemaProps | openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning. | + +--- + +##### `openApiv3Schema`Optional + +```typescript +public readonly openApiv3Schema: JsonSchemaProps; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JsonSchemaProps + +openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning. + +--- + +### CustomResourceValidationV1Beta1 + +CustomResourceValidation is a list of validation methods for CustomResources. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const customResourceValidationV1Beta1: k8s.CustomResourceValidationV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| openApiv3Schema | @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1 | openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning. | + +--- + +##### `openApiv3Schema`Optional + +```typescript +public readonly openApiv3Schema: JsonSchemaPropsV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1 + +openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning. + +--- + +### DaemonSetSpec + +DaemonSetSpec is the specification of a daemon set. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const daemonSetSpec: k8s.DaemonSetSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| selector | @smallcase/cdk8s-botkube.k8s.LabelSelector | A label query over pods that are managed by the daemon set. | +| template | @smallcase/cdk8s-botkube.k8s.PodTemplateSpec | An object that describes the pod that will be created. | +| minReadySeconds | number | The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. | +| revisionHistoryLimit | number | The number of old history to retain to allow rollback. | +| updateStrategy | @smallcase/cdk8s-botkube.k8s.DaemonSetUpdateStrategy | An update strategy to replace existing DaemonSet pods with new pods. | + +--- + +##### `selector`Required + +```typescript +public readonly selector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +A label query over pods that are managed by the daemon set. + +Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + +--- + +##### `template`Required + +```typescript +public readonly template: PodTemplateSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodTemplateSpec + +An object that describes the pod that will be created. + +The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template + +--- + +##### `minReadySeconds`Optional + +```typescript +public readonly minReadySeconds: number; +``` + +- *Type:* number +- *Default:* 0 (pod will be considered available as soon as it is ready). + +The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. + +Defaults to 0 (pod will be considered available as soon as it is ready). + +--- + +##### `revisionHistoryLimit`Optional + +```typescript +public readonly revisionHistoryLimit: number; +``` + +- *Type:* number +- *Default:* 10. + +The number of old history to retain to allow rollback. + +This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. + +--- + +##### `updateStrategy`Optional + +```typescript +public readonly updateStrategy: DaemonSetUpdateStrategy; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.DaemonSetUpdateStrategy + +An update strategy to replace existing DaemonSet pods with new pods. + +--- + +### DaemonSetUpdateStrategy + +DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const daemonSetUpdateStrategy: k8s.DaemonSetUpdateStrategy = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| rollingUpdate | @smallcase/cdk8s-botkube.k8s.RollingUpdateDaemonSet | Rolling update config params. | +| type | string | Type of daemon set update. | + +--- + +##### `rollingUpdate`Optional + +```typescript +public readonly rollingUpdate: RollingUpdateDaemonSet; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RollingUpdateDaemonSet + +Rolling update config params. + +Present only if type = "RollingUpdate". + +--- + +##### `type`Optional + +```typescript +public readonly type: string; +``` + +- *Type:* string +- *Default:* RollingUpdate. + +Type of daemon set update. + +Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate. + +--- + +### DeleteOptions + +DeleteOptions may be provided when deleting an API object. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const deleteOptions: k8s.DeleteOptions = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiVersion | string | APIVersion defines the versioned schema of this representation of an object. | +| dryRun | string[] | When present, indicates that modifications should not be persisted. | +| gracePeriodSeconds | number | The duration in seconds before the object should be deleted. | +| kind | @smallcase/cdk8s-botkube.k8s.IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind | Kind is a string value representing the REST resource this object represents. | +| orphanDependents | boolean | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | +| preconditions | @smallcase/cdk8s-botkube.k8s.Preconditions | Must be fulfilled before a deletion is carried out. | +| propagationPolicy | string | Whether and how garbage collection will be performed. | + +--- + +##### `apiVersion`Optional + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +APIVersion defines the versioned schema of this representation of an object. + +Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + +--- + +##### `dryRun`Optional + +```typescript +public readonly dryRun: string[]; +``` + +- *Type:* string[] + +When present, indicates that modifications should not be persisted. + +An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed + +--- + +##### `gracePeriodSeconds`Optional + +```typescript +public readonly gracePeriodSeconds: number; +``` + +- *Type:* number +- *Default:* a per object value if not specified. zero means delete immediately. + +The duration in seconds before the object should be deleted. + +Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. + +--- + +##### `kind`Optional + +```typescript +public readonly kind: IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind + +Kind is a string value representing the REST resource this object represents. + +Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +##### `orphanDependents`Optional + +```typescript +public readonly orphanDependents: boolean; +``` + +- *Type:* boolean + +Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. + +--- + +##### `preconditions`Optional + +```typescript +public readonly preconditions: Preconditions; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Preconditions + +Must be fulfilled before a deletion is carried out. + +If not possible, a 409 Conflict status will be returned. + +--- + +##### `propagationPolicy`Optional + +```typescript +public readonly propagationPolicy: string; +``` + +- *Type:* string + +Whether and how garbage collection will be performed. + +Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. + +--- + +### DeploymentSpec + +DeploymentSpec is the specification of the desired behavior of the Deployment. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const deploymentSpec: k8s.DeploymentSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| selector | @smallcase/cdk8s-botkube.k8s.LabelSelector | Label selector for pods. | +| template | @smallcase/cdk8s-botkube.k8s.PodTemplateSpec | Template describes the pods that will be created. | +| minReadySeconds | number | 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. | +| paused | boolean | Indicates that the deployment is paused. | +| progressDeadlineSeconds | number | The maximum time in seconds for a deployment to make progress before it is considered to be failed. | +| replicas | number | Number of desired pods. | +| revisionHistoryLimit | number | The number of old ReplicaSets to retain to allow rollback. | +| strategy | @smallcase/cdk8s-botkube.k8s.DeploymentStrategy | The deployment strategy to use to replace existing pods with new ones. | + +--- + +##### `selector`Required + +```typescript +public readonly selector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +Label selector for pods. + +Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. + +--- + +##### `template`Required + +```typescript +public readonly template: PodTemplateSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodTemplateSpec + +Template describes the pods that will be created. + +--- + +##### `minReadySeconds`Optional + +```typescript +public readonly minReadySeconds: number; +``` + +- *Type:* number +- *Default:* 0 (pod will be considered available as soon as it is ready) + +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. + +Defaults to 0 (pod will be considered available as soon as it is ready) + +--- + +##### `paused`Optional + +```typescript +public readonly paused: boolean; +``` + +- *Type:* boolean + +Indicates that the deployment is paused. + +--- + +##### `progressDeadlineSeconds`Optional + +```typescript +public readonly progressDeadlineSeconds: number; +``` + +- *Type:* number +- *Default:* 600s. + +The maximum time in seconds for a deployment to make progress before it is considered to be failed. + +The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s. + +--- + +##### `replicas`Optional + +```typescript +public readonly replicas: number; +``` + +- *Type:* number +- *Default:* 1. + +Number of desired pods. + +This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. + +--- + +##### `revisionHistoryLimit`Optional + +```typescript +public readonly revisionHistoryLimit: number; +``` + +- *Type:* number +- *Default:* 10. + +The number of old ReplicaSets to retain to allow rollback. + +This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. + +--- + +##### `strategy`Optional + +```typescript +public readonly strategy: DeploymentStrategy; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.DeploymentStrategy + +The deployment strategy to use to replace existing pods with new ones. + +--- + +### DeploymentStrategy + +DeploymentStrategy describes how to replace existing pods with new ones. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const deploymentStrategy: k8s.DeploymentStrategy = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| rollingUpdate | @smallcase/cdk8s-botkube.k8s.RollingUpdateDeployment | Rolling update config params. | +| type | string | Type of deployment. | + +--- + +##### `rollingUpdate`Optional + +```typescript +public readonly rollingUpdate: RollingUpdateDeployment; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RollingUpdateDeployment + +Rolling update config params. + +Present only if DeploymentStrategyType = RollingUpdate. + +--- + +##### `type`Optional + +```typescript +public readonly type: string; +``` + +- *Type:* string +- *Default:* RollingUpdate. + +Type of deployment. + +Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. + +--- + +### DownwardApiProjection + +Represents downward API info for projecting into a projected volume. + +Note that this is identical to a downwardAPI volume source without the default mode. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const downwardApiProjection: k8s.DownwardApiProjection = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.DownwardApiVolumeFile[] | Items is a list of DownwardAPIVolume file. | + +--- + +##### `items`Optional + +```typescript +public readonly items: DownwardApiVolumeFile[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.DownwardApiVolumeFile[] + +Items is a list of DownwardAPIVolume file. + +--- + +### DownwardApiVolumeFile + +DownwardAPIVolumeFile represents information to create the file containing the pod field. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const downwardApiVolumeFile: k8s.DownwardApiVolumeFile = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| path | string | Required: Path is the relative path name of the file to be created. | +| fieldRef | @smallcase/cdk8s-botkube.k8s.ObjectFieldSelector | Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. | +| mode | number | Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. | +| resourceFieldRef | @smallcase/cdk8s-botkube.k8s.ResourceFieldSelector | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. | + +--- + +##### `path`Required + +```typescript +public readonly path: string; +``` + +- *Type:* string + +Required: Path is the relative path name of the file to be created. + +Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + +--- + +##### `fieldRef`Optional + +```typescript +public readonly fieldRef: ObjectFieldSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectFieldSelector + +Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. + +--- + +##### `mode`Optional + +```typescript +public readonly mode: number; +``` + +- *Type:* number + +Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. + +YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +--- + +##### `resourceFieldRef`Optional + +```typescript +public readonly resourceFieldRef: ResourceFieldSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ResourceFieldSelector + +Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + +--- + +### DownwardApiVolumeSource + +DownwardAPIVolumeSource represents a volume containing downward API info. + +Downward API volumes support ownership management and SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const downwardApiVolumeSource: k8s.DownwardApiVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| defaultMode | number | Optional: mode bits to use on created files by default. | +| items | @smallcase/cdk8s-botkube.k8s.DownwardApiVolumeFile[] | Items is a list of downward API volume file. | + +--- + +##### `defaultMode`Optional + +```typescript +public readonly defaultMode: number; +``` + +- *Type:* number +- *Default:* 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +Optional: mode bits to use on created files by default. + +Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +--- + +##### `items`Optional + +```typescript +public readonly items: DownwardApiVolumeFile[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.DownwardApiVolumeFile[] + +Items is a list of downward API volume file. + +--- + +### EmptyDirVolumeSource + +Represents an empty directory for a pod. + +Empty directory volumes support ownership management and SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const emptyDirVolumeSource: k8s.EmptyDirVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| medium | string | What type of storage medium should back this directory. | +| sizeLimit | @smallcase/cdk8s-botkube.k8s.Quantity | Total amount of local storage required for this EmptyDir volume. | + +--- + +##### `medium`Optional + +```typescript +public readonly medium: string; +``` + +- *Type:* string + +What type of storage medium should back this directory. + +The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + +--- + +##### `sizeLimit`Optional + +```typescript +public readonly sizeLimit: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +Total amount of local storage required for this EmptyDir volume. + +The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir + +--- + +### Endpoint + +Endpoint represents a single logical "backend" implementing a service. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const endpoint: k8s.Endpoint = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| addresses | string[] | addresses of this endpoint. | +| conditions | @smallcase/cdk8s-botkube.k8s.EndpointConditions | conditions contains information about the current status of the endpoint. | +| deprecatedTopology | {[ key: string ]: string} | deprecatedTopology contains topology information part of the v1beta1 API. | +| hints | @smallcase/cdk8s-botkube.k8s.EndpointHints | hints contains information associated with how an endpoint should be consumed. | +| hostname | string | hostname of this endpoint. | +| nodeName | string | nodeName represents the name of the Node hosting this endpoint. | +| targetRef | @smallcase/cdk8s-botkube.k8s.ObjectReference | targetRef is a reference to a Kubernetes object that represents this endpoint. | +| zone | string | zone is the name of the Zone this endpoint exists in. | + +--- + +##### `addresses`Required + +```typescript +public readonly addresses: string[]; +``` + +- *Type:* string[] + +addresses of this endpoint. + +The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100. + +--- + +##### `conditions`Optional + +```typescript +public readonly conditions: EndpointConditions; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EndpointConditions + +conditions contains information about the current status of the endpoint. + +--- + +##### `deprecatedTopology`Optional + +```typescript +public readonly deprecatedTopology: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +deprecatedTopology contains topology information part of the v1beta1 API. + +This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24). While this field can hold values, it is not writable through the v1 API, and any attempts to write to it will be silently ignored. Topology information can be found in the zone and nodeName fields instead. + +--- + +##### `hints`Optional + +```typescript +public readonly hints: EndpointHints; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EndpointHints + +hints contains information associated with how an endpoint should be consumed. + +--- + +##### `hostname`Optional + +```typescript +public readonly hostname: string; +``` + +- *Type:* string + +hostname of this endpoint. + +This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation. + +--- + +##### `nodeName`Optional + +```typescript +public readonly nodeName: string; +``` + +- *Type:* string + +nodeName represents the name of the Node hosting this endpoint. + +This can be used to determine endpoints local to a Node. This field can be enabled with the EndpointSliceNodeName feature gate. + +--- + +##### `targetRef`Optional + +```typescript +public readonly targetRef: ObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectReference + +targetRef is a reference to a Kubernetes object that represents this endpoint. + +--- + +##### `zone`Optional + +```typescript +public readonly zone: string; +``` + +- *Type:* string + +zone is the name of the Zone this endpoint exists in. + +--- + +### EndpointAddress + +EndpointAddress is a tuple that describes single IP address. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const endpointAddress: k8s.EndpointAddress = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ip | string | The IP of this endpoint. | +| hostname | string | The Hostname of this endpoint. | +| nodeName | string | Optional: Node hosting this endpoint. | +| targetRef | @smallcase/cdk8s-botkube.k8s.ObjectReference | Reference to object providing the endpoint. | + +--- + +##### `ip`Required + +```typescript +public readonly ip: string; +``` + +- *Type:* string + +The IP of this endpoint. + +May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready. + +--- + +##### `hostname`Optional + +```typescript +public readonly hostname: string; +``` + +- *Type:* string + +The Hostname of this endpoint. + +--- + +##### `nodeName`Optional + +```typescript +public readonly nodeName: string; +``` + +- *Type:* string + +Optional: Node hosting this endpoint. + +This can be used to determine endpoints local to a node. + +--- + +##### `targetRef`Optional + +```typescript +public readonly targetRef: ObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectReference + +Reference to object providing the endpoint. + +--- + +### EndpointConditions + +EndpointConditions represents the current condition of an endpoint. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const endpointConditions: k8s.EndpointConditions = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ready | boolean | ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. | +| serving | boolean | serving is identical to ready except that it is set regardless of the terminating state of endpoints. | +| terminating | boolean | terminating indicates that this endpoint is terminating. | + +--- + +##### `ready`Optional + +```typescript +public readonly ready: boolean; +``` + +- *Type:* boolean + +ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. + +A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be "true" for terminating endpoints. + +--- + +##### `serving`Optional + +```typescript +public readonly serving: boolean; +``` + +- *Type:* boolean + +serving is identical to ready except that it is set regardless of the terminating state of endpoints. + +This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition. This field can be enabled with the EndpointSliceTerminatingCondition feature gate. + +--- + +##### `terminating`Optional + +```typescript +public readonly terminating: boolean; +``` + +- *Type:* boolean + +terminating indicates that this endpoint is terminating. + +A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating. This field can be enabled with the EndpointSliceTerminatingCondition feature gate. + +--- + +### EndpointConditionsV1Beta1 + +EndpointConditions represents the current condition of an endpoint. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const endpointConditionsV1Beta1: k8s.EndpointConditionsV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ready | boolean | ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. | +| serving | boolean | serving is identical to ready except that it is set regardless of the terminating state of endpoints. | +| terminating | boolean | terminating indicates that this endpoint is terminating. | + +--- + +##### `ready`Optional + +```typescript +public readonly ready: boolean; +``` + +- *Type:* boolean + +ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. + +A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be "true" for terminating endpoints. + +--- + +##### `serving`Optional + +```typescript +public readonly serving: boolean; +``` + +- *Type:* boolean + +serving is identical to ready except that it is set regardless of the terminating state of endpoints. + +This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition. This field can be enabled with the EndpointSliceTerminatingCondition feature gate. + +--- + +##### `terminating`Optional + +```typescript +public readonly terminating: boolean; +``` + +- *Type:* boolean + +terminating indicates that this endpoint is terminating. + +A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating. This field can be enabled with the EndpointSliceTerminatingCondition feature gate. + +--- + +### EndpointHints + +EndpointHints provides hints describing how an endpoint should be consumed. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const endpointHints: k8s.EndpointHints = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| forZones | @smallcase/cdk8s-botkube.k8s.ForZone[] | forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing. | + +--- + +##### `forZones`Optional + +```typescript +public readonly forZones: ForZone[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ForZone[] + +forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing. + +--- + +### EndpointHintsV1Beta1 + +EndpointHints provides hints describing how an endpoint should be consumed. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const endpointHintsV1Beta1: k8s.EndpointHintsV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| forZones | @smallcase/cdk8s-botkube.k8s.ForZoneV1Beta1[] | forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing. | + +--- + +##### `forZones`Optional + +```typescript +public readonly forZones: ForZoneV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ForZoneV1Beta1[] + +forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing. + +May contain a maximum of 8 entries. + +--- + +### EndpointPort + +EndpointPort is a tuple that describes a single port. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const endpointPort: k8s.EndpointPort = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| port | number | The port number of the endpoint. | +| appProtocol | string | The application protocol for this port. | +| name | string | The name of this port. | +| protocol | string | The IP protocol for this port. | + +--- + +##### `port`Required + +```typescript +public readonly port: number; +``` + +- *Type:* number + +The port number of the endpoint. + +--- + +##### `appProtocol`Optional + +```typescript +public readonly appProtocol: string; +``` + +- *Type:* string + +The application protocol for this port. + +This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default. + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of this port. + +This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined. + +--- + +##### `protocol`Optional + +```typescript +public readonly protocol: string; +``` + +- *Type:* string +- *Default:* TCP. + +The IP protocol for this port. + +Must be UDP, TCP, or SCTP. Default is TCP. + +--- + +### EndpointPortV1Beta1 + +EndpointPort represents a Port used by an EndpointSlice. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const endpointPortV1Beta1: k8s.EndpointPortV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| appProtocol | string | The application protocol for this port. | +| name | string | The name of this port. | +| port | number | The port number of the endpoint. | +| protocol | string | The IP protocol for this port. | + +--- + +##### `appProtocol`Optional + +```typescript +public readonly appProtocol: string; +``` + +- *Type:* string + +The application protocol for this port. + +This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string +- *Default:* empty string. + +The name of this port. + +All ports in an EndpointSlice must have a unique name. If the EndpointSlice is dervied from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string. + +--- + +##### `port`Optional + +```typescript +public readonly port: number; +``` + +- *Type:* number + +The port number of the endpoint. + +If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer. + +--- + +##### `protocol`Optional + +```typescript +public readonly protocol: string; +``` + +- *Type:* string +- *Default:* TCP. + +The IP protocol for this port. + +Must be UDP, TCP, or SCTP. Default is TCP. + +--- + +### EndpointSubset + +EndpointSubset is a group of addresses with a common set of ports. + +The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: +{ +Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], +Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] +} +The resulting set of endpoints can be viewed as: +a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], +b: [ 10.10.1.1:309, 10.10.2.2:309 ] + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const endpointSubset: k8s.EndpointSubset = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| addresses | @smallcase/cdk8s-botkube.k8s.EndpointAddress[] | IP addresses which offer the related ports that are marked as ready. | +| notReadyAddresses | @smallcase/cdk8s-botkube.k8s.EndpointAddress[] | IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. | +| ports | @smallcase/cdk8s-botkube.k8s.EndpointPort[] | Port numbers available on the related IP addresses. | + +--- + +##### `addresses`Optional + +```typescript +public readonly addresses: EndpointAddress[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EndpointAddress[] + +IP addresses which offer the related ports that are marked as ready. + +These endpoints should be considered safe for load balancers and clients to utilize. + +--- + +##### `notReadyAddresses`Optional + +```typescript +public readonly notReadyAddresses: EndpointAddress[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EndpointAddress[] + +IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. + +--- + +##### `ports`Optional + +```typescript +public readonly ports: EndpointPort[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EndpointPort[] + +Port numbers available on the related IP addresses. + +--- + +### EndpointV1Beta1 + +Endpoint represents a single logical "backend" implementing a service. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const endpointV1Beta1: k8s.EndpointV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| addresses | string[] | addresses of this endpoint. | +| conditions | @smallcase/cdk8s-botkube.k8s.EndpointConditionsV1Beta1 | conditions contains information about the current status of the endpoint. | +| hints | @smallcase/cdk8s-botkube.k8s.EndpointHintsV1Beta1 | hints contains information associated with how an endpoint should be consumed. | +| hostname | string | hostname of this endpoint. | +| nodeName | string | nodeName represents the name of the Node hosting this endpoint. | +| targetRef | @smallcase/cdk8s-botkube.k8s.ObjectReference | targetRef is a reference to a Kubernetes object that represents this endpoint. | +| topology | {[ key: string ]: string} | topology contains arbitrary topology information associated with the endpoint. | + +--- + +##### `addresses`Required + +```typescript +public readonly addresses: string[]; +``` + +- *Type:* string[] + +addresses of this endpoint. + +The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100. + +--- + +##### `conditions`Optional + +```typescript +public readonly conditions: EndpointConditionsV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EndpointConditionsV1Beta1 + +conditions contains information about the current status of the endpoint. + +--- + +##### `hints`Optional + +```typescript +public readonly hints: EndpointHintsV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EndpointHintsV1Beta1 + +hints contains information associated with how an endpoint should be consumed. + +--- + +##### `hostname`Optional + +```typescript +public readonly hostname: string; +``` + +- *Type:* string + +hostname of this endpoint. + +This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation. + +--- + +##### `nodeName`Optional + +```typescript +public readonly nodeName: string; +``` + +- *Type:* string + +nodeName represents the name of the Node hosting this endpoint. + +This can be used to determine endpoints local to a Node. This field can be enabled with the EndpointSliceNodeName feature gate. + +--- + +##### `targetRef`Optional + +```typescript +public readonly targetRef: ObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectReference + +targetRef is a reference to a Kubernetes object that represents this endpoint. + +--- + +##### `topology`Optional + +```typescript +public readonly topology: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +topology contains arbitrary topology information associated with the endpoint. + +These key/value pairs must conform with the label format. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Topology may include a maximum of 16 key/value pairs. This includes, but is not limited to the following well known keys: * kubernetes.io/hostname: the value indicates the hostname of the node +where the endpoint is located. This should match the corresponding +node label. +* topology.kubernetes.io/zone: the value indicates the zone where the +endpoint is located. This should match the corresponding node label. +* topology.kubernetes.io/region: the value indicates the region where the +endpoint is located. This should match the corresponding node label. +This field is deprecated and will be removed in future api versions. + +--- + +### EnvFromSource + +EnvFromSource represents the source of a set of ConfigMaps. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const envFromSource: k8s.EnvFromSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| configMapRef | @smallcase/cdk8s-botkube.k8s.ConfigMapEnvSource | The ConfigMap to select from. | +| prefix | string | An optional identifier to prepend to each key in the ConfigMap. | +| secretRef | @smallcase/cdk8s-botkube.k8s.SecretEnvSource | The Secret to select from. | + +--- + +##### `configMapRef`Optional + +```typescript +public readonly configMapRef: ConfigMapEnvSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ConfigMapEnvSource + +The ConfigMap to select from. + +--- + +##### `prefix`Optional + +```typescript +public readonly prefix: string; +``` + +- *Type:* string + +An optional identifier to prepend to each key in the ConfigMap. + +Must be a C_IDENTIFIER. + +--- + +##### `secretRef`Optional + +```typescript +public readonly secretRef: SecretEnvSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecretEnvSource + +The Secret to select from. + +--- + +### EnvVar + +EnvVar represents an environment variable present in a Container. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const envVar: k8s.EnvVar = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | Name of the environment variable. | +| value | string | Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. | +| valueFrom | @smallcase/cdk8s-botkube.k8s.EnvVarSource | Source for the environment variable's value. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the environment variable. + +Must be a C_IDENTIFIER. + +--- + +##### `value`Optional + +```typescript +public readonly value: string; +``` + +- *Type:* string +- *Default:* . + +Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. + +If 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). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". + +--- + +##### `valueFrom`Optional + +```typescript +public readonly valueFrom: EnvVarSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EnvVarSource + +Source for the environment variable's value. + +Cannot be used if value is not empty. + +--- + +### EnvVarSource + +EnvVarSource represents a source for the value of an EnvVar. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const envVarSource: k8s.EnvVarSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| configMapKeyRef | @smallcase/cdk8s-botkube.k8s.ConfigMapKeySelector | Selects a key of a ConfigMap. | +| fieldRef | @smallcase/cdk8s-botkube.k8s.ObjectFieldSelector | Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. | +| resourceFieldRef | @smallcase/cdk8s-botkube.k8s.ResourceFieldSelector | Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. | +| secretKeyRef | @smallcase/cdk8s-botkube.k8s.SecretKeySelector | Selects a key of a secret in the pod's namespace. | + +--- + +##### `configMapKeyRef`Optional + +```typescript +public readonly configMapKeyRef: ConfigMapKeySelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ConfigMapKeySelector + +Selects a key of a ConfigMap. + +--- + +##### `fieldRef`Optional + +```typescript +public readonly fieldRef: ObjectFieldSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectFieldSelector + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + +--- + +##### `resourceFieldRef`Optional + +```typescript +public readonly resourceFieldRef: ResourceFieldSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ResourceFieldSelector + +Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. + +--- + +##### `secretKeyRef`Optional + +```typescript +public readonly secretKeyRef: SecretKeySelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecretKeySelector + +Selects a key of a secret in the pod's namespace. + +--- + +### EphemeralContainer + +An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. + +Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ephemeralContainer: k8s.EphemeralContainer = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | Name of the ephemeral container specified as a DNS_LABEL. | +| args | string[] | Arguments to the entrypoint. | +| command | string[] | Entrypoint array. | +| env | @smallcase/cdk8s-botkube.k8s.EnvVar[] | List of environment variables to set in the container. | +| envFrom | @smallcase/cdk8s-botkube.k8s.EnvFromSource[] | List of sources to populate environment variables in the container. | +| image | string | Docker image name. | +| imagePullPolicy | string | Image pull policy. | +| lifecycle | @smallcase/cdk8s-botkube.k8s.Lifecycle | Lifecycle is not allowed for ephemeral containers. | +| livenessProbe | @smallcase/cdk8s-botkube.k8s.Probe | Probes are not allowed for ephemeral containers. | +| ports | @smallcase/cdk8s-botkube.k8s.ContainerPort[] | Ports are not allowed for ephemeral containers. | +| readinessProbe | @smallcase/cdk8s-botkube.k8s.Probe | Probes are not allowed for ephemeral containers. | +| resources | @smallcase/cdk8s-botkube.k8s.ResourceRequirements | Resources are not allowed for ephemeral containers. | +| securityContext | @smallcase/cdk8s-botkube.k8s.SecurityContext | SecurityContext is not allowed for ephemeral containers. | +| startupProbe | @smallcase/cdk8s-botkube.k8s.Probe | Probes are not allowed for ephemeral containers. | +| stdin | boolean | Whether this container should allocate a buffer for stdin in the container runtime. | +| stdinOnce | boolean | Whether the container runtime should close the stdin channel after it has been opened by a single attach. | +| targetContainerName | string | If set, the name of the container from PodSpec that this ephemeral container targets. | +| terminationMessagePath | string | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. | +| terminationMessagePolicy | string | Indicate how the termination message should be populated. | +| tty | boolean | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. | +| volumeDevices | @smallcase/cdk8s-botkube.k8s.VolumeDevice[] | volumeDevices is the list of block devices to be used by the container. | +| volumeMounts | @smallcase/cdk8s-botkube.k8s.VolumeMount[] | Pod volumes to mount into the container's filesystem. | +| workingDir | string | Container's working directory. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the ephemeral container specified as a DNS_LABEL. + +This name must be unique among all containers, init containers and ephemeral containers. + +--- + +##### `args`Optional + +```typescript +public readonly args: string[]; +``` + +- *Type:* string[] + +Arguments to the entrypoint. + +The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If 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). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +--- + +##### `command`Optional + +```typescript +public readonly command: string[]; +``` + +- *Type:* string[] + +Entrypoint array. + +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. If 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). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + +--- + +##### `env`Optional + +```typescript +public readonly env: EnvVar[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EnvVar[] + +List of environment variables to set in the container. + +Cannot be updated. + +--- + +##### `envFrom`Optional + +```typescript +public readonly envFrom: EnvFromSource[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EnvFromSource[] + +List of sources to populate environment variables in the container. + +The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + +--- + +##### `image`Optional + +```typescript +public readonly image: string; +``` + +- *Type:* string + +Docker image name. + +More info: https://kubernetes.io/docs/concepts/containers/images + +--- + +##### `imagePullPolicy`Optional + +```typescript +public readonly imagePullPolicy: string; +``` + +- *Type:* string +- *Default:* Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + +Image pull policy. + +One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + +--- + +##### `lifecycle`Optional + +```typescript +public readonly lifecycle: Lifecycle; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Lifecycle + +Lifecycle is not allowed for ephemeral containers. + +--- + +##### `livenessProbe`Optional + +```typescript +public readonly livenessProbe: Probe; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Probe + +Probes are not allowed for ephemeral containers. + +--- + +##### `ports`Optional + +```typescript +public readonly ports: ContainerPort[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ContainerPort[] + +Ports are not allowed for ephemeral containers. + +--- + +##### `readinessProbe`Optional + +```typescript +public readonly readinessProbe: Probe; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Probe + +Probes are not allowed for ephemeral containers. + +--- + +##### `resources`Optional + +```typescript +public readonly resources: ResourceRequirements; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ResourceRequirements + +Resources are not allowed for ephemeral containers. + +Ephemeral containers use spare resources already allocated to the pod. + +--- + +##### `securityContext`Optional + +```typescript +public readonly securityContext: SecurityContext; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecurityContext + +SecurityContext is not allowed for ephemeral containers. + +--- + +##### `startupProbe`Optional + +```typescript +public readonly startupProbe: Probe; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Probe + +Probes are not allowed for ephemeral containers. + +--- + +##### `stdin`Optional + +```typescript +public readonly stdin: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +Whether this container should allocate a buffer for stdin in the container runtime. + +If this is not set, reads from stdin in the container will always result in EOF. Default is false. + +--- + +##### `stdinOnce`Optional + +```typescript +public readonly stdinOnce: boolean; +``` + +- *Type:* boolean +- *Default:* false + +Whether the container runtime should close the stdin channel after it has been opened by a single attach. + +When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + +--- + +##### `targetContainerName`Optional + +```typescript +public readonly targetContainerName: string; +``` + +- *Type:* string + +If set, the name of the container from PodSpec that this ephemeral container targets. + +The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature. + +--- + +##### `terminationMessagePath`Optional + +```typescript +public readonly terminationMessagePath: string; +``` + +- *Type:* string +- *Default:* dev/termination-log. Cannot be updated. + +Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. + +Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + +--- + +##### `terminationMessagePolicy`Optional + +```typescript +public readonly terminationMessagePolicy: string; +``` + +- *Type:* string +- *Default:* File. Cannot be updated. + +Indicate how the termination message should be populated. + +File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + +--- + +##### `tty`Optional + +```typescript +public readonly tty: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. + +Default is false. + +--- + +##### `volumeDevices`Optional + +```typescript +public readonly volumeDevices: VolumeDevice[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VolumeDevice[] + +volumeDevices is the list of block devices to be used by the container. + +--- + +##### `volumeMounts`Optional + +```typescript +public readonly volumeMounts: VolumeMount[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VolumeMount[] + +Pod volumes to mount into the container's filesystem. + +Cannot be updated. + +--- + +##### `workingDir`Optional + +```typescript +public readonly workingDir: string; +``` + +- *Type:* string + +Container's working directory. + +If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + +--- + +### EphemeralVolumeSource + +Represents an ephemeral volume that is handled by a normal storage driver. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ephemeralVolumeSource: k8s.EphemeralVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| volumeClaimTemplate | @smallcase/cdk8s-botkube.k8s.PersistentVolumeClaimTemplate | Will be used to create a stand-alone PVC to provision the volume. | + +--- + +##### `volumeClaimTemplate`Optional + +```typescript +public readonly volumeClaimTemplate: PersistentVolumeClaimTemplate; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PersistentVolumeClaimTemplate + +Will be used to create a stand-alone PVC to provision the volume. + +The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). + +An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. + +This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. + +Required, must not be nil. + +--- + +### EventSeries + +EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. How often to update the EventSeries is up to the event reporters. The default event reporter in "k8s.io/client-go/tools/events/event_broadcaster.go" shows how this struct is updated on heartbeats and can guide customized reporter implementations. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const eventSeries: k8s.EventSeries = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| count | number | count is the number of occurrences in this series up to the last heartbeat time. | +| lastObservedTime | Date | lastObservedTime is the time when last Event from the series was seen before last heartbeat. | + +--- + +##### `count`Required + +```typescript +public readonly count: number; +``` + +- *Type:* number + +count is the number of occurrences in this series up to the last heartbeat time. + +--- + +##### `lastObservedTime`Required + +```typescript +public readonly lastObservedTime: Date; +``` + +- *Type:* Date + +lastObservedTime is the time when last Event from the series was seen before last heartbeat. + +--- + +### EventSeriesV1Beta1 + +EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const eventSeriesV1Beta1: k8s.EventSeriesV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| count | number | count is the number of occurrences in this series up to the last heartbeat time. | +| lastObservedTime | Date | lastObservedTime is the time when last Event from the series was seen before last heartbeat. | + +--- + +##### `count`Required + +```typescript +public readonly count: number; +``` + +- *Type:* number + +count is the number of occurrences in this series up to the last heartbeat time. + +--- + +##### `lastObservedTime`Required + +```typescript +public readonly lastObservedTime: Date; +``` + +- *Type:* Date + +lastObservedTime is the time when last Event from the series was seen before last heartbeat. + +--- + +### EventSource + +EventSource contains information for an event. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const eventSource: k8s.EventSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| component | string | Component from which the event is generated. | +| host | string | Node name on which the event is generated. | + +--- + +##### `component`Optional + +```typescript +public readonly component: string; +``` + +- *Type:* string + +Component from which the event is generated. + +--- + +##### `host`Optional + +```typescript +public readonly host: string; +``` + +- *Type:* string + +Node name on which the event is generated. + +--- + +### ExecAction + +ExecAction describes a "run in container" action. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const execAction: k8s.ExecAction = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| command | string[] | Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. | + +--- + +##### `command`Optional + +```typescript +public readonly command: string[]; +``` + +- *Type:* string[] + +Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. + +The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + +--- + +### ExternalDocumentation + +ExternalDocumentation allows referencing an external resource for extended documentation. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const externalDocumentation: k8s.ExternalDocumentation = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| description | string | *No description.* | +| url | string | *No description.* | + +--- + +##### `description`Optional + +```typescript +public readonly description: string; +``` + +- *Type:* string + +--- + +##### `url`Optional + +```typescript +public readonly url: string; +``` + +- *Type:* string + +--- + +### ExternalDocumentationV1Beta1 + +ExternalDocumentation allows referencing an external resource for extended documentation. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const externalDocumentationV1Beta1: k8s.ExternalDocumentationV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| description | string | *No description.* | +| url | string | *No description.* | + +--- + +##### `description`Optional + +```typescript +public readonly description: string; +``` + +- *Type:* string + +--- + +##### `url`Optional + +```typescript +public readonly url: string; +``` + +- *Type:* string + +--- + +### ExternalMetricSourceV2Beta1 + +ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). + +Exactly one "target" type should be set. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const externalMetricSourceV2Beta1: k8s.ExternalMetricSourceV2Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metricName | string | metricName is the name of the metric in question. | +| metricSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | metricSelector is used to identify a specific time series within a given metric. | +| targetAverageValue | @smallcase/cdk8s-botkube.k8s.Quantity | targetAverageValue is the target per-pod value of global metric (as a quantity). | +| targetValue | @smallcase/cdk8s-botkube.k8s.Quantity | targetValue is the target value of the metric (as a quantity). | + +--- + +##### `metricName`Required + +```typescript +public readonly metricName: string; +``` + +- *Type:* string + +metricName is the name of the metric in question. + +--- + +##### `metricSelector`Optional + +```typescript +public readonly metricSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +metricSelector is used to identify a specific time series within a given metric. + +--- + +##### `targetAverageValue`Optional + +```typescript +public readonly targetAverageValue: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +targetAverageValue is the target per-pod value of global metric (as a quantity). + +Mutually exclusive with TargetValue. + +--- + +##### `targetValue`Optional + +```typescript +public readonly targetValue: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +targetValue is the target value of the metric (as a quantity). + +Mutually exclusive with TargetAverageValue. + +--- + +### ExternalMetricSourceV2Beta2 + +ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const externalMetricSourceV2Beta2: k8s.ExternalMetricSourceV2Beta2 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metric | @smallcase/cdk8s-botkube.k8s.MetricIdentifierV2Beta2 | metric identifies the target metric by name and selector. | +| target | @smallcase/cdk8s-botkube.k8s.MetricTargetV2Beta2 | target specifies the target value for the given metric. | + +--- + +##### `metric`Required + +```typescript +public readonly metric: MetricIdentifierV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.MetricIdentifierV2Beta2 + +metric identifies the target metric by name and selector. + +--- + +##### `target`Required + +```typescript +public readonly target: MetricTargetV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.MetricTargetV2Beta2 + +target specifies the target value for the given metric. + +--- + +### FcVolumeSource + +Represents a Fibre Channel volume. + +Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const fcVolumeSource: k8s.FcVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| fsType | string | Filesystem type to mount. | +| lun | number | Optional: FC target lun number. | +| readOnly | boolean | Optional: Defaults to false (read/write). | +| targetWwNs | string[] | Optional: FC target worldwide names (WWNs). | +| wwids | string[] | Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. | + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type to mount. + +Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +--- + +##### `lun`Optional + +```typescript +public readonly lun: number; +``` + +- *Type:* number + +Optional: FC target lun number. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Optional: Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +--- + +##### `targetWwNs`Optional + +```typescript +public readonly targetWwNs: string[]; +``` + +- *Type:* string[] + +Optional: FC target worldwide names (WWNs). + +--- + +##### `wwids`Optional + +```typescript +public readonly wwids: string[]; +``` + +- *Type:* string[] + +Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. + +--- + +### FlexPersistentVolumeSource + +FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const flexPersistentVolumeSource: k8s.FlexPersistentVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| driver | string | Driver is the name of the driver to use for this volume. | +| fsType | string | Filesystem type to mount. | +| options | {[ key: string ]: string} | Optional: Extra command options if any. | +| readOnly | boolean | Optional: Defaults to false (read/write). | +| secretRef | @smallcase/cdk8s-botkube.k8s.SecretReference | Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. | + +--- + +##### `driver`Required + +```typescript +public readonly driver: string; +``` + +- *Type:* string + +Driver is the name of the driver to use for this volume. + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type to mount. + +Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. + +--- + +##### `options`Optional + +```typescript +public readonly options: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +Optional: Extra command options if any. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Optional: Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +--- + +##### `secretRef`Optional + +```typescript +public readonly secretRef: SecretReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecretReference + +Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. + +This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. + +--- + +### FlexVolumeSource + +FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const flexVolumeSource: k8s.FlexVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| driver | string | Driver is the name of the driver to use for this volume. | +| fsType | string | Filesystem type to mount. | +| options | {[ key: string ]: string} | Optional: Extra command options if any. | +| readOnly | boolean | Optional: Defaults to false (read/write). | +| secretRef | @smallcase/cdk8s-botkube.k8s.LocalObjectReference | Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. | + +--- + +##### `driver`Required + +```typescript +public readonly driver: string; +``` + +- *Type:* string + +Driver is the name of the driver to use for this volume. + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type to mount. + +Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. + +--- + +##### `options`Optional + +```typescript +public readonly options: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +Optional: Extra command options if any. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Optional: Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +--- + +##### `secretRef`Optional + +```typescript +public readonly secretRef: LocalObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LocalObjectReference + +Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. + +This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. + +--- + +### FlockerVolumeSource + +Represents a Flocker volume mounted by the Flocker agent. + +One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const flockerVolumeSource: k8s.FlockerVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| datasetName | string | Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated. | +| datasetUuid | string | UUID of the dataset. | + +--- + +##### `datasetName`Optional + +```typescript +public readonly datasetName: string; +``` + +- *Type:* string + +Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated. + +--- + +##### `datasetUuid`Optional + +```typescript +public readonly datasetUuid: string; +``` + +- *Type:* string + +UUID of the dataset. + +This is unique identifier of a Flocker dataset + +--- + +### FlowDistinguisherMethodV1Beta1 + +FlowDistinguisherMethod specifies the method of a flow distinguisher. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const flowDistinguisherMethodV1Beta1: k8s.FlowDistinguisherMethodV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| type | string | `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". | + +--- + +##### `type`Required + +```typescript +public readonly type: string; +``` + +- *Type:* string + +`type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". + +Required. + +--- + +### FlowSchemaSpecV1Beta1 + +FlowSchemaSpec describes how the FlowSchema's specification looks like. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const flowSchemaSpecV1Beta1: k8s.FlowSchemaSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| priorityLevelConfiguration | @smallcase/cdk8s-botkube.k8s.PriorityLevelConfigurationReferenceV1Beta1 | `priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. | +| distinguisherMethod | @smallcase/cdk8s-botkube.k8s.FlowDistinguisherMethodV1Beta1 | `distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. | +| matchingPrecedence | number | `matchingPrecedence` is used to choose among the FlowSchemas that match a given request. | +| rules | @smallcase/cdk8s-botkube.k8s.PolicyRulesWithSubjectsV1Beta1[] | `rules` describes which requests will match this flow schema. | + +--- + +##### `priorityLevelConfiguration`Required + +```typescript +public readonly priorityLevelConfiguration: PriorityLevelConfigurationReferenceV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PriorityLevelConfigurationReferenceV1Beta1 + +`priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. + +If the reference cannot be resolved, the FlowSchema will be ignored and marked as invalid in its status. Required. + +--- + +##### `distinguisherMethod`Optional + +```typescript +public readonly distinguisherMethod: FlowDistinguisherMethodV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.FlowDistinguisherMethodV1Beta1 + +`distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. + +`nil` specifies that the distinguisher is disabled and thus will always be the empty string. + +--- + +##### `matchingPrecedence`Optional + +```typescript +public readonly matchingPrecedence: number; +``` + +- *Type:* number + +`matchingPrecedence` is used to choose among the FlowSchemas that match a given request. + +The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be ranged in [1,10000]. Note that if the precedence is not specified, it will be set to 1000 as default. + +--- + +##### `rules`Optional + +```typescript +public readonly rules: PolicyRulesWithSubjectsV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PolicyRulesWithSubjectsV1Beta1[] + +`rules` describes which requests will match this flow schema. + +This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema. + +--- + +### ForZone + +ForZone provides information about which zones should consume this endpoint. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const forZone: k8s.ForZone = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | name represents the name of the zone. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +name represents the name of the zone. + +--- + +### ForZoneV1Beta1 + +ForZone provides information about which zones should consume this endpoint. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const forZoneV1Beta1: k8s.ForZoneV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | name represents the name of the zone. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +name represents the name of the zone. + +--- + +### FsGroupStrategyOptionsV1Beta1 + +FSGroupStrategyOptions defines the strategy type and options used to create the strategy. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const fsGroupStrategyOptionsV1Beta1: k8s.FsGroupStrategyOptionsV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ranges | @smallcase/cdk8s-botkube.k8s.IdRangeV1Beta1[] | ranges are the allowed ranges of fs groups. | +| rule | string | rule is the strategy that will dictate what FSGroup is used in the SecurityContext. | + +--- + +##### `ranges`Optional + +```typescript +public readonly ranges: IdRangeV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IdRangeV1Beta1[] + +ranges are the allowed ranges of fs groups. + +If you would like to force a single fs group then supply a single range with the same start and end. Required for MustRunAs. + +--- + +##### `rule`Optional + +```typescript +public readonly rule: string; +``` + +- *Type:* string + +rule is the strategy that will dictate what FSGroup is used in the SecurityContext. + +--- + +### GcePersistentDiskVolumeSource + +Represents a Persistent Disk resource in Google Compute Engine. + +A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const gcePersistentDiskVolumeSource: k8s.GcePersistentDiskVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| pdName | string | Unique name of the PD resource in GCE. | +| fsType | string | Filesystem type of the volume that you want to mount. | +| partition | number | The partition in the volume that you want to mount. | +| readOnly | boolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. | + +--- + +##### `pdName`Required + +```typescript +public readonly pdName: string; +``` + +- *Type:* string + +Unique name of the PD resource in GCE. + +Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type of the volume that you want to mount. + +Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +--- + +##### `partition`Optional + +```typescript +public readonly partition: number; +``` + +- *Type:* number + +The partition in the volume that you want to mount. + +If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +--- + +### GitRepoVolumeSource + +Represents a volume that is populated with the contents of a git repository. + +Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. + +DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const gitRepoVolumeSource: k8s.GitRepoVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| repository | string | Repository URL. | +| directory | string | Target directory name. | +| revision | string | Commit hash for the specified revision. | + +--- + +##### `repository`Required + +```typescript +public readonly repository: string; +``` + +- *Type:* string + +Repository URL. + +--- + +##### `directory`Optional + +```typescript +public readonly directory: string; +``` + +- *Type:* string + +Target directory name. + +Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. + +--- + +##### `revision`Optional + +```typescript +public readonly revision: string; +``` + +- *Type:* string + +Commit hash for the specified revision. + +--- + +### GlusterfsPersistentVolumeSource + +Represents a Glusterfs mount that lasts the lifetime of a pod. + +Glusterfs volumes do not support ownership management or SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const glusterfsPersistentVolumeSource: k8s.GlusterfsPersistentVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| endpoints | string | EndpointsName is the endpoint name that details Glusterfs topology. | +| path | string | Path is the Glusterfs volume path. | +| endpointsNamespace | string | EndpointsNamespace is the namespace that contains Glusterfs endpoint. | +| readOnly | boolean | ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. | + +--- + +##### `endpoints`Required + +```typescript +public readonly endpoints: string; +``` + +- *Type:* string + +EndpointsName is the endpoint name that details Glusterfs topology. + +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +--- + +##### `path`Required + +```typescript +public readonly path: string; +``` + +- *Type:* string + +Path is the Glusterfs volume path. + +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +--- + +##### `endpointsNamespace`Optional + +```typescript +public readonly endpointsNamespace: string; +``` + +- *Type:* string + +EndpointsNamespace is the namespace that contains Glusterfs endpoint. + +If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. + +Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +--- + +### GlusterfsVolumeSource + +Represents a Glusterfs mount that lasts the lifetime of a pod. + +Glusterfs volumes do not support ownership management or SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const glusterfsVolumeSource: k8s.GlusterfsVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| endpoints | string | EndpointsName is the endpoint name that details Glusterfs topology. | +| path | string | Path is the Glusterfs volume path. | +| readOnly | boolean | ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. | + +--- + +##### `endpoints`Required + +```typescript +public readonly endpoints: string; +``` + +- *Type:* string + +EndpointsName is the endpoint name that details Glusterfs topology. + +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +--- + +##### `path`Required + +```typescript +public readonly path: string; +``` + +- *Type:* string + +Path is the Glusterfs volume path. + +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. + +Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + +--- + +### Handler + +Handler defines a specific action that should be taken. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const handler: k8s.Handler = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| exec | @smallcase/cdk8s-botkube.k8s.ExecAction | One and only one of the following should be specified. | +| httpGet | @smallcase/cdk8s-botkube.k8s.HttpGetAction | HTTPGet specifies the http request to perform. | +| tcpSocket | @smallcase/cdk8s-botkube.k8s.TcpSocketAction | TCPSocket specifies an action involving a TCP port. | + +--- + +##### `exec`Optional + +```typescript +public readonly exec: ExecAction; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ExecAction + +One and only one of the following should be specified. + +Exec specifies the action to take. + +--- + +##### `httpGet`Optional + +```typescript +public readonly httpGet: HttpGetAction; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HttpGetAction + +HTTPGet specifies the http request to perform. + +--- + +##### `tcpSocket`Optional + +```typescript +public readonly tcpSocket: TcpSocketAction; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.TcpSocketAction + +TCPSocket specifies an action involving a TCP port. + +TCP hooks not yet supported + +--- + +### HorizontalPodAutoscalerBehaviorV2Beta2 + +HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const horizontalPodAutoscalerBehaviorV2Beta2: k8s.HorizontalPodAutoscalerBehaviorV2Beta2 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| scaleDown | @smallcase/cdk8s-botkube.k8s.HpaScalingRulesV2Beta2 | scaleDown is scaling policy for scaling Down. | +| scaleUp | @smallcase/cdk8s-botkube.k8s.HpaScalingRulesV2Beta2 | scaleUp is scaling policy for scaling Up. | + +--- + +##### `scaleDown`Optional + +```typescript +public readonly scaleDown: HpaScalingRulesV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HpaScalingRulesV2Beta2 + +scaleDown is scaling policy for scaling Down. + +If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used). + +--- + +##### `scaleUp`Optional + +```typescript +public readonly scaleUp: HpaScalingRulesV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HpaScalingRulesV2Beta2 + +scaleUp is scaling policy for scaling Up. + +If not set, the default value is the higher of: +* increase no more than 4 pods per 60 seconds +* double the number of pods per 60 seconds +No stabilization is used. + +--- + +### HorizontalPodAutoscalerSpec + +specification of a horizontal pod autoscaler. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const horizontalPodAutoscalerSpec: k8s.HorizontalPodAutoscalerSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| maxReplicas | number | upper limit for the number of pods that can be set by the autoscaler; | +| scaleTargetRef | @smallcase/cdk8s-botkube.k8s.CrossVersionObjectReference | reference to scaled resource; | +| minReplicas | number | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. | +| targetCpuUtilizationPercentage | number | target average CPU utilization (represented as a percentage of requested CPU) over all the pods; | + +--- + +##### `maxReplicas`Required + +```typescript +public readonly maxReplicas: number; +``` + +- *Type:* number + +upper limit for the number of pods that can be set by the autoscaler; + +cannot be smaller than MinReplicas. + +--- + +##### `scaleTargetRef`Required + +```typescript +public readonly scaleTargetRef: CrossVersionObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CrossVersionObjectReference + +reference to scaled resource; + +horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource. + +--- + +##### `minReplicas`Optional + +```typescript +public readonly minReplicas: number; +``` + +- *Type:* number + +minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. + +It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. + +--- + +##### `targetCpuUtilizationPercentage`Optional + +```typescript +public readonly targetCpuUtilizationPercentage: number; +``` + +- *Type:* number + +target average CPU utilization (represented as a percentage of requested CPU) over all the pods; + +if not specified the default autoscaling policy will be used. + +--- + +### HorizontalPodAutoscalerSpecV2Beta1 + +HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const horizontalPodAutoscalerSpecV2Beta1: k8s.HorizontalPodAutoscalerSpecV2Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| maxReplicas | number | maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. | +| scaleTargetRef | @smallcase/cdk8s-botkube.k8s.CrossVersionObjectReferenceV2Beta1 | scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count. | +| metrics | @smallcase/cdk8s-botkube.k8s.MetricSpecV2Beta1[] | metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). | +| minReplicas | number | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. | + +--- + +##### `maxReplicas`Required + +```typescript +public readonly maxReplicas: number; +``` + +- *Type:* number + +maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. + +It cannot be less that minReplicas. + +--- + +##### `scaleTargetRef`Required + +```typescript +public readonly scaleTargetRef: CrossVersionObjectReferenceV2Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CrossVersionObjectReferenceV2Beta1 + +scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count. + +--- + +##### `metrics`Optional + +```typescript +public readonly metrics: MetricSpecV2Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.MetricSpecV2Beta1[] + +metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). + +The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. + +--- + +##### `minReplicas`Optional + +```typescript +public readonly minReplicas: number; +``` + +- *Type:* number + +minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. + +It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. + +--- + +### HorizontalPodAutoscalerSpecV2Beta2 + +HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const horizontalPodAutoscalerSpecV2Beta2: k8s.HorizontalPodAutoscalerSpecV2Beta2 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| maxReplicas | number | maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. | +| scaleTargetRef | @smallcase/cdk8s-botkube.k8s.CrossVersionObjectReferenceV2Beta2 | scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count. | +| behavior | @smallcase/cdk8s-botkube.k8s.HorizontalPodAutoscalerBehaviorV2Beta2 | behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). | +| metrics | @smallcase/cdk8s-botkube.k8s.MetricSpecV2Beta2[] | metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). | +| minReplicas | number | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. | + +--- + +##### `maxReplicas`Required + +```typescript +public readonly maxReplicas: number; +``` + +- *Type:* number + +maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. + +It cannot be less that minReplicas. + +--- + +##### `scaleTargetRef`Required + +```typescript +public readonly scaleTargetRef: CrossVersionObjectReferenceV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CrossVersionObjectReferenceV2Beta2 + +scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count. + +--- + +##### `behavior`Optional + +```typescript +public readonly behavior: HorizontalPodAutoscalerBehaviorV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HorizontalPodAutoscalerBehaviorV2Beta2 + +behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). + +If not set, the default HPAScalingRules for scale up and scale down are used. + +--- + +##### `metrics`Optional + +```typescript +public readonly metrics: MetricSpecV2Beta2[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.MetricSpecV2Beta2[] + +metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). + +The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization. + +--- + +##### `minReplicas`Optional + +```typescript +public readonly minReplicas: number; +``` + +- *Type:* number + +minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. + +It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. + +--- + +### HostAlias + +HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const hostAlias: k8s.HostAlias = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| hostnames | string[] | Hostnames for the above IP address. | +| ip | string | IP address of the host file entry. | + +--- + +##### `hostnames`Optional + +```typescript +public readonly hostnames: string[]; +``` + +- *Type:* string[] + +Hostnames for the above IP address. + +--- + +##### `ip`Optional + +```typescript +public readonly ip: string; +``` + +- *Type:* string + +IP address of the host file entry. + +--- + +### HostPathVolumeSource + +Represents a host path mapped into a pod. + +Host path volumes do not support ownership management or SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const hostPathVolumeSource: k8s.HostPathVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| path | string | Path of the directory on the host. | +| type | string | Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath. | + +--- + +##### `path`Required + +```typescript +public readonly path: string; +``` + +- *Type:* string + +Path of the directory on the host. + +If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + +--- + +##### `type`Optional + +```typescript +public readonly type: string; +``` + +- *Type:* string +- *Default:* More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + +Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath. + +--- + +### HostPortRangeV1Beta1 + +HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. + +It requires both the start and end to be defined. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const hostPortRangeV1Beta1: k8s.HostPortRangeV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| max | number | max is the end of the range, inclusive. | +| min | number | min is the start of the range, inclusive. | + +--- + +##### `max`Required + +```typescript +public readonly max: number; +``` + +- *Type:* number + +max is the end of the range, inclusive. + +--- + +##### `min`Required + +```typescript +public readonly min: number; +``` + +- *Type:* number + +min is the start of the range, inclusive. + +--- + +### HpaScalingPolicyV2Beta2 + +HPAScalingPolicy is a single policy which must hold true for a specified past interval. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const hpaScalingPolicyV2Beta2: k8s.HpaScalingPolicyV2Beta2 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| periodSeconds | number | PeriodSeconds specifies the window of time for which the policy should hold true. | +| type | string | Type is used to specify the scaling policy. | +| value | number | Value contains the amount of change which is permitted by the policy. | + +--- + +##### `periodSeconds`Required + +```typescript +public readonly periodSeconds: number; +``` + +- *Type:* number + +PeriodSeconds specifies the window of time for which the policy should hold true. + +PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min). + +--- + +##### `type`Required + +```typescript +public readonly type: string; +``` + +- *Type:* string + +Type is used to specify the scaling policy. + +--- + +##### `value`Required + +```typescript +public readonly value: number; +``` + +- *Type:* number + +Value contains the amount of change which is permitted by the policy. + +It must be greater than zero + +--- + +### HpaScalingRulesV2Beta2 + +HPAScalingRules configures the scaling behavior for one direction. + +These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const hpaScalingRulesV2Beta2: k8s.HpaScalingRulesV2Beta2 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| policies | @smallcase/cdk8s-botkube.k8s.HpaScalingPolicyV2Beta2[] | policies is a list of potential scaling polices which can be used during scaling. | +| selectPolicy | string | selectPolicy is used to specify which policy should be used. | +| stabilizationWindowSeconds | number | StabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. | + +--- + +##### `policies`Optional + +```typescript +public readonly policies: HpaScalingPolicyV2Beta2[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HpaScalingPolicyV2Beta2[] + +policies is a list of potential scaling polices which can be used during scaling. + +At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid + +--- + +##### `selectPolicy`Optional + +```typescript +public readonly selectPolicy: string; +``` + +- *Type:* string + +selectPolicy is used to specify which policy should be used. + +If not set, the default value MaxPolicySelect is used. + +--- + +##### `stabilizationWindowSeconds`Optional + +```typescript +public readonly stabilizationWindowSeconds: number; +``` + +- *Type:* number + +StabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. + +StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long). + +--- + +### HttpGetAction + +HTTPGetAction describes an action based on HTTP Get requests. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const httpGetAction: k8s.HttpGetAction = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| port | @smallcase/cdk8s-botkube.k8s.IntOrString | Name or number of the port to access on the container. | +| host | string | Host name to connect to, defaults to the pod IP. | +| httpHeaders | @smallcase/cdk8s-botkube.k8s.HttpHeader[] | Custom headers to set in the request. | +| path | string | Path to access on the HTTP server. | +| scheme | string | Scheme to use for connecting to the host. | + +--- + +##### `port`Required + +```typescript +public readonly port: IntOrString; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IntOrString + +Name or number of the port to access on the container. + +Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +--- + +##### `host`Optional + +```typescript +public readonly host: string; +``` + +- *Type:* string + +Host name to connect to, defaults to the pod IP. + +You probably want to set "Host" in httpHeaders instead. + +--- + +##### `httpHeaders`Optional + +```typescript +public readonly httpHeaders: HttpHeader[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HttpHeader[] + +Custom headers to set in the request. + +HTTP allows repeated headers. + +--- + +##### `path`Optional + +```typescript +public readonly path: string; +``` + +- *Type:* string + +Path to access on the HTTP server. + +--- + +##### `scheme`Optional + +```typescript +public readonly scheme: string; +``` + +- *Type:* string +- *Default:* HTTP. + +Scheme to use for connecting to the host. + +Defaults to HTTP. + +--- + +### HttpHeader + +HTTPHeader describes a custom header to be used in HTTP probes. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const httpHeader: k8s.HttpHeader = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | The header field name. | +| value | string | The header field value. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The header field name. + +--- + +##### `value`Required + +```typescript +public readonly value: string; +``` + +- *Type:* string + +The header field value. + +--- + +### HttpIngressPath + +HTTPIngressPath associates a path with a backend. + +Incoming urls matching the path are forwarded to the backend. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const httpIngressPath: k8s.HttpIngressPath = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| backend | @smallcase/cdk8s-botkube.k8s.IngressBackend | Backend defines the referenced service endpoint to which the traffic will be forwarded to. | +| path | string | Path is matched against the path of an incoming request. | +| pathType | string | PathType determines the interpretation of the Path matching. | + +--- + +##### `backend`Required + +```typescript +public readonly backend: IngressBackend; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressBackend + +Backend defines the referenced service endpoint to which the traffic will be forwarded to. + +--- + +##### `path`Optional + +```typescript +public readonly path: string; +``` + +- *Type:* string + +Path is 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 '/'. When unspecified, all paths from incoming requests are matched. + +--- + +##### `pathType`Optional + +```typescript +public readonly pathType: string; +``` + +- *Type:* string + +PathType determines the interpretation of the Path matching. + +PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is +done on a path element by element basis. A path element refers is the +list of labels in the path split by the '/' separator. A request is a +match for path p if every p is an element-wise prefix of p of the +request path. Note that if the last element of the path is a substring +of the last element in request path, it is not a match (e.g. /foo/bar +matches /foo/bar/baz, but does not match /foo/barbaz). +* ImplementationSpecific: Interpretation of the Path matching is up to +the IngressClass. Implementations can treat this as a separate PathType +or treat it identically to Prefix or Exact path types. +Implementations are required to support all path types. + +--- + +### HttpIngressPathV1Beta1 + +HTTPIngressPath associates a path with a backend. + +Incoming urls matching the path are forwarded to the backend. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const httpIngressPathV1Beta1: k8s.HttpIngressPathV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| backend | @smallcase/cdk8s-botkube.k8s.IngressBackendV1Beta1 | Backend defines the referenced service endpoint to which the traffic will be forwarded to. | +| path | string | Path is matched against the path of an incoming request. | +| pathType | string | PathType determines the interpretation of the Path matching. | + +--- + +##### `backend`Required + +```typescript +public readonly backend: IngressBackendV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressBackendV1Beta1 + +Backend defines the referenced service endpoint to which the traffic will be forwarded to. + +--- + +##### `path`Optional + +```typescript +public readonly path: string; +``` + +- *Type:* string + +Path is 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 '/'. When unspecified, all paths from incoming requests are matched. + +--- + +##### `pathType`Optional + +```typescript +public readonly pathType: string; +``` + +- *Type:* string +- *Default:* ImplementationSpecific. + +PathType determines the interpretation of the Path matching. + +PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is +done on a path element by element basis. A path element refers is the +list of labels in the path split by the '/' separator. A request is a +match for path p if every p is an element-wise prefix of p of the +request path. Note that if the last element of the path is a substring +of the last element in request path, it is not a match (e.g. /foo/bar +matches /foo/bar/baz, but does not match /foo/barbaz). +* ImplementationSpecific: Interpretation of the Path matching is up to +the IngressClass. Implementations can treat this as a separate PathType +or treat it identically to Prefix or Exact path types. +Implementations are required to support all path types. Defaults to ImplementationSpecific. + +--- + +### HttpIngressRuleValue + +HTTPIngressRuleValue is a list of http selectors pointing to backends. + +In the example: http:///? -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const httpIngressRuleValue: k8s.HttpIngressRuleValue = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| paths | @smallcase/cdk8s-botkube.k8s.HttpIngressPath[] | A collection of paths that map requests to backends. | + +--- + +##### `paths`Required + +```typescript +public readonly paths: HttpIngressPath[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HttpIngressPath[] + +A collection of paths that map requests to backends. + +--- + +### HttpIngressRuleValueV1Beta1 + +HTTPIngressRuleValue is a list of http selectors pointing to backends. + +In the example: http:///? -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const httpIngressRuleValueV1Beta1: k8s.HttpIngressRuleValueV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| paths | @smallcase/cdk8s-botkube.k8s.HttpIngressPathV1Beta1[] | A collection of paths that map requests to backends. | + +--- + +##### `paths`Required + +```typescript +public readonly paths: HttpIngressPathV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HttpIngressPathV1Beta1[] + +A collection of paths that map requests to backends. + +--- + +### IdRangeV1Beta1 + +IDRange provides a min/max of an allowed range of IDs. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const idRangeV1Beta1: k8s.IdRangeV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| max | number | max is the end of the range, inclusive. | +| min | number | min is the start of the range, inclusive. | + +--- + +##### `max`Required + +```typescript +public readonly max: number; +``` + +- *Type:* number + +max is the end of the range, inclusive. + +--- + +##### `min`Required + +```typescript +public readonly min: number; +``` + +- *Type:* number + +min is the start of the range, inclusive. + +--- + +### IngressBackend + +IngressBackend describes all endpoints for a given service and port. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ingressBackend: k8s.IngressBackend = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| resource | @smallcase/cdk8s-botkube.k8s.TypedLocalObjectReference | Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. | +| service | @smallcase/cdk8s-botkube.k8s.IngressServiceBackend | Service references a Service as a Backend. | + +--- + +##### `resource`Optional + +```typescript +public readonly resource: TypedLocalObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.TypedLocalObjectReference + +Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. + +If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with "Service". + +--- + +##### `service`Optional + +```typescript +public readonly service: IngressServiceBackend; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressServiceBackend + +Service references a Service as a Backend. + +This is a mutually exclusive setting with "Resource". + +--- + +### IngressBackendV1Beta1 + +IngressBackend describes all endpoints for a given service and port. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ingressBackendV1Beta1: k8s.IngressBackendV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| resource | @smallcase/cdk8s-botkube.k8s.TypedLocalObjectReference | Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. | +| serviceName | string | Specifies the name of the referenced service. | +| servicePort | @smallcase/cdk8s-botkube.k8s.IntOrString | Specifies the port of the referenced service. | + +--- + +##### `resource`Optional + +```typescript +public readonly resource: TypedLocalObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.TypedLocalObjectReference + +Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. + +If resource is specified, serviceName and servicePort must not be specified. + +--- + +##### `serviceName`Optional + +```typescript +public readonly serviceName: string; +``` + +- *Type:* string + +Specifies the name of the referenced service. + +--- + +##### `servicePort`Optional + +```typescript +public readonly servicePort: IntOrString; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IntOrString + +Specifies the port of the referenced service. + +--- + +### IngressClassParametersReference + +IngressClassParametersReference identifies an API object. + +This can be used to specify a cluster or namespace-scoped resource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ingressClassParametersReference: k8s.IngressClassParametersReference = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| kind | string | Kind is the type of resource being referenced. | +| name | string | Name is the name of resource being referenced. | +| apiGroup | string | APIGroup is the group for the resource being referenced. | +| namespace | string | Namespace is the namespace of the resource being referenced. | +| scope | string | Scope represents if this refers to a cluster or namespace scoped resource. | + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind is the type of resource being referenced. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name is the name of resource being referenced. + +--- + +##### `apiGroup`Optional + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +APIGroup is the group for the resource being referenced. + +If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + +--- + +##### `namespace`Optional + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +Namespace is the namespace of the resource being referenced. + +This field is required when scope is set to "Namespace" and must be unset when scope is set to "Cluster". + +--- + +##### `scope`Optional + +```typescript +public readonly scope: string; +``` + +- *Type:* string + +Scope represents if this refers to a cluster or namespace scoped resource. + +This may be set to "Cluster" (default) or "Namespace". Field can be enabled with IngressClassNamespacedParams feature gate. + +--- + +### IngressClassParametersReferenceV1Beta1 + +IngressClassParametersReference identifies an API object. + +This can be used to specify a cluster or namespace-scoped resource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ingressClassParametersReferenceV1Beta1: k8s.IngressClassParametersReferenceV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| kind | string | Kind is the type of resource being referenced. | +| name | string | Name is the name of resource being referenced. | +| apiGroup | string | APIGroup is the group for the resource being referenced. | +| namespace | string | Namespace is the namespace of the resource being referenced. | +| scope | string | Scope represents if this refers to a cluster or namespace scoped resource. | + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind is the type of resource being referenced. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name is the name of resource being referenced. + +--- + +##### `apiGroup`Optional + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +APIGroup is the group for the resource being referenced. + +If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + +--- + +##### `namespace`Optional + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +Namespace is the namespace of the resource being referenced. + +This field is required when scope is set to "Namespace" and must be unset when scope is set to "Cluster". + +--- + +##### `scope`Optional + +```typescript +public readonly scope: string; +``` + +- *Type:* string + +Scope represents if this refers to a cluster or namespace scoped resource. + +This may be set to "Cluster" (default) or "Namespace". Field can be enabled with IngressClassNamespacedParams feature gate. + +--- + +### IngressClassSpec + +IngressClassSpec provides information about the class of an Ingress. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ingressClassSpec: k8s.IngressClassSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| controller | string | Controller refers to the name of the controller that should handle this class. | +| parameters | @smallcase/cdk8s-botkube.k8s.IngressClassParametersReference | Parameters is a link to a custom resource containing additional configuration for the controller. | + +--- + +##### `controller`Optional + +```typescript +public readonly controller: string; +``` + +- *Type:* string + +Controller refers to the name of the controller that should handle this class. + +This allows for different "flavors" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable. + +--- + +##### `parameters`Optional + +```typescript +public readonly parameters: IngressClassParametersReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressClassParametersReference + +Parameters is a link to a custom resource containing additional configuration for the controller. + +This is optional if the controller does not require extra parameters. + +--- + +### IngressClassSpecV1Beta1 + +IngressClassSpec provides information about the class of an Ingress. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ingressClassSpecV1Beta1: k8s.IngressClassSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| controller | string | Controller refers to the name of the controller that should handle this class. | +| parameters | @smallcase/cdk8s-botkube.k8s.IngressClassParametersReferenceV1Beta1 | Parameters is a link to a custom resource containing additional configuration for the controller. | + +--- + +##### `controller`Optional + +```typescript +public readonly controller: string; +``` + +- *Type:* string + +Controller refers to the name of the controller that should handle this class. + +This allows for different "flavors" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable. + +--- + +##### `parameters`Optional + +```typescript +public readonly parameters: IngressClassParametersReferenceV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressClassParametersReferenceV1Beta1 + +Parameters is a link to a custom resource containing additional configuration for the controller. + +This is optional if the controller does not require extra parameters. + +--- + +### IngressRule + +IngressRule represents the rules mapping the paths under a specified host to the related backend services. + +Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ingressRule: k8s.IngressRule = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| host | string | Host is the fully qualified domain name of a network host, as defined by RFC 3986. | +| http | @smallcase/cdk8s-botkube.k8s.HttpIngressRuleValue | *No description.* | + +--- + +##### `host`Optional + +```typescript +public readonly host: string; +``` + +- *Type:* string + +Host is the fully qualified domain name of a network host, as defined by RFC 3986. + +Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to +the IP in the Spec of the parent Ingress. +2. The `:` delimiter is not respected because ports are not allowed. +Currently the port of an Ingress is implicitly :80 for http and +:443 for https. +Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. + +Host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If Host is precise, the request matches this rule if the http host header is equal to Host. 2. If Host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule. + +--- + +##### `http`Optional + +```typescript +public readonly http: HttpIngressRuleValue; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HttpIngressRuleValue + +--- + +### IngressRuleV1Beta1 + +IngressRule represents the rules mapping the paths under a specified host to the related backend services. + +Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ingressRuleV1Beta1: k8s.IngressRuleV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| host | string | Host is the fully qualified domain name of a network host, as defined by RFC 3986. | +| http | @smallcase/cdk8s-botkube.k8s.HttpIngressRuleValueV1Beta1 | *No description.* | + +--- + +##### `host`Optional + +```typescript +public readonly host: string; +``` + +- *Type:* string + +Host is the fully qualified domain name of a network host, as defined by RFC 3986. + +Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to +the IP in the Spec of the parent Ingress. +2. The `:` delimiter is not respected because ports are not allowed. +Currently the port of an Ingress is implicitly :80 for http and +:443 for https. +Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. + +Host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If Host is precise, the request matches this rule if the http host header is equal to Host. 2. If Host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule. + +--- + +##### `http`Optional + +```typescript +public readonly http: HttpIngressRuleValueV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HttpIngressRuleValueV1Beta1 + +--- + +### IngressServiceBackend + +IngressServiceBackend references a Kubernetes Service as a Backend. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ingressServiceBackend: k8s.IngressServiceBackend = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | Name is the referenced service. | +| port | @smallcase/cdk8s-botkube.k8s.ServiceBackendPort | Port of the referenced service. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name is the referenced service. + +The service must exist in the same namespace as the Ingress object. + +--- + +##### `port`Optional + +```typescript +public readonly port: ServiceBackendPort; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ServiceBackendPort + +Port of the referenced service. + +A port name or port number is required for a IngressServiceBackend. + +--- + +### IngressSpec + +IngressSpec describes the Ingress the user wishes to exist. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ingressSpec: k8s.IngressSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| defaultBackend | @smallcase/cdk8s-botkube.k8s.IngressBackend | DefaultBackend is the backend that should handle requests that don't match any rule. | +| ingressClassName | string | IngressClassName is the name of the IngressClass cluster resource. | +| rules | @smallcase/cdk8s-botkube.k8s.IngressRule[] | A list of host rules used to configure the Ingress. | +| tls | @smallcase/cdk8s-botkube.k8s.IngressTls[] | TLS configuration. | + +--- + +##### `defaultBackend`Optional + +```typescript +public readonly defaultBackend: IngressBackend; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressBackend + +DefaultBackend is the backend that should handle requests that don't match any rule. + +If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller. + +--- + +##### `ingressClassName`Optional + +```typescript +public readonly ingressClassName: string; +``` + +- *Type:* string + +IngressClassName is the name of the IngressClass cluster resource. + +The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation. + +--- + +##### `rules`Optional + +```typescript +public readonly rules: IngressRule[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressRule[] + +A list of host rules used to configure the Ingress. + +If unspecified, or no rule matches, all traffic is sent to the default backend. + +--- + +##### `tls`Optional + +```typescript +public readonly tls: IngressTls[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressTls[] + +TLS configuration. + +Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. + +--- + +### IngressSpecV1Beta1 + +IngressSpec describes the Ingress the user wishes to exist. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ingressSpecV1Beta1: k8s.IngressSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| backend | @smallcase/cdk8s-botkube.k8s.IngressBackendV1Beta1 | A default backend capable of servicing requests that don't match any rule. | +| ingressClassName | string | IngressClassName is the name of the IngressClass cluster resource. | +| rules | @smallcase/cdk8s-botkube.k8s.IngressRuleV1Beta1[] | A list of host rules used to configure the Ingress. | +| tls | @smallcase/cdk8s-botkube.k8s.IngressTlsv1Beta1[] | TLS configuration. | + +--- + +##### `backend`Optional + +```typescript +public readonly backend: IngressBackendV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressBackendV1Beta1 + +A default backend capable of servicing requests that don't match any rule. + +At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default. + +--- + +##### `ingressClassName`Optional + +```typescript +public readonly ingressClassName: string; +``` + +- *Type:* string + +IngressClassName is the name of the IngressClass cluster resource. + +The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation. + +--- + +##### `rules`Optional + +```typescript +public readonly rules: IngressRuleV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressRuleV1Beta1[] + +A list of host rules used to configure the Ingress. + +If unspecified, or no rule matches, all traffic is sent to the default backend. + +--- + +##### `tls`Optional + +```typescript +public readonly tls: IngressTlsv1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressTlsv1Beta1[] + +TLS configuration. + +Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. + +--- + +### IngressTls + +IngressTLS describes the transport layer security associated with an Ingress. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ingressTls: k8s.IngressTls = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| hosts | string[] | Hosts are a list of hosts included in the TLS certificate. | +| secretName | string | SecretName is the name of the secret used to terminate TLS traffic on port 443. | + +--- + +##### `hosts`Optional + +```typescript +public readonly hosts: string[]; +``` + +- *Type:* string[] +- *Default:* the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. + +Hosts are a list of hosts included in the TLS certificate. + +The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. + +--- + +##### `secretName`Optional + +```typescript +public readonly secretName: string; +``` + +- *Type:* string + +SecretName is the name of the secret used to terminate TLS traffic on port 443. + +Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. + +--- + +### IngressTlsv1Beta1 + +IngressTLS describes the transport layer security associated with an Ingress. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ingressTlsv1Beta1: k8s.IngressTlsv1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| hosts | string[] | Hosts are a list of hosts included in the TLS certificate. | +| secretName | string | SecretName is the name of the secret used to terminate TLS traffic on port 443. | + +--- + +##### `hosts`Optional + +```typescript +public readonly hosts: string[]; +``` + +- *Type:* string[] +- *Default:* the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. + +Hosts are a list of hosts included in the TLS certificate. + +The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. + +--- + +##### `secretName`Optional + +```typescript +public readonly secretName: string; +``` + +- *Type:* string + +SecretName is the name of the secret used to terminate TLS traffic on port 443. + +Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. + +--- + +### IpBlock + +IPBlock describes a particular CIDR (Ex. + +"192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ipBlock: k8s.IpBlock = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| cidr | string | CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64". | +| except | string[] | Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range. | + +--- + +##### `cidr`Required + +```typescript +public readonly cidr: string; +``` + +- *Type:* string + +CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64". + +--- + +##### `except`Optional + +```typescript +public readonly except: string[]; +``` + +- *Type:* string[] + +Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range. + +--- + +### IscsiPersistentVolumeSource + +ISCSIPersistentVolumeSource represents an ISCSI disk. + +ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const iscsiPersistentVolumeSource: k8s.IscsiPersistentVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| iqn | string | Target iSCSI Qualified Name. | +| lun | number | iSCSI Target Lun number. | +| targetPortal | string | iSCSI Target Portal. | +| chapAuthDiscovery | boolean | whether support iSCSI Discovery CHAP authentication. | +| chapAuthSession | boolean | whether support iSCSI Session CHAP authentication. | +| fsType | string | Filesystem type of the volume that you want to mount. | +| initiatorName | string | Custom iSCSI Initiator Name. | +| iscsiInterface | string | iSCSI Interface Name that uses an iSCSI transport. | +| portals | string[] | iSCSI Target Portal List. | +| readOnly | boolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. | +| secretRef | @smallcase/cdk8s-botkube.k8s.SecretReference | CHAP Secret for iSCSI target and initiator authentication. | + +--- + +##### `iqn`Required + +```typescript +public readonly iqn: string; +``` + +- *Type:* string + +Target iSCSI Qualified Name. + +--- + +##### `lun`Required + +```typescript +public readonly lun: number; +``` + +- *Type:* number + +iSCSI Target Lun number. + +--- + +##### `targetPortal`Required + +```typescript +public readonly targetPortal: string; +``` + +- *Type:* string + +iSCSI Target Portal. + +The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + +--- + +##### `chapAuthDiscovery`Optional + +```typescript +public readonly chapAuthDiscovery: boolean; +``` + +- *Type:* boolean + +whether support iSCSI Discovery CHAP authentication. + +--- + +##### `chapAuthSession`Optional + +```typescript +public readonly chapAuthSession: boolean; +``` + +- *Type:* boolean + +whether support iSCSI Session CHAP authentication. + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type of the volume that you want to mount. + +Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi + +--- + +##### `initiatorName`Optional + +```typescript +public readonly initiatorName: string; +``` + +- *Type:* string + +Custom iSCSI Initiator Name. + +If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. + +--- + +##### `iscsiInterface`Optional + +```typescript +public readonly iscsiInterface: string; +``` + +- *Type:* string +- *Default:* default' (tcp). + +iSCSI Interface Name that uses an iSCSI transport. + +Defaults to 'default' (tcp). + +--- + +##### `portals`Optional + +```typescript +public readonly portals: string[]; +``` + +- *Type:* string[] + +iSCSI Target Portal List. + +The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Defaults to false. + +--- + +##### `secretRef`Optional + +```typescript +public readonly secretRef: SecretReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecretReference + +CHAP Secret for iSCSI target and initiator authentication. + +--- + +### IscsiVolumeSource + +Represents an ISCSI disk. + +ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const iscsiVolumeSource: k8s.IscsiVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| iqn | string | Target iSCSI Qualified Name. | +| lun | number | iSCSI Target Lun number. | +| targetPortal | string | iSCSI Target Portal. | +| chapAuthDiscovery | boolean | whether support iSCSI Discovery CHAP authentication. | +| chapAuthSession | boolean | whether support iSCSI Session CHAP authentication. | +| fsType | string | Filesystem type of the volume that you want to mount. | +| initiatorName | string | Custom iSCSI Initiator Name. | +| iscsiInterface | string | iSCSI Interface Name that uses an iSCSI transport. | +| portals | string[] | iSCSI Target Portal List. | +| readOnly | boolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. | +| secretRef | @smallcase/cdk8s-botkube.k8s.LocalObjectReference | CHAP Secret for iSCSI target and initiator authentication. | + +--- + +##### `iqn`Required + +```typescript +public readonly iqn: string; +``` + +- *Type:* string + +Target iSCSI Qualified Name. + +--- + +##### `lun`Required + +```typescript +public readonly lun: number; +``` + +- *Type:* number + +iSCSI Target Lun number. + +--- + +##### `targetPortal`Required + +```typescript +public readonly targetPortal: string; +``` + +- *Type:* string + +iSCSI Target Portal. + +The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + +--- + +##### `chapAuthDiscovery`Optional + +```typescript +public readonly chapAuthDiscovery: boolean; +``` + +- *Type:* boolean + +whether support iSCSI Discovery CHAP authentication. + +--- + +##### `chapAuthSession`Optional + +```typescript +public readonly chapAuthSession: boolean; +``` + +- *Type:* boolean + +whether support iSCSI Session CHAP authentication. + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type of the volume that you want to mount. + +Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi + +--- + +##### `initiatorName`Optional + +```typescript +public readonly initiatorName: string; +``` + +- *Type:* string + +Custom iSCSI Initiator Name. + +If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. + +--- + +##### `iscsiInterface`Optional + +```typescript +public readonly iscsiInterface: string; +``` + +- *Type:* string +- *Default:* default' (tcp). + +iSCSI Interface Name that uses an iSCSI transport. + +Defaults to 'default' (tcp). + +--- + +##### `portals`Optional + +```typescript +public readonly portals: string[]; +``` + +- *Type:* string[] + +iSCSI Target Portal List. + +The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Defaults to false. + +--- + +##### `secretRef`Optional + +```typescript +public readonly secretRef: LocalObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LocalObjectReference + +CHAP Secret for iSCSI target and initiator authentication. + +--- + +### JobSpec + +JobSpec describes how the job execution will look like. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const jobSpec: k8s.JobSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| template | @smallcase/cdk8s-botkube.k8s.PodTemplateSpec | Describes the pod that will be created when executing a job. | +| activeDeadlineSeconds | number | Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; | +| backoffLimit | number | Specifies the number of retries before marking this job failed. | +| completionMode | string | CompletionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`. | +| completions | number | Specifies the desired number of successfully finished pods the job should be run with. | +| manualSelector | boolean | manualSelector controls generation of pod labels and pod selectors. | +| parallelism | number | Specifies the maximum desired number of pods the job should run at any given time. | +| selector | @smallcase/cdk8s-botkube.k8s.LabelSelector | A label query over pods that should match the pod count. | +| suspend | boolean | Suspend specifies whether the Job controller should create Pods or not. | +| ttlSecondsAfterFinished | number | ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). | + +--- + +##### `template`Required + +```typescript +public readonly template: PodTemplateSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodTemplateSpec + +Describes the pod that will be created when executing a job. + +More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ + +--- + +##### `activeDeadlineSeconds`Optional + +```typescript +public readonly activeDeadlineSeconds: number; +``` + +- *Type:* number + +Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; + +value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again. + +--- + +##### `backoffLimit`Optional + +```typescript +public readonly backoffLimit: number; +``` + +- *Type:* number +- *Default:* 6 + +Specifies the number of retries before marking this job failed. + +Defaults to 6 + +--- + +##### `completionMode`Optional + +```typescript +public readonly completionMode: string; +``` + +- *Type:* string + +CompletionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`. + +`NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other. + +`Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. + +This field is alpha-level and is only honored by servers that enable the IndexedJob feature gate. More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, the controller skips updates for the Job. + +--- + +##### `completions`Optional + +```typescript +public readonly completions: number; +``` + +- *Type:* number + +Specifies the desired number of successfully finished pods the job should be run with. + +Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ + +--- + +##### `manualSelector`Optional + +```typescript +public readonly manualSelector: boolean; +``` + +- *Type:* boolean + +manualSelector controls generation of pod labels and pod selectors. + +Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector + +--- + +##### `parallelism`Optional + +```typescript +public readonly parallelism: number; +``` + +- *Type:* number + +Specifies the maximum desired number of pods the job should run at any given time. + +The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ + +--- + +##### `selector`Optional + +```typescript +public readonly selector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +A label query over pods that should match the pod count. + +Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + +--- + +##### `suspend`Optional + +```typescript +public readonly suspend: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +Suspend specifies whether the Job controller should create Pods or not. + +If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. This is an alpha field and requires the SuspendJob feature gate to be enabled; otherwise this field may not be set to true. Defaults to false. + +--- + +##### `ttlSecondsAfterFinished`Optional + +```typescript +public readonly ttlSecondsAfterFinished: number; +``` + +- *Type:* number + +ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). + +If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature. + +--- + +### JobTemplateSpec + +JobTemplateSpec describes the data a Job should have when created from a template. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const jobTemplateSpec: k8s.JobTemplateSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata of the jobs created from this template. | +| spec | @smallcase/cdk8s-botkube.k8s.JobSpec | Specification of the desired behavior of the job. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata of the jobs created from this template. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: JobSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JobSpec + +Specification of the desired behavior of the job. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### JobTemplateSpecV1Beta1 + +JobTemplateSpec describes the data a Job should have when created from a template. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const jobTemplateSpecV1Beta1: k8s.JobTemplateSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata of the jobs created from this template. | +| spec | @smallcase/cdk8s-botkube.k8s.JobSpec | Specification of the desired behavior of the job. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata of the jobs created from this template. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: JobSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JobSpec + +Specification of the desired behavior of the job. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### JsonSchemaProps + +JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const jsonSchemaProps: k8s.JsonSchemaProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| additionalItems | any | *No description.* | +| additionalProperties | any | *No description.* | +| allOf | @smallcase/cdk8s-botkube.k8s.JsonSchemaProps[] | *No description.* | +| anyOf | @smallcase/cdk8s-botkube.k8s.JsonSchemaProps[] | *No description.* | +| default | any | default is a default value for undefined object fields. | +| definitions | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.JsonSchemaProps} | *No description.* | +| dependencies | {[ key: string ]: any} | *No description.* | +| description | string | *No description.* | +| enum | any[] | *No description.* | +| example | any | *No description.* | +| exclusiveMaximum | boolean | *No description.* | +| exclusiveMinimum | boolean | *No description.* | +| externalDocs | @smallcase/cdk8s-botkube.k8s.ExternalDocumentation | *No description.* | +| format | string | format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:. | +| id | string | *No description.* | +| items | any | *No description.* | +| maximum | number | *No description.* | +| maxItems | number | *No description.* | +| maxLength | number | *No description.* | +| maxProperties | number | *No description.* | +| minimum | number | *No description.* | +| minItems | number | *No description.* | +| minLength | number | *No description.* | +| minProperties | number | *No description.* | +| multipleOf | number | *No description.* | +| not | @smallcase/cdk8s-botkube.k8s.JsonSchemaProps | *No description.* | +| nullable | boolean | *No description.* | +| oneOf | @smallcase/cdk8s-botkube.k8s.JsonSchemaProps[] | *No description.* | +| pattern | string | *No description.* | +| patternProperties | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.JsonSchemaProps} | *No description.* | +| properties | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.JsonSchemaProps} | *No description.* | +| ref | string | *No description.* | +| required | string[] | *No description.* | +| schema | string | *No description.* | +| title | string | *No description.* | +| type | string | *No description.* | +| uniqueItems | boolean | *No description.* | +| xKubernetesEmbeddedResource | boolean | x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata). | +| xKubernetesIntOrString | boolean | x-kubernetes-int-or-string specifies that this value is either an integer or a string. | +| xKubernetesListMapKeys | string[] | x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. | +| xKubernetesListType | string | x-kubernetes-list-type annotates an array to further describe its topology. | +| xKubernetesMapType | string | x-kubernetes-map-type annotates an object to further describe its topology. | +| xKubernetesPreserveUnknownFields | boolean | x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. | + +--- + +##### `additionalItems`Optional + +```typescript +public readonly additionalItems: any; +``` + +- *Type:* any + +--- + +##### `additionalProperties`Optional + +```typescript +public readonly additionalProperties: any; +``` + +- *Type:* any + +--- + +##### `allOf`Optional + +```typescript +public readonly allOf: JsonSchemaProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JsonSchemaProps[] + +--- + +##### `anyOf`Optional + +```typescript +public readonly anyOf: JsonSchemaProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JsonSchemaProps[] + +--- + +##### `default`Optional + +```typescript +public readonly default: any; +``` + +- *Type:* any + +default is a default value for undefined object fields. + +Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false. + +--- + +##### `definitions`Optional + +```typescript +public readonly definitions: {[ key: string ]: JsonSchemaProps}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.JsonSchemaProps} + +--- + +##### `dependencies`Optional + +```typescript +public readonly dependencies: {[ key: string ]: any}; +``` + +- *Type:* {[ key: string ]: any} + +--- + +##### `description`Optional + +```typescript +public readonly description: string; +``` + +- *Type:* string + +--- + +##### `enum`Optional + +```typescript +public readonly enum: any[]; +``` + +- *Type:* any[] + +--- + +##### `example`Optional + +```typescript +public readonly example: any; +``` + +- *Type:* any + +--- + +##### `exclusiveMaximum`Optional + +```typescript +public readonly exclusiveMaximum: boolean; +``` + +- *Type:* boolean + +--- + +##### `exclusiveMinimum`Optional + +```typescript +public readonly exclusiveMinimum: boolean; +``` + +- *Type:* boolean + +--- + +##### `externalDocs`Optional + +```typescript +public readonly externalDocs: ExternalDocumentation; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ExternalDocumentation + +--- + +##### `format`Optional + +```typescript +public readonly format: string; +``` + +- *Type:* string + +format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:. + +bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339. + +--- + +##### `id`Optional + +```typescript +public readonly id: string; +``` + +- *Type:* string + +--- + +##### `items`Optional + +```typescript +public readonly items: any; +``` + +- *Type:* any + +--- + +##### `maximum`Optional + +```typescript +public readonly maximum: number; +``` + +- *Type:* number + +--- + +##### `maxItems`Optional + +```typescript +public readonly maxItems: number; +``` + +- *Type:* number + +--- + +##### `maxLength`Optional + +```typescript +public readonly maxLength: number; +``` + +- *Type:* number + +--- + +##### `maxProperties`Optional + +```typescript +public readonly maxProperties: number; +``` + +- *Type:* number + +--- + +##### `minimum`Optional + +```typescript +public readonly minimum: number; +``` + +- *Type:* number + +--- + +##### `minItems`Optional + +```typescript +public readonly minItems: number; +``` + +- *Type:* number + +--- + +##### `minLength`Optional + +```typescript +public readonly minLength: number; +``` + +- *Type:* number + +--- + +##### `minProperties`Optional + +```typescript +public readonly minProperties: number; +``` + +- *Type:* number + +--- + +##### `multipleOf`Optional + +```typescript +public readonly multipleOf: number; +``` + +- *Type:* number + +--- + +##### `not`Optional + +```typescript +public readonly not: JsonSchemaProps; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JsonSchemaProps + +--- + +##### `nullable`Optional + +```typescript +public readonly nullable: boolean; +``` + +- *Type:* boolean + +--- + +##### `oneOf`Optional + +```typescript +public readonly oneOf: JsonSchemaProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JsonSchemaProps[] + +--- + +##### `pattern`Optional + +```typescript +public readonly pattern: string; +``` + +- *Type:* string + +--- + +##### `patternProperties`Optional + +```typescript +public readonly patternProperties: {[ key: string ]: JsonSchemaProps}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.JsonSchemaProps} + +--- + +##### `properties`Optional + +```typescript +public readonly properties: {[ key: string ]: JsonSchemaProps}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.JsonSchemaProps} + +--- + +##### `ref`Optional + +```typescript +public readonly ref: string; +``` + +- *Type:* string + +--- + +##### `required`Optional + +```typescript +public readonly required: string[]; +``` + +- *Type:* string[] + +--- + +##### `schema`Optional + +```typescript +public readonly schema: string; +``` + +- *Type:* string + +--- + +##### `title`Optional + +```typescript +public readonly title: string; +``` + +- *Type:* string + +--- + +##### `type`Optional + +```typescript +public readonly type: string; +``` + +- *Type:* string + +--- + +##### `uniqueItems`Optional + +```typescript +public readonly uniqueItems: boolean; +``` + +- *Type:* boolean + +--- + +##### `xKubernetesEmbeddedResource`Optional + +```typescript +public readonly xKubernetesEmbeddedResource: boolean; +``` + +- *Type:* boolean + +x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata). + +--- + +##### `xKubernetesIntOrString`Optional + +```typescript +public readonly xKubernetesIntOrString: boolean; +``` + +- *Type:* boolean + +x-kubernetes-int-or-string specifies that this value is either an integer or a string. + +If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns: + +1) anyOf: +- type: integer +- type: string +2) allOf: +- anyOf: +- type: integer +- type: string +- ... zero or more + +--- + +##### `xKubernetesListMapKeys`Optional + +```typescript +public readonly xKubernetesListMapKeys: string[]; +``` + +- *Type:* string[] + +x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. + +This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported). + +The properties specified must either be required or have a default value, to ensure those properties are present for all list items. + +--- + +##### `xKubernetesListType`Optional + +```typescript +public readonly xKubernetesListType: string; +``` + +- *Type:* string +- *Default:* atomic for arrays. + +x-kubernetes-list-type annotates an array to further describe its topology. + +This extension must only be used on lists and may have 3 possible values: + +1) `atomic`: the list is treated as a single entity, like a scalar. +Atomic lists will be entirely replaced when updated. This extension +may be used on any type of list (struct, scalar, ...). +2) `set`: +Sets are lists that must not have multiple items with the same value. Each +value must be a scalar, an object with x-kubernetes-map-type `atomic` or an +array with x-kubernetes-list-type `atomic`. +3) `map`: +These lists are like maps in that their elements have a non-index key +used to identify them. Order is preserved upon merge. The map tag +must only be used on a list with elements of type object. +Defaults to atomic for arrays. + +--- + +##### `xKubernetesMapType`Optional + +```typescript +public readonly xKubernetesMapType: string; +``` + +- *Type:* string + +x-kubernetes-map-type annotates an object to further describe its topology. + +This extension must only be used when type is object and may have 2 possible values: + +1) `granular`: +These maps are actual maps (key-value pairs) and each fields are independent +from each other (they can each be manipulated by separate actors). This is +the default behaviour for all maps. +2) `atomic`: the list is treated as a single entity, like a scalar. +Atomic maps will be entirely replaced when updated. + +--- + +##### `xKubernetesPreserveUnknownFields`Optional + +```typescript +public readonly xKubernetesPreserveUnknownFields: boolean; +``` + +- *Type:* boolean + +x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. + +This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden. + +--- + +### JsonSchemaPropsV1Beta1 + +JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const jsonSchemaPropsV1Beta1: k8s.JsonSchemaPropsV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| additionalItems | any | *No description.* | +| additionalProperties | any | *No description.* | +| allOf | @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1[] | *No description.* | +| anyOf | @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1[] | *No description.* | +| default | any | default is a default value for undefined object fields. | +| definitions | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1} | *No description.* | +| dependencies | {[ key: string ]: any} | *No description.* | +| description | string | *No description.* | +| enum | any[] | *No description.* | +| example | any | *No description.* | +| exclusiveMaximum | boolean | *No description.* | +| exclusiveMinimum | boolean | *No description.* | +| externalDocs | @smallcase/cdk8s-botkube.k8s.ExternalDocumentationV1Beta1 | *No description.* | +| format | string | format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:. | +| id | string | *No description.* | +| items | any | *No description.* | +| maximum | number | *No description.* | +| maxItems | number | *No description.* | +| maxLength | number | *No description.* | +| maxProperties | number | *No description.* | +| minimum | number | *No description.* | +| minItems | number | *No description.* | +| minLength | number | *No description.* | +| minProperties | number | *No description.* | +| multipleOf | number | *No description.* | +| not | @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1 | *No description.* | +| nullable | boolean | *No description.* | +| oneOf | @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1[] | *No description.* | +| pattern | string | *No description.* | +| patternProperties | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1} | *No description.* | +| properties | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1} | *No description.* | +| ref | string | *No description.* | +| required | string[] | *No description.* | +| schema | string | *No description.* | +| title | string | *No description.* | +| type | string | *No description.* | +| uniqueItems | boolean | *No description.* | +| xKubernetesEmbeddedResource | boolean | x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata). | +| xKubernetesIntOrString | boolean | x-kubernetes-int-or-string specifies that this value is either an integer or a string. | +| xKubernetesListMapKeys | string[] | x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. | +| xKubernetesListType | string | x-kubernetes-list-type annotates an array to further describe its topology. | +| xKubernetesMapType | string | x-kubernetes-map-type annotates an object to further describe its topology. | +| xKubernetesPreserveUnknownFields | boolean | x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. | + +--- + +##### `additionalItems`Optional + +```typescript +public readonly additionalItems: any; +``` + +- *Type:* any + +--- + +##### `additionalProperties`Optional + +```typescript +public readonly additionalProperties: any; +``` + +- *Type:* any + +--- + +##### `allOf`Optional + +```typescript +public readonly allOf: JsonSchemaPropsV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1[] + +--- + +##### `anyOf`Optional + +```typescript +public readonly anyOf: JsonSchemaPropsV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1[] + +--- + +##### `default`Optional + +```typescript +public readonly default: any; +``` + +- *Type:* any + +default is a default value for undefined object fields. + +Defaulting is a beta feature under the CustomResourceDefaulting feature gate. CustomResourceDefinitions with defaults must be created using the v1 (or newer) CustomResourceDefinition API. + +--- + +##### `definitions`Optional + +```typescript +public readonly definitions: {[ key: string ]: JsonSchemaPropsV1Beta1}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1} + +--- + +##### `dependencies`Optional + +```typescript +public readonly dependencies: {[ key: string ]: any}; +``` + +- *Type:* {[ key: string ]: any} + +--- + +##### `description`Optional + +```typescript +public readonly description: string; +``` + +- *Type:* string + +--- + +##### `enum`Optional + +```typescript +public readonly enum: any[]; +``` + +- *Type:* any[] + +--- + +##### `example`Optional + +```typescript +public readonly example: any; +``` + +- *Type:* any + +--- + +##### `exclusiveMaximum`Optional + +```typescript +public readonly exclusiveMaximum: boolean; +``` + +- *Type:* boolean + +--- + +##### `exclusiveMinimum`Optional + +```typescript +public readonly exclusiveMinimum: boolean; +``` + +- *Type:* boolean + +--- + +##### `externalDocs`Optional + +```typescript +public readonly externalDocs: ExternalDocumentationV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ExternalDocumentationV1Beta1 + +--- + +##### `format`Optional + +```typescript +public readonly format: string; +``` + +- *Type:* string + +format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated:. + +bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339. + +--- + +##### `id`Optional + +```typescript +public readonly id: string; +``` + +- *Type:* string + +--- + +##### `items`Optional + +```typescript +public readonly items: any; +``` + +- *Type:* any + +--- + +##### `maximum`Optional + +```typescript +public readonly maximum: number; +``` + +- *Type:* number + +--- + +##### `maxItems`Optional + +```typescript +public readonly maxItems: number; +``` + +- *Type:* number + +--- + +##### `maxLength`Optional + +```typescript +public readonly maxLength: number; +``` + +- *Type:* number + +--- + +##### `maxProperties`Optional + +```typescript +public readonly maxProperties: number; +``` + +- *Type:* number + +--- + +##### `minimum`Optional + +```typescript +public readonly minimum: number; +``` + +- *Type:* number + +--- + +##### `minItems`Optional + +```typescript +public readonly minItems: number; +``` + +- *Type:* number + +--- + +##### `minLength`Optional + +```typescript +public readonly minLength: number; +``` + +- *Type:* number + +--- + +##### `minProperties`Optional + +```typescript +public readonly minProperties: number; +``` + +- *Type:* number + +--- + +##### `multipleOf`Optional + +```typescript +public readonly multipleOf: number; +``` + +- *Type:* number + +--- + +##### `not`Optional + +```typescript +public readonly not: JsonSchemaPropsV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1 + +--- + +##### `nullable`Optional + +```typescript +public readonly nullable: boolean; +``` + +- *Type:* boolean + +--- + +##### `oneOf`Optional + +```typescript +public readonly oneOf: JsonSchemaPropsV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1[] + +--- + +##### `pattern`Optional + +```typescript +public readonly pattern: string; +``` + +- *Type:* string + +--- + +##### `patternProperties`Optional + +```typescript +public readonly patternProperties: {[ key: string ]: JsonSchemaPropsV1Beta1}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1} + +--- + +##### `properties`Optional + +```typescript +public readonly properties: {[ key: string ]: JsonSchemaPropsV1Beta1}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.JsonSchemaPropsV1Beta1} + +--- + +##### `ref`Optional + +```typescript +public readonly ref: string; +``` + +- *Type:* string + +--- + +##### `required`Optional + +```typescript +public readonly required: string[]; +``` + +- *Type:* string[] + +--- + +##### `schema`Optional + +```typescript +public readonly schema: string; +``` + +- *Type:* string + +--- + +##### `title`Optional + +```typescript +public readonly title: string; +``` + +- *Type:* string + +--- + +##### `type`Optional + +```typescript +public readonly type: string; +``` + +- *Type:* string + +--- + +##### `uniqueItems`Optional + +```typescript +public readonly uniqueItems: boolean; +``` + +- *Type:* boolean + +--- + +##### `xKubernetesEmbeddedResource`Optional + +```typescript +public readonly xKubernetesEmbeddedResource: boolean; +``` + +- *Type:* boolean + +x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata). + +--- + +##### `xKubernetesIntOrString`Optional + +```typescript +public readonly xKubernetesIntOrString: boolean; +``` + +- *Type:* boolean + +x-kubernetes-int-or-string specifies that this value is either an integer or a string. + +If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns: + +1) anyOf: +- type: integer +- type: string +2) allOf: +- anyOf: +- type: integer +- type: string +- ... zero or more + +--- + +##### `xKubernetesListMapKeys`Optional + +```typescript +public readonly xKubernetesListMapKeys: string[]; +``` + +- *Type:* string[] + +x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. + +This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported). + +The properties specified must either be required or have a default value, to ensure those properties are present for all list items. + +--- + +##### `xKubernetesListType`Optional + +```typescript +public readonly xKubernetesListType: string; +``` + +- *Type:* string +- *Default:* atomic for arrays. + +x-kubernetes-list-type annotates an array to further describe its topology. + +This extension must only be used on lists and may have 3 possible values: + +1) `atomic`: the list is treated as a single entity, like a scalar. +Atomic lists will be entirely replaced when updated. This extension +may be used on any type of list (struct, scalar, ...). +2) `set`: +Sets are lists that must not have multiple items with the same value. Each +value must be a scalar, an object with x-kubernetes-map-type `atomic` or an +array with x-kubernetes-list-type `atomic`. +3) `map`: +These lists are like maps in that their elements have a non-index key +used to identify them. Order is preserved upon merge. The map tag +must only be used on a list with elements of type object. +Defaults to atomic for arrays. + +--- + +##### `xKubernetesMapType`Optional + +```typescript +public readonly xKubernetesMapType: string; +``` + +- *Type:* string + +x-kubernetes-map-type annotates an object to further describe its topology. + +This extension must only be used when type is object and may have 2 possible values: + +1) `granular`: +These maps are actual maps (key-value pairs) and each fields are independent +from each other (they can each be manipulated by separate actors). This is +the default behaviour for all maps. +2) `atomic`: the list is treated as a single entity, like a scalar. +Atomic maps will be entirely replaced when updated. + +--- + +##### `xKubernetesPreserveUnknownFields`Optional + +```typescript +public readonly xKubernetesPreserveUnknownFields: boolean; +``` + +- *Type:* boolean + +x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. + +This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden. + +--- + +### KeyToPath + +Maps a string key to a path within a volume. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const keyToPath: k8s.KeyToPath = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| key | string | The key to project. | +| path | string | The relative path of the file to map the key to. | +| mode | number | Optional: mode bits used to set permissions on this file. | + +--- + +##### `key`Required + +```typescript +public readonly key: string; +``` + +- *Type:* string + +The key to project. + +--- + +##### `path`Required + +```typescript +public readonly path: string; +``` + +- *Type:* string + +The relative path of the file to map the key to. + +May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + +--- + +##### `mode`Optional + +```typescript +public readonly mode: number; +``` + +- *Type:* number + +Optional: mode bits used to set permissions on this file. + +Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +--- + +### KubeApiServiceListProps + +APIServiceList is a list of APIService objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeApiServiceListProps: k8s.KubeApiServiceListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeApiServiceProps[] | *No description.* | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | *No description.* | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeApiServiceProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeApiServiceProps[] + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +--- + +### KubeApiServiceListV1Beta1Props + +APIServiceList is a list of APIService objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeApiServiceListV1Beta1Props: k8s.KubeApiServiceListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeApiServiceV1Beta1Props[] | *No description.* | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | *No description.* | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeApiServiceV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeApiServiceV1Beta1Props[] + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +--- + +### KubeApiServiceProps + +APIService represents a server for a particular GroupVersion. + +Name must be "version.group". + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeApiServiceProps: k8s.KubeApiServiceProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | +| spec | @smallcase/cdk8s-botkube.k8s.ApiServiceSpec | Spec contains information for locating and communicating with a server. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +##### `spec`Optional + +```typescript +public readonly spec: ApiServiceSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ApiServiceSpec + +Spec contains information for locating and communicating with a server. + +--- + +### KubeApiServiceV1Beta1Props + +APIService represents a server for a particular GroupVersion. + +Name must be "version.group". + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeApiServiceV1Beta1Props: k8s.KubeApiServiceV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | +| spec | @smallcase/cdk8s-botkube.k8s.ApiServiceSpecV1Beta1 | Spec contains information for locating and communicating with a server. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +##### `spec`Optional + +```typescript +public readonly spec: ApiServiceSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ApiServiceSpecV1Beta1 + +Spec contains information for locating and communicating with a server. + +--- + +### KubeBindingProps + +Binding ties one object to another; + +for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeBindingProps: k8s.KubeBindingProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| target | @smallcase/cdk8s-botkube.k8s.ObjectReference | The target object that you want to bind to the standard object. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | + +--- + +##### `target`Required + +```typescript +public readonly target: ObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectReference + +The target object that you want to bind to the standard object. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeCertificateSigningRequestListProps + +CertificateSigningRequestList is a collection of CertificateSigningRequest objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCertificateSigningRequestListProps: k8s.KubeCertificateSigningRequestListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestProps[] | items is a collection of CertificateSigningRequest objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | *No description.* | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeCertificateSigningRequestProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestProps[] + +items is a collection of CertificateSigningRequest objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +--- + +### KubeCertificateSigningRequestListV1Beta1Props + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCertificateSigningRequestListV1Beta1Props: k8s.KubeCertificateSigningRequestListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestV1Beta1Props[] | *No description.* | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | *No description.* | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeCertificateSigningRequestV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCertificateSigningRequestV1Beta1Props[] + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +--- + +### KubeCertificateSigningRequestProps + +CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request, and having it asynchronously approved and issued. + +Kubelets use this API to obtain: +1. client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client-kubelet" signerName). +2. serving certificates for TLS endpoints kube-apiserver can connect to securely (with the "kubernetes.io/kubelet-serving" signerName). + +This API can be used to request client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client" signerName), or to obtain certificates from custom non-Kubernetes signers. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCertificateSigningRequestProps: k8s.KubeCertificateSigningRequestProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.CertificateSigningRequestSpec | spec contains the certificate request, and is immutable after creation. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `spec`Required + +```typescript +public readonly spec: CertificateSigningRequestSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CertificateSigningRequestSpec + +spec contains the certificate request, and is immutable after creation. + +Only the request, signerName, and usages fields can be set on creation. Other fields are derived by Kubernetes and cannot be modified by users. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeCertificateSigningRequestV1Beta1Props + +Describes a certificate signing request. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCertificateSigningRequestV1Beta1Props: k8s.KubeCertificateSigningRequestV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | +| spec | @smallcase/cdk8s-botkube.k8s.CertificateSigningRequestSpecV1Beta1 | The certificate request itself and any additional information. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +##### `spec`Optional + +```typescript +public readonly spec: CertificateSigningRequestSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CertificateSigningRequestSpecV1Beta1 + +The certificate request itself and any additional information. + +--- + +### KubeClusterRoleBindingListProps + +ClusterRoleBindingList is a collection of ClusterRoleBindings. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeClusterRoleBindingListProps: k8s.KubeClusterRoleBindingListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingProps[] | Items is a list of ClusterRoleBindings. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeClusterRoleBindingProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingProps[] + +Items is a list of ClusterRoleBindings. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +--- + +### KubeClusterRoleBindingListV1Alpha1Props + +ClusterRoleBindingList is a collection of ClusterRoleBindings. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBindings, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeClusterRoleBindingListV1Alpha1Props: k8s.KubeClusterRoleBindingListV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingV1Alpha1Props[] | Items is a list of ClusterRoleBindings. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeClusterRoleBindingV1Alpha1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingV1Alpha1Props[] + +Items is a list of ClusterRoleBindings. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +--- + +### KubeClusterRoleBindingListV1Beta1Props + +ClusterRoleBindingList is a collection of ClusterRoleBindings. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBindingList, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeClusterRoleBindingListV1Beta1Props: k8s.KubeClusterRoleBindingListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingV1Beta1Props[] | Items is a list of ClusterRoleBindings. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeClusterRoleBindingV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleBindingV1Beta1Props[] + +Items is a list of ClusterRoleBindings. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +--- + +### KubeClusterRoleBindingProps + +ClusterRoleBinding references a ClusterRole, but not contain it. + +It can reference a ClusterRole in the global namespace, and adds who information via Subject. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeClusterRoleBindingProps: k8s.KubeClusterRoleBindingProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| roleRef | @smallcase/cdk8s-botkube.k8s.RoleRef | RoleRef can only reference a ClusterRole in the global namespace. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| subjects | @smallcase/cdk8s-botkube.k8s.Subject[] | Subjects holds references to the objects the role applies to. | + +--- + +##### `roleRef`Required + +```typescript +public readonly roleRef: RoleRef; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RoleRef + +RoleRef can only reference a ClusterRole in the global namespace. + +If the RoleRef cannot be resolved, the Authorizer must return an error. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +--- + +##### `subjects`Optional + +```typescript +public readonly subjects: Subject[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Subject[] + +Subjects holds references to the objects the role applies to. + +--- + +### KubeClusterRoleBindingV1Alpha1Props + +ClusterRoleBinding references a ClusterRole, but not contain it. + +It can reference a ClusterRole in the global namespace, and adds who information via Subject. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBinding, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeClusterRoleBindingV1Alpha1Props: k8s.KubeClusterRoleBindingV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| roleRef | @smallcase/cdk8s-botkube.k8s.RoleRefV1Alpha1 | RoleRef can only reference a ClusterRole in the global namespace. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| subjects | @smallcase/cdk8s-botkube.k8s.SubjectV1Alpha1[] | Subjects holds references to the objects the role applies to. | + +--- + +##### `roleRef`Required + +```typescript +public readonly roleRef: RoleRefV1Alpha1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RoleRefV1Alpha1 + +RoleRef can only reference a ClusterRole in the global namespace. + +If the RoleRef cannot be resolved, the Authorizer must return an error. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +--- + +##### `subjects`Optional + +```typescript +public readonly subjects: SubjectV1Alpha1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SubjectV1Alpha1[] + +Subjects holds references to the objects the role applies to. + +--- + +### KubeClusterRoleBindingV1Beta1Props + +ClusterRoleBinding references a ClusterRole, but not contain it. + +It can reference a ClusterRole in the global namespace, and adds who information via Subject. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBinding, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeClusterRoleBindingV1Beta1Props: k8s.KubeClusterRoleBindingV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| roleRef | @smallcase/cdk8s-botkube.k8s.RoleRefV1Beta1 | RoleRef can only reference a ClusterRole in the global namespace. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| subjects | @smallcase/cdk8s-botkube.k8s.SubjectV1Beta1[] | Subjects holds references to the objects the role applies to. | + +--- + +##### `roleRef`Required + +```typescript +public readonly roleRef: RoleRefV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RoleRefV1Beta1 + +RoleRef can only reference a ClusterRole in the global namespace. + +If the RoleRef cannot be resolved, the Authorizer must return an error. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +--- + +##### `subjects`Optional + +```typescript +public readonly subjects: SubjectV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SubjectV1Beta1[] + +Subjects holds references to the objects the role applies to. + +--- + +### KubeClusterRoleListProps + +ClusterRoleList is a collection of ClusterRoles. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeClusterRoleListProps: k8s.KubeClusterRoleListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleProps[] | Items is a list of ClusterRoles. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeClusterRoleProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleProps[] + +Items is a list of ClusterRoles. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +--- + +### KubeClusterRoleListV1Alpha1Props + +ClusterRoleList is a collection of ClusterRoles. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoles, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeClusterRoleListV1Alpha1Props: k8s.KubeClusterRoleListV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleV1Alpha1Props[] | Items is a list of ClusterRoles. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeClusterRoleV1Alpha1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleV1Alpha1Props[] + +Items is a list of ClusterRoles. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +--- + +### KubeClusterRoleListV1Beta1Props + +ClusterRoleList is a collection of ClusterRoles. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoles, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeClusterRoleListV1Beta1Props: k8s.KubeClusterRoleListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeClusterRoleV1Beta1Props[] | Items is a list of ClusterRoles. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeClusterRoleV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeClusterRoleV1Beta1Props[] + +Items is a list of ClusterRoles. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +--- + +### KubeClusterRoleProps + +ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeClusterRoleProps: k8s.KubeClusterRoleProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| aggregationRule | @smallcase/cdk8s-botkube.k8s.AggregationRule | AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| rules | @smallcase/cdk8s-botkube.k8s.PolicyRule[] | Rules holds all the PolicyRules for this ClusterRole. | + +--- + +##### `aggregationRule`Optional + +```typescript +public readonly aggregationRule: AggregationRule; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.AggregationRule + +AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. + +If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +--- + +##### `rules`Optional + +```typescript +public readonly rules: PolicyRule[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PolicyRule[] + +Rules holds all the PolicyRules for this ClusterRole. + +--- + +### KubeClusterRoleV1Alpha1Props + +ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRole, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeClusterRoleV1Alpha1Props: k8s.KubeClusterRoleV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| aggregationRule | @smallcase/cdk8s-botkube.k8s.AggregationRuleV1Alpha1 | AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| rules | @smallcase/cdk8s-botkube.k8s.PolicyRuleV1Alpha1[] | Rules holds all the PolicyRules for this ClusterRole. | + +--- + +##### `aggregationRule`Optional + +```typescript +public readonly aggregationRule: AggregationRuleV1Alpha1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.AggregationRuleV1Alpha1 + +AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. + +If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +--- + +##### `rules`Optional + +```typescript +public readonly rules: PolicyRuleV1Alpha1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PolicyRuleV1Alpha1[] + +Rules holds all the PolicyRules for this ClusterRole. + +--- + +### KubeClusterRoleV1Beta1Props + +ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRole, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeClusterRoleV1Beta1Props: k8s.KubeClusterRoleV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| aggregationRule | @smallcase/cdk8s-botkube.k8s.AggregationRuleV1Beta1 | AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| rules | @smallcase/cdk8s-botkube.k8s.PolicyRuleV1Beta1[] | Rules holds all the PolicyRules for this ClusterRole. | + +--- + +##### `aggregationRule`Optional + +```typescript +public readonly aggregationRule: AggregationRuleV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.AggregationRuleV1Beta1 + +AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. + +If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +--- + +##### `rules`Optional + +```typescript +public readonly rules: PolicyRuleV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PolicyRuleV1Beta1[] + +Rules holds all the PolicyRules for this ClusterRole. + +--- + +### KubeComponentStatusListProps + +Status of all the conditions for the component as a list of ComponentStatus objects. + +Deprecated: This API is deprecated in v1.19+ + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeComponentStatusListProps: k8s.KubeComponentStatusListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeComponentStatusProps[] | List of ComponentStatus objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeComponentStatusProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeComponentStatusProps[] + +List of ComponentStatus objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeComponentStatusProps + +ComponentStatus (and ComponentStatusList) holds the cluster validation info. + +Deprecated: This API is deprecated in v1.19+ + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeComponentStatusProps: k8s.KubeComponentStatusProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| conditions | @smallcase/cdk8s-botkube.k8s.ComponentCondition[] | List of component conditions observed. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | + +--- + +##### `conditions`Optional + +```typescript +public readonly conditions: ComponentCondition[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ComponentCondition[] + +List of component conditions observed. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeConfigMapListProps + +ConfigMapList is a resource containing a list of ConfigMap objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeConfigMapListProps: k8s.KubeConfigMapListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeConfigMapProps[] | Items is the list of ConfigMaps. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeConfigMapProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeConfigMapProps[] + +Items is the list of ConfigMaps. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubeConfigMapProps + +ConfigMap holds configuration data for pods to consume. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeConfigMapProps: k8s.KubeConfigMapProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| binaryData | {[ key: string ]: string} | BinaryData contains the binary data. | +| data | {[ key: string ]: string} | Data contains the configuration data. | +| immutable | boolean | Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | + +--- + +##### `binaryData`Optional + +```typescript +public readonly binaryData: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +BinaryData contains the binary data. + +Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet. + +--- + +##### `data`Optional + +```typescript +public readonly data: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +Data contains the configuration data. + +Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process. + +--- + +##### `immutable`Optional + +```typescript +public readonly immutable: boolean; +``` + +- *Type:* boolean + +Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). + +If not set to true, the field can be modified at any time. Defaulted to nil. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeControllerRevisionListProps + +ControllerRevisionList is a resource containing a list of ControllerRevision objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeControllerRevisionListProps: k8s.KubeControllerRevisionListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeControllerRevisionProps[] | Items is the list of ControllerRevisions. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeControllerRevisionProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeControllerRevisionProps[] + +Items is the list of ControllerRevisions. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubeControllerRevisionProps + +ControllerRevision implements an immutable snapshot of state data. + +Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeControllerRevisionProps: k8s.KubeControllerRevisionProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| revision | number | Revision indicates the revision of the state represented by Data. | +| data | any | Data is the serialized representation of the state. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | + +--- + +##### `revision`Required + +```typescript +public readonly revision: number; +``` + +- *Type:* number + +Revision indicates the revision of the state represented by Data. + +--- + +##### `data`Optional + +```typescript +public readonly data: any; +``` + +- *Type:* any + +Data is the serialized representation of the state. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeCronJobListProps + +CronJobList is a collection of cron jobs. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCronJobListProps: k8s.KubeCronJobListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeCronJobProps[] | items is the list of CronJobs. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeCronJobProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCronJobProps[] + +items is the list of CronJobs. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeCronJobListV1Beta1Props + +CronJobList is a collection of cron jobs. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCronJobListV1Beta1Props: k8s.KubeCronJobListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeCronJobV1Beta1Props[] | items is the list of CronJobs. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeCronJobV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCronJobV1Beta1Props[] + +items is the list of CronJobs. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeCronJobProps + +CronJob represents the configuration of a single cron job. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCronJobProps: k8s.KubeCronJobProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.CronJobSpec | Specification of the desired behavior of a cron job, including the schedule. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: CronJobSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CronJobSpec + +Specification of the desired behavior of a cron job, including the schedule. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeCronJobV1Beta1Props + +CronJob represents the configuration of a single cron job. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCronJobV1Beta1Props: k8s.KubeCronJobV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.CronJobSpecV1Beta1 | Specification of the desired behavior of a cron job, including the schedule. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: CronJobSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CronJobSpecV1Beta1 + +Specification of the desired behavior of a cron job, including the schedule. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeCsiDriverListProps + +CSIDriverList is a collection of CSIDriver objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCsiDriverListProps: k8s.KubeCsiDriverListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeCsiDriverProps[] | items is the list of CSIDriver. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeCsiDriverProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiDriverProps[] + +items is the list of CSIDriver. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubeCsiDriverListV1Beta1Props + +CSIDriverList is a collection of CSIDriver objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCsiDriverListV1Beta1Props: k8s.KubeCsiDriverListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeCsiDriverV1Beta1Props[] | items is the list of CSIDriver. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeCsiDriverV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiDriverV1Beta1Props[] + +items is the list of CSIDriver. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubeCsiDriverProps + +CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. + +Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCsiDriverProps: k8s.KubeCsiDriverProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.CsiDriverSpec | Specification of the CSI Driver. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object metadata. | + +--- + +##### `spec`Required + +```typescript +public readonly spec: CsiDriverSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CsiDriverSpec + +Specification of the CSI Driver. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object metadata. + +metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeCsiDriverV1Beta1Props + +CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. + +CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCsiDriverV1Beta1Props: k8s.KubeCsiDriverV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.CsiDriverSpecV1Beta1 | Specification of the CSI Driver. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object metadata. | + +--- + +##### `spec`Required + +```typescript +public readonly spec: CsiDriverSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CsiDriverSpecV1Beta1 + +Specification of the CSI Driver. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object metadata. + +metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeCsiNodeListProps + +CSINodeList is a collection of CSINode objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCsiNodeListProps: k8s.KubeCsiNodeListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeCsiNodeProps[] | items is the list of CSINode. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeCsiNodeProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiNodeProps[] + +items is the list of CSINode. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubeCsiNodeListV1Beta1Props + +CSINodeList is a collection of CSINode objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCsiNodeListV1Beta1Props: k8s.KubeCsiNodeListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeCsiNodeV1Beta1Props[] | items is the list of CSINode. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeCsiNodeV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiNodeV1Beta1Props[] + +items is the list of CSINode. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubeCsiNodeProps + +CSINode holds information about all CSI drivers installed on a node. + +CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCsiNodeProps: k8s.KubeCsiNodeProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.CsiNodeSpec | spec is the specification of CSINode. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | metadata.name must be the Kubernetes node name. | + +--- + +##### `spec`Required + +```typescript +public readonly spec: CsiNodeSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CsiNodeSpec + +spec is the specification of CSINode. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +metadata.name must be the Kubernetes node name. + +--- + +### KubeCsiNodeV1Beta1Props + +DEPRECATED - This group version of CSINode is deprecated by storage/v1/CSINode. + +See the release notes for more information. CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCsiNodeV1Beta1Props: k8s.KubeCsiNodeV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.CsiNodeSpecV1Beta1 | spec is the specification of CSINode. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | metadata.name must be the Kubernetes node name. | + +--- + +##### `spec`Required + +```typescript +public readonly spec: CsiNodeSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CsiNodeSpecV1Beta1 + +spec is the specification of CSINode. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +metadata.name must be the Kubernetes node name. + +--- + +### KubeCsiStorageCapacityListV1Alpha1Props + +CSIStorageCapacityList is a collection of CSIStorageCapacity objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCsiStorageCapacityListV1Alpha1Props: k8s.KubeCsiStorageCapacityListV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityV1Alpha1Props[] | Items is the list of CSIStorageCapacity objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeCsiStorageCapacityV1Alpha1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityV1Alpha1Props[] + +Items is the list of CSIStorageCapacity objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubeCsiStorageCapacityListV1Beta1Props + +CSIStorageCapacityList is a collection of CSIStorageCapacity objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCsiStorageCapacityListV1Beta1Props: k8s.KubeCsiStorageCapacityListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityV1Beta1Props[] | Items is the list of CSIStorageCapacity objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeCsiStorageCapacityV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCsiStorageCapacityV1Beta1Props[] + +Items is the list of CSIStorageCapacity objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubeCsiStorageCapacityV1Alpha1Props + +CSIStorageCapacity stores the result of one CSI GetCapacity call. + +For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes. + +For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123" + +The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero + +The producer of these objects can decide which approach is more suitable. + +They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCsiStorageCapacityV1Alpha1Props: k8s.KubeCsiStorageCapacityV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| storageClassName | string | The name of the StorageClass that the reported capacity applies to. | +| capacity | @smallcase/cdk8s-botkube.k8s.Quantity | Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. | +| maximumVolumeSize | @smallcase/cdk8s-botkube.k8s.Quantity | MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| nodeTopology | @smallcase/cdk8s-botkube.k8s.LabelSelector | NodeTopology defines which nodes have access to the storage for which capacity was reported. | + +--- + +##### `storageClassName`Required + +```typescript +public readonly storageClassName: string; +``` + +- *Type:* string + +The name of the StorageClass that the reported capacity applies to. + +It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable. + +--- + +##### `capacity`Optional + +```typescript +public readonly capacity: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. + +The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity. + +--- + +##### `maximumVolumeSize`Optional + +```typescript +public readonly maximumVolumeSize: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. + +This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-, a generated name, or a reverse-domain name which ends with the unique CSI driver name. + +Objects are namespaced. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `nodeTopology`Optional + +```typescript +public readonly nodeTopology: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +NodeTopology defines which nodes have access to the storage for which capacity was reported. + +If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable. + +--- + +### KubeCsiStorageCapacityV1Beta1Props + +CSIStorageCapacity stores the result of one CSI GetCapacity call. + +For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes. + +For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123" + +The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero + +The producer of these objects can decide which approach is more suitable. + +They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCsiStorageCapacityV1Beta1Props: k8s.KubeCsiStorageCapacityV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| storageClassName | string | The name of the StorageClass that the reported capacity applies to. | +| capacity | @smallcase/cdk8s-botkube.k8s.Quantity | Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. | +| maximumVolumeSize | @smallcase/cdk8s-botkube.k8s.Quantity | MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| nodeTopology | @smallcase/cdk8s-botkube.k8s.LabelSelector | NodeTopology defines which nodes have access to the storage for which capacity was reported. | + +--- + +##### `storageClassName`Required + +```typescript +public readonly storageClassName: string; +``` + +- *Type:* string + +The name of the StorageClass that the reported capacity applies to. + +It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable. + +--- + +##### `capacity`Optional + +```typescript +public readonly capacity: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. + +The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity. + +--- + +##### `maximumVolumeSize`Optional + +```typescript +public readonly maximumVolumeSize: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. + +This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-, a generated name, or a reverse-domain name which ends with the unique CSI driver name. + +Objects are namespaced. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `nodeTopology`Optional + +```typescript +public readonly nodeTopology: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +NodeTopology defines which nodes have access to the storage for which capacity was reported. + +If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable. + +--- + +### KubeCustomResourceDefinitionListProps + +CustomResourceDefinitionList is a list of CustomResourceDefinition objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCustomResourceDefinitionListProps: k8s.KubeCustomResourceDefinitionListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionProps[] | items list individual CustomResourceDefinition objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | *No description.* | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeCustomResourceDefinitionProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionProps[] + +items list individual CustomResourceDefinition objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +--- + +### KubeCustomResourceDefinitionListV1Beta1Props + +CustomResourceDefinitionList is a list of CustomResourceDefinition objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCustomResourceDefinitionListV1Beta1Props: k8s.KubeCustomResourceDefinitionListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionV1Beta1Props[] | items list individual CustomResourceDefinition objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | *No description.* | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeCustomResourceDefinitionV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeCustomResourceDefinitionV1Beta1Props[] + +items list individual CustomResourceDefinition objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +--- + +### KubeCustomResourceDefinitionProps + +CustomResourceDefinition represents a resource that should be exposed on the API server. + +Its name MUST be in the format <.spec.name>.<.spec.group>. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCustomResourceDefinitionProps: k8s.KubeCustomResourceDefinitionProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.CustomResourceDefinitionSpec | spec describes how the user wants the resources to appear. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `spec`Required + +```typescript +public readonly spec: CustomResourceDefinitionSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceDefinitionSpec + +spec describes how the user wants the resources to appear. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeCustomResourceDefinitionV1Beta1Props + +CustomResourceDefinition represents a resource that should be exposed on the API server. + +Its name MUST be in the format <.spec.name>.<.spec.group>. Deprecated in v1.16, planned for removal in v1.22. Use apiextensions.k8s.io/v1 CustomResourceDefinition instead. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeCustomResourceDefinitionV1Beta1Props: k8s.KubeCustomResourceDefinitionV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.CustomResourceDefinitionSpecV1Beta1 | spec describes how the user wants the resources to appear. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `spec`Required + +```typescript +public readonly spec: CustomResourceDefinitionSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CustomResourceDefinitionSpecV1Beta1 + +spec describes how the user wants the resources to appear. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeDaemonSetListProps + +DaemonSetList is a collection of daemon sets. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeDaemonSetListProps: k8s.KubeDaemonSetListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeDaemonSetProps[] | A list of daemon sets. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeDaemonSetProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeDaemonSetProps[] + +A list of daemon sets. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeDaemonSetProps + +DaemonSet represents the configuration of a daemon set. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeDaemonSetProps: k8s.KubeDaemonSetProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.DaemonSetSpec | The desired behavior of this daemon set. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: DaemonSetSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.DaemonSetSpec + +The desired behavior of this daemon set. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeDeploymentListProps + +DeploymentList is a list of Deployments. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeDeploymentListProps: k8s.KubeDeploymentListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeDeploymentProps[] | Items is the list of Deployments. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeDeploymentProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeDeploymentProps[] + +Items is the list of Deployments. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +--- + +### KubeDeploymentProps + +Deployment enables declarative updates for Pods and ReplicaSets. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeDeploymentProps: k8s.KubeDeploymentProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.DeploymentSpec | Specification of the desired behavior of the Deployment. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object metadata. + +--- + +##### `spec`Optional + +```typescript +public readonly spec: DeploymentSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.DeploymentSpec + +Specification of the desired behavior of the Deployment. + +--- + +### KubeEndpointSliceListProps + +EndpointSliceList represents a list of endpoint slices. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeEndpointSliceListProps: k8s.KubeEndpointSliceListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceProps[] | List of endpoint slices. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeEndpointSliceProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceProps[] + +List of endpoint slices. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +--- + +### KubeEndpointSliceListV1Beta1Props + +EndpointSliceList represents a list of endpoint slices. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeEndpointSliceListV1Beta1Props: k8s.KubeEndpointSliceListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceV1Beta1Props[] | List of endpoint slices. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeEndpointSliceV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointSliceV1Beta1Props[] + +List of endpoint slices. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +--- + +### KubeEndpointSliceProps + +EndpointSlice represents a subset of the endpoints that implement a service. + +For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeEndpointSliceProps: k8s.KubeEndpointSliceProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| addressType | string | addressType specifies the type of address carried by this EndpointSlice. | +| endpoints | @smallcase/cdk8s-botkube.k8s.Endpoint[] | endpoints is a list of unique endpoints in this slice. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| ports | @smallcase/cdk8s-botkube.k8s.EndpointPort[] | ports specifies the list of network ports exposed by each endpoint in this slice. | + +--- + +##### `addressType`Required + +```typescript +public readonly addressType: string; +``` + +- *Type:* string + +addressType specifies the type of address carried by this EndpointSlice. + +All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name. + +--- + +##### `endpoints`Required + +```typescript +public readonly endpoints: Endpoint[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Endpoint[] + +endpoints is a list of unique endpoints in this slice. + +Each slice may include a maximum of 1000 endpoints. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +--- + +##### `ports`Optional + +```typescript +public readonly ports: EndpointPort[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EndpointPort[] + +ports specifies the list of network ports exposed by each endpoint in this slice. + +Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports. + +--- + +### KubeEndpointSliceV1Beta1Props + +EndpointSlice represents a subset of the endpoints that implement a service. + +For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeEndpointSliceV1Beta1Props: k8s.KubeEndpointSliceV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| addressType | string | addressType specifies the type of address carried by this EndpointSlice. | +| endpoints | @smallcase/cdk8s-botkube.k8s.EndpointV1Beta1[] | endpoints is a list of unique endpoints in this slice. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| ports | @smallcase/cdk8s-botkube.k8s.EndpointPortV1Beta1[] | ports specifies the list of network ports exposed by each endpoint in this slice. | + +--- + +##### `addressType`Required + +```typescript +public readonly addressType: string; +``` + +- *Type:* string + +addressType specifies the type of address carried by this EndpointSlice. + +All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name. + +--- + +##### `endpoints`Required + +```typescript +public readonly endpoints: EndpointV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EndpointV1Beta1[] + +endpoints is a list of unique endpoints in this slice. + +Each slice may include a maximum of 1000 endpoints. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +--- + +##### `ports`Optional + +```typescript +public readonly ports: EndpointPortV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EndpointPortV1Beta1[] + +ports specifies the list of network ports exposed by each endpoint in this slice. + +Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports. + +--- + +### KubeEndpointsListProps + +EndpointsList is a list of endpoints. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeEndpointsListProps: k8s.KubeEndpointsListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeEndpointsProps[] | List of endpoints. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeEndpointsProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEndpointsProps[] + +List of endpoints. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeEndpointsProps + +Endpoints is a collection of endpoints that implement the actual service. + +Example: +Name: "mysvc", +Subsets: [ +{ +Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], +Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] +}, +{ +Addresses: [{"ip": "10.10.3.3"}], +Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] +}, +] + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeEndpointsProps: k8s.KubeEndpointsProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| subsets | @smallcase/cdk8s-botkube.k8s.EndpointSubset[] | The set of all endpoints is the union of all subsets. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `subsets`Optional + +```typescript +public readonly subsets: EndpointSubset[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EndpointSubset[] + +The set of all endpoints is the union of all subsets. + +Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. + +--- + +### KubeEphemeralContainersProps + +A list of ephemeral containers used with the Pod ephemeralcontainers subresource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeEphemeralContainersProps: k8s.KubeEphemeralContainersProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ephemeralContainers | @smallcase/cdk8s-botkube.k8s.EphemeralContainer[] | A list of ephemeral containers associated with this pod. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `ephemeralContainers`Required + +```typescript +public readonly ephemeralContainers: EphemeralContainer[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EphemeralContainer[] + +A list of ephemeral containers associated with this pod. + +New ephemeral containers may be appended to this list, but existing ephemeral containers may not be removed or modified. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeEventListProps + +EventList is a list of Event objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeEventListProps: k8s.KubeEventListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeEventProps[] | items is a list of schema objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeEventProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEventProps[] + +items is a list of schema objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeEventListV1Beta1Props + +EventList is a list of Event objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeEventListV1Beta1Props: k8s.KubeEventListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeEventV1Beta1Props[] | items is a list of schema objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeEventV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeEventV1Beta1Props[] + +items is a list of schema objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeEventProps + +Event is a report of an event somewhere in the cluster. + +It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeEventProps: k8s.KubeEventProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| eventTime | Date | eventTime is the time when this Event was first observed. | +| action | string | action is what action was taken/failed regarding to the regarding object. | +| deprecatedCount | number | deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. | +| deprecatedFirstTimestamp | Date | deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. | +| deprecatedLastTimestamp | Date | deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. | +| deprecatedSource | @smallcase/cdk8s-botkube.k8s.EventSource | deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| note | string | note is a human-readable description of the status of this operation. | +| reason | string | reason is why the action was taken. | +| regarding | @smallcase/cdk8s-botkube.k8s.ObjectReference | regarding contains the object this Event is about. | +| related | @smallcase/cdk8s-botkube.k8s.ObjectReference | related is the optional secondary object for more complex actions. | +| reportingController | string | reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events. | +| reportingInstance | string | reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters. | +| series | @smallcase/cdk8s-botkube.k8s.EventSeries | series is data about the Event series this event represents or nil if it's a singleton Event. | +| type | string | type is the type of this event (Normal, Warning), new types could be added in the future. | + +--- + +##### `eventTime`Required + +```typescript +public readonly eventTime: Date; +``` + +- *Type:* Date + +eventTime is the time when this Event was first observed. + +It is required. + +--- + +##### `action`Optional + +```typescript +public readonly action: string; +``` + +- *Type:* string + +action is what action was taken/failed regarding to the regarding object. + +It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters. + +--- + +##### `deprecatedCount`Optional + +```typescript +public readonly deprecatedCount: number; +``` + +- *Type:* number + +deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. + +--- + +##### `deprecatedFirstTimestamp`Optional + +```typescript +public readonly deprecatedFirstTimestamp: Date; +``` + +- *Type:* Date + +deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. + +--- + +##### `deprecatedLastTimestamp`Optional + +```typescript +public readonly deprecatedLastTimestamp: Date; +``` + +- *Type:* Date + +deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. + +--- + +##### `deprecatedSource`Optional + +```typescript +public readonly deprecatedSource: EventSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EventSource + +deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `note`Optional + +```typescript +public readonly note: string; +``` + +- *Type:* string + +note is a human-readable description of the status of this operation. + +Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB. + +--- + +##### `reason`Optional + +```typescript +public readonly reason: string; +``` + +- *Type:* string + +reason is why the action was taken. + +It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters. + +--- + +##### `regarding`Optional + +```typescript +public readonly regarding: ObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectReference + +regarding contains the object this Event is about. + +In most cases it's an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object. + +--- + +##### `related`Optional + +```typescript +public readonly related: ObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectReference + +related is the optional secondary object for more complex actions. + +E.g. when regarding object triggers a creation or deletion of related object. + +--- + +##### `reportingController`Optional + +```typescript +public readonly reportingController: string; +``` + +- *Type:* string + +reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events. + +--- + +##### `reportingInstance`Optional + +```typescript +public readonly reportingInstance: string; +``` + +- *Type:* string + +reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters. + +--- + +##### `series`Optional + +```typescript +public readonly series: EventSeries; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EventSeries + +series is data about the Event series this event represents or nil if it's a singleton Event. + +--- + +##### `type`Optional + +```typescript +public readonly type: string; +``` + +- *Type:* string + +type is the type of this event (Normal, Warning), new types could be added in the future. + +It is machine-readable. This field cannot be empty for new Events. + +--- + +### KubeEventV1Beta1Props + +Event is a report of an event somewhere in the cluster. + +It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeEventV1Beta1Props: k8s.KubeEventV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| eventTime | Date | eventTime is the time when this Event was first observed. | +| action | string | action is what action was taken/failed regarding to the regarding object. | +| deprecatedCount | number | deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. | +| deprecatedFirstTimestamp | Date | deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. | +| deprecatedLastTimestamp | Date | deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. | +| deprecatedSource | @smallcase/cdk8s-botkube.k8s.EventSource | deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| note | string | note is a human-readable description of the status of this operation. | +| reason | string | reason is why the action was taken. | +| regarding | @smallcase/cdk8s-botkube.k8s.ObjectReference | regarding contains the object this Event is about. | +| related | @smallcase/cdk8s-botkube.k8s.ObjectReference | related is the optional secondary object for more complex actions. | +| reportingController | string | reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events. | +| reportingInstance | string | reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters. | +| series | @smallcase/cdk8s-botkube.k8s.EventSeriesV1Beta1 | series is data about the Event series this event represents or nil if it's a singleton Event. | +| type | string | type is the type of this event (Normal, Warning), new types could be added in the future. | + +--- + +##### `eventTime`Required + +```typescript +public readonly eventTime: Date; +``` + +- *Type:* Date + +eventTime is the time when this Event was first observed. + +It is required. + +--- + +##### `action`Optional + +```typescript +public readonly action: string; +``` + +- *Type:* string + +action is what action was taken/failed regarding to the regarding object. + +It is machine-readable. This field can have at most 128 characters. + +--- + +##### `deprecatedCount`Optional + +```typescript +public readonly deprecatedCount: number; +``` + +- *Type:* number + +deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. + +--- + +##### `deprecatedFirstTimestamp`Optional + +```typescript +public readonly deprecatedFirstTimestamp: Date; +``` + +- *Type:* Date + +deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. + +--- + +##### `deprecatedLastTimestamp`Optional + +```typescript +public readonly deprecatedLastTimestamp: Date; +``` + +- *Type:* Date + +deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. + +--- + +##### `deprecatedSource`Optional + +```typescript +public readonly deprecatedSource: EventSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EventSource + +deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `note`Optional + +```typescript +public readonly note: string; +``` + +- *Type:* string + +note is a human-readable description of the status of this operation. + +Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB. + +--- + +##### `reason`Optional + +```typescript +public readonly reason: string; +``` + +- *Type:* string + +reason is why the action was taken. + +It is human-readable. This field can have at most 128 characters. + +--- + +##### `regarding`Optional + +```typescript +public readonly regarding: ObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectReference + +regarding contains the object this Event is about. + +In most cases it's an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object. + +--- + +##### `related`Optional + +```typescript +public readonly related: ObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectReference + +related is the optional secondary object for more complex actions. + +E.g. when regarding object triggers a creation or deletion of related object. + +--- + +##### `reportingController`Optional + +```typescript +public readonly reportingController: string; +``` + +- *Type:* string + +reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events. + +--- + +##### `reportingInstance`Optional + +```typescript +public readonly reportingInstance: string; +``` + +- *Type:* string + +reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters. + +--- + +##### `series`Optional + +```typescript +public readonly series: EventSeriesV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EventSeriesV1Beta1 + +series is data about the Event series this event represents or nil if it's a singleton Event. + +--- + +##### `type`Optional + +```typescript +public readonly type: string; +``` + +- *Type:* string + +type is the type of this event (Normal, Warning), new types could be added in the future. + +It is machine-readable. + +--- + +### KubeEvictionV1Beta1Props + +Eviction evicts a pod from its node subject to certain policies and safety constraints. + +This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods//evictions. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeEvictionV1Beta1Props: k8s.KubeEvictionV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| deleteOptions | @smallcase/cdk8s-botkube.k8s.DeleteOptions | DeleteOptions may be provided. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | ObjectMeta describes the pod that is being evicted. | + +--- + +##### `deleteOptions`Optional + +```typescript +public readonly deleteOptions: DeleteOptions; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.DeleteOptions + +DeleteOptions may be provided. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +ObjectMeta describes the pod that is being evicted. + +--- + +### KubeFlowSchemaListV1Beta1Props + +FlowSchemaList is a list of FlowSchema objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeFlowSchemaListV1Beta1Props: k8s.KubeFlowSchemaListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeFlowSchemaV1Beta1Props[] | `items` is a list of FlowSchemas. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | `metadata` is the standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeFlowSchemaV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeFlowSchemaV1Beta1Props[] + +`items` is a list of FlowSchemas. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +`metadata` is the standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeFlowSchemaV1Beta1Props + +FlowSchema defines the schema of a group of flows. + +Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher". + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeFlowSchemaV1Beta1Props: k8s.KubeFlowSchemaV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | `metadata` is the standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.FlowSchemaSpecV1Beta1 | `spec` is the specification of the desired behavior of a FlowSchema. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +`metadata` is the standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: FlowSchemaSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.FlowSchemaSpecV1Beta1 + +`spec` is the specification of the desired behavior of a FlowSchema. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeHorizontalPodAutoscalerListProps + +list of horizontal pod autoscaler objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeHorizontalPodAutoscalerListProps: k8s.KubeHorizontalPodAutoscalerListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerProps[] | list of horizontal pod autoscaler objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeHorizontalPodAutoscalerProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerProps[] + +list of horizontal pod autoscaler objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +--- + +### KubeHorizontalPodAutoscalerListV2Beta1Props + +HorizontalPodAutoscaler is a list of horizontal pod autoscaler objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeHorizontalPodAutoscalerListV2Beta1Props: k8s.KubeHorizontalPodAutoscalerListV2Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerV2Beta1Props[] | items is the list of horizontal pod autoscaler objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | metadata is the standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeHorizontalPodAutoscalerV2Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerV2Beta1Props[] + +items is the list of horizontal pod autoscaler objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +metadata is the standard list metadata. + +--- + +### KubeHorizontalPodAutoscalerListV2Beta2Props + +HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeHorizontalPodAutoscalerListV2Beta2Props: k8s.KubeHorizontalPodAutoscalerListV2Beta2Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerV2Beta2Props[] | items is the list of horizontal pod autoscaler objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | metadata is the standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeHorizontalPodAutoscalerV2Beta2Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeHorizontalPodAutoscalerV2Beta2Props[] + +items is the list of horizontal pod autoscaler objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +metadata is the standard list metadata. + +--- + +### KubeHorizontalPodAutoscalerProps + +configuration of a horizontal pod autoscaler. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeHorizontalPodAutoscalerProps: k8s.KubeHorizontalPodAutoscalerProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.HorizontalPodAutoscalerSpec | behaviour of autoscaler. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: HorizontalPodAutoscalerSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HorizontalPodAutoscalerSpec + +behaviour of autoscaler. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. + +--- + +### KubeHorizontalPodAutoscalerV2Beta1Props + +HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeHorizontalPodAutoscalerV2Beta1Props: k8s.KubeHorizontalPodAutoscalerV2Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | metadata is the standard object metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.HorizontalPodAutoscalerSpecV2Beta1 | spec is the specification for the behaviour of the autoscaler. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +metadata is the standard object metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: HorizontalPodAutoscalerSpecV2Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HorizontalPodAutoscalerSpecV2Beta1 + +spec is the specification for the behaviour of the autoscaler. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. + +--- + +### KubeHorizontalPodAutoscalerV2Beta2Props + +HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeHorizontalPodAutoscalerV2Beta2Props: k8s.KubeHorizontalPodAutoscalerV2Beta2Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | metadata is the standard object metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.HorizontalPodAutoscalerSpecV2Beta2 | spec is the specification for the behaviour of the autoscaler. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +metadata is the standard object metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: HorizontalPodAutoscalerSpecV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HorizontalPodAutoscalerSpecV2Beta2 + +spec is the specification for the behaviour of the autoscaler. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. + +--- + +### KubeIngressClassListProps + +IngressClassList is a collection of IngressClasses. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeIngressClassListProps: k8s.KubeIngressClassListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeIngressClassProps[] | Items is the list of IngressClasses. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeIngressClassProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressClassProps[] + +Items is the list of IngressClasses. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +--- + +### KubeIngressClassListV1Beta1Props + +IngressClassList is a collection of IngressClasses. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeIngressClassListV1Beta1Props: k8s.KubeIngressClassListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeIngressClassV1Beta1Props[] | Items is the list of IngressClasses. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeIngressClassV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressClassV1Beta1Props[] + +Items is the list of IngressClasses. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +--- + +### KubeIngressClassProps + +IngressClass represents the class of the Ingress, referenced by the Ingress Spec. + +The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeIngressClassProps: k8s.KubeIngressClassProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.IngressClassSpec | Spec is the desired state of the IngressClass. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: IngressClassSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressClassSpec + +Spec is the desired state of the IngressClass. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeIngressClassV1Beta1Props + +IngressClass represents the class of the Ingress, referenced by the Ingress Spec. + +The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeIngressClassV1Beta1Props: k8s.KubeIngressClassV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.IngressClassSpecV1Beta1 | Spec is the desired state of the IngressClass. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: IngressClassSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressClassSpecV1Beta1 + +Spec is the desired state of the IngressClass. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeIngressListProps + +IngressList is a collection of Ingress. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeIngressListProps: k8s.KubeIngressListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeIngressProps[] | Items is the list of Ingress. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeIngressProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressProps[] + +Items is the list of Ingress. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeIngressListV1Beta1Props + +IngressList is a collection of Ingress. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeIngressListV1Beta1Props: k8s.KubeIngressListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeIngressV1Beta1Props[] | Items is the list of Ingress. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeIngressV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeIngressV1Beta1Props[] + +Items is the list of Ingress. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeIngressProps + +Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. + +An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeIngressProps: k8s.KubeIngressProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.IngressSpec | Spec is the desired state of the Ingress. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: IngressSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressSpec + +Spec is the desired state of the Ingress. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeIngressV1Beta1Props + +Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. + +An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeIngressV1Beta1Props: k8s.KubeIngressV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.IngressSpecV1Beta1 | Spec is the desired state of the Ingress. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: IngressSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IngressSpecV1Beta1 + +Spec is the desired state of the Ingress. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeJobListProps + +JobList is a collection of jobs. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeJobListProps: k8s.KubeJobListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeJobProps[] | items is the list of Jobs. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeJobProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeJobProps[] + +items is the list of Jobs. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeJobProps + +Job represents the configuration of a single job. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeJobProps: k8s.KubeJobProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.JobSpec | Specification of the desired behavior of a job. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: JobSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.JobSpec + +Specification of the desired behavior of a job. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeLeaseListProps + +LeaseList is a list of Lease objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeLeaseListProps: k8s.KubeLeaseListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeLeaseProps[] | Items is a list of schema objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeLeaseProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLeaseProps[] + +Items is a list of schema objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeLeaseListV1Beta1Props + +LeaseList is a list of Lease objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeLeaseListV1Beta1Props: k8s.KubeLeaseListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeLeaseV1Beta1Props[] | Items is a list of schema objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeLeaseV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLeaseV1Beta1Props[] + +Items is a list of schema objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeLeaseProps + +Lease defines a lease concept. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeLeaseProps: k8s.KubeLeaseProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.LeaseSpec | Specification of the Lease. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +##### `spec`Optional + +```typescript +public readonly spec: LeaseSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LeaseSpec + +Specification of the Lease. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeLeaseV1Beta1Props + +Lease defines a lease concept. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeLeaseV1Beta1Props: k8s.KubeLeaseV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.LeaseSpecV1Beta1 | Specification of the Lease. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +##### `spec`Optional + +```typescript +public readonly spec: LeaseSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LeaseSpecV1Beta1 + +Specification of the Lease. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeLimitRangeListProps + +LimitRangeList is a list of LimitRange items. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeLimitRangeListProps: k8s.KubeLimitRangeListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeLimitRangeProps[] | Items is a list of LimitRange objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeLimitRangeProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeLimitRangeProps[] + +Items is a list of LimitRange objects. + +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeLimitRangeProps + +LimitRange sets resource usage limits for each kind of resource in a Namespace. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeLimitRangeProps: k8s.KubeLimitRangeProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.LimitRangeSpec | Spec defines the limits enforced. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: LimitRangeSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LimitRangeSpec + +Spec defines the limits enforced. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeLocalSubjectAccessReviewProps + +LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. + +Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeLocalSubjectAccessReviewProps: k8s.KubeLocalSubjectAccessReviewProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.SubjectAccessReviewSpec | Spec holds information about the request being evaluated. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `spec`Required + +```typescript +public readonly spec: SubjectAccessReviewSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SubjectAccessReviewSpec + +Spec holds information about the request being evaluated. + +spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeLocalSubjectAccessReviewV1Beta1Props + +LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. + +Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeLocalSubjectAccessReviewV1Beta1Props: k8s.KubeLocalSubjectAccessReviewV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.SubjectAccessReviewSpecV1Beta1 | Spec holds information about the request being evaluated. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `spec`Required + +```typescript +public readonly spec: SubjectAccessReviewSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SubjectAccessReviewSpecV1Beta1 + +Spec holds information about the request being evaluated. + +spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeMutatingWebhookConfigurationListProps + +MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeMutatingWebhookConfigurationListProps: k8s.KubeMutatingWebhookConfigurationListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationProps[] | List of MutatingWebhookConfiguration. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeMutatingWebhookConfigurationProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationProps[] + +List of MutatingWebhookConfiguration. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeMutatingWebhookConfigurationListV1Beta1Props + +MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeMutatingWebhookConfigurationListV1Beta1Props: k8s.KubeMutatingWebhookConfigurationListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationV1Beta1Props[] | List of MutatingWebhookConfiguration. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeMutatingWebhookConfigurationV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeMutatingWebhookConfigurationV1Beta1Props[] + +List of MutatingWebhookConfiguration. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeMutatingWebhookConfigurationProps + +MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeMutatingWebhookConfigurationProps: k8s.KubeMutatingWebhookConfigurationProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object metadata; | +| webhooks | @smallcase/cdk8s-botkube.k8s.MutatingWebhook[] | Webhooks is a list of webhooks and the affected resources and operations. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object metadata; + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +##### `webhooks`Optional + +```typescript +public readonly webhooks: MutatingWebhook[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.MutatingWebhook[] + +Webhooks is a list of webhooks and the affected resources and operations. + +--- + +### KubeMutatingWebhookConfigurationV1Beta1Props + +MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. + +Deprecated in v1.16, planned for removal in v1.19. Use admissionregistration.k8s.io/v1 MutatingWebhookConfiguration instead. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeMutatingWebhookConfigurationV1Beta1Props: k8s.KubeMutatingWebhookConfigurationV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object metadata; | +| webhooks | @smallcase/cdk8s-botkube.k8s.MutatingWebhookV1Beta1[] | Webhooks is a list of webhooks and the affected resources and operations. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object metadata; + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +##### `webhooks`Optional + +```typescript +public readonly webhooks: MutatingWebhookV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.MutatingWebhookV1Beta1[] + +Webhooks is a list of webhooks and the affected resources and operations. + +--- + +### KubeNamespaceListProps + +NamespaceList is a list of Namespaces. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeNamespaceListProps: k8s.KubeNamespaceListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeNamespaceProps[] | Items is the list of Namespace objects in the list. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeNamespaceProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNamespaceProps[] + +Items is the list of Namespace objects in the list. + +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeNamespaceProps + +Namespace provides a scope for Names. + +Use of multiple namespaces is optional. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeNamespaceProps: k8s.KubeNamespaceProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.NamespaceSpec | Spec defines the behavior of the Namespace. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: NamespaceSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NamespaceSpec + +Spec defines the behavior of the Namespace. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeNetworkPolicyListProps + +NetworkPolicyList is a list of NetworkPolicy objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeNetworkPolicyListProps: k8s.KubeNetworkPolicyListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeNetworkPolicyProps[] | Items is a list of schema objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeNetworkPolicyProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNetworkPolicyProps[] + +Items is a list of schema objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeNetworkPolicyProps + +NetworkPolicy describes what network traffic is allowed for a set of Pods. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeNetworkPolicyProps: k8s.KubeNetworkPolicyProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.NetworkPolicySpec | Specification of the desired behavior for this NetworkPolicy. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: NetworkPolicySpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NetworkPolicySpec + +Specification of the desired behavior for this NetworkPolicy. + +--- + +### KubeNodeListProps + +NodeList is the whole list of all Nodes which have been registered with master. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeNodeListProps: k8s.KubeNodeListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeNodeProps[] | List of nodes. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeNodeProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeNodeProps[] + +List of nodes. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeNodeProps + +Node is a worker node in Kubernetes. + +Each node will have a unique identifier in the cache (i.e. in etcd). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeNodeProps: k8s.KubeNodeProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.NodeSpec | Spec defines the behavior of a node. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: NodeSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NodeSpec + +Spec defines the behavior of a node. + +https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubePersistentVolumeClaimListProps + +PersistentVolumeClaimList is a list of PersistentVolumeClaim items. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePersistentVolumeClaimListProps: k8s.KubePersistentVolumeClaimListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeClaimProps[] | A list of persistent volume claims. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubePersistentVolumeClaimProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeClaimProps[] + +A list of persistent volume claims. + +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubePersistentVolumeClaimProps + +PersistentVolumeClaim is a user's request for and claim to a persistent volume. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePersistentVolumeClaimProps: k8s.KubePersistentVolumeClaimProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.PersistentVolumeClaimSpec | Spec defines the desired characteristics of a volume requested by a pod author. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: PersistentVolumeClaimSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PersistentVolumeClaimSpec + +Spec defines the desired characteristics of a volume requested by a pod author. + +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + +--- + +### KubePersistentVolumeListProps + +PersistentVolumeList is a list of PersistentVolume items. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePersistentVolumeListProps: k8s.KubePersistentVolumeListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeProps[] | List of persistent volumes. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubePersistentVolumeProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeProps[] + +List of persistent volumes. + +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubePersistentVolumeProps + +PersistentVolume (PV) is a storage resource provisioned by an administrator. + +It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePersistentVolumeProps: k8s.KubePersistentVolumeProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.PersistentVolumeSpec | Spec defines a specification of a persistent volume owned by the cluster. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: PersistentVolumeSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PersistentVolumeSpec + +Spec defines a specification of a persistent volume owned by the cluster. + +Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes + +--- + +### KubePodDisruptionBudgetListProps + +PodDisruptionBudgetList is a collection of PodDisruptionBudgets. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePodDisruptionBudgetListProps: k8s.KubePodDisruptionBudgetListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetProps[] | Items is a list of PodDisruptionBudgets. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubePodDisruptionBudgetProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetProps[] + +Items is a list of PodDisruptionBudgets. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubePodDisruptionBudgetListV1Beta1Props + +PodDisruptionBudgetList is a collection of PodDisruptionBudgets. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePodDisruptionBudgetListV1Beta1Props: k8s.KubePodDisruptionBudgetListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetV1Beta1Props[] | *No description.* | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | *No description.* | + +--- + +##### `items`Required + +```typescript +public readonly items: KubePodDisruptionBudgetV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodDisruptionBudgetV1Beta1Props[] + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +--- + +### KubePodDisruptionBudgetProps + +PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePodDisruptionBudgetProps: k8s.KubePodDisruptionBudgetProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.PodDisruptionBudgetSpec | Specification of the desired behavior of the PodDisruptionBudget. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: PodDisruptionBudgetSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodDisruptionBudgetSpec + +Specification of the desired behavior of the PodDisruptionBudget. + +--- + +### KubePodDisruptionBudgetV1Beta1Props + +PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePodDisruptionBudgetV1Beta1Props: k8s.KubePodDisruptionBudgetV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | +| spec | @smallcase/cdk8s-botkube.k8s.PodDisruptionBudgetSpecV1Beta1 | Specification of the desired behavior of the PodDisruptionBudget. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +##### `spec`Optional + +```typescript +public readonly spec: PodDisruptionBudgetSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodDisruptionBudgetSpecV1Beta1 + +Specification of the desired behavior of the PodDisruptionBudget. + +--- + +### KubePodListProps + +PodList is a list of Pods. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePodListProps: k8s.KubePodListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubePodProps[] | List of pods. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubePodProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodProps[] + +List of pods. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubePodProps + +Pod is a collection of containers that can run on a host. + +This resource is created by clients and scheduled onto hosts. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePodProps: k8s.KubePodProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.PodSpec | Specification of the desired behavior of the pod. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: PodSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodSpec + +Specification of the desired behavior of the pod. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubePodSecurityPolicyListV1Beta1Props + +PodSecurityPolicyList is a list of PodSecurityPolicy objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePodSecurityPolicyListV1Beta1Props: k8s.KubePodSecurityPolicyListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubePodSecurityPolicyV1Beta1Props[] | items is a list of schema objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubePodSecurityPolicyV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodSecurityPolicyV1Beta1Props[] + +items is a list of schema objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubePodSecurityPolicyV1Beta1Props + +PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. + +Deprecated in 1.21. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePodSecurityPolicyV1Beta1Props: k8s.KubePodSecurityPolicyV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.PodSecurityPolicySpecV1Beta1 | spec defines the policy enforced. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: PodSecurityPolicySpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodSecurityPolicySpecV1Beta1 + +spec defines the policy enforced. + +--- + +### KubePodTemplateListProps + +PodTemplateList is a list of PodTemplates. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePodTemplateListProps: k8s.KubePodTemplateListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubePodTemplateProps[] | List of pod templates. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubePodTemplateProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePodTemplateProps[] + +List of pod templates. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubePodTemplateProps + +PodTemplate describes a template for creating copies of a predefined pod. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePodTemplateProps: k8s.KubePodTemplateProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| template | @smallcase/cdk8s-botkube.k8s.PodTemplateSpec | Template defines the pods that will be created from this pod template. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `template`Optional + +```typescript +public readonly template: PodTemplateSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodTemplateSpec + +Template defines the pods that will be created from this pod template. + +https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubePriorityClassListProps + +PriorityClassList is a collection of priority classes. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePriorityClassListProps: k8s.KubePriorityClassListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubePriorityClassProps[] | items is the list of PriorityClasses. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubePriorityClassProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassProps[] + +items is the list of PriorityClasses. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubePriorityClassListV1Alpha1Props + +PriorityClassList is a collection of priority classes. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePriorityClassListV1Alpha1Props: k8s.KubePriorityClassListV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubePriorityClassV1Alpha1Props[] | items is the list of PriorityClasses. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubePriorityClassV1Alpha1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassV1Alpha1Props[] + +items is the list of PriorityClasses. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubePriorityClassListV1Beta1Props + +PriorityClassList is a collection of priority classes. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePriorityClassListV1Beta1Props: k8s.KubePriorityClassListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubePriorityClassV1Beta1Props[] | items is the list of PriorityClasses. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubePriorityClassV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityClassV1Beta1Props[] + +items is the list of PriorityClasses. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubePriorityClassProps + +PriorityClass defines mapping from a priority class name to the priority integer value. + +The value can be any valid integer. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePriorityClassProps: k8s.KubePriorityClassProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| value | number | The value of this priority class. | +| description | string | description is an arbitrary string that usually provides guidelines on when this priority class should be used. | +| globalDefault | boolean | globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| preemptionPolicy | string | PreemptionPolicy is the Policy for preempting pods with lower priority. | + +--- + +##### `value`Required + +```typescript +public readonly value: number; +``` + +- *Type:* number + +The value of this priority class. + +This is the actual priority that pods receive when they have the name of this class in their pod spec. + +--- + +##### `description`Optional + +```typescript +public readonly description: string; +``` + +- *Type:* string + +description is an arbitrary string that usually provides guidelines on when this priority class should be used. + +--- + +##### `globalDefault`Optional + +```typescript +public readonly globalDefault: boolean; +``` + +- *Type:* boolean + +globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. + +Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `preemptionPolicy`Optional + +```typescript +public readonly preemptionPolicy: string; +``` + +- *Type:* string +- *Default:* PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + +PreemptionPolicy is the Policy for preempting pods with lower priority. + +One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + +--- + +### KubePriorityClassV1Alpha1Props + +DEPRECATED - This group version of PriorityClass is deprecated by scheduling.k8s.io/v1/PriorityClass. PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePriorityClassV1Alpha1Props: k8s.KubePriorityClassV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| value | number | The value of this priority class. | +| description | string | description is an arbitrary string that usually provides guidelines on when this priority class should be used. | +| globalDefault | boolean | globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| preemptionPolicy | string | PreemptionPolicy is the Policy for preempting pods with lower priority. | + +--- + +##### `value`Required + +```typescript +public readonly value: number; +``` + +- *Type:* number + +The value of this priority class. + +This is the actual priority that pods receive when they have the name of this class in their pod spec. + +--- + +##### `description`Optional + +```typescript +public readonly description: string; +``` + +- *Type:* string + +description is an arbitrary string that usually provides guidelines on when this priority class should be used. + +--- + +##### `globalDefault`Optional + +```typescript +public readonly globalDefault: boolean; +``` + +- *Type:* boolean + +globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. + +Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `preemptionPolicy`Optional + +```typescript +public readonly preemptionPolicy: string; +``` + +- *Type:* string +- *Default:* PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + +PreemptionPolicy is the Policy for preempting pods with lower priority. + +One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + +--- + +### KubePriorityClassV1Beta1Props + +DEPRECATED - This group version of PriorityClass is deprecated by scheduling.k8s.io/v1/PriorityClass. PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePriorityClassV1Beta1Props: k8s.KubePriorityClassV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| value | number | The value of this priority class. | +| description | string | description is an arbitrary string that usually provides guidelines on when this priority class should be used. | +| globalDefault | boolean | globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| preemptionPolicy | string | PreemptionPolicy is the Policy for preempting pods with lower priority. | + +--- + +##### `value`Required + +```typescript +public readonly value: number; +``` + +- *Type:* number + +The value of this priority class. + +This is the actual priority that pods receive when they have the name of this class in their pod spec. + +--- + +##### `description`Optional + +```typescript +public readonly description: string; +``` + +- *Type:* string + +description is an arbitrary string that usually provides guidelines on when this priority class should be used. + +--- + +##### `globalDefault`Optional + +```typescript +public readonly globalDefault: boolean; +``` + +- *Type:* boolean + +globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. + +Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `preemptionPolicy`Optional + +```typescript +public readonly preemptionPolicy: string; +``` + +- *Type:* string +- *Default:* PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + +PreemptionPolicy is the Policy for preempting pods with lower priority. + +One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + +--- + +### KubePriorityLevelConfigurationListV1Beta1Props + +PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePriorityLevelConfigurationListV1Beta1Props: k8s.KubePriorityLevelConfigurationListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubePriorityLevelConfigurationV1Beta1Props[] | `items` is a list of request-priorities. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | `metadata` is the standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubePriorityLevelConfigurationV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePriorityLevelConfigurationV1Beta1Props[] + +`items` is a list of request-priorities. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +`metadata` is the standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubePriorityLevelConfigurationV1Beta1Props + +PriorityLevelConfiguration represents the configuration of a priority level. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubePriorityLevelConfigurationV1Beta1Props: k8s.KubePriorityLevelConfigurationV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | `metadata` is the standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.PriorityLevelConfigurationSpecV1Beta1 | `spec` is the specification of the desired behavior of a "request-priority". | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +`metadata` is the standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: PriorityLevelConfigurationSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PriorityLevelConfigurationSpecV1Beta1 + +`spec` is the specification of the desired behavior of a "request-priority". + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeReplicaSetListProps + +ReplicaSetList is a collection of ReplicaSets. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeReplicaSetListProps: k8s.KubeReplicaSetListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeReplicaSetProps[] | List of ReplicaSets. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeReplicaSetProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeReplicaSetProps[] + +List of ReplicaSets. + +More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeReplicaSetProps + +ReplicaSet ensures that a specified number of pod replicas are running at any given time. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeReplicaSetProps: k8s.KubeReplicaSetProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. | +| spec | @smallcase/cdk8s-botkube.k8s.ReplicaSetSpec | Spec defines the specification of the desired behavior of the ReplicaSet. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. + +Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: ReplicaSetSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ReplicaSetSpec + +Spec defines the specification of the desired behavior of the ReplicaSet. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeReplicationControllerListProps + +ReplicationControllerList is a collection of replication controllers. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeReplicationControllerListProps: k8s.KubeReplicationControllerListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeReplicationControllerProps[] | List of replication controllers. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeReplicationControllerProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeReplicationControllerProps[] + +List of replication controllers. + +More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeReplicationControllerProps + +ReplicationController represents the configuration of a replication controller. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeReplicationControllerProps: k8s.KubeReplicationControllerProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. | +| spec | @smallcase/cdk8s-botkube.k8s.ReplicationControllerSpec | Spec defines the specification of the desired behavior of the replication controller. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. + +Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: ReplicationControllerSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ReplicationControllerSpec + +Spec defines the specification of the desired behavior of the replication controller. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeResourceQuotaListProps + +ResourceQuotaList is a list of ResourceQuota items. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeResourceQuotaListProps: k8s.KubeResourceQuotaListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeResourceQuotaProps[] | Items is a list of ResourceQuota objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeResourceQuotaProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeResourceQuotaProps[] + +Items is a list of ResourceQuota objects. + +More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeResourceQuotaProps + +ResourceQuota sets aggregate quota restrictions enforced per namespace. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeResourceQuotaProps: k8s.KubeResourceQuotaProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.ResourceQuotaSpec | Spec defines the desired quota. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: ResourceQuotaSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ResourceQuotaSpec + +Spec defines the desired quota. + +https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeRoleBindingListProps + +RoleBindingList is a collection of RoleBindings. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRoleBindingListProps: k8s.KubeRoleBindingListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeRoleBindingProps[] | Items is a list of RoleBindings. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeRoleBindingProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingProps[] + +Items is a list of RoleBindings. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +--- + +### KubeRoleBindingListV1Alpha1Props + +RoleBindingList is a collection of RoleBindings Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBindingList, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRoleBindingListV1Alpha1Props: k8s.KubeRoleBindingListV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeRoleBindingV1Alpha1Props[] | Items is a list of RoleBindings. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeRoleBindingV1Alpha1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingV1Alpha1Props[] + +Items is a list of RoleBindings. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +--- + +### KubeRoleBindingListV1Beta1Props + +RoleBindingList is a collection of RoleBindings Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBindingList, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRoleBindingListV1Beta1Props: k8s.KubeRoleBindingListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeRoleBindingV1Beta1Props[] | Items is a list of RoleBindings. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeRoleBindingV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleBindingV1Beta1Props[] + +Items is a list of RoleBindings. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +--- + +### KubeRoleBindingProps + +RoleBinding references a role, but does not contain it. + +It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRoleBindingProps: k8s.KubeRoleBindingProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| roleRef | @smallcase/cdk8s-botkube.k8s.RoleRef | RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| subjects | @smallcase/cdk8s-botkube.k8s.Subject[] | Subjects holds references to the objects the role applies to. | + +--- + +##### `roleRef`Required + +```typescript +public readonly roleRef: RoleRef; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RoleRef + +RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. + +If the RoleRef cannot be resolved, the Authorizer must return an error. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +--- + +##### `subjects`Optional + +```typescript +public readonly subjects: Subject[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Subject[] + +Subjects holds references to the objects the role applies to. + +--- + +### KubeRoleBindingV1Alpha1Props + +RoleBinding references a role, but does not contain it. + +It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBinding, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRoleBindingV1Alpha1Props: k8s.KubeRoleBindingV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| roleRef | @smallcase/cdk8s-botkube.k8s.RoleRefV1Alpha1 | RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| subjects | @smallcase/cdk8s-botkube.k8s.SubjectV1Alpha1[] | Subjects holds references to the objects the role applies to. | + +--- + +##### `roleRef`Required + +```typescript +public readonly roleRef: RoleRefV1Alpha1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RoleRefV1Alpha1 + +RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. + +If the RoleRef cannot be resolved, the Authorizer must return an error. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +--- + +##### `subjects`Optional + +```typescript +public readonly subjects: SubjectV1Alpha1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SubjectV1Alpha1[] + +Subjects holds references to the objects the role applies to. + +--- + +### KubeRoleBindingV1Beta1Props + +RoleBinding references a role, but does not contain it. + +It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBinding, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRoleBindingV1Beta1Props: k8s.KubeRoleBindingV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| roleRef | @smallcase/cdk8s-botkube.k8s.RoleRefV1Beta1 | RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| subjects | @smallcase/cdk8s-botkube.k8s.SubjectV1Beta1[] | Subjects holds references to the objects the role applies to. | + +--- + +##### `roleRef`Required + +```typescript +public readonly roleRef: RoleRefV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RoleRefV1Beta1 + +RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. + +If the RoleRef cannot be resolved, the Authorizer must return an error. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +--- + +##### `subjects`Optional + +```typescript +public readonly subjects: SubjectV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SubjectV1Beta1[] + +Subjects holds references to the objects the role applies to. + +--- + +### KubeRoleListProps + +RoleList is a collection of Roles. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRoleListProps: k8s.KubeRoleListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeRoleProps[] | Items is a list of Roles. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeRoleProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleProps[] + +Items is a list of Roles. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +--- + +### KubeRoleListV1Alpha1Props + +RoleList is a collection of Roles. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleList, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRoleListV1Alpha1Props: k8s.KubeRoleListV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeRoleV1Alpha1Props[] | Items is a list of Roles. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeRoleV1Alpha1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleV1Alpha1Props[] + +Items is a list of Roles. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +--- + +### KubeRoleListV1Beta1Props + +RoleList is a collection of Roles Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleList, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRoleListV1Beta1Props: k8s.KubeRoleListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeRoleV1Beta1Props[] | Items is a list of Roles. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard object's metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeRoleV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRoleV1Beta1Props[] + +Items is a list of Roles. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard object's metadata. + +--- + +### KubeRoleProps + +Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRoleProps: k8s.KubeRoleProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| rules | @smallcase/cdk8s-botkube.k8s.PolicyRule[] | Rules holds all the PolicyRules for this Role. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +--- + +##### `rules`Optional + +```typescript +public readonly rules: PolicyRule[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PolicyRule[] + +Rules holds all the PolicyRules for this Role. + +--- + +### KubeRoleV1Alpha1Props + +Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 Role, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRoleV1Alpha1Props: k8s.KubeRoleV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| rules | @smallcase/cdk8s-botkube.k8s.PolicyRuleV1Alpha1[] | Rules holds all the PolicyRules for this Role. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +--- + +##### `rules`Optional + +```typescript +public readonly rules: PolicyRuleV1Alpha1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PolicyRuleV1Alpha1[] + +Rules holds all the PolicyRules for this Role. + +--- + +### KubeRoleV1Beta1Props + +Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. + +Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 Role, and will no longer be served in v1.22. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRoleV1Beta1Props: k8s.KubeRoleV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| rules | @smallcase/cdk8s-botkube.k8s.PolicyRuleV1Beta1[] | Rules holds all the PolicyRules for this Role. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +--- + +##### `rules`Optional + +```typescript +public readonly rules: PolicyRuleV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PolicyRuleV1Beta1[] + +Rules holds all the PolicyRules for this Role. + +--- + +### KubeRuntimeClassListProps + +RuntimeClassList is a list of RuntimeClass objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRuntimeClassListProps: k8s.KubeRuntimeClassListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassProps[] | Items is a list of schema objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeRuntimeClassProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassProps[] + +Items is a list of schema objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeRuntimeClassListV1Alpha1Props + +RuntimeClassList is a list of RuntimeClass objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRuntimeClassListV1Alpha1Props: k8s.KubeRuntimeClassListV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassV1Alpha1Props[] | Items is a list of schema objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeRuntimeClassV1Alpha1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassV1Alpha1Props[] + +Items is a list of schema objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeRuntimeClassListV1Beta1Props + +RuntimeClassList is a list of RuntimeClass objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRuntimeClassListV1Beta1Props: k8s.KubeRuntimeClassListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassV1Beta1Props[] | Items is a list of schema objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeRuntimeClassV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeRuntimeClassV1Beta1Props[] + +Items is a list of schema objects. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeRuntimeClassProps + +RuntimeClass defines a class of container runtime supported in the cluster. + +The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://kubernetes.io/docs/concepts/containers/runtime-class/ + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRuntimeClassProps: k8s.KubeRuntimeClassProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| handler | string | Handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | +| overhead | @smallcase/cdk8s-botkube.k8s.Overhead | Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. | +| scheduling | @smallcase/cdk8s-botkube.k8s.Scheduling | Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. | + +--- + +##### `handler`Required + +```typescript +public readonly handler: string; +``` + +- *Type:* string + +Handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. + +The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +##### `overhead`Optional + +```typescript +public readonly overhead: Overhead; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Overhead + +Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. + +For more details, see +https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/ +This field is in beta starting v1.18 and is only honored by servers that enable the PodOverhead feature. + +--- + +##### `scheduling`Optional + +```typescript +public readonly scheduling: Scheduling; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Scheduling + +Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. + +If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes. + +--- + +### KubeRuntimeClassV1Alpha1Props + +RuntimeClass defines a class of container runtime supported in the cluster. + +The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are (currently) manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRuntimeClassV1Alpha1Props: k8s.KubeRuntimeClassV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.RuntimeClassSpecV1Alpha1 | Specification of the RuntimeClass More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `spec`Required + +```typescript +public readonly spec: RuntimeClassSpecV1Alpha1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RuntimeClassSpecV1Alpha1 + +Specification of the RuntimeClass More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubeRuntimeClassV1Beta1Props + +RuntimeClass defines a class of container runtime supported in the cluster. + +The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are (currently) manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeRuntimeClassV1Beta1Props: k8s.KubeRuntimeClassV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| handler | string | Handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | +| overhead | @smallcase/cdk8s-botkube.k8s.OverheadV1Beta1 | Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. | +| scheduling | @smallcase/cdk8s-botkube.k8s.SchedulingV1Beta1 | Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. | + +--- + +##### `handler`Required + +```typescript +public readonly handler: string; +``` + +- *Type:* string + +Handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. + +The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +##### `overhead`Optional + +```typescript +public readonly overhead: OverheadV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.OverheadV1Beta1 + +Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. + +For more details, see https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature. + +--- + +##### `scheduling`Optional + +```typescript +public readonly scheduling: SchedulingV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SchedulingV1Beta1 + +Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. + +If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes. + +--- + +### KubeScaleProps + +Scale represents a scaling request for a resource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeScaleProps: k8s.KubeScaleProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object metadata; | +| spec | @smallcase/cdk8s-botkube.k8s.ScaleSpec | defines the behavior of the scale. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object metadata; + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +##### `spec`Optional + +```typescript +public readonly spec: ScaleSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ScaleSpec + +defines the behavior of the scale. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. + +--- + +### KubeSecretListProps + +SecretList is a list of Secret. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeSecretListProps: k8s.KubeSecretListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeSecretProps[] | Items is a list of secret objects. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeSecretProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeSecretProps[] + +Items is a list of secret objects. + +More info: https://kubernetes.io/docs/concepts/configuration/secret + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeSecretProps + +Secret holds secret data of a certain type. + +The total bytes of the values in the Data field must be less than MaxSecretSize bytes. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeSecretProps: k8s.KubeSecretProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| data | {[ key: string ]: string} | Data contains the secret data. | +| immutable | boolean | Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| stringData | {[ key: string ]: string} | stringData allows specifying non-binary secret data in string form. | +| type | string | Used to facilitate programmatic handling of secret data. | + +--- + +##### `data`Optional + +```typescript +public readonly data: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +Data contains the secret data. + +Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 + +--- + +##### `immutable`Optional + +```typescript +public readonly immutable: boolean; +``` + +- *Type:* boolean + +Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). + +If not set to true, the field can be modified at any time. Defaulted to nil. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `stringData`Optional + +```typescript +public readonly stringData: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +stringData allows specifying non-binary secret data in string form. + +It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API. + +--- + +##### `type`Optional + +```typescript +public readonly type: string; +``` + +- *Type:* string + +Used to facilitate programmatic handling of secret data. + +--- + +### KubeSelfSubjectAccessReviewProps + +SelfSubjectAccessReview checks whether or the current user can perform an action. + +Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeSelfSubjectAccessReviewProps: k8s.KubeSelfSubjectAccessReviewProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.SelfSubjectAccessReviewSpec | Spec holds information about the request being evaluated. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `spec`Required + +```typescript +public readonly spec: SelfSubjectAccessReviewSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SelfSubjectAccessReviewSpec + +Spec holds information about the request being evaluated. + +user and groups must be empty + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeSelfSubjectAccessReviewV1Beta1Props + +SelfSubjectAccessReview checks whether or the current user can perform an action. + +Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeSelfSubjectAccessReviewV1Beta1Props: k8s.KubeSelfSubjectAccessReviewV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.SelfSubjectAccessReviewSpecV1Beta1 | Spec holds information about the request being evaluated. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `spec`Required + +```typescript +public readonly spec: SelfSubjectAccessReviewSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SelfSubjectAccessReviewSpecV1Beta1 + +Spec holds information about the request being evaluated. + +user and groups must be empty + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeSelfSubjectRulesReviewProps + +SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. + +The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeSelfSubjectRulesReviewProps: k8s.KubeSelfSubjectRulesReviewProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.SelfSubjectRulesReviewSpec | Spec holds information about the request being evaluated. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `spec`Required + +```typescript +public readonly spec: SelfSubjectRulesReviewSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SelfSubjectRulesReviewSpec + +Spec holds information about the request being evaluated. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeSelfSubjectRulesReviewV1Beta1Props + +SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. + +The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeSelfSubjectRulesReviewV1Beta1Props: k8s.KubeSelfSubjectRulesReviewV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.SelfSubjectRulesReviewSpecV1Beta1 | Spec holds information about the request being evaluated. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `spec`Required + +```typescript +public readonly spec: SelfSubjectRulesReviewSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SelfSubjectRulesReviewSpecV1Beta1 + +Spec holds information about the request being evaluated. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeServiceAccountListProps + +ServiceAccountList is a list of ServiceAccount objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeServiceAccountListProps: k8s.KubeServiceAccountListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeServiceAccountProps[] | List of ServiceAccounts. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeServiceAccountProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeServiceAccountProps[] + +List of ServiceAccounts. + +More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeServiceAccountProps + +ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeServiceAccountProps: k8s.KubeServiceAccountProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| automountServiceAccountToken | boolean | AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. | +| imagePullSecrets | @smallcase/cdk8s-botkube.k8s.LocalObjectReference[] | ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| secrets | @smallcase/cdk8s-botkube.k8s.ObjectReference[] | Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. | + +--- + +##### `automountServiceAccountToken`Optional + +```typescript +public readonly automountServiceAccountToken: boolean; +``` + +- *Type:* boolean + +AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. + +Can be overridden at the pod level. + +--- + +##### `imagePullSecrets`Optional + +```typescript +public readonly imagePullSecrets: LocalObjectReference[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LocalObjectReference[] + +ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. + +ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `secrets`Optional + +```typescript +public readonly secrets: ObjectReference[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectReference[] + +Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. + +More info: https://kubernetes.io/docs/concepts/configuration/secret + +--- + +### KubeServiceListProps + +ServiceList holds a list of services. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeServiceListProps: k8s.KubeServiceListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeServiceProps[] | List of services. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeServiceProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeServiceProps[] + +List of services. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeServiceProps + +Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeServiceProps: k8s.KubeServiceProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.ServiceSpec | Spec defines the behavior of a service. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: ServiceSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ServiceSpec + +Spec defines the behavior of a service. + +https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### KubeStatefulSetListProps + +StatefulSetList is a collection of StatefulSets. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeStatefulSetListProps: k8s.KubeStatefulSetListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeStatefulSetProps[] | *No description.* | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | *No description.* | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeStatefulSetProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStatefulSetProps[] + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +--- + +### KubeStatefulSetProps + +StatefulSet represents a set of pods with consistent identities. + +Identities are defined as: +- Network: A single stable DNS and hostname. +- Storage: As many VolumeClaims as requested. +The StatefulSet guarantees that a given network identity will always map to the same storage identity. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeStatefulSetProps: k8s.KubeStatefulSetProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | +| spec | @smallcase/cdk8s-botkube.k8s.StatefulSetSpec | Spec defines the desired identities of pods in this set. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +##### `spec`Optional + +```typescript +public readonly spec: StatefulSetSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.StatefulSetSpec + +Spec defines the desired identities of pods in this set. + +--- + +### KubeStatusProps + +Status is a return value for calls that don't return other objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeStatusProps: k8s.KubeStatusProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| code | number | Suggested HTTP return code for this status, 0 if not set. | +| details | @smallcase/cdk8s-botkube.k8s.StatusDetails | Extended data associated with the reason. | +| message | string | A human-readable description of the status of this operation. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | +| reason | string | A machine-readable description of why this operation is in the "Failure" status. | + +--- + +##### `code`Optional + +```typescript +public readonly code: number; +``` + +- *Type:* number + +Suggested HTTP return code for this status, 0 if not set. + +--- + +##### `details`Optional + +```typescript +public readonly details: StatusDetails; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.StatusDetails + +Extended data associated with the reason. + +Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. + +--- + +##### `message`Optional + +```typescript +public readonly message: string; +``` + +- *Type:* string + +A human-readable description of the status of this operation. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +##### `reason`Optional + +```typescript +public readonly reason: string; +``` + +- *Type:* string + +A machine-readable description of why this operation is in the "Failure" status. + +If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. + +--- + +### KubeStorageClassListProps + +StorageClassList is a collection of storage classes. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeStorageClassListProps: k8s.KubeStorageClassListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeStorageClassProps[] | Items is the list of StorageClasses. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeStorageClassProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageClassProps[] + +Items is the list of StorageClasses. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubeStorageClassListV1Beta1Props + +StorageClassList is a collection of storage classes. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeStorageClassListV1Beta1Props: k8s.KubeStorageClassListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeStorageClassV1Beta1Props[] | Items is the list of StorageClasses. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeStorageClassV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageClassV1Beta1Props[] + +Items is the list of StorageClasses. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubeStorageClassProps + +StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. + +StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeStorageClassProps: k8s.KubeStorageClassProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| provisioner | string | Provisioner indicates the type of the provisioner. | +| allowedTopologies | @smallcase/cdk8s-botkube.k8s.TopologySelectorTerm[] | Restrict the node topologies where volumes can be dynamically provisioned. | +| allowVolumeExpansion | boolean | AllowVolumeExpansion shows whether the storage class allow volume expand. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| mountOptions | string[] | Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. | +| parameters | {[ key: string ]: string} | Parameters holds the parameters for the provisioner that should create volumes of this storage class. | +| reclaimPolicy | string | Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. | +| volumeBindingMode | string | VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. | + +--- + +##### `provisioner`Required + +```typescript +public readonly provisioner: string; +``` + +- *Type:* string + +Provisioner indicates the type of the provisioner. + +--- + +##### `allowedTopologies`Optional + +```typescript +public readonly allowedTopologies: TopologySelectorTerm[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.TopologySelectorTerm[] + +Restrict the node topologies where volumes can be dynamically provisioned. + +Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature. + +--- + +##### `allowVolumeExpansion`Optional + +```typescript +public readonly allowVolumeExpansion: boolean; +``` + +- *Type:* boolean + +AllowVolumeExpansion shows whether the storage class allow volume expand. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `mountOptions`Optional + +```typescript +public readonly mountOptions: string[]; +``` + +- *Type:* string[] + +Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. + +--- + +##### `parameters`Optional + +```typescript +public readonly parameters: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +Parameters holds the parameters for the provisioner that should create volumes of this storage class. + +--- + +##### `reclaimPolicy`Optional + +```typescript +public readonly reclaimPolicy: string; +``` + +- *Type:* string +- *Default:* Delete. + +Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. + +Defaults to Delete. + +--- + +##### `volumeBindingMode`Optional + +```typescript +public readonly volumeBindingMode: string; +``` + +- *Type:* string + +VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. + +When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature. + +--- + +### KubeStorageClassV1Beta1Props + +StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. + +StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeStorageClassV1Beta1Props: k8s.KubeStorageClassV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| provisioner | string | Provisioner indicates the type of the provisioner. | +| allowedTopologies | @smallcase/cdk8s-botkube.k8s.TopologySelectorTerm[] | Restrict the node topologies where volumes can be dynamically provisioned. | +| allowVolumeExpansion | boolean | AllowVolumeExpansion shows whether the storage class allow volume expand. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| mountOptions | string[] | Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. | +| parameters | {[ key: string ]: string} | Parameters holds the parameters for the provisioner that should create volumes of this storage class. | +| reclaimPolicy | string | Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. | +| volumeBindingMode | string | VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. | + +--- + +##### `provisioner`Required + +```typescript +public readonly provisioner: string; +``` + +- *Type:* string + +Provisioner indicates the type of the provisioner. + +--- + +##### `allowedTopologies`Optional + +```typescript +public readonly allowedTopologies: TopologySelectorTerm[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.TopologySelectorTerm[] + +Restrict the node topologies where volumes can be dynamically provisioned. + +Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature. + +--- + +##### `allowVolumeExpansion`Optional + +```typescript +public readonly allowVolumeExpansion: boolean; +``` + +- *Type:* boolean + +AllowVolumeExpansion shows whether the storage class allow volume expand. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `mountOptions`Optional + +```typescript +public readonly mountOptions: string[]; +``` + +- *Type:* string[] + +Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. + +--- + +##### `parameters`Optional + +```typescript +public readonly parameters: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +Parameters holds the parameters for the provisioner that should create volumes of this storage class. + +--- + +##### `reclaimPolicy`Optional + +```typescript +public readonly reclaimPolicy: string; +``` + +- *Type:* string +- *Default:* Delete. + +Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. + +Defaults to Delete. + +--- + +##### `volumeBindingMode`Optional + +```typescript +public readonly volumeBindingMode: string; +``` + +- *Type:* string + +VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. + +When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature. + +--- + +### KubeStorageVersionListV1Alpha1Props + +A list of StorageVersions. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeStorageVersionListV1Alpha1Props: k8s.KubeStorageVersionListV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeStorageVersionV1Alpha1Props[] | *No description.* | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | *No description.* | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeStorageVersionV1Alpha1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeStorageVersionV1Alpha1Props[] + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +--- + +### KubeStorageVersionV1Alpha1Props + +Storage version of a specific resource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeStorageVersionV1Alpha1Props: k8s.KubeStorageVersionV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | any | Spec is an empty spec. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | The name is .. | + +--- + +##### `spec`Required + +```typescript +public readonly spec: any; +``` + +- *Type:* any + +Spec is an empty spec. + +It is here to comply with Kubernetes API style. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +The name is .. + +--- + +### KubeSubjectAccessReviewProps + +SubjectAccessReview checks whether or not a user or group can perform an action. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeSubjectAccessReviewProps: k8s.KubeSubjectAccessReviewProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.SubjectAccessReviewSpec | Spec holds information about the request being evaluated. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `spec`Required + +```typescript +public readonly spec: SubjectAccessReviewSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SubjectAccessReviewSpec + +Spec holds information about the request being evaluated. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeSubjectAccessReviewV1Beta1Props + +SubjectAccessReview checks whether or not a user or group can perform an action. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeSubjectAccessReviewV1Beta1Props: k8s.KubeSubjectAccessReviewV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.SubjectAccessReviewSpecV1Beta1 | Spec holds information about the request being evaluated. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `spec`Required + +```typescript +public readonly spec: SubjectAccessReviewSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SubjectAccessReviewSpecV1Beta1 + +Spec holds information about the request being evaluated. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeTokenRequestProps + +TokenRequest requests a token for a given service account. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeTokenRequestProps: k8s.KubeTokenRequestProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.TokenRequestSpec | *No description.* | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `spec`Required + +```typescript +public readonly spec: TokenRequestSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.TokenRequestSpec + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeTokenReviewProps + +TokenReview attempts to authenticate a token to a known user. + +Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeTokenReviewProps: k8s.KubeTokenReviewProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.TokenReviewSpec | Spec holds information about the request being evaluated. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `spec`Required + +```typescript +public readonly spec: TokenReviewSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.TokenReviewSpec + +Spec holds information about the request being evaluated. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeTokenReviewV1Beta1Props + +TokenReview attempts to authenticate a token to a known user. + +Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeTokenReviewV1Beta1Props: k8s.KubeTokenReviewV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.TokenReviewSpecV1Beta1 | Spec holds information about the request being evaluated. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | *No description.* | + +--- + +##### `spec`Required + +```typescript +public readonly spec: TokenReviewSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.TokenReviewSpecV1Beta1 + +Spec holds information about the request being evaluated. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +--- + +### KubeValidatingWebhookConfigurationListProps + +ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeValidatingWebhookConfigurationListProps: k8s.KubeValidatingWebhookConfigurationListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationProps[] | List of ValidatingWebhookConfiguration. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeValidatingWebhookConfigurationProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationProps[] + +List of ValidatingWebhookConfiguration. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeValidatingWebhookConfigurationListV1Beta1Props + +ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeValidatingWebhookConfigurationListV1Beta1Props: k8s.KubeValidatingWebhookConfigurationListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationV1Beta1Props[] | List of ValidatingWebhookConfiguration. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeValidatingWebhookConfigurationV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeValidatingWebhookConfigurationV1Beta1Props[] + +List of ValidatingWebhookConfiguration. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +### KubeValidatingWebhookConfigurationProps + +ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeValidatingWebhookConfigurationProps: k8s.KubeValidatingWebhookConfigurationProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object metadata; | +| webhooks | @smallcase/cdk8s-botkube.k8s.ValidatingWebhook[] | Webhooks is a list of webhooks and the affected resources and operations. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object metadata; + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +##### `webhooks`Optional + +```typescript +public readonly webhooks: ValidatingWebhook[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ValidatingWebhook[] + +Webhooks is a list of webhooks and the affected resources and operations. + +--- + +### KubeValidatingWebhookConfigurationV1Beta1Props + +ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. + +Deprecated in v1.16, planned for removal in v1.19. Use admissionregistration.k8s.io/v1 ValidatingWebhookConfiguration instead. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeValidatingWebhookConfigurationV1Beta1Props: k8s.KubeValidatingWebhookConfigurationV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object metadata; | +| webhooks | @smallcase/cdk8s-botkube.k8s.ValidatingWebhookV1Beta1[] | Webhooks is a list of webhooks and the affected resources and operations. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object metadata; + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +##### `webhooks`Optional + +```typescript +public readonly webhooks: ValidatingWebhookV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ValidatingWebhookV1Beta1[] + +Webhooks is a list of webhooks and the affected resources and operations. + +--- + +### KubeVolumeAttachmentListProps + +VolumeAttachmentList is a collection of VolumeAttachment objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeVolumeAttachmentListProps: k8s.KubeVolumeAttachmentListProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentProps[] | Items is the list of VolumeAttachments. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeVolumeAttachmentProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentProps[] + +Items is the list of VolumeAttachments. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubeVolumeAttachmentListV1Alpha1Props + +VolumeAttachmentList is a collection of VolumeAttachment objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeVolumeAttachmentListV1Alpha1Props: k8s.KubeVolumeAttachmentListV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentV1Alpha1Props[] | Items is the list of VolumeAttachments. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeVolumeAttachmentV1Alpha1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentV1Alpha1Props[] + +Items is the list of VolumeAttachments. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubeVolumeAttachmentListV1Beta1Props + +VolumeAttachmentList is a collection of VolumeAttachment objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeVolumeAttachmentListV1Beta1Props: k8s.KubeVolumeAttachmentListV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentV1Beta1Props[] | Items is the list of VolumeAttachments. | +| metadata | @smallcase/cdk8s-botkube.k8s.ListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. | + +--- + +##### `items`Required + +```typescript +public readonly items: KubeVolumeAttachmentV1Beta1Props[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubeVolumeAttachmentV1Beta1Props[] + +Items is the list of VolumeAttachments. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ListMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ListMeta + +Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + +--- + +### KubeVolumeAttachmentProps + +VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + +VolumeAttachment objects are non-namespaced. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeVolumeAttachmentProps: k8s.KubeVolumeAttachmentProps = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.VolumeAttachmentSpec | Specification of the desired attach/detach volume behavior. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object metadata. | + +--- + +##### `spec`Required + +```typescript +public readonly spec: VolumeAttachmentSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VolumeAttachmentSpec + +Specification of the desired attach/detach volume behavior. + +Populated by the Kubernetes system. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeVolumeAttachmentV1Alpha1Props + +VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + +VolumeAttachment objects are non-namespaced. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeVolumeAttachmentV1Alpha1Props: k8s.KubeVolumeAttachmentV1Alpha1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.VolumeAttachmentSpecV1Alpha1 | Specification of the desired attach/detach volume behavior. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object metadata. | + +--- + +##### `spec`Required + +```typescript +public readonly spec: VolumeAttachmentSpecV1Alpha1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VolumeAttachmentSpecV1Alpha1 + +Specification of the desired attach/detach volume behavior. + +Populated by the Kubernetes system. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### KubeVolumeAttachmentV1Beta1Props + +VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + +VolumeAttachment objects are non-namespaced. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const kubeVolumeAttachmentV1Beta1Props: k8s.KubeVolumeAttachmentV1Beta1Props = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.VolumeAttachmentSpecV1Beta1 | Specification of the desired attach/detach volume behavior. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object metadata. | + +--- + +##### `spec`Required + +```typescript +public readonly spec: VolumeAttachmentSpecV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VolumeAttachmentSpecV1Beta1 + +Specification of the desired attach/detach volume behavior. + +Populated by the Kubernetes system. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +### LabelSelector + +A label selector is a label query over a set of resources. + +The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const labelSelector: k8s.LabelSelector = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| matchExpressions | @smallcase/cdk8s-botkube.k8s.LabelSelectorRequirement[] | matchExpressions is a list of label selector requirements. | +| matchLabels | {[ key: string ]: string} | matchLabels is a map of {key,value} pairs. | + +--- + +##### `matchExpressions`Optional + +```typescript +public readonly matchExpressions: LabelSelectorRequirement[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelectorRequirement[] + +matchExpressions is a list of label selector requirements. + +The requirements are ANDed. + +--- + +##### `matchLabels`Optional + +```typescript +public readonly matchLabels: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +matchLabels is a map of {key,value} pairs. + +A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. + +--- + +### LabelSelectorRequirement + +A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const labelSelectorRequirement: k8s.LabelSelectorRequirement = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| key | string | key is the label key that the selector applies to. | +| operator | string | operator represents a key's relationship to a set of values. | +| values | string[] | values is an array of string values. | + +--- + +##### `key`Required + +```typescript +public readonly key: string; +``` + +- *Type:* string + +key is the label key that the selector applies to. + +--- + +##### `operator`Required + +```typescript +public readonly operator: string; +``` + +- *Type:* string + +operator represents a key's relationship to a set of values. + +Valid operators are In, NotIn, Exists and DoesNotExist. + +--- + +##### `values`Optional + +```typescript +public readonly values: string[]; +``` + +- *Type:* string[] + +values is an array of string values. + +If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. + +--- + +### LeaseSpec + +LeaseSpec is a specification of a Lease. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const leaseSpec: k8s.LeaseSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| acquireTime | Date | acquireTime is a time when the current lease was acquired. | +| holderIdentity | string | holderIdentity contains the identity of the holder of a current lease. | +| leaseDurationSeconds | number | leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. | +| leaseTransitions | number | leaseTransitions is the number of transitions of a lease between holders. | +| renewTime | Date | renewTime is a time when the current holder of a lease has last updated the lease. | + +--- + +##### `acquireTime`Optional + +```typescript +public readonly acquireTime: Date; +``` + +- *Type:* Date + +acquireTime is a time when the current lease was acquired. + +--- + +##### `holderIdentity`Optional + +```typescript +public readonly holderIdentity: string; +``` + +- *Type:* string + +holderIdentity contains the identity of the holder of a current lease. + +--- + +##### `leaseDurationSeconds`Optional + +```typescript +public readonly leaseDurationSeconds: number; +``` + +- *Type:* number + +leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. + +This is measure against time of last observed RenewTime. + +--- + +##### `leaseTransitions`Optional + +```typescript +public readonly leaseTransitions: number; +``` + +- *Type:* number + +leaseTransitions is the number of transitions of a lease between holders. + +--- + +##### `renewTime`Optional + +```typescript +public readonly renewTime: Date; +``` + +- *Type:* Date + +renewTime is a time when the current holder of a lease has last updated the lease. + +--- + +### LeaseSpecV1Beta1 + +LeaseSpec is a specification of a Lease. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const leaseSpecV1Beta1: k8s.LeaseSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| acquireTime | Date | acquireTime is a time when the current lease was acquired. | +| holderIdentity | string | holderIdentity contains the identity of the holder of a current lease. | +| leaseDurationSeconds | number | leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. | +| leaseTransitions | number | leaseTransitions is the number of transitions of a lease between holders. | +| renewTime | Date | renewTime is a time when the current holder of a lease has last updated the lease. | + +--- + +##### `acquireTime`Optional + +```typescript +public readonly acquireTime: Date; +``` + +- *Type:* Date + +acquireTime is a time when the current lease was acquired. + +--- + +##### `holderIdentity`Optional + +```typescript +public readonly holderIdentity: string; +``` + +- *Type:* string + +holderIdentity contains the identity of the holder of a current lease. + +--- + +##### `leaseDurationSeconds`Optional + +```typescript +public readonly leaseDurationSeconds: number; +``` + +- *Type:* number + +leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. + +This is measure against time of last observed RenewTime. + +--- + +##### `leaseTransitions`Optional + +```typescript +public readonly leaseTransitions: number; +``` + +- *Type:* number + +leaseTransitions is the number of transitions of a lease between holders. + +--- + +##### `renewTime`Optional + +```typescript +public readonly renewTime: Date; +``` + +- *Type:* Date + +renewTime is a time when the current holder of a lease has last updated the lease. + +--- + +### Lifecycle + +Lifecycle describes actions that the management system should take in response to container lifecycle events. + +For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const lifecycle: k8s.Lifecycle = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| postStart | @smallcase/cdk8s-botkube.k8s.Handler | PostStart is called immediately after a container is created. | +| preStop | @smallcase/cdk8s-botkube.k8s.Handler | PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. | + +--- + +##### `postStart`Optional + +```typescript +public readonly postStart: Handler; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Handler + +PostStart is called immediately after a container is created. + +If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks + +--- + +##### `preStop`Optional + +```typescript +public readonly preStop: Handler; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Handler + +PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. + +The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks + +--- + +### LimitedPriorityLevelConfigurationV1Beta1 + +LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. + +It addresses two issues: +* How are requests for this priority level limited? +* What should be done with requests that exceed the limit? + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const limitedPriorityLevelConfigurationV1Beta1: k8s.LimitedPriorityLevelConfigurationV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| assuredConcurrencyShares | number | `assuredConcurrencyShares` (ACS) configures the execution limit, which is a limit on the number of requests of this priority level that may be exeucting at a given time. | +| limitResponse | @smallcase/cdk8s-botkube.k8s.LimitResponseV1Beta1 | `limitResponse` indicates what to do with requests that can not be executed right now. | + +--- + +##### `assuredConcurrencyShares`Optional + +```typescript +public readonly assuredConcurrencyShares: number; +``` + +- *Type:* number + +`assuredConcurrencyShares` (ACS) configures the execution limit, which is a limit on the number of requests of this priority level that may be exeucting at a given time. + +ACS must be a positive number. The server's concurrency limit (SCL) is divided among the concurrency-controlled priority levels in proportion to their assured concurrency shares. This produces the assured concurrency value (ACV) --- the number of requests that may be executing at a time --- for each such priority level: + +ACV(l) = ceil( SCL * ACS(l) / ( sum[priority levels k] ACS(k) ) ) + +bigger numbers of ACS mean more reserved concurrent requests (at the expense of every other PL). This field has a default value of 30. + +--- + +##### `limitResponse`Optional + +```typescript +public readonly limitResponse: LimitResponseV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LimitResponseV1Beta1 + +`limitResponse` indicates what to do with requests that can not be executed right now. + +--- + +### LimitRangeItem + +LimitRangeItem defines a min/max usage limit for any resource that matches on kind. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const limitRangeItem: k8s.LimitRangeItem = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| type | string | Type of resource that this limit applies to. | +| default | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} | Default resource requirement limit value by resource name if resource limit is omitted. | +| defaultRequest | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} | DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. | +| max | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} | Max usage constraints on this kind by resource name. | +| maxLimitRequestRatio | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} | MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; | +| min | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} | Min usage constraints on this kind by resource name. | + +--- + +##### `type`Required + +```typescript +public readonly type: string; +``` + +- *Type:* string + +Type of resource that this limit applies to. + +--- + +##### `default`Optional + +```typescript +public readonly default: {[ key: string ]: Quantity}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} + +Default resource requirement limit value by resource name if resource limit is omitted. + +--- + +##### `defaultRequest`Optional + +```typescript +public readonly defaultRequest: {[ key: string ]: Quantity}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} + +DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. + +--- + +##### `max`Optional + +```typescript +public readonly max: {[ key: string ]: Quantity}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} + +Max usage constraints on this kind by resource name. + +--- + +##### `maxLimitRequestRatio`Optional + +```typescript +public readonly maxLimitRequestRatio: {[ key: string ]: Quantity}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} + +MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; + +this represents the max burst for the named resource. + +--- + +##### `min`Optional + +```typescript +public readonly min: {[ key: string ]: Quantity}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} + +Min usage constraints on this kind by resource name. + +--- + +### LimitRangeSpec + +LimitRangeSpec defines a min/max usage limit for resources that match on kind. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const limitRangeSpec: k8s.LimitRangeSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| limits | @smallcase/cdk8s-botkube.k8s.LimitRangeItem[] | Limits is the list of LimitRangeItem objects that are enforced. | + +--- + +##### `limits`Required + +```typescript +public readonly limits: LimitRangeItem[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LimitRangeItem[] + +Limits is the list of LimitRangeItem objects that are enforced. + +--- + +### LimitResponseV1Beta1 + +LimitResponse defines how to handle requests that can not be executed right now. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const limitResponseV1Beta1: k8s.LimitResponseV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| type | string | `type` is "Queue" or "Reject". | +| queuing | @smallcase/cdk8s-botkube.k8s.QueuingConfigurationV1Beta1 | `queuing` holds the configuration parameters for queuing. | + +--- + +##### `type`Required + +```typescript +public readonly type: string; +``` + +- *Type:* string + +`type` is "Queue" or "Reject". + +"Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required. + +--- + +##### `queuing`Optional + +```typescript +public readonly queuing: QueuingConfigurationV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.QueuingConfigurationV1Beta1 + +`queuing` holds the configuration parameters for queuing. + +This field may be non-empty only if `type` is `"Queue"`. + +--- + +### ListMeta + +ListMeta describes metadata that synthetic resources must have, including lists and various status objects. + +A resource may have only one of {ObjectMeta, ListMeta}. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const listMeta: k8s.ListMeta = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| continue | string | continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. | +| remainingItemCount | number | remainingItemCount is the number of subsequent items in the list which are not included in this list response. | +| resourceVersion | string | String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. | +| selfLink | string | selfLink is a URL representing this object. Populated by the system. Read-only. | + +--- + +##### `continue`Optional + +```typescript +public readonly continue: string; +``` + +- *Type:* string + +continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. + +The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. + +--- + +##### `remainingItemCount`Optional + +```typescript +public readonly remainingItemCount: number; +``` + +- *Type:* number + +remainingItemCount is the number of subsequent items in the list which are not included in this list response. + +If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. + +--- + +##### `resourceVersion`Optional + +```typescript +public readonly resourceVersion: string; +``` + +- *Type:* string + +String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. + +Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + +--- + +##### `selfLink`Optional + +```typescript +public readonly selfLink: string; +``` + +- *Type:* string + +selfLink is a URL representing this object. Populated by the system. Read-only. + +DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. + +--- + +### LocalObjectReference + +LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const localObjectReference: k8s.LocalObjectReference = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | Name of the referent. | + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the referent. + +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +--- + +### LocalVolumeSource + +Local represents directly-attached storage with node affinity (Beta feature). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const localVolumeSource: k8s.LocalVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| path | string | The full path to the volume on the node. | +| fsType | string | Filesystem type to mount. | + +--- + +##### `path`Required + +```typescript +public readonly path: string; +``` + +- *Type:* string + +The full path to the volume on the node. + +It can be either a directory or block device (disk, partition, ...). + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type to mount. + +It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified. + +--- + +### ManagedFieldsEntry + +ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const managedFieldsEntry: k8s.ManagedFieldsEntry = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiVersion | string | APIVersion defines the version of this resource that this field set applies to. | +| fieldsType | string | FieldsType is the discriminator for the different fields format and version. | +| fieldsV1 | any | FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. | +| manager | string | Manager is an identifier of the workflow managing these fields. | +| operation | string | Operation is the type of operation which lead to this ManagedFieldsEntry being created. | +| time | Date | Time is timestamp of when these fields were set. | + +--- + +##### `apiVersion`Optional + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +APIVersion defines the version of this resource that this field set applies to. + +The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. + +--- + +##### `fieldsType`Optional + +```typescript +public readonly fieldsType: string; +``` + +- *Type:* string + +FieldsType is the discriminator for the different fields format and version. + +There is currently only one possible value: "FieldsV1" + +--- + +##### `fieldsV1`Optional + +```typescript +public readonly fieldsV1: any; +``` + +- *Type:* any + +FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. + +--- + +##### `manager`Optional + +```typescript +public readonly manager: string; +``` + +- *Type:* string + +Manager is an identifier of the workflow managing these fields. + +--- + +##### `operation`Optional + +```typescript +public readonly operation: string; +``` + +- *Type:* string + +Operation is the type of operation which lead to this ManagedFieldsEntry being created. + +The only valid values for this field are 'Apply' and 'Update'. + +--- + +##### `time`Optional + +```typescript +public readonly time: Date; +``` + +- *Type:* Date + +Time is timestamp of when these fields were set. + +It should always be empty if Operation is 'Apply' + +--- + +### MetricIdentifierV2Beta2 + +MetricIdentifier defines the name and optionally selector for a metric. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const metricIdentifierV2Beta2: k8s.MetricIdentifierV2Beta2 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | name is the name of the given metric. | +| selector | @smallcase/cdk8s-botkube.k8s.LabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +name is the name of the given metric. + +--- + +##### `selector`Optional + +```typescript +public readonly selector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. + +When unset, just the metricName will be used to gather metrics. + +--- + +### MetricSpecV2Beta1 + +MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const metricSpecV2Beta1: k8s.MetricSpecV2Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| type | string | type is the type of metric source. | +| containerResource | @smallcase/cdk8s-botkube.k8s.ContainerResourceMetricSourceV2Beta1 | container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag. | +| external | @smallcase/cdk8s-botkube.k8s.ExternalMetricSourceV2Beta1 | external refers to a global metric that is not associated with any Kubernetes object. | +| object | @smallcase/cdk8s-botkube.k8s.ObjectMetricSourceV2Beta1 | object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). | +| pods | @smallcase/cdk8s-botkube.k8s.PodsMetricSourceV2Beta1 | pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). | +| resource | @smallcase/cdk8s-botkube.k8s.ResourceMetricSourceV2Beta1 | resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. | + +--- + +##### `type`Required + +```typescript +public readonly type: string; +``` + +- *Type:* string + +type is the type of metric source. + +It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled + +--- + +##### `containerResource`Optional + +```typescript +public readonly containerResource: ContainerResourceMetricSourceV2Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ContainerResourceMetricSourceV2Beta1 + +container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag. + +--- + +##### `external`Optional + +```typescript +public readonly external: ExternalMetricSourceV2Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ExternalMetricSourceV2Beta1 + +external refers to a global metric that is not associated with any Kubernetes object. + +It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). + +--- + +##### `object`Optional + +```typescript +public readonly object: ObjectMetricSourceV2Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMetricSourceV2Beta1 + +object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). + +--- + +##### `pods`Optional + +```typescript +public readonly pods: PodsMetricSourceV2Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodsMetricSourceV2Beta1 + +pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). + +The values will be averaged together before being compared to the target value. + +--- + +##### `resource`Optional + +```typescript +public readonly resource: ResourceMetricSourceV2Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ResourceMetricSourceV2Beta1 + +resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. + +--- + +### MetricSpecV2Beta2 + +MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const metricSpecV2Beta2: k8s.MetricSpecV2Beta2 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| type | string | type is the type of metric source. | +| containerResource | @smallcase/cdk8s-botkube.k8s.ContainerResourceMetricSourceV2Beta2 | container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag. | +| external | @smallcase/cdk8s-botkube.k8s.ExternalMetricSourceV2Beta2 | external refers to a global metric that is not associated with any Kubernetes object. | +| object | @smallcase/cdk8s-botkube.k8s.ObjectMetricSourceV2Beta2 | object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). | +| pods | @smallcase/cdk8s-botkube.k8s.PodsMetricSourceV2Beta2 | pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). | +| resource | @smallcase/cdk8s-botkube.k8s.ResourceMetricSourceV2Beta2 | resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. | + +--- + +##### `type`Required + +```typescript +public readonly type: string; +``` + +- *Type:* string + +type is the type of metric source. + +It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled + +--- + +##### `containerResource`Optional + +```typescript +public readonly containerResource: ContainerResourceMetricSourceV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ContainerResourceMetricSourceV2Beta2 + +container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag. + +--- + +##### `external`Optional + +```typescript +public readonly external: ExternalMetricSourceV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ExternalMetricSourceV2Beta2 + +external refers to a global metric that is not associated with any Kubernetes object. + +It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). + +--- + +##### `object`Optional + +```typescript +public readonly object: ObjectMetricSourceV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMetricSourceV2Beta2 + +object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). + +--- + +##### `pods`Optional + +```typescript +public readonly pods: PodsMetricSourceV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodsMetricSourceV2Beta2 + +pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). + +The values will be averaged together before being compared to the target value. + +--- + +##### `resource`Optional + +```typescript +public readonly resource: ResourceMetricSourceV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ResourceMetricSourceV2Beta2 + +resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. + +--- + +### MetricTargetV2Beta2 + +MetricTarget defines the target value, average value, or average utilization of a specific metric. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const metricTargetV2Beta2: k8s.MetricTargetV2Beta2 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| type | string | type represents whether the metric type is Utilization, Value, or AverageValue. | +| averageUtilization | number | averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. | +| averageValue | @smallcase/cdk8s-botkube.k8s.Quantity | averageValue is the target value of the average of the metric across all relevant pods (as a quantity). | +| value | @smallcase/cdk8s-botkube.k8s.Quantity | value is the target value of the metric (as a quantity). | + +--- + +##### `type`Required + +```typescript +public readonly type: string; +``` + +- *Type:* string + +type represents whether the metric type is Utilization, Value, or AverageValue. + +--- + +##### `averageUtilization`Optional + +```typescript +public readonly averageUtilization: number; +``` + +- *Type:* number + +averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. + +Currently only valid for Resource metric source type + +--- + +##### `averageValue`Optional + +```typescript +public readonly averageValue: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +averageValue is the target value of the average of the metric across all relevant pods (as a quantity). + +--- + +##### `value`Optional + +```typescript +public readonly value: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +value is the target value of the metric (as a quantity). + +--- + +### MutatingWebhook + +MutatingWebhook describes an admission webhook and the resources and operations it applies to. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const mutatingWebhook: k8s.MutatingWebhook = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| admissionReviewVersions | string[] | AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. | +| clientConfig | @smallcase/cdk8s-botkube.k8s.WebhookClientConfig | ClientConfig defines how to communicate with the hook. | +| name | string | The name of the admission webhook. | +| sideEffects | string | SideEffects states whether this webhook has side effects. | +| failurePolicy | string | FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. | +| matchPolicy | string | matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". | +| namespaceSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. | +| objectSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | ObjectSelector decides whether to run the webhook based on if the object has matching labels. | +| reinvocationPolicy | string | reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. | +| rules | @smallcase/cdk8s-botkube.k8s.RuleWithOperations[] | Rules describes what operations on what resources/subresources the webhook cares about. | +| timeoutSeconds | number | TimeoutSeconds specifies the timeout for this webhook. | + +--- + +##### `admissionReviewVersions`Required + +```typescript +public readonly admissionReviewVersions: string[]; +``` + +- *Type:* string[] + +AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. + +API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. + +--- + +##### `clientConfig`Required + +```typescript +public readonly clientConfig: WebhookClientConfig; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.WebhookClientConfig + +ClientConfig defines how to communicate with the hook. + +Required + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the admission webhook. + +Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. + +--- + +##### `sideEffects`Required + +```typescript +public readonly sideEffects: string; +``` + +- *Type:* string + +SideEffects states whether this webhook has side effects. + +Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. + +--- + +##### `failurePolicy`Optional + +```typescript +public readonly failurePolicy: string; +``` + +- *Type:* string +- *Default:* Fail. + +FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. + +Defaults to Fail. + +--- + +##### `matchPolicy`Optional + +```typescript +public readonly matchPolicy: string; +``` + +- *Type:* string +- *Default:* Equivalent" + +matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". + +Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. + +- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. + +Defaults to "Equivalent" + +--- + +##### `namespaceSelector`Optional + +```typescript +public readonly namespaceSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector +- *Default:* the empty LabelSelector, which matches everything. + +NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. + +If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. + +For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { +"matchExpressions": [ +{ +"key": "runlevel", +"operator": "NotIn", +"values": [ +"0", +"1" +] +} +] +} + +If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { +"matchExpressions": [ +{ +"key": "environment", +"operator": "In", +"values": [ +"prod", +"staging" +] +} +] +} + +See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. + +Default to the empty LabelSelector, which matches everything. + +--- + +##### `objectSelector`Optional + +```typescript +public readonly objectSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector +- *Default:* the empty LabelSelector, which matches everything. + +ObjectSelector decides whether to run the webhook based on if the object has matching labels. + +objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. + +--- + +##### `reinvocationPolicy`Optional + +```typescript +public readonly reinvocationPolicy: string; +``` + +- *Type:* string +- *Default:* Never". + +reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. + +Allowed values are "Never" and "IfNeeded". + +Never: the webhook will not be called more than once in a single admission evaluation. + +IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. + +Defaults to "Never". + +--- + +##### `rules`Optional + +```typescript +public readonly rules: RuleWithOperations[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RuleWithOperations[] + +Rules describes what operations on what resources/subresources the webhook cares about. + +The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + +--- + +##### `timeoutSeconds`Optional + +```typescript +public readonly timeoutSeconds: number; +``` + +- *Type:* number +- *Default:* 10 seconds. + +TimeoutSeconds specifies the timeout for this webhook. + +After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds. + +--- + +### MutatingWebhookV1Beta1 + +MutatingWebhook describes an admission webhook and the resources and operations it applies to. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const mutatingWebhookV1Beta1: k8s.MutatingWebhookV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| clientConfig | @smallcase/cdk8s-botkube.k8s.WebhookClientConfigV1Beta1 | ClientConfig defines how to communicate with the hook. | +| name | string | The name of the admission webhook. | +| admissionReviewVersions | string[] | AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. | +| failurePolicy | string | FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. | +| matchPolicy | string | matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". | +| namespaceSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. | +| objectSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | ObjectSelector decides whether to run the webhook based on if the object has matching labels. | +| reinvocationPolicy | string | reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. | +| rules | @smallcase/cdk8s-botkube.k8s.RuleWithOperationsV1Beta1[] | Rules describes what operations on what resources/subresources the webhook cares about. | +| sideEffects | string | SideEffects states whether this webhook has side effects. | +| timeoutSeconds | number | TimeoutSeconds specifies the timeout for this webhook. | + +--- + +##### `clientConfig`Required + +```typescript +public readonly clientConfig: WebhookClientConfigV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.WebhookClientConfigV1Beta1 + +ClientConfig defines how to communicate with the hook. + +Required + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the admission webhook. + +Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. + +--- + +##### `admissionReviewVersions`Optional + +```typescript +public readonly admissionReviewVersions: string[]; +``` + +- *Type:* string[] +- *Default:* v1beta1']`. + +AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. + +API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. Default to `['v1beta1']`. + +--- + +##### `failurePolicy`Optional + +```typescript +public readonly failurePolicy: string; +``` + +- *Type:* string +- *Default:* Ignore. + +FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. + +Defaults to Ignore. + +--- + +##### `matchPolicy`Optional + +```typescript +public readonly matchPolicy: string; +``` + +- *Type:* string +- *Default:* Exact" + +matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". + +Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. + +- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. + +Defaults to "Exact" + +--- + +##### `namespaceSelector`Optional + +```typescript +public readonly namespaceSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector +- *Default:* the empty LabelSelector, which matches everything. + +NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. + +If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. + +For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { +"matchExpressions": [ +{ +"key": "runlevel", +"operator": "NotIn", +"values": [ +"0", +"1" +] +} +] +} + +If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { +"matchExpressions": [ +{ +"key": "environment", +"operator": "In", +"values": [ +"prod", +"staging" +] +} +] +} + +See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. + +Default to the empty LabelSelector, which matches everything. + +--- + +##### `objectSelector`Optional + +```typescript +public readonly objectSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector +- *Default:* the empty LabelSelector, which matches everything. + +ObjectSelector decides whether to run the webhook based on if the object has matching labels. + +objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. + +--- + +##### `reinvocationPolicy`Optional + +```typescript +public readonly reinvocationPolicy: string; +``` + +- *Type:* string +- *Default:* Never". + +reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. + +Allowed values are "Never" and "IfNeeded". + +Never: the webhook will not be called more than once in a single admission evaluation. + +IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. + +Defaults to "Never". + +--- + +##### `rules`Optional + +```typescript +public readonly rules: RuleWithOperationsV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RuleWithOperationsV1Beta1[] + +Rules describes what operations on what resources/subresources the webhook cares about. + +The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + +--- + +##### `sideEffects`Optional + +```typescript +public readonly sideEffects: string; +``` + +- *Type:* string +- *Default:* Unknown. + +SideEffects states whether this webhook has side effects. + +Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. Defaults to Unknown. + +--- + +##### `timeoutSeconds`Optional + +```typescript +public readonly timeoutSeconds: number; +``` + +- *Type:* number +- *Default:* 30 seconds. + +TimeoutSeconds specifies the timeout for this webhook. + +After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 30 seconds. + +--- + +### NamespaceSpec + +NamespaceSpec describes the attributes on a Namespace. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const namespaceSpec: k8s.NamespaceSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| finalizers | string[] | Finalizers is an opaque list of values that must be empty to permanently remove object from storage. | + +--- + +##### `finalizers`Optional + +```typescript +public readonly finalizers: string[]; +``` + +- *Type:* string[] + +Finalizers is an opaque list of values that must be empty to permanently remove object from storage. + +More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ + +--- + +### NetworkPolicyEgressRule + +NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. + +The traffic must match both ports and to. This type is beta-level in 1.8 + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const networkPolicyEgressRule: k8s.NetworkPolicyEgressRule = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ports | @smallcase/cdk8s-botkube.k8s.NetworkPolicyPort[] | List of destination ports for outgoing traffic. | +| to | @smallcase/cdk8s-botkube.k8s.NetworkPolicyPeer[] | List of destinations for outgoing traffic of pods selected for this rule. | + +--- + +##### `ports`Optional + +```typescript +public readonly ports: NetworkPolicyPort[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NetworkPolicyPort[] + +List of destination ports for outgoing traffic. + +Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. + +--- + +##### `to`Optional + +```typescript +public readonly to: NetworkPolicyPeer[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NetworkPolicyPeer[] + +List of destinations for outgoing traffic of pods selected for this rule. + +Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list. + +--- + +### NetworkPolicyIngressRule + +NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. + +The traffic must match both ports and from. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const networkPolicyIngressRule: k8s.NetworkPolicyIngressRule = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| from | @smallcase/cdk8s-botkube.k8s.NetworkPolicyPeer[] | List of sources which should be able to access the pods selected for this rule. | +| ports | @smallcase/cdk8s-botkube.k8s.NetworkPolicyPort[] | List of ports which should be made accessible on the pods selected for this rule. | + +--- + +##### `from`Optional + +```typescript +public readonly from: NetworkPolicyPeer[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NetworkPolicyPeer[] + +List of sources which should be able to access the pods selected for this rule. + +Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list. + +--- + +##### `ports`Optional + +```typescript +public readonly ports: NetworkPolicyPort[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NetworkPolicyPort[] + +List of ports which should be made accessible on the pods selected for this rule. + +Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. + +--- + +### NetworkPolicyPeer + +NetworkPolicyPeer describes a peer to allow traffic to/from. + +Only certain combinations of fields are allowed + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const networkPolicyPeer: k8s.NetworkPolicyPeer = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ipBlock | @smallcase/cdk8s-botkube.k8s.IpBlock | IPBlock defines policy on a particular IPBlock. | +| namespaceSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | Selects Namespaces using cluster-scoped labels. | +| podSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | This is a label selector which selects Pods. | + +--- + +##### `ipBlock`Optional + +```typescript +public readonly ipBlock: IpBlock; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IpBlock + +IPBlock defines policy on a particular IPBlock. + +If this field is set then neither of the other fields can be. + +--- + +##### `namespaceSelector`Optional + +```typescript +public readonly namespaceSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +Selects Namespaces using cluster-scoped labels. + +This field follows standard label selector semantics; if present but empty, it selects all namespaces. + +If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector. + +--- + +##### `podSelector`Optional + +```typescript +public readonly podSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +This is a label selector which selects Pods. + +This field follows standard label selector semantics; if present but empty, it selects all pods. + +If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace. + +--- + +### NetworkPolicyPort + +NetworkPolicyPort describes a port to allow traffic on. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const networkPolicyPort: k8s.NetworkPolicyPort = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| endPort | number | If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. | +| port | @smallcase/cdk8s-botkube.k8s.IntOrString | The port on the given protocol. | +| protocol | string | The protocol (TCP, UDP, or SCTP) which traffic must match. | + +--- + +##### `endPort`Optional + +```typescript +public readonly endPort: number; +``` + +- *Type:* number + +If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. + +This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. This feature is in Alpha state and should be enabled using the Feature Gate "NetworkPolicyEndPort". + +--- + +##### `port`Optional + +```typescript +public readonly port: IntOrString; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IntOrString + +The port on the given protocol. + +This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched. + +--- + +##### `protocol`Optional + +```typescript +public readonly protocol: string; +``` + +- *Type:* string + +The protocol (TCP, UDP, or SCTP) which traffic must match. + +If not specified, this field defaults to TCP. + +--- + +### NetworkPolicySpec + +NetworkPolicySpec provides the specification of a NetworkPolicy. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const networkPolicySpec: k8s.NetworkPolicySpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| podSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | Selects the pods to which this NetworkPolicy object applies. | +| egress | @smallcase/cdk8s-botkube.k8s.NetworkPolicyEgressRule[] | List of egress rules to be applied to the selected pods. | +| ingress | @smallcase/cdk8s-botkube.k8s.NetworkPolicyIngressRule[] | List of ingress rules to be applied to the selected pods. | +| policyTypes | string[] | List of rule types that the NetworkPolicy relates to. | + +--- + +##### `podSelector`Required + +```typescript +public readonly podSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +Selects the pods to which this NetworkPolicy object applies. + +The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace. + +--- + +##### `egress`Optional + +```typescript +public readonly egress: NetworkPolicyEgressRule[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NetworkPolicyEgressRule[] + +List of egress rules to be applied to the selected pods. + +Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8 + +--- + +##### `ingress`Optional + +```typescript +public readonly ingress: NetworkPolicyIngressRule[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NetworkPolicyIngressRule[] + +List of ingress rules to be applied to the selected pods. + +Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default) + +--- + +##### `policyTypes`Optional + +```typescript +public readonly policyTypes: string[]; +``` + +- *Type:* string[] + +List of rule types that the NetworkPolicy relates to. + +Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"]. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8 + +--- + +### NfsVolumeSource + +Represents an NFS mount that lasts the lifetime of a pod. + +NFS volumes do not support ownership management or SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const nfsVolumeSource: k8s.NfsVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| path | string | Path that is exported by the NFS server. | +| server | string | Server is the hostname or IP address of the NFS server. | +| readOnly | boolean | ReadOnly here will force the NFS export to be mounted with read-only permissions. | + +--- + +##### `path`Required + +```typescript +public readonly path: string; +``` + +- *Type:* string + +Path that is exported by the NFS server. + +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +--- + +##### `server`Required + +```typescript +public readonly server: string; +``` + +- *Type:* string + +Server is the hostname or IP address of the NFS server. + +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +ReadOnly here will force the NFS export to be mounted with read-only permissions. + +Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +--- + +### NodeAffinity + +Node affinity is a group of node affinity scheduling rules. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const nodeAffinity: k8s.NodeAffinity = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| preferredDuringSchedulingIgnoredDuringExecution | @smallcase/cdk8s-botkube.k8s.PreferredSchedulingTerm[] | The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. | +| requiredDuringSchedulingIgnoredDuringExecution | @smallcase/cdk8s-botkube.k8s.NodeSelector | If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. | + +--- + +##### `preferredDuringSchedulingIgnoredDuringExecution`Optional + +```typescript +public readonly preferredDuringSchedulingIgnoredDuringExecution: PreferredSchedulingTerm[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PreferredSchedulingTerm[] + +The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. + +The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. + +--- + +##### `requiredDuringSchedulingIgnoredDuringExecution`Optional + +```typescript +public readonly requiredDuringSchedulingIgnoredDuringExecution: NodeSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NodeSelector + +If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. + +If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. + +--- + +### NodeConfigSource + +NodeConfigSource specifies a source of node configuration. + +Exactly one subfield (excluding metadata) must be non-nil. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const nodeConfigSource: k8s.NodeConfigSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| configMap | @smallcase/cdk8s-botkube.k8s.ConfigMapNodeConfigSource | ConfigMap is a reference to a Node's ConfigMap. | + +--- + +##### `configMap`Optional + +```typescript +public readonly configMap: ConfigMapNodeConfigSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ConfigMapNodeConfigSource + +ConfigMap is a reference to a Node's ConfigMap. + +--- + +### NodeSelector + +A node selector represents the union of the results of one or more label queries over a set of nodes; + +that is, it represents the OR of the selectors represented by the node selector terms. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const nodeSelector: k8s.NodeSelector = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| nodeSelectorTerms | @smallcase/cdk8s-botkube.k8s.NodeSelectorTerm[] | Required. | + +--- + +##### `nodeSelectorTerms`Required + +```typescript +public readonly nodeSelectorTerms: NodeSelectorTerm[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NodeSelectorTerm[] + +Required. + +A list of node selector terms. The terms are ORed. + +--- + +### NodeSelectorRequirement + +A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const nodeSelectorRequirement: k8s.NodeSelectorRequirement = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| key | string | The label key that the selector applies to. | +| operator | string | Represents a key's relationship to a set of values. | +| values | string[] | An array of string values. | + +--- + +##### `key`Required + +```typescript +public readonly key: string; +``` + +- *Type:* string + +The label key that the selector applies to. + +--- + +##### `operator`Required + +```typescript +public readonly operator: string; +``` + +- *Type:* string + +Represents a key's relationship to a set of values. + +Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + +--- + +##### `values`Optional + +```typescript +public readonly values: string[]; +``` + +- *Type:* string[] + +An array of string values. + +If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + +--- + +### NodeSelectorTerm + +A null or empty node selector term matches no objects. + +The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const nodeSelectorTerm: k8s.NodeSelectorTerm = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| matchExpressions | @smallcase/cdk8s-botkube.k8s.NodeSelectorRequirement[] | A list of node selector requirements by node's labels. | +| matchFields | @smallcase/cdk8s-botkube.k8s.NodeSelectorRequirement[] | A list of node selector requirements by node's fields. | + +--- + +##### `matchExpressions`Optional + +```typescript +public readonly matchExpressions: NodeSelectorRequirement[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NodeSelectorRequirement[] + +A list of node selector requirements by node's labels. + +--- + +##### `matchFields`Optional + +```typescript +public readonly matchFields: NodeSelectorRequirement[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NodeSelectorRequirement[] + +A list of node selector requirements by node's fields. + +--- + +### NodeSpec + +NodeSpec describes the attributes that a node is created with. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const nodeSpec: k8s.NodeSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| configSource | @smallcase/cdk8s-botkube.k8s.NodeConfigSource | If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field. | +| externalId | string | Deprecated. | +| podCidr | string | PodCIDR represents the pod IP range assigned to the node. | +| podCidRs | string[] | podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. | +| providerId | string | ID of the node assigned by the cloud provider in the format: ://. | +| taints | @smallcase/cdk8s-botkube.k8s.Taint[] | If specified, the node's taints. | +| unschedulable | boolean | Unschedulable controls node schedulability of new pods. | + +--- + +##### `configSource`Optional + +```typescript +public readonly configSource: NodeConfigSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NodeConfigSource + +If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field. + +--- + +##### `externalId`Optional + +```typescript +public readonly externalId: string; +``` + +- *Type:* string + +Deprecated. + +Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966 + +--- + +##### `podCidr`Optional + +```typescript +public readonly podCidr: string; +``` + +- *Type:* string + +PodCIDR represents the pod IP range assigned to the node. + +--- + +##### `podCidRs`Optional + +```typescript +public readonly podCidRs: string[]; +``` + +- *Type:* string[] + +podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. + +If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6. + +--- + +##### `providerId`Optional + +```typescript +public readonly providerId: string; +``` + +- *Type:* string + +ID of the node assigned by the cloud provider in the format: ://. + +--- + +##### `taints`Optional + +```typescript +public readonly taints: Taint[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Taint[] + +If specified, the node's taints. + +--- + +##### `unschedulable`Optional + +```typescript +public readonly unschedulable: boolean; +``` + +- *Type:* boolean + +Unschedulable controls node schedulability of new pods. + +By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration + +--- + +### NonResourceAttributes + +NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const nonResourceAttributes: k8s.NonResourceAttributes = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| path | string | Path is the URL path of the request. | +| verb | string | Verb is the standard HTTP verb. | + +--- + +##### `path`Optional + +```typescript +public readonly path: string; +``` + +- *Type:* string + +Path is the URL path of the request. + +--- + +##### `verb`Optional + +```typescript +public readonly verb: string; +``` + +- *Type:* string + +Verb is the standard HTTP verb. + +--- + +### NonResourceAttributesV1Beta1 + +NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const nonResourceAttributesV1Beta1: k8s.NonResourceAttributesV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| path | string | Path is the URL path of the request. | +| verb | string | Verb is the standard HTTP verb. | + +--- + +##### `path`Optional + +```typescript +public readonly path: string; +``` + +- *Type:* string + +Path is the URL path of the request. + +--- + +##### `verb`Optional + +```typescript +public readonly verb: string; +``` + +- *Type:* string + +Verb is the standard HTTP verb. + +--- + +### NonResourcePolicyRuleV1Beta1 + +NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. + +A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const nonResourcePolicyRuleV1Beta1: k8s.NonResourcePolicyRuleV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| nonResourceUrLs | string[] | `nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. | +| verbs | string[] | `verbs` is a list of matching verbs and may not be empty. | + +--- + +##### `nonResourceUrLs`Required + +```typescript +public readonly nonResourceUrLs: string[]; +``` + +- *Type:* string[] + +`nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. + +For example: +- "/healthz" is legal +- "/hea*" is illegal +- "/hea" is legal but matches nothing +- "/hea/*" also matches nothing +- "/healthz/*" matches all per-component health checks. +"*" matches all non-resource urls. if it is present, it must be the only entry. Required. + +--- + +##### `verbs`Required + +```typescript +public readonly verbs: string[]; +``` + +- *Type:* string[] + +`verbs` is a list of matching verbs and may not be empty. + +"*" matches all verbs. If it is present, it must be the only entry. Required. + +--- + +### ObjectFieldSelector + +ObjectFieldSelector selects an APIVersioned field of an object. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const objectFieldSelector: k8s.ObjectFieldSelector = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| fieldPath | string | Path of the field to select in the specified API version. | +| apiVersion | string | Version of the schema the FieldPath is written in terms of, defaults to "v1". | + +--- + +##### `fieldPath`Required + +```typescript +public readonly fieldPath: string; +``` + +- *Type:* string + +Path of the field to select in the specified API version. + +--- + +##### `apiVersion`Optional + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +Version of the schema the FieldPath is written in terms of, defaults to "v1". + +--- + +### ObjectMeta + +ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const objectMeta: k8s.ObjectMeta = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| annotations | {[ key: string ]: string} | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. | +| clusterName | string | The name of the cluster which the object belongs to. | +| creationTimestamp | Date | CreationTimestamp is a timestamp representing the server time when this object was created. | +| deletionGracePeriodSeconds | number | Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. | +| deletionTimestamp | Date | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. | +| finalizers | string[] | Must be empty before the object is deleted from the registry. | +| generateName | string | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. | +| generation | number | A sequence number representing a specific generation of the desired state. | +| labels | {[ key: string ]: string} | Map of string keys and values that can be used to organize and categorize (scope and select) objects. | +| managedFields | @smallcase/cdk8s-botkube.k8s.ManagedFieldsEntry[] | ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. | +| name | string | Name must be unique within a namespace. | +| namespace | string | Namespace defines the space within which each name must be unique. | +| ownerReferences | @smallcase/cdk8s-botkube.k8s.OwnerReference[] | List of objects depended by this object. | +| resourceVersion | string | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. | +| selfLink | string | SelfLink is a URL representing this object. Populated by the system. Read-only. | +| uid | string | UID is the unique in time and space value for this object. | + +--- + +##### `annotations`Optional + +```typescript +public readonly annotations: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. + +They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations + +--- + +##### `clusterName`Optional + +```typescript +public readonly clusterName: string; +``` + +- *Type:* string + +The name of the cluster which the object belongs to. + +This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. + +--- + +##### `creationTimestamp`Optional + +```typescript +public readonly creationTimestamp: Date; +``` + +- *Type:* Date + +CreationTimestamp is a timestamp representing the server time when this object was created. + +It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. + +Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `deletionGracePeriodSeconds`Optional + +```typescript +public readonly deletionGracePeriodSeconds: number; +``` + +- *Type:* number + +Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. + +Only set when deletionTimestamp is also set. May only be shortened. Read-only. + +--- + +##### `deletionTimestamp`Optional + +```typescript +public readonly deletionTimestamp: Date; +``` + +- *Type:* Date + +DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. + +This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. + +Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `finalizers`Optional + +```typescript +public readonly finalizers: string[]; +``` + +- *Type:* string[] + +Must be empty before the object is deleted from the registry. + +Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. + +--- + +##### `generateName`Optional + +```typescript +public readonly generateName: string; +``` + +- *Type:* string + +GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. + +If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. + +If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). + +Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency + +--- + +##### `generation`Optional + +```typescript +public readonly generation: number; +``` + +- *Type:* number + +A sequence number representing a specific generation of the desired state. + +Populated by the system. Read-only. + +--- + +##### `labels`Optional + +```typescript +public readonly labels: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +Map of string keys and values that can be used to organize and categorize (scope and select) objects. + +May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels + +--- + +##### `managedFields`Optional + +```typescript +public readonly managedFields: ManagedFieldsEntry[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ManagedFieldsEntry[] + +ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. + +This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name must be unique within a namespace. + +Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names + +--- + +##### `namespace`Optional + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +Namespace defines the space within which each name must be unique. + +An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. + +Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces + +--- + +##### `ownerReferences`Optional + +```typescript +public readonly ownerReferences: OwnerReference[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.OwnerReference[] + +List of objects depended by this object. + +If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. + +--- + +##### `resourceVersion`Optional + +```typescript +public readonly resourceVersion: string; +``` + +- *Type:* string + +An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. + +May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. + +Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + +--- + +##### `selfLink`Optional + +```typescript +public readonly selfLink: string; +``` + +- *Type:* string + +SelfLink is a URL representing this object. Populated by the system. Read-only. + +DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. + +--- + +##### `uid`Optional + +```typescript +public readonly uid: string; +``` + +- *Type:* string + +UID is the unique in time and space value for this object. + +It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. + +Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids + +--- + +### ObjectMetricSourceV2Beta1 + +ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const objectMetricSourceV2Beta1: k8s.ObjectMetricSourceV2Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metricName | string | metricName is the name of the metric in question. | +| target | @smallcase/cdk8s-botkube.k8s.CrossVersionObjectReferenceV2Beta1 | target is the described Kubernetes object. | +| targetValue | @smallcase/cdk8s-botkube.k8s.Quantity | targetValue is the target value of the metric (as a quantity). | +| averageValue | @smallcase/cdk8s-botkube.k8s.Quantity | averageValue is the target value of the average of the metric across all relevant pods (as a quantity). | +| selector | @smallcase/cdk8s-botkube.k8s.LabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics. | + +--- + +##### `metricName`Required + +```typescript +public readonly metricName: string; +``` + +- *Type:* string + +metricName is the name of the metric in question. + +--- + +##### `target`Required + +```typescript +public readonly target: CrossVersionObjectReferenceV2Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CrossVersionObjectReferenceV2Beta1 + +target is the described Kubernetes object. + +--- + +##### `targetValue`Required + +```typescript +public readonly targetValue: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +targetValue is the target value of the metric (as a quantity). + +--- + +##### `averageValue`Optional + +```typescript +public readonly averageValue: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +averageValue is the target value of the average of the metric across all relevant pods (as a quantity). + +--- + +##### `selector`Optional + +```typescript +public readonly selector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics. + +--- + +### ObjectMetricSourceV2Beta2 + +ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const objectMetricSourceV2Beta2: k8s.ObjectMetricSourceV2Beta2 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| describedObject | @smallcase/cdk8s-botkube.k8s.CrossVersionObjectReferenceV2Beta2 | *No description.* | +| metric | @smallcase/cdk8s-botkube.k8s.MetricIdentifierV2Beta2 | metric identifies the target metric by name and selector. | +| target | @smallcase/cdk8s-botkube.k8s.MetricTargetV2Beta2 | target specifies the target value for the given metric. | + +--- + +##### `describedObject`Required + +```typescript +public readonly describedObject: CrossVersionObjectReferenceV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CrossVersionObjectReferenceV2Beta2 + +--- + +##### `metric`Required + +```typescript +public readonly metric: MetricIdentifierV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.MetricIdentifierV2Beta2 + +metric identifies the target metric by name and selector. + +--- + +##### `target`Required + +```typescript +public readonly target: MetricTargetV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.MetricTargetV2Beta2 + +target specifies the target value for the given metric. + +--- + +### ObjectReference + +ObjectReference contains enough information to let you inspect or modify the referred object. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const objectReference: k8s.ObjectReference = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiVersion | string | API version of the referent. | +| fieldPath | string | If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. | +| kind | string | Kind of the referent. | +| name | string | Name of the referent. | +| namespace | string | Namespace of the referent. | +| resourceVersion | string | Specific resourceVersion to which this reference is made, if any. | +| uid | string | UID of the referent. | + +--- + +##### `apiVersion`Optional + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +API version of the referent. + +--- + +##### `fieldPath`Optional + +```typescript +public readonly fieldPath: string; +``` + +- *Type:* string + +If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. + +--- + +##### `kind`Optional + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind of the referent. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the referent. + +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +--- + +##### `namespace`Optional + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +Namespace of the referent. + +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + +--- + +##### `resourceVersion`Optional + +```typescript +public readonly resourceVersion: string; +``` + +- *Type:* string + +Specific resourceVersion to which this reference is made, if any. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + +--- + +##### `uid`Optional + +```typescript +public readonly uid: string; +``` + +- *Type:* string + +UID of the referent. + +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids + +--- + +### Overhead + +Overhead structure represents the resource overhead associated with running a pod. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const overhead: k8s.Overhead = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| podFixed | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} | PodFixed represents the fixed resource overhead associated with running a pod. | + +--- + +##### `podFixed`Optional + +```typescript +public readonly podFixed: {[ key: string ]: Quantity}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} + +PodFixed represents the fixed resource overhead associated with running a pod. + +--- + +### OverheadV1Alpha1 + +Overhead structure represents the resource overhead associated with running a pod. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const overheadV1Alpha1: k8s.OverheadV1Alpha1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| podFixed | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} | PodFixed represents the fixed resource overhead associated with running a pod. | + +--- + +##### `podFixed`Optional + +```typescript +public readonly podFixed: {[ key: string ]: Quantity}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} + +PodFixed represents the fixed resource overhead associated with running a pod. + +--- + +### OverheadV1Beta1 + +Overhead structure represents the resource overhead associated with running a pod. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const overheadV1Beta1: k8s.OverheadV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| podFixed | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} | PodFixed represents the fixed resource overhead associated with running a pod. | + +--- + +##### `podFixed`Optional + +```typescript +public readonly podFixed: {[ key: string ]: Quantity}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} + +PodFixed represents the fixed resource overhead associated with running a pod. + +--- + +### OwnerReference + +OwnerReference contains enough information to let you identify an owning object. + +An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ownerReference: k8s.OwnerReference = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiVersion | string | API version of the referent. | +| kind | string | Kind of the referent. | +| name | string | Name of the referent. | +| uid | string | UID of the referent. | +| blockOwnerDeletion | boolean | If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. | +| controller | boolean | If true, this reference points to the managing controller. | + +--- + +##### `apiVersion`Required + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string + +API version of the referent. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind of the referent. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the referent. + +More info: http://kubernetes.io/docs/user-guide/identifiers#names + +--- + +##### `uid`Required + +```typescript +public readonly uid: string; +``` + +- *Type:* string + +UID of the referent. + +More info: http://kubernetes.io/docs/user-guide/identifiers#uids + +--- + +##### `blockOwnerDeletion`Optional + +```typescript +public readonly blockOwnerDeletion: boolean; +``` + +- *Type:* boolean +- *Default:* false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. + +If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. + +Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. + +--- + +##### `controller`Optional + +```typescript +public readonly controller: boolean; +``` + +- *Type:* boolean + +If true, this reference points to the managing controller. + +--- + +### PersistentVolumeClaimSpec + +PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const persistentVolumeClaimSpec: k8s.PersistentVolumeClaimSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| accessModes | string[] | AccessModes contains the desired access modes the volume should have. | +| dataSource | @smallcase/cdk8s-botkube.k8s.TypedLocalObjectReference | This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. | +| resources | @smallcase/cdk8s-botkube.k8s.ResourceRequirements | Resources represents the minimum resources the volume should have. | +| selector | @smallcase/cdk8s-botkube.k8s.LabelSelector | A label query over volumes to consider for binding. | +| storageClassName | string | Name of the StorageClass required by the claim. | +| volumeMode | string | volumeMode defines what type of volume is required by the claim. | +| volumeName | string | VolumeName is the binding reference to the PersistentVolume backing this claim. | + +--- + +##### `accessModes`Optional + +```typescript +public readonly accessModes: string[]; +``` + +- *Type:* string[] + +AccessModes contains the desired access modes the volume should have. + +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 + +--- + +##### `dataSource`Optional + +```typescript +public readonly dataSource: TypedLocalObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.TypedLocalObjectReference + +This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. + +--- + +##### `resources`Optional + +```typescript +public readonly resources: ResourceRequirements; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ResourceRequirements + +Resources represents the minimum resources the volume should have. + +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources + +--- + +##### `selector`Optional + +```typescript +public readonly selector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +A label query over volumes to consider for binding. + +--- + +##### `storageClassName`Optional + +```typescript +public readonly storageClassName: string; +``` + +- *Type:* string + +Name of the StorageClass required by the claim. + +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 + +--- + +##### `volumeMode`Optional + +```typescript +public readonly volumeMode: string; +``` + +- *Type:* string + +volumeMode defines what type of volume is required by the claim. + +Value of Filesystem is implied when not included in claim spec. + +--- + +##### `volumeName`Optional + +```typescript +public readonly volumeName: string; +``` + +- *Type:* string + +VolumeName is the binding reference to the PersistentVolume backing this claim. + +--- + +### PersistentVolumeClaimTemplate + +PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const persistentVolumeClaimTemplate: k8s.PersistentVolumeClaimTemplate = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| spec | @smallcase/cdk8s-botkube.k8s.PersistentVolumeClaimSpec | The specification for the PersistentVolumeClaim. | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | May contain labels and annotations that will be copied into the PVC when creating it. | + +--- + +##### `spec`Required + +```typescript +public readonly spec: PersistentVolumeClaimSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PersistentVolumeClaimSpec + +The specification for the PersistentVolumeClaim. + +The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +May contain labels and annotations that will be copied into the PVC when creating it. + +No other fields are allowed and will be rejected during validation. + +--- + +### PersistentVolumeClaimVolumeSource + +PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. + +This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const persistentVolumeClaimVolumeSource: k8s.PersistentVolumeClaimVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| claimName | string | ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. | +| readOnly | boolean | Will force the ReadOnly setting in VolumeMounts. | + +--- + +##### `claimName`Required + +```typescript +public readonly claimName: string; +``` + +- *Type:* string + +ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. + +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean + +Will force the ReadOnly setting in VolumeMounts. + +Default false. + +--- + +### PersistentVolumeSpec + +PersistentVolumeSpec is the specification of a persistent volume. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const persistentVolumeSpec: k8s.PersistentVolumeSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| accessModes | string[] | AccessModes contains all ways the volume can be mounted. | +| awsElasticBlockStore | @smallcase/cdk8s-botkube.k8s.AwsElasticBlockStoreVolumeSource | AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. | +| azureDisk | @smallcase/cdk8s-botkube.k8s.AzureDiskVolumeSource | AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. | +| azureFile | @smallcase/cdk8s-botkube.k8s.AzureFilePersistentVolumeSource | AzureFile represents an Azure File Service mount on the host and bind mount to the pod. | +| capacity | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} | A description of the persistent volume's resources and capacity. | +| cephfs | @smallcase/cdk8s-botkube.k8s.CephFsPersistentVolumeSource | CephFS represents a Ceph FS mount on the host that shares a pod's lifetime. | +| cinder | @smallcase/cdk8s-botkube.k8s.CinderPersistentVolumeSource | Cinder represents a cinder volume attached and mounted on kubelets host machine. | +| claimRef | @smallcase/cdk8s-botkube.k8s.ObjectReference | ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. | +| csi | @smallcase/cdk8s-botkube.k8s.CsiPersistentVolumeSource | CSI represents storage that is handled by an external CSI driver (Beta feature). | +| fc | @smallcase/cdk8s-botkube.k8s.FcVolumeSource | FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. | +| flexVolume | @smallcase/cdk8s-botkube.k8s.FlexPersistentVolumeSource | FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. | +| flocker | @smallcase/cdk8s-botkube.k8s.FlockerVolumeSource | Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. | +| gcePersistentDisk | @smallcase/cdk8s-botkube.k8s.GcePersistentDiskVolumeSource | GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. | +| glusterfs | @smallcase/cdk8s-botkube.k8s.GlusterfsPersistentVolumeSource | Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. | +| hostPath | @smallcase/cdk8s-botkube.k8s.HostPathVolumeSource | HostPath represents a directory on the host. | +| iscsi | @smallcase/cdk8s-botkube.k8s.IscsiPersistentVolumeSource | ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. | +| local | @smallcase/cdk8s-botkube.k8s.LocalVolumeSource | Local represents directly-attached storage with node affinity. | +| mountOptions | string[] | A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options. | +| nfs | @smallcase/cdk8s-botkube.k8s.NfsVolumeSource | NFS represents an NFS mount on the host. | +| nodeAffinity | @smallcase/cdk8s-botkube.k8s.VolumeNodeAffinity | NodeAffinity defines constraints that limit what nodes this volume can be accessed from. | +| persistentVolumeReclaimPolicy | string | What happens to a persistent volume when released from its claim. | +| photonPersistentDisk | @smallcase/cdk8s-botkube.k8s.PhotonPersistentDiskVolumeSource | PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. | +| portworxVolume | @smallcase/cdk8s-botkube.k8s.PortworxVolumeSource | PortworxVolume represents a portworx volume attached and mounted on kubelets host machine. | +| quobyte | @smallcase/cdk8s-botkube.k8s.QuobyteVolumeSource | Quobyte represents a Quobyte mount on the host that shares a pod's lifetime. | +| rbd | @smallcase/cdk8s-botkube.k8s.RbdPersistentVolumeSource | RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. | +| scaleIo | @smallcase/cdk8s-botkube.k8s.ScaleIoPersistentVolumeSource | ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. | +| storageClassName | string | Name of StorageClass to which this persistent volume belongs. | +| storageos | @smallcase/cdk8s-botkube.k8s.StorageOsPersistentVolumeSource | StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md. | +| volumeMode | string | volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. | +| vsphereVolume | @smallcase/cdk8s-botkube.k8s.VsphereVirtualDiskVolumeSource | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. | + +--- + +##### `accessModes`Optional + +```typescript +public readonly accessModes: string[]; +``` + +- *Type:* string[] + +AccessModes contains all ways the volume can be mounted. + +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes + +--- + +##### `awsElasticBlockStore`Optional + +```typescript +public readonly awsElasticBlockStore: AwsElasticBlockStoreVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.AwsElasticBlockStoreVolumeSource + +AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. + +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +--- + +##### `azureDisk`Optional + +```typescript +public readonly azureDisk: AzureDiskVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.AzureDiskVolumeSource + +AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + +--- + +##### `azureFile`Optional + +```typescript +public readonly azureFile: AzureFilePersistentVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.AzureFilePersistentVolumeSource + +AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + +--- + +##### `capacity`Optional + +```typescript +public readonly capacity: {[ key: string ]: Quantity}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} + +A description of the persistent volume's resources and capacity. + +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity + +--- + +##### `cephfs`Optional + +```typescript +public readonly cephfs: CephFsPersistentVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CephFsPersistentVolumeSource + +CephFS represents a Ceph FS mount on the host that shares a pod's lifetime. + +--- + +##### `cinder`Optional + +```typescript +public readonly cinder: CinderPersistentVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CinderPersistentVolumeSource + +Cinder represents a cinder volume attached and mounted on kubelets host machine. + +More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +--- + +##### `claimRef`Optional + +```typescript +public readonly claimRef: ObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectReference + +ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. + +Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding + +--- + +##### `csi`Optional + +```typescript +public readonly csi: CsiPersistentVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CsiPersistentVolumeSource + +CSI represents storage that is handled by an external CSI driver (Beta feature). + +--- + +##### `fc`Optional + +```typescript +public readonly fc: FcVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.FcVolumeSource + +FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + +--- + +##### `flexVolume`Optional + +```typescript +public readonly flexVolume: FlexPersistentVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.FlexPersistentVolumeSource + +FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. + +--- + +##### `flocker`Optional + +```typescript +public readonly flocker: FlockerVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.FlockerVolumeSource + +Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. + +This depends on the Flocker control service being running + +--- + +##### `gcePersistentDisk`Optional + +```typescript +public readonly gcePersistentDisk: GcePersistentDiskVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.GcePersistentDiskVolumeSource + +GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. + +Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +--- + +##### `glusterfs`Optional + +```typescript +public readonly glusterfs: GlusterfsPersistentVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.GlusterfsPersistentVolumeSource + +Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. + +Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md + +--- + +##### `hostPath`Optional + +```typescript +public readonly hostPath: HostPathVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HostPathVolumeSource + +HostPath represents a directory on the host. + +Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + +--- + +##### `iscsi`Optional + +```typescript +public readonly iscsi: IscsiPersistentVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IscsiPersistentVolumeSource + +ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. + +Provisioned by an admin. + +--- + +##### `local`Optional + +```typescript +public readonly local: LocalVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LocalVolumeSource + +Local represents directly-attached storage with node affinity. + +--- + +##### `mountOptions`Optional + +```typescript +public readonly mountOptions: string[]; +``` + +- *Type:* string[] + +A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options. + +--- + +##### `nfs`Optional + +```typescript +public readonly nfs: NfsVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NfsVolumeSource + +NFS represents an NFS mount on the host. + +Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + +--- + +##### `nodeAffinity`Optional + +```typescript +public readonly nodeAffinity: VolumeNodeAffinity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VolumeNodeAffinity + +NodeAffinity defines constraints that limit what nodes this volume can be accessed from. + +This field influences the scheduling of pods that use this volume. + +--- + +##### `persistentVolumeReclaimPolicy`Optional + +```typescript +public readonly persistentVolumeReclaimPolicy: string; +``` + +- *Type:* string + +What happens to a persistent volume when released from its claim. + +Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming + +--- + +##### `photonPersistentDisk`Optional + +```typescript +public readonly photonPersistentDisk: PhotonPersistentDiskVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PhotonPersistentDiskVolumeSource + +PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. + +--- + +##### `portworxVolume`Optional + +```typescript +public readonly portworxVolume: PortworxVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PortworxVolumeSource + +PortworxVolume represents a portworx volume attached and mounted on kubelets host machine. + +--- + +##### `quobyte`Optional + +```typescript +public readonly quobyte: QuobyteVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.QuobyteVolumeSource + +Quobyte represents a Quobyte mount on the host that shares a pod's lifetime. + +--- + +##### `rbd`Optional + +```typescript +public readonly rbd: RbdPersistentVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RbdPersistentVolumeSource + +RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. + +More info: https://examples.k8s.io/volumes/rbd/README.md + +--- + +##### `scaleIo`Optional + +```typescript +public readonly scaleIo: ScaleIoPersistentVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ScaleIoPersistentVolumeSource + +ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + +--- + +##### `storageClassName`Optional + +```typescript +public readonly storageClassName: string; +``` + +- *Type:* string + +Name of StorageClass to which this persistent volume belongs. + +Empty value means that this volume does not belong to any StorageClass. + +--- + +##### `storageos`Optional + +```typescript +public readonly storageos: StorageOsPersistentVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.StorageOsPersistentVolumeSource + +StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md. + +--- + +##### `volumeMode`Optional + +```typescript +public readonly volumeMode: string; +``` + +- *Type:* string + +volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. + +Value of Filesystem is implied when not included in spec. + +--- + +##### `vsphereVolume`Optional + +```typescript +public readonly vsphereVolume: VsphereVirtualDiskVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VsphereVirtualDiskVolumeSource + +VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. + +--- + +### PhotonPersistentDiskVolumeSource + +Represents a Photon Controller persistent disk resource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const photonPersistentDiskVolumeSource: k8s.PhotonPersistentDiskVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| pdId | string | ID that identifies Photon Controller persistent disk. | +| fsType | string | Filesystem type to mount. | + +--- + +##### `pdId`Required + +```typescript +public readonly pdId: string; +``` + +- *Type:* string + +ID that identifies Photon Controller persistent disk. + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type to mount. + +Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +--- + +### PodAffinity + +Pod affinity is a group of inter pod affinity scheduling rules. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const podAffinity: k8s.PodAffinity = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| preferredDuringSchedulingIgnoredDuringExecution | @smallcase/cdk8s-botkube.k8s.WeightedPodAffinityTerm[] | The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. | +| requiredDuringSchedulingIgnoredDuringExecution | @smallcase/cdk8s-botkube.k8s.PodAffinityTerm[] | If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. | + +--- + +##### `preferredDuringSchedulingIgnoredDuringExecution`Optional + +```typescript +public readonly preferredDuringSchedulingIgnoredDuringExecution: WeightedPodAffinityTerm[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.WeightedPodAffinityTerm[] + +The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. + +The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. + +--- + +##### `requiredDuringSchedulingIgnoredDuringExecution`Optional + +```typescript +public readonly requiredDuringSchedulingIgnoredDuringExecution: PodAffinityTerm[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodAffinityTerm[] + +If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. + +If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. + +--- + +### PodAffinityTerm + +Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const podAffinityTerm: k8s.PodAffinityTerm = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| topologyKey | string | This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. | +| labelSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | A label query over a set of resources, in this case pods. | +| namespaces | string[] | namespaces specifies a static list of namespace names that the term applies to. | +| namespaceSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | A label query over the set of namespaces that the term applies to. | + +--- + +##### `topologyKey`Required + +```typescript +public readonly topologyKey: string; +``` + +- *Type:* string + +This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. + +Empty topologyKey is not allowed. + +--- + +##### `labelSelector`Optional + +```typescript +public readonly labelSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +A label query over a set of resources, in this case pods. + +--- + +##### `namespaces`Optional + +```typescript +public readonly namespaces: string[]; +``` + +- *Type:* string[] + +namespaces specifies a static list of namespace names that the term applies to. + +The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" + +--- + +##### `namespaceSelector`Optional + +```typescript +public readonly namespaceSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +A label query over the set of namespaces that the term applies to. + +The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is alpha-level and is only honored when PodAffinityNamespaceSelector feature is enabled. + +--- + +### PodAntiAffinity + +Pod anti affinity is a group of inter pod anti affinity scheduling rules. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const podAntiAffinity: k8s.PodAntiAffinity = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| preferredDuringSchedulingIgnoredDuringExecution | @smallcase/cdk8s-botkube.k8s.WeightedPodAffinityTerm[] | The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. | +| requiredDuringSchedulingIgnoredDuringExecution | @smallcase/cdk8s-botkube.k8s.PodAffinityTerm[] | If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. | + +--- + +##### `preferredDuringSchedulingIgnoredDuringExecution`Optional + +```typescript +public readonly preferredDuringSchedulingIgnoredDuringExecution: WeightedPodAffinityTerm[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.WeightedPodAffinityTerm[] + +The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. + +The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. + +--- + +##### `requiredDuringSchedulingIgnoredDuringExecution`Optional + +```typescript +public readonly requiredDuringSchedulingIgnoredDuringExecution: PodAffinityTerm[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodAffinityTerm[] + +If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. + +If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. + +--- + +### PodDisruptionBudgetSpec + +PodDisruptionBudgetSpec is a description of a PodDisruptionBudget. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const podDisruptionBudgetSpec: k8s.PodDisruptionBudgetSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| maxUnavailable | @smallcase/cdk8s-botkube.k8s.IntOrString | An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". | +| minAvailable | @smallcase/cdk8s-botkube.k8s.IntOrString | An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". | +| selector | @smallcase/cdk8s-botkube.k8s.LabelSelector | Label query over pods whose evictions are managed by the disruption budget. | + +--- + +##### `maxUnavailable`Optional + +```typescript +public readonly maxUnavailable: IntOrString; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IntOrString + +An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". + +--- + +##### `minAvailable`Optional + +```typescript +public readonly minAvailable: IntOrString; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IntOrString + +An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". + +--- + +##### `selector`Optional + +```typescript +public readonly selector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +Label query over pods whose evictions are managed by the disruption budget. + +A null selector will match no pods, while an empty ({}) selector will select all pods within the namespace. + +--- + +### PodDisruptionBudgetSpecV1Beta1 + +PodDisruptionBudgetSpec is a description of a PodDisruptionBudget. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const podDisruptionBudgetSpecV1Beta1: k8s.PodDisruptionBudgetSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| maxUnavailable | @smallcase/cdk8s-botkube.k8s.IntOrString | An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". | +| minAvailable | @smallcase/cdk8s-botkube.k8s.IntOrString | An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". | +| selector | @smallcase/cdk8s-botkube.k8s.LabelSelector | Label query over pods whose evictions are managed by the disruption budget. | + +--- + +##### `maxUnavailable`Optional + +```typescript +public readonly maxUnavailable: IntOrString; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IntOrString + +An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". + +--- + +##### `minAvailable`Optional + +```typescript +public readonly minAvailable: IntOrString; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IntOrString + +An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". + +--- + +##### `selector`Optional + +```typescript +public readonly selector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +Label query over pods whose evictions are managed by the disruption budget. + +A null selector selects no pods. An empty selector ({}) also selects no pods, which differs from standard behavior of selecting all pods. In policy/v1, an empty selector will select all pods in the namespace. + +--- + +### PodDnsConfig + +PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const podDnsConfig: k8s.PodDnsConfig = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| nameservers | string[] | A list of DNS name server IP addresses. | +| options | @smallcase/cdk8s-botkube.k8s.PodDnsConfigOption[] | A list of DNS resolver options. | +| searches | string[] | A list of DNS search domains for host-name lookup. | + +--- + +##### `nameservers`Optional + +```typescript +public readonly nameservers: string[]; +``` + +- *Type:* string[] + +A list of DNS name server IP addresses. + +This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. + +--- + +##### `options`Optional + +```typescript +public readonly options: PodDnsConfigOption[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodDnsConfigOption[] + +A list of DNS resolver options. + +This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. + +--- + +##### `searches`Optional + +```typescript +public readonly searches: string[]; +``` + +- *Type:* string[] + +A list of DNS search domains for host-name lookup. + +This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. + +--- + +### PodDnsConfigOption + +PodDNSConfigOption defines DNS resolver options of a pod. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const podDnsConfigOption: k8s.PodDnsConfigOption = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | Required. | +| value | string | *No description.* | + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Required. + +--- + +##### `value`Optional + +```typescript +public readonly value: string; +``` + +- *Type:* string + +--- + +### PodReadinessGate + +PodReadinessGate contains the reference to a pod condition. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const podReadinessGate: k8s.PodReadinessGate = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| conditionType | string | ConditionType refers to a condition in the pod's condition list with matching type. | + +--- + +##### `conditionType`Required + +```typescript +public readonly conditionType: string; +``` + +- *Type:* string + +ConditionType refers to a condition in the pod's condition list with matching type. + +--- + +### PodSecurityContext + +PodSecurityContext holds pod-level security attributes and common container settings. + +Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const podSecurityContext: k8s.PodSecurityContext = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| fsGroup | number | A special supplemental group that applies to all containers in a pod. | +| fsGroupChangePolicy | string | fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. | +| runAsGroup | number | The GID to run the entrypoint of the container process. | +| runAsNonRoot | boolean | Indicates that the container must run as a non-root user. | +| runAsUser | number | The UID to run the entrypoint of the container process. | +| seccompProfile | @smallcase/cdk8s-botkube.k8s.SeccompProfile | The seccomp options to use by the containers in this pod. | +| seLinuxOptions | @smallcase/cdk8s-botkube.k8s.SeLinuxOptions | The SELinux context to be applied to all containers. | +| supplementalGroups | number[] | A list of groups applied to the first process run in each container, in addition to the container's primary GID. | +| sysctls | @smallcase/cdk8s-botkube.k8s.Sysctl[] | Sysctls hold a list of namespaced sysctls used for the pod. | +| windowsOptions | @smallcase/cdk8s-botkube.k8s.WindowsSecurityContextOptions | The Windows specific settings applied to all containers. | + +--- + +##### `fsGroup`Optional + +```typescript +public readonly fsGroup: number; +``` + +- *Type:* number + +A special supplemental group that applies to all containers in a pod. + +Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: + +1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- + +If unset, the Kubelet will not modify the ownership and permissions of any volume. + +--- + +##### `fsGroupChangePolicy`Optional + +```typescript +public readonly fsGroupChangePolicy: string; +``` + +- *Type:* string + +fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. + +This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. + +--- + +##### `runAsGroup`Optional + +```typescript +public readonly runAsGroup: number; +``` + +- *Type:* number + +The GID to run the entrypoint of the container process. + +Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + +--- + +##### `runAsNonRoot`Optional + +```typescript +public readonly runAsNonRoot: boolean; +``` + +- *Type:* boolean + +Indicates that the container must run as a non-root user. + +If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +--- + +##### `runAsUser`Optional + +```typescript +public readonly runAsUser: number; +``` + +- *Type:* number +- *Default:* user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + +The UID to run the entrypoint of the container process. + +Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + +--- + +##### `seccompProfile`Optional + +```typescript +public readonly seccompProfile: SeccompProfile; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SeccompProfile + +The seccomp options to use by the containers in this pod. + +--- + +##### `seLinuxOptions`Optional + +```typescript +public readonly seLinuxOptions: SeLinuxOptions; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SeLinuxOptions + +The SELinux context to be applied to all containers. + +If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + +--- + +##### `supplementalGroups`Optional + +```typescript +public readonly supplementalGroups: number[]; +``` + +- *Type:* number[] + +A list of groups applied to the first process run in each container, in addition to the container's primary GID. + +If unspecified, no groups will be added to any container. + +--- + +##### `sysctls`Optional + +```typescript +public readonly sysctls: Sysctl[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Sysctl[] + +Sysctls hold a list of namespaced sysctls used for the pod. + +Pods with unsupported sysctls (by the container runtime) might fail to launch. + +--- + +##### `windowsOptions`Optional + +```typescript +public readonly windowsOptions: WindowsSecurityContextOptions; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.WindowsSecurityContextOptions + +The Windows specific settings applied to all containers. + +If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +--- + +### PodSecurityPolicySpecV1Beta1 + +PodSecurityPolicySpec defines the policy enforced. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const podSecurityPolicySpecV1Beta1: k8s.PodSecurityPolicySpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| fsGroup | @smallcase/cdk8s-botkube.k8s.FsGroupStrategyOptionsV1Beta1 | fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. | +| runAsUser | @smallcase/cdk8s-botkube.k8s.RunAsUserStrategyOptionsV1Beta1 | runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set. | +| seLinux | @smallcase/cdk8s-botkube.k8s.SeLinuxStrategyOptionsV1Beta1 | seLinux is the strategy that will dictate the allowable labels that may be set. | +| supplementalGroups | @smallcase/cdk8s-botkube.k8s.SupplementalGroupsStrategyOptionsV1Beta1 | supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. | +| allowedCapabilities | string[] | allowedCapabilities is a list of capabilities that can be requested to add to the container. | +| allowedCsiDrivers | @smallcase/cdk8s-botkube.k8s.AllowedCsiDriverV1Beta1[] | AllowedCSIDrivers is an allowlist of inline CSI drivers that must be explicitly set to be embedded within a pod spec. | +| allowedFlexVolumes | @smallcase/cdk8s-botkube.k8s.AllowedFlexVolumeV1Beta1[] | allowedFlexVolumes is an allowlist of Flexvolumes. | +| allowedHostPaths | @smallcase/cdk8s-botkube.k8s.AllowedHostPathV1Beta1[] | allowedHostPaths is an allowlist of host paths. | +| allowedProcMountTypes | string[] | AllowedProcMountTypes is an allowlist of allowed ProcMountTypes. | +| allowedUnsafeSysctls | string[] | allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. | +| allowPrivilegeEscalation | boolean | allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. | +| defaultAddCapabilities | string[] | defaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. | +| defaultAllowPrivilegeEscalation | boolean | defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. | +| forbiddenSysctls | string[] | forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. | +| hostIpc | boolean | hostIPC determines if the policy allows the use of HostIPC in the pod spec. | +| hostNetwork | boolean | hostNetwork determines if the policy allows the use of HostNetwork in the pod spec. | +| hostPid | boolean | hostPID determines if the policy allows the use of HostPID in the pod spec. | +| hostPorts | @smallcase/cdk8s-botkube.k8s.HostPortRangeV1Beta1[] | hostPorts determines which host port ranges are allowed to be exposed. | +| privileged | boolean | privileged determines if a pod can request to be run as privileged. | +| readOnlyRootFilesystem | boolean | readOnlyRootFilesystem when set to true will force containers to run with a read only root file system. | +| requiredDropCapabilities | string[] | requiredDropCapabilities are the capabilities that will be dropped from the container. | +| runAsGroup | @smallcase/cdk8s-botkube.k8s.RunAsGroupStrategyOptionsV1Beta1 | RunAsGroup is the strategy that will dictate the allowable RunAsGroup values that may be set. | +| runtimeClass | @smallcase/cdk8s-botkube.k8s.RuntimeClassStrategyOptionsV1Beta1 | runtimeClass is the strategy that will dictate the allowable RuntimeClasses for a pod. | +| volumes | string[] | volumes is an allowlist of volume plugins. | + +--- + +##### `fsGroup`Required + +```typescript +public readonly fsGroup: FsGroupStrategyOptionsV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.FsGroupStrategyOptionsV1Beta1 + +fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. + +--- + +##### `runAsUser`Required + +```typescript +public readonly runAsUser: RunAsUserStrategyOptionsV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RunAsUserStrategyOptionsV1Beta1 + +runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set. + +--- + +##### `seLinux`Required + +```typescript +public readonly seLinux: SeLinuxStrategyOptionsV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SeLinuxStrategyOptionsV1Beta1 + +seLinux is the strategy that will dictate the allowable labels that may be set. + +--- + +##### `supplementalGroups`Required + +```typescript +public readonly supplementalGroups: SupplementalGroupsStrategyOptionsV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SupplementalGroupsStrategyOptionsV1Beta1 + +supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. + +--- + +##### `allowedCapabilities`Optional + +```typescript +public readonly allowedCapabilities: string[]; +``` + +- *Type:* string[] + +allowedCapabilities is a list of capabilities that can be requested to add to the container. + +Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both allowedCapabilities and requiredDropCapabilities. + +--- + +##### `allowedCsiDrivers`Optional + +```typescript +public readonly allowedCsiDrivers: AllowedCsiDriverV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.AllowedCsiDriverV1Beta1[] + +AllowedCSIDrivers is an allowlist of inline CSI drivers that must be explicitly set to be embedded within a pod spec. + +An empty value indicates that any CSI driver can be used for inline ephemeral volumes. This is a beta field, and is only honored if the API server enables the CSIInlineVolume feature gate. + +--- + +##### `allowedFlexVolumes`Optional + +```typescript +public readonly allowedFlexVolumes: AllowedFlexVolumeV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.AllowedFlexVolumeV1Beta1[] + +allowedFlexVolumes is an allowlist of Flexvolumes. + +Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "volumes" field. + +--- + +##### `allowedHostPaths`Optional + +```typescript +public readonly allowedHostPaths: AllowedHostPathV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.AllowedHostPathV1Beta1[] + +allowedHostPaths is an allowlist of host paths. + +Empty indicates that all host paths may be used. + +--- + +##### `allowedProcMountTypes`Optional + +```typescript +public readonly allowedProcMountTypes: string[]; +``` + +- *Type:* string[] + +AllowedProcMountTypes is an allowlist of allowed ProcMountTypes. + +Empty or nil indicates that only the DefaultProcMountType may be used. This requires the ProcMountType feature flag to be enabled. + +--- + +##### `allowedUnsafeSysctls`Optional + +```typescript +public readonly allowedUnsafeSysctls: string[]; +``` + +- *Type:* string[] + +allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. + +Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to allowlist all allowed unsafe sysctls explicitly to avoid rejection. + +Examples: e.g. "foo/*" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc. + +--- + +##### `allowPrivilegeEscalation`Optional + +```typescript +public readonly allowPrivilegeEscalation: boolean; +``` + +- *Type:* boolean + +allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. + +If unspecified, defaults to true. + +--- + +##### `defaultAddCapabilities`Optional + +```typescript +public readonly defaultAddCapabilities: string[]; +``` + +- *Type:* string[] + +defaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. + +You may not list a capability in both defaultAddCapabilities and requiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the allowedCapabilities list. + +--- + +##### `defaultAllowPrivilegeEscalation`Optional + +```typescript +public readonly defaultAllowPrivilegeEscalation: boolean; +``` + +- *Type:* boolean + +defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. + +--- + +##### `forbiddenSysctls`Optional + +```typescript +public readonly forbiddenSysctls: string[]; +``` + +- *Type:* string[] + +forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. + +Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden. + +Examples: e.g. "foo/*" forbids "foo/bar", "foo/baz", etc. e.g. "foo.*" forbids "foo.bar", "foo.baz", etc. + +--- + +##### `hostIpc`Optional + +```typescript +public readonly hostIpc: boolean; +``` + +- *Type:* boolean + +hostIPC determines if the policy allows the use of HostIPC in the pod spec. + +--- + +##### `hostNetwork`Optional + +```typescript +public readonly hostNetwork: boolean; +``` + +- *Type:* boolean + +hostNetwork determines if the policy allows the use of HostNetwork in the pod spec. + +--- + +##### `hostPid`Optional + +```typescript +public readonly hostPid: boolean; +``` + +- *Type:* boolean + +hostPID determines if the policy allows the use of HostPID in the pod spec. + +--- + +##### `hostPorts`Optional + +```typescript +public readonly hostPorts: HostPortRangeV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HostPortRangeV1Beta1[] + +hostPorts determines which host port ranges are allowed to be exposed. + +--- + +##### `privileged`Optional + +```typescript +public readonly privileged: boolean; +``` + +- *Type:* boolean + +privileged determines if a pod can request to be run as privileged. + +--- + +##### `readOnlyRootFilesystem`Optional + +```typescript +public readonly readOnlyRootFilesystem: boolean; +``` + +- *Type:* boolean + +readOnlyRootFilesystem when set to true will force containers to run with a read only root file system. + +If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to. + +--- + +##### `requiredDropCapabilities`Optional + +```typescript +public readonly requiredDropCapabilities: string[]; +``` + +- *Type:* string[] + +requiredDropCapabilities are the capabilities that will be dropped from the container. + +These are required to be dropped and cannot be added. + +--- + +##### `runAsGroup`Optional + +```typescript +public readonly runAsGroup: RunAsGroupStrategyOptionsV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RunAsGroupStrategyOptionsV1Beta1 + +RunAsGroup is the strategy that will dictate the allowable RunAsGroup values that may be set. + +If this field is omitted, the pod's RunAsGroup can take any value. This field requires the RunAsGroup feature gate to be enabled. + +--- + +##### `runtimeClass`Optional + +```typescript +public readonly runtimeClass: RuntimeClassStrategyOptionsV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RuntimeClassStrategyOptionsV1Beta1 + +runtimeClass is the strategy that will dictate the allowable RuntimeClasses for a pod. + +If this field is omitted, the pod's runtimeClassName field is unrestricted. Enforcement of this field depends on the RuntimeClass feature gate being enabled. + +--- + +##### `volumes`Optional + +```typescript +public readonly volumes: string[]; +``` + +- *Type:* string[] + +volumes is an allowlist of volume plugins. + +Empty indicates that no volumes may be used. To allow all volumes you may use '*'. + +--- + +### PodsMetricSourceV2Beta1 + +PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). + +The values will be averaged together before being compared to the target value. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const podsMetricSourceV2Beta1: k8s.PodsMetricSourceV2Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metricName | string | metricName is the name of the metric in question. | +| targetAverageValue | @smallcase/cdk8s-botkube.k8s.Quantity | targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity). | +| selector | @smallcase/cdk8s-botkube.k8s.LabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics. | + +--- + +##### `metricName`Required + +```typescript +public readonly metricName: string; +``` + +- *Type:* string + +metricName is the name of the metric in question. + +--- + +##### `targetAverageValue`Required + +```typescript +public readonly targetAverageValue: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity). + +--- + +##### `selector`Optional + +```typescript +public readonly selector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics. + +--- + +### PodsMetricSourceV2Beta2 + +PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). + +The values will be averaged together before being compared to the target value. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const podsMetricSourceV2Beta2: k8s.PodsMetricSourceV2Beta2 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metric | @smallcase/cdk8s-botkube.k8s.MetricIdentifierV2Beta2 | metric identifies the target metric by name and selector. | +| target | @smallcase/cdk8s-botkube.k8s.MetricTargetV2Beta2 | target specifies the target value for the given metric. | + +--- + +##### `metric`Required + +```typescript +public readonly metric: MetricIdentifierV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.MetricIdentifierV2Beta2 + +metric identifies the target metric by name and selector. + +--- + +##### `target`Required + +```typescript +public readonly target: MetricTargetV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.MetricTargetV2Beta2 + +target specifies the target value for the given metric. + +--- + +### PodSpec + +PodSpec is a description of a pod. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const podSpec: k8s.PodSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| containers | @smallcase/cdk8s-botkube.k8s.Container[] | List of containers belonging to the pod. | +| activeDeadlineSeconds | number | Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. | +| affinity | @smallcase/cdk8s-botkube.k8s.Affinity | If specified, the pod's scheduling constraints. | +| automountServiceAccountToken | boolean | AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. | +| dnsConfig | @smallcase/cdk8s-botkube.k8s.PodDnsConfig | Specifies the DNS parameters of a pod. | +| dnsPolicy | string | Set DNS policy for the pod. | +| enableServiceLinks | boolean | EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. | +| ephemeralContainers | @smallcase/cdk8s-botkube.k8s.EphemeralContainer[] | List of ephemeral containers run in this pod. | +| hostAliases | @smallcase/cdk8s-botkube.k8s.HostAlias[] | HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. | +| hostIpc | boolean | Use the host's ipc namespace. | +| hostname | string | Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. | +| hostNetwork | boolean | Host networking requested for this pod. | +| hostPid | boolean | Use the host's pid namespace. | +| imagePullSecrets | @smallcase/cdk8s-botkube.k8s.LocalObjectReference[] | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. | +| initContainers | @smallcase/cdk8s-botkube.k8s.Container[] | List of initialization containers belonging to the pod. | +| nodeName | string | NodeName is a request to schedule this pod onto a specific node. | +| nodeSelector | {[ key: string ]: string} | NodeSelector is a selector which must be true for the pod to fit on a node. | +| overhead | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} | Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. | +| preemptionPolicy | string | PreemptionPolicy is the Policy for preempting pods with lower priority. | +| priority | number | The priority value. | +| priorityClassName | string | If specified, indicates the pod's priority. | +| readinessGates | @smallcase/cdk8s-botkube.k8s.PodReadinessGate[] | If specified, all readiness gates will be evaluated for pod readiness. | +| restartPolicy | string | Restart policy for all containers within the pod. | +| runtimeClassName | string | RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14. | +| schedulerName | string | If specified, the pod will be dispatched by specified scheduler. | +| securityContext | @smallcase/cdk8s-botkube.k8s.PodSecurityContext | SecurityContext holds pod-level security attributes and common container settings. | +| serviceAccount | string | DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. | +| serviceAccountName | string | ServiceAccountName is the name of the ServiceAccount to use to run this pod. | +| setHostnameAsFqdn | boolean | If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). | +| shareProcessNamespace | boolean | Share a single process namespace between all of the containers in a pod. | +| subdomain | string | If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. | +| terminationGracePeriodSeconds | number | Optional duration in seconds the pod needs to terminate gracefully. | +| tolerations | @smallcase/cdk8s-botkube.k8s.Toleration[] | If specified, the pod's tolerations. | +| topologySpreadConstraints | @smallcase/cdk8s-botkube.k8s.TopologySpreadConstraint[] | TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. | +| volumes | @smallcase/cdk8s-botkube.k8s.Volume[] | List of volumes that can be mounted by containers belonging to the pod. | + +--- + +##### `containers`Required + +```typescript +public readonly containers: Container[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Container[] + +List of containers belonging to the pod. + +Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. + +--- + +##### `activeDeadlineSeconds`Optional + +```typescript +public readonly activeDeadlineSeconds: number; +``` + +- *Type:* number + +Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. + +Value must be a positive integer. + +--- + +##### `affinity`Optional + +```typescript +public readonly affinity: Affinity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Affinity + +If specified, the pod's scheduling constraints. + +--- + +##### `automountServiceAccountToken`Optional + +```typescript +public readonly automountServiceAccountToken: boolean; +``` + +- *Type:* boolean + +AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. + +--- + +##### `dnsConfig`Optional + +```typescript +public readonly dnsConfig: PodDnsConfig; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodDnsConfig + +Specifies the DNS parameters of a pod. + +Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. + +--- + +##### `dnsPolicy`Optional + +```typescript +public readonly dnsPolicy: string; +``` + +- *Type:* string +- *Default:* ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. + +Set DNS policy for the pod. + +Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. + +--- + +##### `enableServiceLinks`Optional + +```typescript +public readonly enableServiceLinks: boolean; +``` + +- *Type:* boolean +- *Default:* true. + +EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. + +Optional: Defaults to true. + +--- + +##### `ephemeralContainers`Optional + +```typescript +public readonly ephemeralContainers: EphemeralContainer[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EphemeralContainer[] + +List of ephemeral containers run in this pod. + +Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. + +--- + +##### `hostAliases`Optional + +```typescript +public readonly hostAliases: HostAlias[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HostAlias[] + +HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. + +This is only valid for non-hostNetwork pods. + +--- + +##### `hostIpc`Optional + +```typescript +public readonly hostIpc: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +Use the host's ipc namespace. + +Optional: Default to false. + +--- + +##### `hostname`Optional + +```typescript +public readonly hostname: string; +``` + +- *Type:* string + +Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. + +--- + +##### `hostNetwork`Optional + +```typescript +public readonly hostNetwork: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +Host networking requested for this pod. + +Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. + +--- + +##### `hostPid`Optional + +```typescript +public readonly hostPid: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +Use the host's pid namespace. + +Optional: Default to false. + +--- + +##### `imagePullSecrets`Optional + +```typescript +public readonly imagePullSecrets: LocalObjectReference[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LocalObjectReference[] + +ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. + +If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod + +--- + +##### `initContainers`Optional + +```typescript +public readonly initContainers: Container[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Container[] + +List of initialization containers belonging to the pod. + +Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ + +--- + +##### `nodeName`Optional + +```typescript +public readonly nodeName: string; +``` + +- *Type:* string + +NodeName is a request to schedule this pod onto a specific node. + +If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. + +--- + +##### `nodeSelector`Optional + +```typescript +public readonly nodeSelector: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +NodeSelector is a selector which must be true for the pod to fit on a node. + +Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + +--- + +##### `overhead`Optional + +```typescript +public readonly overhead: {[ key: string ]: Quantity}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} + +Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. + +This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature. + +--- + +##### `preemptionPolicy`Optional + +```typescript +public readonly preemptionPolicy: string; +``` + +- *Type:* string +- *Default:* PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + +PreemptionPolicy is the Policy for preempting pods with lower priority. + +One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + +--- + +##### `priority`Optional + +```typescript +public readonly priority: number; +``` + +- *Type:* number + +The priority value. + +Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. + +--- + +##### `priorityClassName`Optional + +```typescript +public readonly priorityClassName: string; +``` + +- *Type:* string + +If specified, indicates the pod's priority. + +"system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. + +--- + +##### `readinessGates`Optional + +```typescript +public readonly readinessGates: PodReadinessGate[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodReadinessGate[] + +If specified, all readiness gates will be evaluated for pod readiness. + +A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md + +--- + +##### `restartPolicy`Optional + +```typescript +public readonly restartPolicy: string; +``` + +- *Type:* string +- *Default:* Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy + +Restart policy for all containers within the pod. + +One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy + +--- + +##### `runtimeClassName`Optional + +```typescript +public readonly runtimeClassName: string; +``` + +- *Type:* string + +RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14. + +--- + +##### `schedulerName`Optional + +```typescript +public readonly schedulerName: string; +``` + +- *Type:* string + +If specified, the pod will be dispatched by specified scheduler. + +If not specified, the pod will be dispatched by default scheduler. + +--- + +##### `securityContext`Optional + +```typescript +public readonly securityContext: PodSecurityContext; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodSecurityContext +- *Default:* empty. See type description for default values of each field. + +SecurityContext holds pod-level security attributes and common container settings. + +Optional: Defaults to empty. See type description for default values of each field. + +--- + +##### `serviceAccount`Optional + +```typescript +public readonly serviceAccount: string; +``` + +- *Type:* string + +DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. + +Deprecated: Use serviceAccountName instead. + +--- + +##### `serviceAccountName`Optional + +```typescript +public readonly serviceAccountName: string; +``` + +- *Type:* string + +ServiceAccountName is the name of the ServiceAccount to use to run this pod. + +More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ + +--- + +##### `setHostnameAsFqdn`Optional + +```typescript +public readonly setHostnameAsFqdn: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). + +In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false. + +--- + +##### `shareProcessNamespace`Optional + +```typescript +public readonly shareProcessNamespace: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +Share a single process namespace between all of the containers in a pod. + +When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. + +--- + +##### `subdomain`Optional + +```typescript +public readonly subdomain: string; +``` + +- *Type:* string + +If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. + +--- + +##### `terminationGracePeriodSeconds`Optional + +```typescript +public readonly terminationGracePeriodSeconds: number; +``` + +- *Type:* number +- *Default:* 30 seconds. + +Optional duration in seconds the pod needs to terminate gracefully. + +May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. + +--- + +##### `tolerations`Optional + +```typescript +public readonly tolerations: Toleration[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Toleration[] + +If specified, the pod's tolerations. + +--- + +##### `topologySpreadConstraints`Optional + +```typescript +public readonly topologySpreadConstraints: TopologySpreadConstraint[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.TopologySpreadConstraint[] + +TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. + +Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. + +--- + +##### `volumes`Optional + +```typescript +public readonly volumes: Volume[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Volume[] + +List of volumes that can be mounted by containers belonging to the pod. + +More info: https://kubernetes.io/docs/concepts/storage/volumes + +--- + +### PodTemplateSpec + +PodTemplateSpec describes the data a pod should have when created from a template. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const podTemplateSpec: k8s.PodTemplateSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| metadata | @smallcase/cdk8s-botkube.k8s.ObjectMeta | Standard object's metadata. | +| spec | @smallcase/cdk8s-botkube.k8s.PodSpec | Specification of the desired behavior of the pod. | + +--- + +##### `metadata`Optional + +```typescript +public readonly metadata: ObjectMeta; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectMeta + +Standard object's metadata. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +--- + +##### `spec`Optional + +```typescript +public readonly spec: PodSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodSpec + +Specification of the desired behavior of the pod. + +More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +--- + +### PolicyRule + +PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const policyRule: k8s.PolicyRule = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| verbs | string[] | Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. | +| apiGroups | string[] | APIGroups is the name of the APIGroup that contains the resources. | +| nonResourceUrLs | string[] | NonResourceURLs is a set of partial urls that a user should have access to. | +| resourceNames | string[] | ResourceNames is an optional white list of names that the rule applies to. | +| resources | string[] | Resources is a list of resources this rule applies to. | + +--- + +##### `verbs`Required + +```typescript +public readonly verbs: string[]; +``` + +- *Type:* string[] + +Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. + +VerbAll represents all kinds. + +--- + +##### `apiGroups`Optional + +```typescript +public readonly apiGroups: string[]; +``` + +- *Type:* string[] + +APIGroups is the name of the APIGroup that contains the resources. + +If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. + +--- + +##### `nonResourceUrLs`Optional + +```typescript +public readonly nonResourceUrLs: string[]; +``` + +- *Type:* string[] + +NonResourceURLs is a set of partial urls that a user should have access to. + +*s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. + +--- + +##### `resourceNames`Optional + +```typescript +public readonly resourceNames: string[]; +``` + +- *Type:* string[] + +ResourceNames is an optional white list of names that the rule applies to. + +An empty set means that everything is allowed. + +--- + +##### `resources`Optional + +```typescript +public readonly resources: string[]; +``` + +- *Type:* string[] + +Resources is a list of resources this rule applies to. + +ResourceAll represents all resources. + +--- + +### PolicyRulesWithSubjectsV1Beta1 + +PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. + +The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const policyRulesWithSubjectsV1Beta1: k8s.PolicyRulesWithSubjectsV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| subjects | @smallcase/cdk8s-botkube.k8s.SubjectV1Beta1[] | subjects is the list of normal user, serviceaccount, or group that this rule cares about. | +| nonResourceRules | @smallcase/cdk8s-botkube.k8s.NonResourcePolicyRuleV1Beta1[] | `nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL. | +| resourceRules | @smallcase/cdk8s-botkube.k8s.ResourcePolicyRuleV1Beta1[] | `resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. | + +--- + +##### `subjects`Required + +```typescript +public readonly subjects: SubjectV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SubjectV1Beta1[] + +subjects is the list of normal user, serviceaccount, or group that this rule cares about. + +There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required. + +--- + +##### `nonResourceRules`Optional + +```typescript +public readonly nonResourceRules: NonResourcePolicyRuleV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NonResourcePolicyRuleV1Beta1[] + +`nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL. + +--- + +##### `resourceRules`Optional + +```typescript +public readonly resourceRules: ResourcePolicyRuleV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ResourcePolicyRuleV1Beta1[] + +`resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. + +At least one of `resourceRules` and `nonResourceRules` has to be non-empty. + +--- + +### PolicyRuleV1Alpha1 + +PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const policyRuleV1Alpha1: k8s.PolicyRuleV1Alpha1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| verbs | string[] | Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. | +| apiGroups | string[] | APIGroups is the name of the APIGroup that contains the resources. | +| nonResourceUrLs | string[] | NonResourceURLs is a set of partial urls that a user should have access to. | +| resourceNames | string[] | ResourceNames is an optional white list of names that the rule applies to. | +| resources | string[] | Resources is a list of resources this rule applies to. | + +--- + +##### `verbs`Required + +```typescript +public readonly verbs: string[]; +``` + +- *Type:* string[] + +Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. + +VerbAll represents all kinds. + +--- + +##### `apiGroups`Optional + +```typescript +public readonly apiGroups: string[]; +``` + +- *Type:* string[] + +APIGroups is the name of the APIGroup that contains the resources. + +If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. + +--- + +##### `nonResourceUrLs`Optional + +```typescript +public readonly nonResourceUrLs: string[]; +``` + +- *Type:* string[] + +NonResourceURLs is a set of partial urls that a user should have access to. + +*s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. + +--- + +##### `resourceNames`Optional + +```typescript +public readonly resourceNames: string[]; +``` + +- *Type:* string[] + +ResourceNames is an optional white list of names that the rule applies to. + +An empty set means that everything is allowed. + +--- + +##### `resources`Optional + +```typescript +public readonly resources: string[]; +``` + +- *Type:* string[] + +Resources is a list of resources this rule applies to. + +ResourceAll represents all resources. + +--- + +### PolicyRuleV1Beta1 + +PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const policyRuleV1Beta1: k8s.PolicyRuleV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| verbs | string[] | Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. | +| apiGroups | string[] | APIGroups is the name of the APIGroup that contains the resources. | +| nonResourceUrLs | string[] | NonResourceURLs is a set of partial urls that a user should have access to. | +| resourceNames | string[] | ResourceNames is an optional white list of names that the rule applies to. | +| resources | string[] | Resources is a list of resources this rule applies to. | + +--- + +##### `verbs`Required + +```typescript +public readonly verbs: string[]; +``` + +- *Type:* string[] + +Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. + +VerbAll represents all kinds. + +--- + +##### `apiGroups`Optional + +```typescript +public readonly apiGroups: string[]; +``` + +- *Type:* string[] + +APIGroups is the name of the APIGroup that contains the resources. + +If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. + +--- + +##### `nonResourceUrLs`Optional + +```typescript +public readonly nonResourceUrLs: string[]; +``` + +- *Type:* string[] + +NonResourceURLs is a set of partial urls that a user should have access to. + +*s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. + +--- + +##### `resourceNames`Optional + +```typescript +public readonly resourceNames: string[]; +``` + +- *Type:* string[] + +ResourceNames is an optional white list of names that the rule applies to. + +An empty set means that everything is allowed. + +--- + +##### `resources`Optional + +```typescript +public readonly resources: string[]; +``` + +- *Type:* string[] + +Resources is a list of resources this rule applies to. + +'*' represents all resources in the specified apiGroups. '_/foo' represents the subresource 'foo' for all resources in the specified apiGroups. + +--- + +### PortworxVolumeSource + +PortworxVolumeSource represents a Portworx volume resource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const portworxVolumeSource: k8s.PortworxVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| volumeId | string | VolumeID uniquely identifies a Portworx volume. | +| fsType | string | FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. | +| readOnly | boolean | Defaults to false (read/write). | + +--- + +##### `volumeId`Required + +```typescript +public readonly volumeId: string; +``` + +- *Type:* string + +VolumeID uniquely identifies a Portworx volume. + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. + +Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +--- + +### Preconditions + +Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const preconditions: k8s.Preconditions = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| resourceVersion | string | Specifies the target ResourceVersion. | +| uid | string | Specifies the target UID. | + +--- + +##### `resourceVersion`Optional + +```typescript +public readonly resourceVersion: string; +``` + +- *Type:* string + +Specifies the target ResourceVersion. + +--- + +##### `uid`Optional + +```typescript +public readonly uid: string; +``` + +- *Type:* string + +Specifies the target UID. + +--- + +### PreferredSchedulingTerm + +An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const preferredSchedulingTerm: k8s.PreferredSchedulingTerm = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| preference | @smallcase/cdk8s-botkube.k8s.NodeSelectorTerm | A node selector term, associated with the corresponding weight. | +| weight | number | Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. | + +--- + +##### `preference`Required + +```typescript +public readonly preference: NodeSelectorTerm; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NodeSelectorTerm + +A node selector term, associated with the corresponding weight. + +--- + +##### `weight`Required + +```typescript +public readonly weight: number; +``` + +- *Type:* number + +Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. + +--- + +### PriorityLevelConfigurationReferenceV1Beta1 + +PriorityLevelConfigurationReference contains information that points to the "request-priority" being used. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const priorityLevelConfigurationReferenceV1Beta1: k8s.PriorityLevelConfigurationReferenceV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | `name` is the name of the priority level configuration being referenced Required. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +`name` is the name of the priority level configuration being referenced Required. + +--- + +### PriorityLevelConfigurationSpecV1Beta1 + +PriorityLevelConfigurationSpec specifies the configuration of a priority level. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const priorityLevelConfigurationSpecV1Beta1: k8s.PriorityLevelConfigurationSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| type | string | `type` indicates whether this priority level is subject to limitation on request execution. | +| limited | @smallcase/cdk8s-botkube.k8s.LimitedPriorityLevelConfigurationV1Beta1 | `limited` specifies how requests are handled for a Limited priority level. | + +--- + +##### `type`Required + +```typescript +public readonly type: string; +``` + +- *Type:* string + +`type` indicates whether this priority level is subject to limitation on request execution. + +A value of `"Exempt"` means that requests of this priority level are not subject to a limit (and thus are never queued) and do not detract from the capacity made available to other priority levels. A value of `"Limited"` means that (a) requests of this priority level _are_ subject to limits and (b) some of the server's limited capacity is made available exclusively to this priority level. Required. + +--- + +##### `limited`Optional + +```typescript +public readonly limited: LimitedPriorityLevelConfigurationV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LimitedPriorityLevelConfigurationV1Beta1 + +`limited` specifies how requests are handled for a Limited priority level. + +This field must be non-empty if and only if `type` is `"Limited"`. + +--- + +### Probe + +Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const probe: k8s.Probe = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| exec | @smallcase/cdk8s-botkube.k8s.ExecAction | One and only one of the following should be specified. | +| failureThreshold | number | Minimum consecutive failures for the probe to be considered failed after having succeeded. | +| httpGet | @smallcase/cdk8s-botkube.k8s.HttpGetAction | HTTPGet specifies the http request to perform. | +| initialDelaySeconds | number | Number of seconds after the container has started before liveness probes are initiated. | +| periodSeconds | number | How often (in seconds) to perform the probe. | +| successThreshold | number | Minimum consecutive successes for the probe to be considered successful after having failed. | +| tcpSocket | @smallcase/cdk8s-botkube.k8s.TcpSocketAction | TCPSocket specifies an action involving a TCP port. | +| terminationGracePeriodSeconds | number | Optional duration in seconds the pod needs to terminate gracefully upon probe failure. | +| timeoutSeconds | number | Number of seconds after which the probe times out. | + +--- + +##### `exec`Optional + +```typescript +public readonly exec: ExecAction; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ExecAction + +One and only one of the following should be specified. + +Exec specifies the action to take. + +--- + +##### `failureThreshold`Optional + +```typescript +public readonly failureThreshold: number; +``` + +- *Type:* number +- *Default:* 3. Minimum value is 1. + +Minimum consecutive failures for the probe to be considered failed after having succeeded. + +Defaults to 3. Minimum value is 1. + +--- + +##### `httpGet`Optional + +```typescript +public readonly httpGet: HttpGetAction; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HttpGetAction + +HTTPGet specifies the http request to perform. + +--- + +##### `initialDelaySeconds`Optional + +```typescript +public readonly initialDelaySeconds: number; +``` + +- *Type:* number + +Number of seconds after the container has started before liveness probes are initiated. + +More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +--- + +##### `periodSeconds`Optional + +```typescript +public readonly periodSeconds: number; +``` + +- *Type:* number +- *Default:* 10 seconds. Minimum value is 1. + +How often (in seconds) to perform the probe. + +Default to 10 seconds. Minimum value is 1. + +--- + +##### `successThreshold`Optional + +```typescript +public readonly successThreshold: number; +``` + +- *Type:* number +- *Default:* 1. Must be 1 for liveness and startup. Minimum value is 1. + +Minimum consecutive successes for the probe to be considered successful after having failed. + +Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + +--- + +##### `tcpSocket`Optional + +```typescript +public readonly tcpSocket: TcpSocketAction; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.TcpSocketAction + +TCPSocket specifies an action involving a TCP port. + +TCP hooks not yet supported + +--- + +##### `terminationGracePeriodSeconds`Optional + +```typescript +public readonly terminationGracePeriodSeconds: number; +``` + +- *Type:* number + +Optional duration in seconds the pod needs to terminate gracefully upon probe failure. + +The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. + +--- + +##### `timeoutSeconds`Optional + +```typescript +public readonly timeoutSeconds: number; +``` + +- *Type:* number +- *Default:* 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +Number of seconds after which the probe times out. + +Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + +--- + +### ProjectedVolumeSource + +Represents a projected volume source. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const projectedVolumeSource: k8s.ProjectedVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| defaultMode | number | Mode bits used to set permissions on created files by default. | +| sources | @smallcase/cdk8s-botkube.k8s.VolumeProjection[] | list of volume projections. | + +--- + +##### `defaultMode`Optional + +```typescript +public readonly defaultMode: number; +``` + +- *Type:* number + +Mode bits used to set permissions on created files by default. + +Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +--- + +##### `sources`Optional + +```typescript +public readonly sources: VolumeProjection[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VolumeProjection[] + +list of volume projections. + +--- + +### QueuingConfigurationV1Beta1 + +QueuingConfiguration holds the configuration parameters for queuing. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const queuingConfigurationV1Beta1: k8s.QueuingConfigurationV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| handSize | number | `handSize` is a small positive number that configures the shuffle sharding of requests into queues. | +| queueLengthLimit | number | `queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; | +| queues | number | `queues` is the number of queues for this priority level. | + +--- + +##### `handSize`Optional + +```typescript +public readonly handSize: number; +``` + +- *Type:* number + +`handSize` is a small positive number that configures the shuffle sharding of requests into queues. + +When enqueuing a request at this priority level the request's flow identifier (a string pair) is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here. The request is put into one of the shortest queues in that hand. `handSize` must be no larger than `queues`, and should be significantly smaller (so that a few heavy flows do not saturate most of the queues). See the user-facing documentation for more extensive guidance on setting this field. This field has a default value of 8. + +--- + +##### `queueLengthLimit`Optional + +```typescript +public readonly queueLengthLimit: number; +``` + +- *Type:* number + +`queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; + +excess requests are rejected. This value must be positive. If not specified, it will be defaulted to 50. + +--- + +##### `queues`Optional + +```typescript +public readonly queues: number; +``` + +- *Type:* number + +`queues` is the number of queues for this priority level. + +The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64. + +--- + +### QuobyteVolumeSource + +Represents a Quobyte mount that lasts the lifetime of a pod. + +Quobyte volumes do not support ownership management or SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const quobyteVolumeSource: k8s.QuobyteVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| registry | string | Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes. | +| volume | string | Volume is a string that references an already created Quobyte volume by name. | +| group | string | Group to map volume access to Default is no group. | +| readOnly | boolean | ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. | +| tenant | string | Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin. | +| user | string | User to map volume access to Defaults to serivceaccount user. | + +--- + +##### `registry`Required + +```typescript +public readonly registry: string; +``` + +- *Type:* string + +Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes. + +--- + +##### `volume`Required + +```typescript +public readonly volume: string; +``` + +- *Type:* string + +Volume is a string that references an already created Quobyte volume by name. + +--- + +##### `group`Optional + +```typescript +public readonly group: string; +``` + +- *Type:* string +- *Default:* no group + +Group to map volume access to Default is no group. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. + +Defaults to false. + +--- + +##### `tenant`Optional + +```typescript +public readonly tenant: string; +``` + +- *Type:* string + +Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin. + +--- + +##### `user`Optional + +```typescript +public readonly user: string; +``` + +- *Type:* string +- *Default:* serivceaccount user + +User to map volume access to Defaults to serivceaccount user. + +--- + +### RbdPersistentVolumeSource + +Represents a Rados Block Device mount that lasts the lifetime of a pod. + +RBD volumes support ownership management and SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const rbdPersistentVolumeSource: k8s.RbdPersistentVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| image | string | The rados image name. | +| monitors | string[] | A collection of Ceph monitors. | +| fsType | string | Filesystem type of the volume that you want to mount. | +| keyring | string | Keyring is the path to key ring for RBDUser. | +| pool | string | The rados pool name. | +| readOnly | boolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. | +| secretRef | @smallcase/cdk8s-botkube.k8s.SecretReference | SecretRef is name of the authentication secret for RBDUser. | +| user | string | The rados user name. | + +--- + +##### `image`Required + +```typescript +public readonly image: string; +``` + +- *Type:* string + +The rados image name. + +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +--- + +##### `monitors`Required + +```typescript +public readonly monitors: string[]; +``` + +- *Type:* string[] + +A collection of Ceph monitors. + +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type of the volume that you want to mount. + +Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd + +--- + +##### `keyring`Optional + +```typescript +public readonly keyring: string; +``` + +- *Type:* string +- *Default:* etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +Keyring is the path to key ring for RBDUser. + +Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +--- + +##### `pool`Optional + +```typescript +public readonly pool: string; +``` + +- *Type:* string +- *Default:* rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +The rados pool name. + +Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +--- + +##### `secretRef`Optional + +```typescript +public readonly secretRef: SecretReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecretReference +- *Default:* nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +SecretRef is name of the authentication secret for RBDUser. + +If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +--- + +##### `user`Optional + +```typescript +public readonly user: string; +``` + +- *Type:* string +- *Default:* admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +The rados user name. + +Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +--- + +### RbdVolumeSource + +Represents a Rados Block Device mount that lasts the lifetime of a pod. + +RBD volumes support ownership management and SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const rbdVolumeSource: k8s.RbdVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| image | string | The rados image name. | +| monitors | string[] | A collection of Ceph monitors. | +| fsType | string | Filesystem type of the volume that you want to mount. | +| keyring | string | Keyring is the path to key ring for RBDUser. | +| pool | string | The rados pool name. | +| readOnly | boolean | ReadOnly here will force the ReadOnly setting in VolumeMounts. | +| secretRef | @smallcase/cdk8s-botkube.k8s.LocalObjectReference | SecretRef is name of the authentication secret for RBDUser. | +| user | string | The rados user name. | + +--- + +##### `image`Required + +```typescript +public readonly image: string; +``` + +- *Type:* string + +The rados image name. + +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +--- + +##### `monitors`Required + +```typescript +public readonly monitors: string[]; +``` + +- *Type:* string[] + +A collection of Ceph monitors. + +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type of the volume that you want to mount. + +Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd + +--- + +##### `keyring`Optional + +```typescript +public readonly keyring: string; +``` + +- *Type:* string +- *Default:* etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +Keyring is the path to key ring for RBDUser. + +Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +--- + +##### `pool`Optional + +```typescript +public readonly pool: string; +``` + +- *Type:* string +- *Default:* rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +The rados pool name. + +Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +--- + +##### `secretRef`Optional + +```typescript +public readonly secretRef: LocalObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LocalObjectReference +- *Default:* nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +SecretRef is name of the authentication secret for RBDUser. + +If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +--- + +##### `user`Optional + +```typescript +public readonly user: string; +``` + +- *Type:* string +- *Default:* admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +The rados user name. + +Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + +--- + +### ReplicaSetSpec + +ReplicaSetSpec is the specification of a ReplicaSet. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const replicaSetSpec: k8s.ReplicaSetSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| selector | @smallcase/cdk8s-botkube.k8s.LabelSelector | Selector is a label query over pods that should match the replica count. | +| minReadySeconds | number | 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. | +| replicas | number | Replicas is the number of desired replicas. | +| template | @smallcase/cdk8s-botkube.k8s.PodTemplateSpec | Template is the object that describes the pod that will be created if insufficient replicas are detected. | + +--- + +##### `selector`Required + +```typescript +public readonly selector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +Selector is a label query over pods that should match the replica count. + +Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + +--- + +##### `minReadySeconds`Optional + +```typescript +public readonly minReadySeconds: number; +``` + +- *Type:* number +- *Default:* 0 (pod will be considered available as soon as it is ready) + +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. + +Defaults to 0 (pod will be considered available as soon as it is ready) + +--- + +##### `replicas`Optional + +```typescript +public readonly replicas: number; +``` + +- *Type:* number +- *Default:* 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller + +Replicas is the number of desired replicas. + +This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller + +--- + +##### `template`Optional + +```typescript +public readonly template: PodTemplateSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodTemplateSpec + +Template is the object that describes the pod that will be created if insufficient replicas are detected. + +More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template + +--- + +### ReplicationControllerSpec + +ReplicationControllerSpec is the specification of a replication controller. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const replicationControllerSpec: k8s.ReplicationControllerSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| minReadySeconds | number | 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. | +| replicas | number | Replicas is the number of desired replicas. | +| selector | {[ key: string ]: string} | Selector is a label query over pods that should match the Replicas count. | +| template | @smallcase/cdk8s-botkube.k8s.PodTemplateSpec | Template is the object that describes the pod that will be created if insufficient replicas are detected. | + +--- + +##### `minReadySeconds`Optional + +```typescript +public readonly minReadySeconds: number; +``` + +- *Type:* number +- *Default:* 0 (pod will be considered available as soon as it is ready) + +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. + +Defaults to 0 (pod will be considered available as soon as it is ready) + +--- + +##### `replicas`Optional + +```typescript +public readonly replicas: number; +``` + +- *Type:* number +- *Default:* 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller + +Replicas is the number of desired replicas. + +This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller + +--- + +##### `selector`Optional + +```typescript +public readonly selector: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +Selector is a label query over pods that should match the Replicas count. + +If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + +--- + +##### `template`Optional + +```typescript +public readonly template: PodTemplateSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodTemplateSpec + +Template is the object that describes the pod that will be created if insufficient replicas are detected. + +This takes precedence over a TemplateRef. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template + +--- + +### ResourceAttributes + +ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const resourceAttributes: k8s.ResourceAttributes = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| group | string | Group is the API Group of the Resource. | +| name | string | Name is the name of the resource being requested for a "get" or deleted for a "delete". | +| namespace | string | Namespace is the namespace of the action being requested. | +| resource | string | Resource is one of the existing resource types. | +| subresource | string | Subresource is one of the existing resource types. | +| verb | string | Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. | +| version | string | Version is the API Version of the Resource. | + +--- + +##### `group`Optional + +```typescript +public readonly group: string; +``` + +- *Type:* string + +Group is the API Group of the Resource. + +"*" means all. + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name is the name of the resource being requested for a "get" or deleted for a "delete". + +"" (empty) means all. + +--- + +##### `namespace`Optional + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +Namespace is the namespace of the action being requested. + +Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview + +--- + +##### `resource`Optional + +```typescript +public readonly resource: string; +``` + +- *Type:* string + +Resource is one of the existing resource types. + +"*" means all. + +--- + +##### `subresource`Optional + +```typescript +public readonly subresource: string; +``` + +- *Type:* string + +Subresource is one of the existing resource types. + +"" means none. + +--- + +##### `verb`Optional + +```typescript +public readonly verb: string; +``` + +- *Type:* string + +Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. + +"*" means all. + +--- + +##### `version`Optional + +```typescript +public readonly version: string; +``` + +- *Type:* string + +Version is the API Version of the Resource. + +"*" means all. + +--- + +### ResourceAttributesV1Beta1 + +ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const resourceAttributesV1Beta1: k8s.ResourceAttributesV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| group | string | Group is the API Group of the Resource. | +| name | string | Name is the name of the resource being requested for a "get" or deleted for a "delete". | +| namespace | string | Namespace is the namespace of the action being requested. | +| resource | string | Resource is one of the existing resource types. | +| subresource | string | Subresource is one of the existing resource types. | +| verb | string | Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. | +| version | string | Version is the API Version of the Resource. | + +--- + +##### `group`Optional + +```typescript +public readonly group: string; +``` + +- *Type:* string + +Group is the API Group of the Resource. + +"*" means all. + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name is the name of the resource being requested for a "get" or deleted for a "delete". + +"" (empty) means all. + +--- + +##### `namespace`Optional + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +Namespace is the namespace of the action being requested. + +Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview + +--- + +##### `resource`Optional + +```typescript +public readonly resource: string; +``` + +- *Type:* string + +Resource is one of the existing resource types. + +"*" means all. + +--- + +##### `subresource`Optional + +```typescript +public readonly subresource: string; +``` + +- *Type:* string + +Subresource is one of the existing resource types. + +"" means none. + +--- + +##### `verb`Optional + +```typescript +public readonly verb: string; +``` + +- *Type:* string + +Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. + +"*" means all. + +--- + +##### `version`Optional + +```typescript +public readonly version: string; +``` + +- *Type:* string + +Version is the API Version of the Resource. + +"*" means all. + +--- + +### ResourceFieldSelector + +ResourceFieldSelector represents container resources (cpu, memory) and their output format. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const resourceFieldSelector: k8s.ResourceFieldSelector = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| resource | string | Required: resource to select. | +| containerName | string | Container name: required for volumes, optional for env vars. | +| divisor | @smallcase/cdk8s-botkube.k8s.Quantity | Specifies the output format of the exposed resources, defaults to "1". | + +--- + +##### `resource`Required + +```typescript +public readonly resource: string; +``` + +- *Type:* string + +Required: resource to select. + +--- + +##### `containerName`Optional + +```typescript +public readonly containerName: string; +``` + +- *Type:* string + +Container name: required for volumes, optional for env vars. + +--- + +##### `divisor`Optional + +```typescript +public readonly divisor: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +Specifies the output format of the exposed resources, defaults to "1". + +--- + +### ResourceMetricSourceV2Beta1 + +ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const resourceMetricSourceV2Beta1: k8s.ResourceMetricSourceV2Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | name is the name of the resource in question. | +| targetAverageUtilization | number | targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. | +| targetAverageValue | @smallcase/cdk8s-botkube.k8s.Quantity | targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +name is the name of the resource in question. + +--- + +##### `targetAverageUtilization`Optional + +```typescript +public readonly targetAverageUtilization: number; +``` + +- *Type:* number + +targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. + +--- + +##### `targetAverageValue`Optional + +```typescript +public readonly targetAverageValue: Quantity; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Quantity + +targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. + +--- + +### ResourceMetricSourceV2Beta2 + +ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const resourceMetricSourceV2Beta2: k8s.ResourceMetricSourceV2Beta2 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | name is the name of the resource in question. | +| target | @smallcase/cdk8s-botkube.k8s.MetricTargetV2Beta2 | target specifies the target value for the given metric. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +name is the name of the resource in question. + +--- + +##### `target`Required + +```typescript +public readonly target: MetricTargetV2Beta2; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.MetricTargetV2Beta2 + +target specifies the target value for the given metric. + +--- + +### ResourcePolicyRuleV1Beta1 + +ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. + +A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) least one member of namespaces matches the request. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const resourcePolicyRuleV1Beta1: k8s.ResourcePolicyRuleV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroups | string[] | `apiGroups` is a list of matching API groups and may not be empty. | +| resources | string[] | `resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required. | +| verbs | string[] | `verbs` is a list of matching verbs and may not be empty. | +| clusterScope | boolean | `clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). | +| namespaces | string[] | `namespaces` is a list of target namespaces that restricts matches. | + +--- + +##### `apiGroups`Required + +```typescript +public readonly apiGroups: string[]; +``` + +- *Type:* string[] + +`apiGroups` is a list of matching API groups and may not be empty. + +"*" matches all API groups and, if present, must be the only entry. Required. + +--- + +##### `resources`Required + +```typescript +public readonly resources: string[]; +``` + +- *Type:* string[] + +`resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required. + +--- + +##### `verbs`Required + +```typescript +public readonly verbs: string[]; +``` + +- *Type:* string[] + +`verbs` is a list of matching verbs and may not be empty. + +"*" matches all verbs and, if present, must be the only entry. Required. + +--- + +##### `clusterScope`Optional + +```typescript +public readonly clusterScope: boolean; +``` + +- *Type:* boolean + +`clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). + +If this field is omitted or false then the `namespaces` field must contain a non-empty list. + +--- + +##### `namespaces`Optional + +```typescript +public readonly namespaces: string[]; +``` + +- *Type:* string[] + +`namespaces` is a list of target namespaces that restricts matches. + +A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true. + +--- + +### ResourceQuotaSpec + +ResourceQuotaSpec defines the desired hard limits to enforce for Quota. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const resourceQuotaSpec: k8s.ResourceQuotaSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| hard | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} | hard is the set of desired hard limits for each named resource. | +| scopes | string[] | A collection of filters that must match each object tracked by a quota. | +| scopeSelector | @smallcase/cdk8s-botkube.k8s.ScopeSelector | scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. | + +--- + +##### `hard`Optional + +```typescript +public readonly hard: {[ key: string ]: Quantity}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} + +hard is the set of desired hard limits for each named resource. + +More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ + +--- + +##### `scopes`Optional + +```typescript +public readonly scopes: string[]; +``` + +- *Type:* string[] + +A collection of filters that must match each object tracked by a quota. + +If not specified, the quota matches all objects. + +--- + +##### `scopeSelector`Optional + +```typescript +public readonly scopeSelector: ScopeSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ScopeSelector + +scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. + +For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. + +--- + +### ResourceRequirements + +ResourceRequirements describes the compute resource requirements. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const resourceRequirements: k8s.ResourceRequirements = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| limits | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} | Limits describes the maximum amount of compute resources allowed. | +| requests | {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} | Requests describes the minimum amount of compute resources required. | + +--- + +##### `limits`Optional + +```typescript +public readonly limits: {[ key: string ]: Quantity}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} + +Limits describes the maximum amount of compute resources allowed. + +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +--- + +##### `requests`Optional + +```typescript +public readonly requests: {[ key: string ]: Quantity}; +``` + +- *Type:* {[ key: string ]: @smallcase/cdk8s-botkube.k8s.Quantity} + +Requests describes the minimum amount of compute resources required. + +If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + +--- + +### RoleRef + +RoleRef contains information that points to the role being used. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const roleRef: k8s.RoleRef = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | APIGroup is the group for the resource being referenced. | +| kind | string | Kind is the type of resource being referenced. | +| name | string | Name is the name of resource being referenced. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +APIGroup is the group for the resource being referenced. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind is the type of resource being referenced. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name is the name of resource being referenced. + +--- + +### RoleRefV1Alpha1 + +RoleRef contains information that points to the role being used. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const roleRefV1Alpha1: k8s.RoleRefV1Alpha1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | APIGroup is the group for the resource being referenced. | +| kind | string | Kind is the type of resource being referenced. | +| name | string | Name is the name of resource being referenced. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +APIGroup is the group for the resource being referenced. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind is the type of resource being referenced. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name is the name of resource being referenced. + +--- + +### RoleRefV1Beta1 + +RoleRef contains information that points to the role being used. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const roleRefV1Beta1: k8s.RoleRefV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroup | string | APIGroup is the group for the resource being referenced. | +| kind | string | Kind is the type of resource being referenced. | +| name | string | Name is the name of resource being referenced. | + +--- + +##### `apiGroup`Required + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +APIGroup is the group for the resource being referenced. + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind is the type of resource being referenced. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name is the name of resource being referenced. + +--- + +### RollingUpdateDaemonSet + +Spec to control the desired behavior of daemon set rolling update. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const rollingUpdateDaemonSet: k8s.RollingUpdateDaemonSet = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| maxSurge | @smallcase/cdk8s-botkube.k8s.IntOrString | The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. | +| maxUnavailable | @smallcase/cdk8s-botkube.k8s.IntOrString | The maximum number of DaemonSet pods that can be unavailable during the update. | + +--- + +##### `maxSurge`Optional + +```typescript +public readonly maxSurge: IntOrString; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IntOrString + +The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. + +Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediatedly created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption. This is an alpha field and requires enabling DaemonSetUpdateSurge feature gate. + +--- + +##### `maxUnavailable`Optional + +```typescript +public readonly maxUnavailable: IntOrString; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IntOrString + +The maximum number of DaemonSet pods that can be unavailable during the update. + +Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding down to a minimum of one. This cannot be 0 if MaxSurge is 0 Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. + +--- + +### RollingUpdateDeployment + +Spec to control the desired behavior of rolling update. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const rollingUpdateDeployment: k8s.RollingUpdateDeployment = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| maxSurge | @smallcase/cdk8s-botkube.k8s.IntOrString | The maximum number of pods that can be scheduled above the desired number of pods. | +| maxUnavailable | @smallcase/cdk8s-botkube.k8s.IntOrString | The maximum number of pods that can be unavailable during the update. | + +--- + +##### `maxSurge`Optional + +```typescript +public readonly maxSurge: IntOrString; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IntOrString +- *Default:* 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. + +The maximum number of pods that can be scheduled above the desired number of pods. + +Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. + +--- + +##### `maxUnavailable`Optional + +```typescript +public readonly maxUnavailable: IntOrString; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IntOrString +- *Default:* 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. + +The maximum number of pods that can be unavailable during the update. + +Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. + +--- + +### RollingUpdateStatefulSetStrategy + +RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const rollingUpdateStatefulSetStrategy: k8s.RollingUpdateStatefulSetStrategy = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| partition | number | Partition indicates the ordinal at which the StatefulSet should be partitioned. | + +--- + +##### `partition`Optional + +```typescript +public readonly partition: number; +``` + +- *Type:* number + +Partition indicates the ordinal at which the StatefulSet should be partitioned. + +Default value is 0. + +--- + +### RuleWithOperations + +RuleWithOperations is a tuple of Operations and Resources. + +It is recommended to make sure that all the tuple expansions are valid. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ruleWithOperations: k8s.RuleWithOperations = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroups | string[] | APIGroups is the API groups the resources belong to. | +| apiVersions | string[] | APIVersions is the API versions the resources belong to. | +| operations | string[] | Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. | +| resources | string[] | Resources is a list of resources this rule applies to. | +| scope | string | scope specifies the scope of this rule. | + +--- + +##### `apiGroups`Optional + +```typescript +public readonly apiGroups: string[]; +``` + +- *Type:* string[] + +APIGroups is the API groups the resources belong to. + +'*' is all groups. If '*' is present, the length of the slice must be one. Required. + +--- + +##### `apiVersions`Optional + +```typescript +public readonly apiVersions: string[]; +``` + +- *Type:* string[] + +APIVersions is the API versions the resources belong to. + +'*' is all versions. If '*' is present, the length of the slice must be one. Required. + +--- + +##### `operations`Optional + +```typescript +public readonly operations: string[]; +``` + +- *Type:* string[] + +Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. + +If '*' is present, the length of the slice must be one. Required. + +--- + +##### `resources`Optional + +```typescript +public readonly resources: string[]; +``` + +- *Type:* string[] + +Resources is a list of resources this rule applies to. + +For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '_/scale' means all scale subresources. '_/*' means all resources and their subresources. + +If wildcard is present, the validation rule will ensure resources do not overlap with each other. + +Depending on the enclosing object, subresources might not be allowed. Required. + +--- + +##### `scope`Optional + +```typescript +public readonly scope: string; +``` + +- *Type:* string +- *Default:* . + +scope specifies the scope of this rule. + +Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". + +--- + +### RuleWithOperationsV1Beta1 + +RuleWithOperations is a tuple of Operations and Resources. + +It is recommended to make sure that all the tuple expansions are valid. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const ruleWithOperationsV1Beta1: k8s.RuleWithOperationsV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| apiGroups | string[] | APIGroups is the API groups the resources belong to. | +| apiVersions | string[] | APIVersions is the API versions the resources belong to. | +| operations | string[] | Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. | +| resources | string[] | Resources is a list of resources this rule applies to. | +| scope | string | scope specifies the scope of this rule. | + +--- + +##### `apiGroups`Optional + +```typescript +public readonly apiGroups: string[]; +``` + +- *Type:* string[] + +APIGroups is the API groups the resources belong to. + +'*' is all groups. If '*' is present, the length of the slice must be one. Required. + +--- + +##### `apiVersions`Optional + +```typescript +public readonly apiVersions: string[]; +``` + +- *Type:* string[] + +APIVersions is the API versions the resources belong to. + +'*' is all versions. If '*' is present, the length of the slice must be one. Required. + +--- + +##### `operations`Optional + +```typescript +public readonly operations: string[]; +``` + +- *Type:* string[] + +Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. + +If '*' is present, the length of the slice must be one. Required. + +--- + +##### `resources`Optional + +```typescript +public readonly resources: string[]; +``` + +- *Type:* string[] + +Resources is a list of resources this rule applies to. + +For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '_/scale' means all scale subresources. '_/*' means all resources and their subresources. + +If wildcard is present, the validation rule will ensure resources do not overlap with each other. + +Depending on the enclosing object, subresources might not be allowed. Required. + +--- + +##### `scope`Optional + +```typescript +public readonly scope: string; +``` + +- *Type:* string +- *Default:* . + +scope specifies the scope of this rule. + +Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". + +--- + +### RunAsGroupStrategyOptionsV1Beta1 + +RunAsGroupStrategyOptions defines the strategy type and any options used to create the strategy. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const runAsGroupStrategyOptionsV1Beta1: k8s.RunAsGroupStrategyOptionsV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| rule | string | rule is the strategy that will dictate the allowable RunAsGroup values that may be set. | +| ranges | @smallcase/cdk8s-botkube.k8s.IdRangeV1Beta1[] | ranges are the allowed ranges of gids that may be used. | + +--- + +##### `rule`Required + +```typescript +public readonly rule: string; +``` + +- *Type:* string + +rule is the strategy that will dictate the allowable RunAsGroup values that may be set. + +--- + +##### `ranges`Optional + +```typescript +public readonly ranges: IdRangeV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IdRangeV1Beta1[] + +ranges are the allowed ranges of gids that may be used. + +If you would like to force a single gid then supply a single range with the same start and end. Required for MustRunAs. + +--- + +### RunAsUserStrategyOptionsV1Beta1 + +RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const runAsUserStrategyOptionsV1Beta1: k8s.RunAsUserStrategyOptionsV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| rule | string | rule is the strategy that will dictate the allowable RunAsUser values that may be set. | +| ranges | @smallcase/cdk8s-botkube.k8s.IdRangeV1Beta1[] | ranges are the allowed ranges of uids that may be used. | + +--- + +##### `rule`Required + +```typescript +public readonly rule: string; +``` + +- *Type:* string + +rule is the strategy that will dictate the allowable RunAsUser values that may be set. + +--- + +##### `ranges`Optional + +```typescript +public readonly ranges: IdRangeV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IdRangeV1Beta1[] + +ranges are the allowed ranges of uids that may be used. + +If you would like to force a single uid then supply a single range with the same start and end. Required for MustRunAs. + +--- + +### RuntimeClassSpecV1Alpha1 + +RuntimeClassSpec is a specification of a RuntimeClass. + +It contains parameters that are required to describe the RuntimeClass to the Container Runtime Interface (CRI) implementation, as well as any other components that need to understand how the pod will be run. The RuntimeClassSpec is immutable. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const runtimeClassSpecV1Alpha1: k8s.RuntimeClassSpecV1Alpha1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| runtimeHandler | string | RuntimeHandler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. | +| overhead | @smallcase/cdk8s-botkube.k8s.OverheadV1Alpha1 | Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. | +| scheduling | @smallcase/cdk8s-botkube.k8s.SchedulingV1Alpha1 | Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. | + +--- + +##### `runtimeHandler`Required + +```typescript +public readonly runtimeHandler: string; +``` + +- *Type:* string + +RuntimeHandler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. + +The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The RuntimeHandler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable. + +--- + +##### `overhead`Optional + +```typescript +public readonly overhead: OverheadV1Alpha1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.OverheadV1Alpha1 + +Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. + +For more details, see https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature. + +--- + +##### `scheduling`Optional + +```typescript +public readonly scheduling: SchedulingV1Alpha1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SchedulingV1Alpha1 + +Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. + +If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes. + +--- + +### RuntimeClassStrategyOptionsV1Beta1 + +RuntimeClassStrategyOptions define the strategy that will dictate the allowable RuntimeClasses for a pod. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const runtimeClassStrategyOptionsV1Beta1: k8s.RuntimeClassStrategyOptionsV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| allowedRuntimeClassNames | string[] | allowedRuntimeClassNames is an allowlist of RuntimeClass names that may be specified on a pod. | +| defaultRuntimeClassName | string | defaultRuntimeClassName is the default RuntimeClassName to set on the pod. | + +--- + +##### `allowedRuntimeClassNames`Required + +```typescript +public readonly allowedRuntimeClassNames: string[]; +``` + +- *Type:* string[] + +allowedRuntimeClassNames is an allowlist of RuntimeClass names that may be specified on a pod. + +A value of "*" means that any RuntimeClass name is allowed, and must be the only item in the list. An empty list requires the RuntimeClassName field to be unset. + +--- + +##### `defaultRuntimeClassName`Optional + +```typescript +public readonly defaultRuntimeClassName: string; +``` + +- *Type:* string + +defaultRuntimeClassName is the default RuntimeClassName to set on the pod. + +The default MUST be allowed by the allowedRuntimeClassNames list. A value of nil does not mutate the Pod. + +--- + +### ScaleIoPersistentVolumeSource + +ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const scaleIoPersistentVolumeSource: k8s.ScaleIoPersistentVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| gateway | string | The host address of the ScaleIO API Gateway. | +| secretRef | @smallcase/cdk8s-botkube.k8s.SecretReference | SecretRef references to the secret for ScaleIO user and other sensitive information. | +| system | string | The name of the storage system as configured in ScaleIO. | +| fsType | string | Filesystem type to mount. | +| protectionDomain | string | The name of the ScaleIO Protection Domain for the configured storage. | +| readOnly | boolean | Defaults to false (read/write). | +| sslEnabled | boolean | Flag to enable/disable SSL communication with Gateway, default false. | +| storageMode | string | Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. | +| storagePool | string | The ScaleIO Storage Pool associated with the protection domain. | +| volumeName | string | The name of a volume already created in the ScaleIO system that is associated with this volume source. | + +--- + +##### `gateway`Required + +```typescript +public readonly gateway: string; +``` + +- *Type:* string + +The host address of the ScaleIO API Gateway. + +--- + +##### `secretRef`Required + +```typescript +public readonly secretRef: SecretReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecretReference + +SecretRef references to the secret for ScaleIO user and other sensitive information. + +If this is not provided, Login operation will fail. + +--- + +##### `system`Required + +```typescript +public readonly system: string; +``` + +- *Type:* string + +The name of the storage system as configured in ScaleIO. + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string +- *Default:* xfs" + +Filesystem type to mount. + +Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs" + +--- + +##### `protectionDomain`Optional + +```typescript +public readonly protectionDomain: string; +``` + +- *Type:* string + +The name of the ScaleIO Protection Domain for the configured storage. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +--- + +##### `sslEnabled`Optional + +```typescript +public readonly sslEnabled: boolean; +``` + +- *Type:* boolean + +Flag to enable/disable SSL communication with Gateway, default false. + +--- + +##### `storageMode`Optional + +```typescript +public readonly storageMode: string; +``` + +- *Type:* string +- *Default:* ThinProvisioned. + +Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. + +Default is ThinProvisioned. + +--- + +##### `storagePool`Optional + +```typescript +public readonly storagePool: string; +``` + +- *Type:* string + +The ScaleIO Storage Pool associated with the protection domain. + +--- + +##### `volumeName`Optional + +```typescript +public readonly volumeName: string; +``` + +- *Type:* string + +The name of a volume already created in the ScaleIO system that is associated with this volume source. + +--- + +### ScaleIoVolumeSource + +ScaleIOVolumeSource represents a persistent ScaleIO volume. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const scaleIoVolumeSource: k8s.ScaleIoVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| gateway | string | The host address of the ScaleIO API Gateway. | +| secretRef | @smallcase/cdk8s-botkube.k8s.LocalObjectReference | SecretRef references to the secret for ScaleIO user and other sensitive information. | +| system | string | The name of the storage system as configured in ScaleIO. | +| fsType | string | Filesystem type to mount. | +| protectionDomain | string | The name of the ScaleIO Protection Domain for the configured storage. | +| readOnly | boolean | Defaults to false (read/write). | +| sslEnabled | boolean | Flag to enable/disable SSL communication with Gateway, default false. | +| storageMode | string | Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. | +| storagePool | string | The ScaleIO Storage Pool associated with the protection domain. | +| volumeName | string | The name of a volume already created in the ScaleIO system that is associated with this volume source. | + +--- + +##### `gateway`Required + +```typescript +public readonly gateway: string; +``` + +- *Type:* string + +The host address of the ScaleIO API Gateway. + +--- + +##### `secretRef`Required + +```typescript +public readonly secretRef: LocalObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LocalObjectReference + +SecretRef references to the secret for ScaleIO user and other sensitive information. + +If this is not provided, Login operation will fail. + +--- + +##### `system`Required + +```typescript +public readonly system: string; +``` + +- *Type:* string + +The name of the storage system as configured in ScaleIO. + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string +- *Default:* xfs". + +Filesystem type to mount. + +Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". + +--- + +##### `protectionDomain`Optional + +```typescript +public readonly protectionDomain: string; +``` + +- *Type:* string + +The name of the ScaleIO Protection Domain for the configured storage. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +--- + +##### `sslEnabled`Optional + +```typescript +public readonly sslEnabled: boolean; +``` + +- *Type:* boolean + +Flag to enable/disable SSL communication with Gateway, default false. + +--- + +##### `storageMode`Optional + +```typescript +public readonly storageMode: string; +``` + +- *Type:* string +- *Default:* ThinProvisioned. + +Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. + +Default is ThinProvisioned. + +--- + +##### `storagePool`Optional + +```typescript +public readonly storagePool: string; +``` + +- *Type:* string + +The ScaleIO Storage Pool associated with the protection domain. + +--- + +##### `volumeName`Optional + +```typescript +public readonly volumeName: string; +``` + +- *Type:* string + +The name of a volume already created in the ScaleIO system that is associated with this volume source. + +--- + +### ScaleSpec + +ScaleSpec describes the attributes of a scale subresource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const scaleSpec: k8s.ScaleSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| replicas | number | desired number of instances for the scaled object. | + +--- + +##### `replicas`Optional + +```typescript +public readonly replicas: number; +``` + +- *Type:* number + +desired number of instances for the scaled object. + +--- + +### Scheduling + +Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const scheduling: k8s.Scheduling = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| nodeSelector | {[ key: string ]: string} | nodeSelector lists labels that must be present on nodes that support this RuntimeClass. | +| tolerations | @smallcase/cdk8s-botkube.k8s.Toleration[] | tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. | + +--- + +##### `nodeSelector`Optional + +```typescript +public readonly nodeSelector: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +nodeSelector lists labels that must be present on nodes that support this RuntimeClass. + +Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission. + +--- + +##### `tolerations`Optional + +```typescript +public readonly tolerations: Toleration[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Toleration[] + +tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. + +--- + +### SchedulingV1Alpha1 + +Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const schedulingV1Alpha1: k8s.SchedulingV1Alpha1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| nodeSelector | {[ key: string ]: string} | nodeSelector lists labels that must be present on nodes that support this RuntimeClass. | +| tolerations | @smallcase/cdk8s-botkube.k8s.Toleration[] | tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. | + +--- + +##### `nodeSelector`Optional + +```typescript +public readonly nodeSelector: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +nodeSelector lists labels that must be present on nodes that support this RuntimeClass. + +Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission. + +--- + +##### `tolerations`Optional + +```typescript +public readonly tolerations: Toleration[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Toleration[] + +tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. + +--- + +### SchedulingV1Beta1 + +Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const schedulingV1Beta1: k8s.SchedulingV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| nodeSelector | {[ key: string ]: string} | nodeSelector lists labels that must be present on nodes that support this RuntimeClass. | +| tolerations | @smallcase/cdk8s-botkube.k8s.Toleration[] | tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. | + +--- + +##### `nodeSelector`Optional + +```typescript +public readonly nodeSelector: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +nodeSelector lists labels that must be present on nodes that support this RuntimeClass. + +Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission. + +--- + +##### `tolerations`Optional + +```typescript +public readonly tolerations: Toleration[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Toleration[] + +tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. + +--- + +### ScopedResourceSelectorRequirement + +A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const scopedResourceSelectorRequirement: k8s.ScopedResourceSelectorRequirement = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| operator | string | Represents a scope's relationship to a set of values. | +| scopeName | string | The name of the scope that the selector applies to. | +| values | string[] | An array of string values. | + +--- + +##### `operator`Required + +```typescript +public readonly operator: string; +``` + +- *Type:* string + +Represents a scope's relationship to a set of values. + +Valid operators are In, NotIn, Exists, DoesNotExist. + +--- + +##### `scopeName`Required + +```typescript +public readonly scopeName: string; +``` + +- *Type:* string + +The name of the scope that the selector applies to. + +--- + +##### `values`Optional + +```typescript +public readonly values: string[]; +``` + +- *Type:* string[] + +An array of string values. + +If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. + +--- + +### ScopeSelector + +A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const scopeSelector: k8s.ScopeSelector = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| matchExpressions | @smallcase/cdk8s-botkube.k8s.ScopedResourceSelectorRequirement[] | A list of scope selector requirements by scope of the resources. | + +--- + +##### `matchExpressions`Optional + +```typescript +public readonly matchExpressions: ScopedResourceSelectorRequirement[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ScopedResourceSelectorRequirement[] + +A list of scope selector requirements by scope of the resources. + +--- + +### SeccompProfile + +SeccompProfile defines a pod/container's seccomp profile settings. + +Only one profile source may be set. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const seccompProfile: k8s.SeccompProfile = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| type | string | type indicates which kind of seccomp profile will be applied. Valid options are:. | +| localhostProfile | string | localhostProfile indicates a profile defined in a file on the node should be used. | + +--- + +##### `type`Required + +```typescript +public readonly type: string; +``` + +- *Type:* string + +type indicates which kind of seccomp profile will be applied. Valid options are:. + +Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. + +--- + +##### `localhostProfile`Optional + +```typescript +public readonly localhostProfile: string; +``` + +- *Type:* string + +localhostProfile indicates a profile defined in a file on the node should be used. + +The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". + +--- + +### SecretEnvSource + +SecretEnvSource selects a Secret to populate the environment variables with. + +The contents of the target Secret's Data field will represent the key-value pairs as environment variables. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const secretEnvSource: k8s.SecretEnvSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | Name of the referent. | +| optional | boolean | Specify whether the Secret must be defined. | + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the referent. + +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +--- + +##### `optional`Optional + +```typescript +public readonly optional: boolean; +``` + +- *Type:* boolean + +Specify whether the Secret must be defined. + +--- + +### SecretKeySelector + +SecretKeySelector selects a key of a Secret. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const secretKeySelector: k8s.SecretKeySelector = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| key | string | The key of the secret to select from. | +| name | string | Name of the referent. | +| optional | boolean | Specify whether the Secret or its key must be defined. | + +--- + +##### `key`Required + +```typescript +public readonly key: string; +``` + +- *Type:* string + +The key of the secret to select from. + +Must be a valid secret key. + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the referent. + +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +--- + +##### `optional`Optional + +```typescript +public readonly optional: boolean; +``` + +- *Type:* boolean + +Specify whether the Secret or its key must be defined. + +--- + +### SecretProjection + +Adapts a secret into a projected volume. + +The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const secretProjection: k8s.SecretProjection = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| items | @smallcase/cdk8s-botkube.k8s.KeyToPath[] | 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. | +| name | string | Name of the referent. | +| optional | boolean | Specify whether the Secret or its key must be defined. | + +--- + +##### `items`Optional + +```typescript +public readonly items: KeyToPath[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KeyToPath[] + +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. + +If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the referent. + +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +--- + +##### `optional`Optional + +```typescript +public readonly optional: boolean; +``` + +- *Type:* boolean + +Specify whether the Secret or its key must be defined. + +--- + +### SecretReference + +SecretReference represents a Secret Reference. + +It has enough information to retrieve secret in any namespace + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const secretReference: k8s.SecretReference = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | Name is unique within a namespace to reference a secret resource. | +| namespace | string | Namespace defines the space within which the secret name must be unique. | + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name is unique within a namespace to reference a secret resource. + +--- + +##### `namespace`Optional + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +Namespace defines the space within which the secret name must be unique. + +--- + +### SecretVolumeSource + +Adapts a Secret into a volume. + +The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const secretVolumeSource: k8s.SecretVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| defaultMode | number | Optional: mode bits used to set permissions on created files by default. | +| items | @smallcase/cdk8s-botkube.k8s.KeyToPath[] | 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. | +| optional | boolean | Specify whether the Secret or its keys must be defined. | +| secretName | string | Name of the secret in the pod's namespace to use. | + +--- + +##### `defaultMode`Optional + +```typescript +public readonly defaultMode: number; +``` + +- *Type:* number +- *Default:* 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +Optional: mode bits used to set permissions on created files by default. + +Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + +--- + +##### `items`Optional + +```typescript +public readonly items: KeyToPath[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KeyToPath[] + +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. + +If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + +--- + +##### `optional`Optional + +```typescript +public readonly optional: boolean; +``` + +- *Type:* boolean + +Specify whether the Secret or its keys must be defined. + +--- + +##### `secretName`Optional + +```typescript +public readonly secretName: string; +``` + +- *Type:* string + +Name of the secret in the pod's namespace to use. + +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + +--- + +### SecurityContext + +SecurityContext holds security configuration that will be applied to a container. + +Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const securityContext: k8s.SecurityContext = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| allowPrivilegeEscalation | boolean | AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. | +| capabilities | @smallcase/cdk8s-botkube.k8s.Capabilities | The capabilities to add/drop when running containers. | +| privileged | boolean | Run container in privileged mode. | +| procMount | string | procMount denotes the type of proc mount to use for the containers. | +| readOnlyRootFilesystem | boolean | Whether this container has a read-only root filesystem. | +| runAsGroup | number | The GID to run the entrypoint of the container process. | +| runAsNonRoot | boolean | Indicates that the container must run as a non-root user. | +| runAsUser | number | The UID to run the entrypoint of the container process. | +| seccompProfile | @smallcase/cdk8s-botkube.k8s.SeccompProfile | The seccomp options to use by this container. | +| seLinuxOptions | @smallcase/cdk8s-botkube.k8s.SeLinuxOptions | The SELinux context to be applied to the container. | +| windowsOptions | @smallcase/cdk8s-botkube.k8s.WindowsSecurityContextOptions | The Windows specific settings applied to all containers. | + +--- + +##### `allowPrivilegeEscalation`Optional + +```typescript +public readonly allowPrivilegeEscalation: boolean; +``` + +- *Type:* boolean + +AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. + +This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN + +--- + +##### `capabilities`Optional + +```typescript +public readonly capabilities: Capabilities; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.Capabilities +- *Default:* the default set of capabilities granted by the container runtime. + +The capabilities to add/drop when running containers. + +Defaults to the default set of capabilities granted by the container runtime. + +--- + +##### `privileged`Optional + +```typescript +public readonly privileged: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +Run container in privileged mode. + +Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. + +--- + +##### `procMount`Optional + +```typescript +public readonly procMount: string; +``` + +- *Type:* string + +procMount denotes the type of proc mount to use for the containers. + +The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. + +--- + +##### `readOnlyRootFilesystem`Optional + +```typescript +public readonly readOnlyRootFilesystem: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +Whether this container has a read-only root filesystem. + +Default is false. + +--- + +##### `runAsGroup`Optional + +```typescript +public readonly runAsGroup: number; +``` + +- *Type:* number + +The GID to run the entrypoint of the container process. + +Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +--- + +##### `runAsNonRoot`Optional + +```typescript +public readonly runAsNonRoot: boolean; +``` + +- *Type:* boolean + +Indicates that the container must run as a non-root user. + +If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +--- + +##### `runAsUser`Optional + +```typescript +public readonly runAsUser: number; +``` + +- *Type:* number +- *Default:* user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +The UID to run the entrypoint of the container process. + +Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +--- + +##### `seccompProfile`Optional + +```typescript +public readonly seccompProfile: SeccompProfile; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SeccompProfile + +The seccomp options to use by this container. + +If seccomp options are provided at both the pod & container level, the container options override the pod options. + +--- + +##### `seLinuxOptions`Optional + +```typescript +public readonly seLinuxOptions: SeLinuxOptions; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SeLinuxOptions + +The SELinux context to be applied to the container. + +If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +--- + +##### `windowsOptions`Optional + +```typescript +public readonly windowsOptions: WindowsSecurityContextOptions; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.WindowsSecurityContextOptions + +The Windows specific settings applied to all containers. + +If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +--- + +### SelfSubjectAccessReviewSpec + +SelfSubjectAccessReviewSpec is a description of the access request. + +Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const selfSubjectAccessReviewSpec: k8s.SelfSubjectAccessReviewSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| nonResourceAttributes | @smallcase/cdk8s-botkube.k8s.NonResourceAttributes | NonResourceAttributes describes information for a non-resource access request. | +| resourceAttributes | @smallcase/cdk8s-botkube.k8s.ResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request. | + +--- + +##### `nonResourceAttributes`Optional + +```typescript +public readonly nonResourceAttributes: NonResourceAttributes; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NonResourceAttributes + +NonResourceAttributes describes information for a non-resource access request. + +--- + +##### `resourceAttributes`Optional + +```typescript +public readonly resourceAttributes: ResourceAttributes; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ResourceAttributes + +ResourceAuthorizationAttributes describes information for a resource access request. + +--- + +### SelfSubjectAccessReviewSpecV1Beta1 + +SelfSubjectAccessReviewSpec is a description of the access request. + +Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const selfSubjectAccessReviewSpecV1Beta1: k8s.SelfSubjectAccessReviewSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| nonResourceAttributes | @smallcase/cdk8s-botkube.k8s.NonResourceAttributesV1Beta1 | NonResourceAttributes describes information for a non-resource access request. | +| resourceAttributes | @smallcase/cdk8s-botkube.k8s.ResourceAttributesV1Beta1 | ResourceAuthorizationAttributes describes information for a resource access request. | + +--- + +##### `nonResourceAttributes`Optional + +```typescript +public readonly nonResourceAttributes: NonResourceAttributesV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NonResourceAttributesV1Beta1 + +NonResourceAttributes describes information for a non-resource access request. + +--- + +##### `resourceAttributes`Optional + +```typescript +public readonly resourceAttributes: ResourceAttributesV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ResourceAttributesV1Beta1 + +ResourceAuthorizationAttributes describes information for a resource access request. + +--- + +### SelfSubjectRulesReviewSpec + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const selfSubjectRulesReviewSpec: k8s.SelfSubjectRulesReviewSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| namespace | string | Namespace to evaluate rules for. | + +--- + +##### `namespace`Optional + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +Namespace to evaluate rules for. + +Required. + +--- + +### SelfSubjectRulesReviewSpecV1Beta1 + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const selfSubjectRulesReviewSpecV1Beta1: k8s.SelfSubjectRulesReviewSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| namespace | string | Namespace to evaluate rules for. | + +--- + +##### `namespace`Optional + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +Namespace to evaluate rules for. + +Required. + +--- + +### SeLinuxOptions + +SELinuxOptions are the labels to be applied to the container. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const seLinuxOptions: k8s.SeLinuxOptions = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| level | string | Level is SELinux level label that applies to the container. | +| role | string | Role is a SELinux role label that applies to the container. | +| type | string | Type is a SELinux type label that applies to the container. | +| user | string | User is a SELinux user label that applies to the container. | + +--- + +##### `level`Optional + +```typescript +public readonly level: string; +``` + +- *Type:* string + +Level is SELinux level label that applies to the container. + +--- + +##### `role`Optional + +```typescript +public readonly role: string; +``` + +- *Type:* string + +Role is a SELinux role label that applies to the container. + +--- + +##### `type`Optional + +```typescript +public readonly type: string; +``` + +- *Type:* string + +Type is a SELinux type label that applies to the container. + +--- + +##### `user`Optional + +```typescript +public readonly user: string; +``` + +- *Type:* string + +User is a SELinux user label that applies to the container. + +--- + +### SeLinuxStrategyOptionsV1Beta1 + +SELinuxStrategyOptions defines the strategy type and any options used to create the strategy. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const seLinuxStrategyOptionsV1Beta1: k8s.SeLinuxStrategyOptionsV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| rule | string | rule is the strategy that will dictate the allowable labels that may be set. | +| seLinuxOptions | @smallcase/cdk8s-botkube.k8s.SeLinuxOptions | seLinuxOptions required to run as; | + +--- + +##### `rule`Required + +```typescript +public readonly rule: string; +``` + +- *Type:* string + +rule is the strategy that will dictate the allowable labels that may be set. + +--- + +##### `seLinuxOptions`Optional + +```typescript +public readonly seLinuxOptions: SeLinuxOptions; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SeLinuxOptions + +seLinuxOptions required to run as; + +required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ + +--- + +### ServiceAccountTokenProjection + +ServiceAccountTokenProjection represents a projected service account token volume. + +This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const serviceAccountTokenProjection: k8s.ServiceAccountTokenProjection = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| path | string | Path is the path relative to the mount point of the file to project the token into. | +| audience | string | Audience is the intended audience of the token. | +| expirationSeconds | number | ExpirationSeconds is the requested duration of validity of the service account token. | + +--- + +##### `path`Required + +```typescript +public readonly path: string; +``` + +- *Type:* string + +Path is the path relative to the mount point of the file to project the token into. + +--- + +##### `audience`Optional + +```typescript +public readonly audience: string; +``` + +- *Type:* string + +Audience is the intended audience of the token. + +A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. + +--- + +##### `expirationSeconds`Optional + +```typescript +public readonly expirationSeconds: number; +``` + +- *Type:* number +- *Default:* 1 hour and must be at least 10 minutes. + +ExpirationSeconds is the requested duration of validity of the service account token. + +As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. + +--- + +### ServiceBackendPort + +ServiceBackendPort is the service port being referenced. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const serviceBackendPort: k8s.ServiceBackendPort = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | Name is the name of the port on the Service. | +| number | number | Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name". | + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name is the name of the port on the Service. + +This is a mutually exclusive setting with "Number". + +--- + +##### `number`Optional + +```typescript +public readonly number: number; +``` + +- *Type:* number + +Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name". + +--- + +### ServicePort + +ServicePort contains information on service's port. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const servicePort: k8s.ServicePort = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| port | number | The port that will be exposed by this service. | +| appProtocol | string | The application protocol for this port. | +| name | string | The name of this port within the service. | +| nodePort | number | The port on each node on which this service is exposed when type is NodePort or LoadBalancer. | +| protocol | string | The IP protocol for this port. | +| targetPort | @smallcase/cdk8s-botkube.k8s.IntOrString | Number or name of the port to access on the pods targeted by the service. | + +--- + +##### `port`Required + +```typescript +public readonly port: number; +``` + +- *Type:* number + +The port that will be exposed by this service. + +--- + +##### `appProtocol`Optional + +```typescript +public readonly appProtocol: string; +``` + +- *Type:* string + +The application protocol for this port. + +This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default. + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of this port within the service. + +This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. + +--- + +##### `nodePort`Optional + +```typescript +public readonly nodePort: number; +``` + +- *Type:* number + +The port on each node on which this service is exposed when type is NodePort or LoadBalancer. + +Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport + +--- + +##### `protocol`Optional + +```typescript +public readonly protocol: string; +``` + +- *Type:* string +- *Default:* TCP. + +The IP protocol for this port. + +Supports "TCP", "UDP", and "SCTP". Default is TCP. + +--- + +##### `targetPort`Optional + +```typescript +public readonly targetPort: IntOrString; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IntOrString + +Number or name of the port to access on the pods targeted by the service. + +Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service + +--- + +### ServiceReference + +ServiceReference holds a reference to Service.legacy.k8s.io. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const serviceReference: k8s.ServiceReference = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | `name` is the name of the service. | +| namespace | string | `namespace` is the namespace of the service. | +| path | string | `path` is an optional URL path which will be sent in any request to this service. | +| port | number | If specified, the port on the service that hosting webhook. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +`name` is the name of the service. + +Required + +--- + +##### `namespace`Required + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +`namespace` is the namespace of the service. + +Required + +--- + +##### `path`Optional + +```typescript +public readonly path: string; +``` + +- *Type:* string + +`path` is an optional URL path which will be sent in any request to this service. + +--- + +##### `port`Optional + +```typescript +public readonly port: number; +``` + +- *Type:* number +- *Default:* 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). + +If specified, the port on the service that hosting webhook. + +Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). + +--- + +### ServiceReferenceV1Beta1 + +ServiceReference holds a reference to Service.legacy.k8s.io. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const serviceReferenceV1Beta1: k8s.ServiceReferenceV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | `name` is the name of the service. | +| namespace | string | `namespace` is the namespace of the service. | +| path | string | `path` is an optional URL path which will be sent in any request to this service. | +| port | number | If specified, the port on the service that hosting webhook. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +`name` is the name of the service. + +Required + +--- + +##### `namespace`Required + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +`namespace` is the namespace of the service. + +Required + +--- + +##### `path`Optional + +```typescript +public readonly path: string; +``` + +- *Type:* string + +`path` is an optional URL path which will be sent in any request to this service. + +--- + +##### `port`Optional + +```typescript +public readonly port: number; +``` + +- *Type:* number +- *Default:* 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). + +If specified, the port on the service that hosting webhook. + +Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). + +--- + +### ServiceSpec + +ServiceSpec describes the attributes that a user creates on a service. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const serviceSpec: k8s.ServiceSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| allocateLoadBalancerNodePorts | boolean | allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. | +| clusterIp | string | clusterIP is the IP address of the service and is usually assigned randomly. | +| clusterIPs | string[] | ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. | +| externalIPs | string[] | externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. | +| externalName | string | externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName". | +| externalTrafficPolicy | string | externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. | +| healthCheckNodePort | number | healthCheckNodePort specifies the healthcheck nodePort for the service. | +| internalTrafficPolicy | string | InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. | +| ipFamilies | string[] | IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service, and is gated by the "IPv6DualStack" feature gate. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. | +| ipFamilyPolicy | string | IPFamilyPolicy represents the dual-stack-ness requested or required by this Service, and is gated by the "IPv6DualStack" feature gate. | +| loadBalancerClass | string | loadBalancerClass is the class of the load balancer implementation this Service belongs to. | +| loadBalancerIp | string | Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. | +| loadBalancerSourceRanges | string[] | If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. | +| ports | @smallcase/cdk8s-botkube.k8s.ServicePort[] | The list of ports that are exposed by this service. | +| publishNotReadyAddresses | boolean | publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. | +| selector | {[ key: string ]: string} | Route service traffic to pods with label keys and values matching this selector. | +| sessionAffinity | string | Supports "ClientIP" and "None". | +| sessionAffinityConfig | @smallcase/cdk8s-botkube.k8s.SessionAffinityConfig | sessionAffinityConfig contains the configurations of session affinity. | +| topologyKeys | string[] | topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. | +| type | string | type determines how the Service is exposed. | + +--- + +##### `allocateLoadBalancerNodePorts`Optional + +```typescript +public readonly allocateLoadBalancerNodePorts: boolean; +``` + +- *Type:* boolean +- *Default:* true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. allocateLoadBalancerNodePorts may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. This field is alpha-level and is only honored by servers that enable the ServiceLBNodePortControl feature. + +allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. + +Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. allocateLoadBalancerNodePorts may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. This field is alpha-level and is only honored by servers that enable the ServiceLBNodePortControl feature. + +--- + +##### `clusterIp`Optional + +```typescript +public readonly clusterIp: string; +``` + +- *Type:* string + +clusterIP is the IP address of the service and is usually assigned randomly. + +If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + +--- + +##### `clusterIPs`Optional + +```typescript +public readonly clusterIPs: string[]; +``` + +- *Type:* string[] + +ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. + +If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. If this field is not specified, it will be initialized from the clusterIP field. If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value. + +Unless the "IPv6DualStack" feature gate is enabled, this field is limited to one value, which must be the same as the clusterIP field. If the feature gate is enabled, this field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + +--- + +##### `externalIPs`Optional + +```typescript +public readonly externalIPs: string[]; +``` + +- *Type:* string[] + +externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. + +These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. + +--- + +##### `externalName`Optional + +```typescript +public readonly externalName: string; +``` + +- *Type:* string + +externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName". + +--- + +##### `externalTrafficPolicy`Optional + +```typescript +public readonly externalTrafficPolicy: string; +``` + +- *Type:* string + +externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. + +"Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading. + +--- + +##### `healthCheckNodePort`Optional + +```typescript +public readonly healthCheckNodePort: number; +``` + +- *Type:* number + +healthCheckNodePort specifies the healthcheck nodePort for the service. + +This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). + +--- + +##### `internalTrafficPolicy`Optional + +```typescript +public readonly internalTrafficPolicy: string; +``` + +- *Type:* string + +InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. + +"Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster". + +--- + +##### `ipFamilies`Optional + +```typescript +public readonly ipFamilies: string[]; +``` + +- *Type:* string[] + +IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service, and is gated by the "IPv6DualStack" feature gate. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. + +This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. + +--- + +##### `ipFamilyPolicy`Optional + +```typescript +public readonly ipFamilyPolicy: string; +``` + +- *Type:* string + +IPFamilyPolicy represents the dual-stack-ness requested or required by this Service, and is gated by the "IPv6DualStack" feature gate. + +If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName. + +--- + +##### `loadBalancerClass`Optional + +```typescript +public readonly loadBalancerClass: string; +``` + +- *Type:* string + +loadBalancerClass is the class of the load balancer implementation this Service belongs to. + +If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type. + +--- + +##### `loadBalancerIp`Optional + +```typescript +public readonly loadBalancerIp: string; +``` + +- *Type:* string + +Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. + +This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. + +--- + +##### `loadBalancerSourceRanges`Optional + +```typescript +public readonly loadBalancerSourceRanges: string[]; +``` + +- *Type:* string[] + +If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. + +This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/ + +--- + +##### `ports`Optional + +```typescript +public readonly ports: ServicePort[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ServicePort[] + +The list of ports that are exposed by this service. + +More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + +--- + +##### `publishNotReadyAddresses`Optional + +```typescript +public readonly publishNotReadyAddresses: boolean; +``` + +- *Type:* boolean + +publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. + +The primary use case for setting this field is for a StatefulSet's Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered "ready" even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior. + +--- + +##### `selector`Optional + +```typescript +public readonly selector: {[ key: string ]: string}; +``` + +- *Type:* {[ key: string ]: string} + +Route service traffic to pods with label keys and values matching this selector. + +If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/ + +--- + +##### `sessionAffinity`Optional + +```typescript +public readonly sessionAffinity: string; +``` + +- *Type:* string +- *Default:* None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + +Supports "ClientIP" and "None". + +Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + +--- + +##### `sessionAffinityConfig`Optional + +```typescript +public readonly sessionAffinityConfig: SessionAffinityConfig; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SessionAffinityConfig + +sessionAffinityConfig contains the configurations of session affinity. + +--- + +##### `topologyKeys`Optional + +```typescript +public readonly topologyKeys: string[]; +``` + +- *Type:* string[] + +topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. + +Topology keys must be valid label keys and at most 16 keys may be specified. Endpoints are chosen based on the first topology key with available backends. If this field is specified and all entries have no backends that match the topology of the client, the service has no backends for that client and connections should fail. The special value "*" may be used to mean "any topology". This catch-all value, if used, only makes sense as the last value in the list. If this is not specified or empty, no topology constraints will be applied. This field is alpha-level and is only honored by servers that enable the ServiceTopology feature. This field is deprecated and will be removed in a future version. + +--- + +##### `type`Optional + +```typescript +public readonly type: string; +``` + +- *Type:* string +- *Default:* ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + +type determines how the Service is exposed. + +Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + +--- + +### SessionAffinityConfig + +SessionAffinityConfig represents the configurations of session affinity. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const sessionAffinityConfig: k8s.SessionAffinityConfig = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| clientIp | @smallcase/cdk8s-botkube.k8s.ClientIpConfig | clientIP contains the configurations of Client IP based session affinity. | + +--- + +##### `clientIp`Optional + +```typescript +public readonly clientIp: ClientIpConfig; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ClientIpConfig + +clientIP contains the configurations of Client IP based session affinity. + +--- + +### StatefulSetSpec + +A StatefulSetSpec is the specification of a StatefulSet. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const statefulSetSpec: k8s.StatefulSetSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| selector | @smallcase/cdk8s-botkube.k8s.LabelSelector | selector is a label query over pods that should match the replica count. | +| serviceName | string | serviceName is the name of the service that governs this StatefulSet. | +| template | @smallcase/cdk8s-botkube.k8s.PodTemplateSpec | template is the object that describes the pod that will be created if insufficient replicas are detected. | +| podManagementPolicy | string | podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. | +| replicas | number | replicas is the desired number of replicas of the given Template. | +| revisionHistoryLimit | number | revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. | +| updateStrategy | @smallcase/cdk8s-botkube.k8s.StatefulSetUpdateStrategy | updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. | +| volumeClaimTemplates | @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeClaimProps[] | volumeClaimTemplates is a list of claims that pods are allowed to reference. | + +--- + +##### `selector`Required + +```typescript +public readonly selector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +selector is a label query over pods that should match the replica count. + +It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + +--- + +##### `serviceName`Required + +```typescript +public readonly serviceName: string; +``` + +- *Type:* string + +serviceName is the name of the service that governs this StatefulSet. + +This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller. + +--- + +##### `template`Required + +```typescript +public readonly template: PodTemplateSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodTemplateSpec + +template is the object that describes the pod that will be created if insufficient replicas are detected. + +Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. + +--- + +##### `podManagementPolicy`Optional + +```typescript +public readonly podManagementPolicy: string; +``` + +- *Type:* string + +podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. + +The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once. + +--- + +##### `replicas`Optional + +```typescript +public readonly replicas: number; +``` + +- *Type:* number + +replicas is the desired number of replicas of the given Template. + +These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1. + +--- + +##### `revisionHistoryLimit`Optional + +```typescript +public readonly revisionHistoryLimit: number; +``` + +- *Type:* number + +revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. + +The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10. + +--- + +##### `updateStrategy`Optional + +```typescript +public readonly updateStrategy: StatefulSetUpdateStrategy; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.StatefulSetUpdateStrategy + +updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. + +--- + +##### `volumeClaimTemplates`Optional + +```typescript +public readonly volumeClaimTemplates: KubePersistentVolumeClaimProps[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.KubePersistentVolumeClaimProps[] + +volumeClaimTemplates is a list of claims that pods are allowed to reference. + +The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name. + +--- + +### StatefulSetUpdateStrategy + +StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. + +It includes any additional parameters necessary to perform the update for the indicated strategy. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const statefulSetUpdateStrategy: k8s.StatefulSetUpdateStrategy = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| rollingUpdate | @smallcase/cdk8s-botkube.k8s.RollingUpdateStatefulSetStrategy | RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. | +| type | string | Type indicates the type of the StatefulSetUpdateStrategy. | + +--- + +##### `rollingUpdate`Optional + +```typescript +public readonly rollingUpdate: RollingUpdateStatefulSetStrategy; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RollingUpdateStatefulSetStrategy + +RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. + +--- + +##### `type`Optional + +```typescript +public readonly type: string; +``` + +- *Type:* string +- *Default:* RollingUpdate. + +Type indicates the type of the StatefulSetUpdateStrategy. + +Default is RollingUpdate. + +--- + +### StatusCause + +StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const statusCause: k8s.StatusCause = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| field | string | The field of the resource that has caused this error, as named by its JSON serialization. | +| message | string | A human-readable description of the cause of the error. | +| reason | string | A machine-readable description of the cause of the error. | + +--- + +##### `field`Optional + +```typescript +public readonly field: string; +``` + +- *Type:* string + +The field of the resource that has caused this error, as named by its JSON serialization. + +May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. + +Examples: +"name" - the field "name" on the current resource +"items[0].name" - the field "name" on the first array entry in "items" + +--- + +##### `message`Optional + +```typescript +public readonly message: string; +``` + +- *Type:* string + +A human-readable description of the cause of the error. + +This field may be presented as-is to a reader. + +--- + +##### `reason`Optional + +```typescript +public readonly reason: string; +``` + +- *Type:* string + +A machine-readable description of the cause of the error. + +If this value is empty there is no information available. + +--- + +### StatusDetails + +StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. + +The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const statusDetails: k8s.StatusDetails = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| causes | @smallcase/cdk8s-botkube.k8s.StatusCause[] | The Causes array includes more details associated with the StatusReason failure. | +| group | string | The group attribute of the resource associated with the status StatusReason. | +| kind | string | The kind attribute of the resource associated with the status StatusReason. | +| name | string | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). | +| retryAfterSeconds | number | If specified, the time in seconds before the operation should be retried. | +| uid | string | UID of the resource. | + +--- + +##### `causes`Optional + +```typescript +public readonly causes: StatusCause[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.StatusCause[] + +The Causes array includes more details associated with the StatusReason failure. + +Not all StatusReasons may provide detailed causes. + +--- + +##### `group`Optional + +```typescript +public readonly group: string; +``` + +- *Type:* string + +The group attribute of the resource associated with the status StatusReason. + +--- + +##### `kind`Optional + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +The kind attribute of the resource associated with the status StatusReason. + +On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +--- + +##### `name`Optional + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). + +--- + +##### `retryAfterSeconds`Optional + +```typescript +public readonly retryAfterSeconds: number; +``` + +- *Type:* number + +If specified, the time in seconds before the operation should be retried. + +Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. + +--- + +##### `uid`Optional + +```typescript +public readonly uid: string; +``` + +- *Type:* string + +UID of the resource. + +(when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids + +--- + +### StorageOsPersistentVolumeSource + +Represents a StorageOS persistent volume resource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const storageOsPersistentVolumeSource: k8s.StorageOsPersistentVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| fsType | string | Filesystem type to mount. | +| readOnly | boolean | Defaults to false (read/write). | +| secretRef | @smallcase/cdk8s-botkube.k8s.ObjectReference | SecretRef specifies the secret to use for obtaining the StorageOS API credentials. | +| volumeName | string | VolumeName is the human-readable name of the StorageOS volume. | +| volumeNamespace | string | VolumeNamespace specifies the scope of the volume within StorageOS. | + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type to mount. + +Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +--- + +##### `secretRef`Optional + +```typescript +public readonly secretRef: ObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ObjectReference + +SecretRef specifies the secret to use for obtaining the StorageOS API credentials. + +If not specified, default values will be attempted. + +--- + +##### `volumeName`Optional + +```typescript +public readonly volumeName: string; +``` + +- *Type:* string + +VolumeName is the human-readable name of the StorageOS volume. + +Volume names are only unique within a namespace. + +--- + +##### `volumeNamespace`Optional + +```typescript +public readonly volumeNamespace: string; +``` + +- *Type:* string + +VolumeNamespace specifies the scope of the volume within StorageOS. + +If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. + +--- + +### StorageOsVolumeSource + +Represents a StorageOS persistent volume resource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const storageOsVolumeSource: k8s.StorageOsVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| fsType | string | Filesystem type to mount. | +| readOnly | boolean | Defaults to false (read/write). | +| secretRef | @smallcase/cdk8s-botkube.k8s.LocalObjectReference | SecretRef specifies the secret to use for obtaining the StorageOS API credentials. | +| volumeName | string | VolumeName is the human-readable name of the StorageOS volume. | +| volumeNamespace | string | VolumeNamespace specifies the scope of the volume within StorageOS. | + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type to mount. + +Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + +Defaults to false (read/write). + +ReadOnly here will force the ReadOnly setting in VolumeMounts. + +--- + +##### `secretRef`Optional + +```typescript +public readonly secretRef: LocalObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LocalObjectReference + +SecretRef specifies the secret to use for obtaining the StorageOS API credentials. + +If not specified, default values will be attempted. + +--- + +##### `volumeName`Optional + +```typescript +public readonly volumeName: string; +``` + +- *Type:* string + +VolumeName is the human-readable name of the StorageOS volume. + +Volume names are only unique within a namespace. + +--- + +##### `volumeNamespace`Optional + +```typescript +public readonly volumeNamespace: string; +``` + +- *Type:* string + +VolumeNamespace specifies the scope of the volume within StorageOS. + +If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. + +--- + +### Subject + +Subject contains a reference to the object or user identities a role binding applies to. + +This can either hold a direct API object reference, or a value for non-objects such as user and group names. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const subject: k8s.Subject = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| kind | string | Kind of object being referenced. | +| name | string | Name of the object being referenced. | +| apiGroup | string | APIGroup holds the API group of the referenced subject. | +| namespace | string | Namespace of the referenced object. | + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind of object being referenced. + +Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the object being referenced. + +--- + +##### `apiGroup`Optional + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string +- *Default:* for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. + +APIGroup holds the API group of the referenced subject. + +Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. + +--- + +##### `namespace`Optional + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +Namespace of the referenced object. + +If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. + +--- + +### SubjectAccessReviewSpec + +SubjectAccessReviewSpec is a description of the access request. + +Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const subjectAccessReviewSpec: k8s.SubjectAccessReviewSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| extra | {[ key: string ]: string[]} | Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. | +| groups | string[] | Groups is the groups you're testing for. | +| nonResourceAttributes | @smallcase/cdk8s-botkube.k8s.NonResourceAttributes | NonResourceAttributes describes information for a non-resource access request. | +| resourceAttributes | @smallcase/cdk8s-botkube.k8s.ResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request. | +| uid | string | UID information about the requesting user. | +| user | string | User is the user you're testing for. | + +--- + +##### `extra`Optional + +```typescript +public readonly extra: {[ key: string ]: string[]}; +``` + +- *Type:* {[ key: string ]: string[]} + +Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. + +--- + +##### `groups`Optional + +```typescript +public readonly groups: string[]; +``` + +- *Type:* string[] + +Groups is the groups you're testing for. + +--- + +##### `nonResourceAttributes`Optional + +```typescript +public readonly nonResourceAttributes: NonResourceAttributes; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NonResourceAttributes + +NonResourceAttributes describes information for a non-resource access request. + +--- + +##### `resourceAttributes`Optional + +```typescript +public readonly resourceAttributes: ResourceAttributes; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ResourceAttributes + +ResourceAuthorizationAttributes describes information for a resource access request. + +--- + +##### `uid`Optional + +```typescript +public readonly uid: string; +``` + +- *Type:* string + +UID information about the requesting user. + +--- + +##### `user`Optional + +```typescript +public readonly user: string; +``` + +- *Type:* string + +User is the user you're testing for. + +If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups + +--- + +### SubjectAccessReviewSpecV1Beta1 + +SubjectAccessReviewSpec is a description of the access request. + +Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const subjectAccessReviewSpecV1Beta1: k8s.SubjectAccessReviewSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| extra | {[ key: string ]: string[]} | Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. | +| group | string[] | Groups is the groups you're testing for. | +| nonResourceAttributes | @smallcase/cdk8s-botkube.k8s.NonResourceAttributesV1Beta1 | NonResourceAttributes describes information for a non-resource access request. | +| resourceAttributes | @smallcase/cdk8s-botkube.k8s.ResourceAttributesV1Beta1 | ResourceAuthorizationAttributes describes information for a resource access request. | +| uid | string | UID information about the requesting user. | +| user | string | User is the user you're testing for. | + +--- + +##### `extra`Optional + +```typescript +public readonly extra: {[ key: string ]: string[]}; +``` + +- *Type:* {[ key: string ]: string[]} + +Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. + +--- + +##### `group`Optional + +```typescript +public readonly group: string[]; +``` + +- *Type:* string[] + +Groups is the groups you're testing for. + +--- + +##### `nonResourceAttributes`Optional + +```typescript +public readonly nonResourceAttributes: NonResourceAttributesV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NonResourceAttributesV1Beta1 + +NonResourceAttributes describes information for a non-resource access request. + +--- + +##### `resourceAttributes`Optional + +```typescript +public readonly resourceAttributes: ResourceAttributesV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ResourceAttributesV1Beta1 + +ResourceAuthorizationAttributes describes information for a resource access request. + +--- + +##### `uid`Optional + +```typescript +public readonly uid: string; +``` + +- *Type:* string + +UID information about the requesting user. + +--- + +##### `user`Optional + +```typescript +public readonly user: string; +``` + +- *Type:* string + +User is the user you're testing for. + +If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups + +--- + +### SubjectV1Alpha1 + +Subject contains a reference to the object or user identities a role binding applies to. + +This can either hold a direct API object reference, or a value for non-objects such as user and group names. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const subjectV1Alpha1: k8s.SubjectV1Alpha1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| kind | string | Kind of object being referenced. | +| name | string | Name of the object being referenced. | +| apiVersion | string | APIVersion holds the API group and version of the referenced subject. | +| namespace | string | Namespace of the referenced object. | + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind of object being referenced. + +Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the object being referenced. + +--- + +##### `apiVersion`Optional + +```typescript +public readonly apiVersion: string; +``` + +- *Type:* string +- *Default:* v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects. + +APIVersion holds the API group and version of the referenced subject. + +Defaults to "v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects. + +--- + +##### `namespace`Optional + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +Namespace of the referenced object. + +If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. + +--- + +### SubjectV1Beta1 + +Subject contains a reference to the object or user identities a role binding applies to. + +This can either hold a direct API object reference, or a value for non-objects such as user and group names. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const subjectV1Beta1: k8s.SubjectV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| kind | string | Kind of object being referenced. | +| name | string | Name of the object being referenced. | +| apiGroup | string | APIGroup holds the API group of the referenced subject. | +| namespace | string | Namespace of the referenced object. | + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind of object being referenced. + +Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of the object being referenced. + +--- + +##### `apiGroup`Optional + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string +- *Default:* for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. + +APIGroup holds the API group of the referenced subject. + +Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. + +--- + +##### `namespace`Optional + +```typescript +public readonly namespace: string; +``` + +- *Type:* string + +Namespace of the referenced object. + +If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. + +--- + +### SupplementalGroupsStrategyOptionsV1Beta1 + +SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const supplementalGroupsStrategyOptionsV1Beta1: k8s.SupplementalGroupsStrategyOptionsV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| ranges | @smallcase/cdk8s-botkube.k8s.IdRangeV1Beta1[] | ranges are the allowed ranges of supplemental groups. | +| rule | string | rule is the strategy that will dictate what supplemental groups is used in the SecurityContext. | + +--- + +##### `ranges`Optional + +```typescript +public readonly ranges: IdRangeV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IdRangeV1Beta1[] + +ranges are the allowed ranges of supplemental groups. + +If you would like to force a single supplemental group then supply a single range with the same start and end. Required for MustRunAs. + +--- + +##### `rule`Optional + +```typescript +public readonly rule: string; +``` + +- *Type:* string + +rule is the strategy that will dictate what supplemental groups is used in the SecurityContext. + +--- + +### Sysctl + +Sysctl defines a kernel parameter to be set. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const sysctl: k8s.Sysctl = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | Name of a property to set. | +| value | string | Value of a property to set. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name of a property to set. + +--- + +##### `value`Required + +```typescript +public readonly value: string; +``` + +- *Type:* string + +Value of a property to set. + +--- + +### Taint + +The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const taint: k8s.Taint = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| effect | string | Required. | +| key | string | Required. | +| timeAdded | Date | TimeAdded represents the time at which the taint was added. | +| value | string | The taint value corresponding to the taint key. | + +--- + +##### `effect`Required + +```typescript +public readonly effect: string; +``` + +- *Type:* string + +Required. + +The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. + +--- + +##### `key`Required + +```typescript +public readonly key: string; +``` + +- *Type:* string + +Required. + +The taint key to be applied to a node. + +--- + +##### `timeAdded`Optional + +```typescript +public readonly timeAdded: Date; +``` + +- *Type:* Date + +TimeAdded represents the time at which the taint was added. + +It is only written for NoExecute taints. + +--- + +##### `value`Optional + +```typescript +public readonly value: string; +``` + +- *Type:* string + +The taint value corresponding to the taint key. + +--- + +### TcpSocketAction + +TCPSocketAction describes an action based on opening a socket. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const tcpSocketAction: k8s.TcpSocketAction = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| port | @smallcase/cdk8s-botkube.k8s.IntOrString | Number or name of the port to access on the container. | +| host | string | Optional: Host name to connect to, defaults to the pod IP. | + +--- + +##### `port`Required + +```typescript +public readonly port: IntOrString; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IntOrString + +Number or name of the port to access on the container. + +Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + +--- + +##### `host`Optional + +```typescript +public readonly host: string; +``` + +- *Type:* string + +Optional: Host name to connect to, defaults to the pod IP. + +--- + +### TokenRequest + +TokenRequest contains parameters of a service account token. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const tokenRequest: k8s.TokenRequest = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| audience | string | Audience is the intended audience of the token in "TokenRequestSpec". | +| expirationSeconds | number | ExpirationSeconds is the duration of validity of the token in "TokenRequestSpec". | + +--- + +##### `audience`Required + +```typescript +public readonly audience: string; +``` + +- *Type:* string + +Audience is the intended audience of the token in "TokenRequestSpec". + +It will default to the audiences of kube apiserver. + +--- + +##### `expirationSeconds`Optional + +```typescript +public readonly expirationSeconds: number; +``` + +- *Type:* number + +ExpirationSeconds is the duration of validity of the token in "TokenRequestSpec". + +It has the same default value of "ExpirationSeconds" in "TokenRequestSpec". + +--- + +### TokenRequestSpec + +TokenRequestSpec contains client provided parameters of a token request. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const tokenRequestSpec: k8s.TokenRequestSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| audiences | string[] | Audiences are the intendend audiences of the token. | +| boundObjectRef | @smallcase/cdk8s-botkube.k8s.BoundObjectReference | BoundObjectRef is a reference to an object that the token will be bound to. | +| expirationSeconds | number | ExpirationSeconds is the requested duration of validity of the request. | + +--- + +##### `audiences`Required + +```typescript +public readonly audiences: string[]; +``` + +- *Type:* string[] + +Audiences are the intendend audiences of the token. + +A recipient of a token must identitfy themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences. + +--- + +##### `boundObjectRef`Optional + +```typescript +public readonly boundObjectRef: BoundObjectReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.BoundObjectReference + +BoundObjectRef is a reference to an object that the token will be bound to. + +The token will only be valid for as long as the bound object exists. NOTE: The API server's TokenReview endpoint will validate the BoundObjectRef, but other audiences may not. Keep ExpirationSeconds small if you want prompt revocation. + +--- + +##### `expirationSeconds`Optional + +```typescript +public readonly expirationSeconds: number; +``` + +- *Type:* number + +ExpirationSeconds is the requested duration of validity of the request. + +The token issuer may return a token with a different validity duration so a client needs to check the 'expiration' field in a response. + +--- + +### TokenRequestV1Beta1 + +TokenRequest contains parameters of a service account token. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const tokenRequestV1Beta1: k8s.TokenRequestV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| audience | string | Audience is the intended audience of the token in "TokenRequestSpec". | +| expirationSeconds | number | ExpirationSeconds is the duration of validity of the token in "TokenRequestSpec". | + +--- + +##### `audience`Required + +```typescript +public readonly audience: string; +``` + +- *Type:* string + +Audience is the intended audience of the token in "TokenRequestSpec". + +It will default to the audiences of kube apiserver. + +--- + +##### `expirationSeconds`Optional + +```typescript +public readonly expirationSeconds: number; +``` + +- *Type:* number + +ExpirationSeconds is the duration of validity of the token in "TokenRequestSpec". + +It has the same default value of "ExpirationSeconds" in "TokenRequestSpec" + +--- + +### TokenReviewSpec + +TokenReviewSpec is a description of the token authentication request. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const tokenReviewSpec: k8s.TokenReviewSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| audiences | string[] | Audiences is a list of the identifiers that the resource server presented with the token identifies as. | +| token | string | Token is the opaque bearer token. | + +--- + +##### `audiences`Optional + +```typescript +public readonly audiences: string[]; +``` + +- *Type:* string[] + +Audiences is a list of the identifiers that the resource server presented with the token identifies as. + +Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver. + +--- + +##### `token`Optional + +```typescript +public readonly token: string; +``` + +- *Type:* string + +Token is the opaque bearer token. + +--- + +### TokenReviewSpecV1Beta1 + +TokenReviewSpec is a description of the token authentication request. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const tokenReviewSpecV1Beta1: k8s.TokenReviewSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| audiences | string[] | Audiences is a list of the identifiers that the resource server presented with the token identifies as. | +| token | string | Token is the opaque bearer token. | + +--- + +##### `audiences`Optional + +```typescript +public readonly audiences: string[]; +``` + +- *Type:* string[] + +Audiences is a list of the identifiers that the resource server presented with the token identifies as. + +Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver. + +--- + +##### `token`Optional + +```typescript +public readonly token: string; +``` + +- *Type:* string + +Token is the opaque bearer token. + +--- + +### Toleration + +The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const toleration: k8s.Toleration = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| effect | string | Effect indicates the taint effect to match. | +| key | string | Key is the taint key that the toleration applies to. | +| operator | string | Operator represents a key's relationship to the value. | +| tolerationSeconds | number | TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. | +| value | string | Value is the taint value the toleration matches to. | + +--- + +##### `effect`Optional + +```typescript +public readonly effect: string; +``` + +- *Type:* string + +Effect indicates the taint effect to match. + +Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. + +--- + +##### `key`Optional + +```typescript +public readonly key: string; +``` + +- *Type:* string + +Key is the taint key that the toleration applies to. + +Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. + +--- + +##### `operator`Optional + +```typescript +public readonly operator: string; +``` + +- *Type:* string +- *Default:* Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. + +Operator represents a key's relationship to the value. + +Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. + +--- + +##### `tolerationSeconds`Optional + +```typescript +public readonly tolerationSeconds: number; +``` + +- *Type:* number + +TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. + +By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. + +--- + +##### `value`Optional + +```typescript +public readonly value: string; +``` + +- *Type:* string + +Value is the taint value the toleration matches to. + +If the operator is Exists, the value should be empty, otherwise just a regular string. + +--- + +### TopologySelectorLabelRequirement + +A topology selector requirement is a selector that matches given label. + +This is an alpha feature and may change in the future. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const topologySelectorLabelRequirement: k8s.TopologySelectorLabelRequirement = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| key | string | The label key that the selector applies to. | +| values | string[] | An array of string values. | + +--- + +##### `key`Required + +```typescript +public readonly key: string; +``` + +- *Type:* string + +The label key that the selector applies to. + +--- + +##### `values`Required + +```typescript +public readonly values: string[]; +``` + +- *Type:* string[] + +An array of string values. + +One value must match the label to be selected. Each entry in Values is ORed. + +--- + +### TopologySelectorTerm + +A topology selector term represents the result of label queries. + +A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const topologySelectorTerm: k8s.TopologySelectorTerm = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| matchLabelExpressions | @smallcase/cdk8s-botkube.k8s.TopologySelectorLabelRequirement[] | A list of topology selector requirements by labels. | + +--- + +##### `matchLabelExpressions`Optional + +```typescript +public readonly matchLabelExpressions: TopologySelectorLabelRequirement[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.TopologySelectorLabelRequirement[] + +A list of topology selector requirements by labels. + +--- + +### TopologySpreadConstraint + +TopologySpreadConstraint specifies how to spread matching pods among the given topology. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const topologySpreadConstraint: k8s.TopologySpreadConstraint = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| maxSkew | number | MaxSkew describes the degree to which pods may be unevenly distributed. | +| topologyKey | string | TopologyKey is the key of node labels. | +| whenUnsatisfiable | string | WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. | +| labelSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | LabelSelector is used to find matching pods. | + +--- + +##### `maxSkew`Required + +```typescript +public readonly maxSkew: number; +``` + +- *Type:* number + +MaxSkew describes the degree to which pods may be unevenly distributed. + +When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. + +--- + +##### `topologyKey`Required + +```typescript +public readonly topologyKey: string; +``` + +- *Type:* string + +TopologyKey is the key of node labels. + +Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. It's a required field. + +--- + +##### `whenUnsatisfiable`Required + +```typescript +public readonly whenUnsatisfiable: string; +``` + +- *Type:* string + +WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. + +DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, +but giving higher precedence to topologies that would help reduce the +skew. +A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. + +--- + +##### `labelSelector`Optional + +```typescript +public readonly labelSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector + +LabelSelector is used to find matching pods. + +Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. + +--- + +### TypedLocalObjectReference + +TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const typedLocalObjectReference: k8s.TypedLocalObjectReference = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| kind | string | Kind is the type of resource being referenced. | +| name | string | Name is the name of resource being referenced. | +| apiGroup | string | APIGroup is the group for the resource being referenced. | + +--- + +##### `kind`Required + +```typescript +public readonly kind: string; +``` + +- *Type:* string + +Kind is the type of resource being referenced. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Name is the name of resource being referenced. + +--- + +##### `apiGroup`Optional + +```typescript +public readonly apiGroup: string; +``` + +- *Type:* string + +APIGroup is the group for the resource being referenced. + +If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + +--- + +### ValidatingWebhook + +ValidatingWebhook describes an admission webhook and the resources and operations it applies to. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const validatingWebhook: k8s.ValidatingWebhook = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| admissionReviewVersions | string[] | AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. | +| clientConfig | @smallcase/cdk8s-botkube.k8s.WebhookClientConfig | ClientConfig defines how to communicate with the hook. | +| name | string | The name of the admission webhook. | +| sideEffects | string | SideEffects states whether this webhook has side effects. | +| failurePolicy | string | FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. | +| matchPolicy | string | matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". | +| namespaceSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. | +| objectSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | ObjectSelector decides whether to run the webhook based on if the object has matching labels. | +| rules | @smallcase/cdk8s-botkube.k8s.RuleWithOperations[] | Rules describes what operations on what resources/subresources the webhook cares about. | +| timeoutSeconds | number | TimeoutSeconds specifies the timeout for this webhook. | + +--- + +##### `admissionReviewVersions`Required + +```typescript +public readonly admissionReviewVersions: string[]; +``` + +- *Type:* string[] + +AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. + +API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. + +--- + +##### `clientConfig`Required + +```typescript +public readonly clientConfig: WebhookClientConfig; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.WebhookClientConfig + +ClientConfig defines how to communicate with the hook. + +Required + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the admission webhook. + +Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. + +--- + +##### `sideEffects`Required + +```typescript +public readonly sideEffects: string; +``` + +- *Type:* string + +SideEffects states whether this webhook has side effects. + +Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. + +--- + +##### `failurePolicy`Optional + +```typescript +public readonly failurePolicy: string; +``` + +- *Type:* string +- *Default:* Fail. + +FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. + +Defaults to Fail. + +--- + +##### `matchPolicy`Optional + +```typescript +public readonly matchPolicy: string; +``` + +- *Type:* string +- *Default:* Equivalent" + +matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". + +Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. + +- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. + +Defaults to "Equivalent" + +--- + +##### `namespaceSelector`Optional + +```typescript +public readonly namespaceSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector +- *Default:* the empty LabelSelector, which matches everything. + +NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. + +If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. + +For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { +"matchExpressions": [ +{ +"key": "runlevel", +"operator": "NotIn", +"values": [ +"0", +"1" +] +} +] +} + +If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { +"matchExpressions": [ +{ +"key": "environment", +"operator": "In", +"values": [ +"prod", +"staging" +] +} +] +} + +See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels for more examples of label selectors. + +Default to the empty LabelSelector, which matches everything. + +--- + +##### `objectSelector`Optional + +```typescript +public readonly objectSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector +- *Default:* the empty LabelSelector, which matches everything. + +ObjectSelector decides whether to run the webhook based on if the object has matching labels. + +objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. + +--- + +##### `rules`Optional + +```typescript +public readonly rules: RuleWithOperations[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RuleWithOperations[] + +Rules describes what operations on what resources/subresources the webhook cares about. + +The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + +--- + +##### `timeoutSeconds`Optional + +```typescript +public readonly timeoutSeconds: number; +``` + +- *Type:* number +- *Default:* 10 seconds. + +TimeoutSeconds specifies the timeout for this webhook. + +After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds. + +--- + +### ValidatingWebhookV1Beta1 + +ValidatingWebhook describes an admission webhook and the resources and operations it applies to. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const validatingWebhookV1Beta1: k8s.ValidatingWebhookV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| clientConfig | @smallcase/cdk8s-botkube.k8s.WebhookClientConfigV1Beta1 | ClientConfig defines how to communicate with the hook. | +| name | string | The name of the admission webhook. | +| admissionReviewVersions | string[] | AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. | +| failurePolicy | string | FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. | +| matchPolicy | string | matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". | +| namespaceSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. | +| objectSelector | @smallcase/cdk8s-botkube.k8s.LabelSelector | ObjectSelector decides whether to run the webhook based on if the object has matching labels. | +| rules | @smallcase/cdk8s-botkube.k8s.RuleWithOperationsV1Beta1[] | Rules describes what operations on what resources/subresources the webhook cares about. | +| sideEffects | string | SideEffects states whether this webhook has side effects. | +| timeoutSeconds | number | TimeoutSeconds specifies the timeout for this webhook. | + +--- + +##### `clientConfig`Required + +```typescript +public readonly clientConfig: WebhookClientConfigV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.WebhookClientConfigV1Beta1 + +ClientConfig defines how to communicate with the hook. + +Required + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +The name of the admission webhook. + +Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. + +--- + +##### `admissionReviewVersions`Optional + +```typescript +public readonly admissionReviewVersions: string[]; +``` + +- *Type:* string[] +- *Default:* v1beta1']`. + +AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. + +API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. Default to `['v1beta1']`. + +--- + +##### `failurePolicy`Optional + +```typescript +public readonly failurePolicy: string; +``` + +- *Type:* string +- *Default:* Ignore. + +FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. + +Defaults to Ignore. + +--- + +##### `matchPolicy`Optional + +```typescript +public readonly matchPolicy: string; +``` + +- *Type:* string +- *Default:* Exact" + +matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". + +Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. + +- Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. + +Defaults to "Exact" + +--- + +##### `namespaceSelector`Optional + +```typescript +public readonly namespaceSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector +- *Default:* the empty LabelSelector, which matches everything. + +NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. + +If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. + +For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { +"matchExpressions": [ +{ +"key": "runlevel", +"operator": "NotIn", +"values": [ +"0", +"1" +] +} +] +} + +If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { +"matchExpressions": [ +{ +"key": "environment", +"operator": "In", +"values": [ +"prod", +"staging" +] +} +] +} + +See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels for more examples of label selectors. + +Default to the empty LabelSelector, which matches everything. + +--- + +##### `objectSelector`Optional + +```typescript +public readonly objectSelector: LabelSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.LabelSelector +- *Default:* the empty LabelSelector, which matches everything. + +ObjectSelector decides whether to run the webhook based on if the object has matching labels. + +objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. + +--- + +##### `rules`Optional + +```typescript +public readonly rules: RuleWithOperationsV1Beta1[]; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RuleWithOperationsV1Beta1[] + +Rules describes what operations on what resources/subresources the webhook cares about. + +The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + +--- + +##### `sideEffects`Optional + +```typescript +public readonly sideEffects: string; +``` + +- *Type:* string +- *Default:* Unknown. + +SideEffects states whether this webhook has side effects. + +Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. Defaults to Unknown. + +--- + +##### `timeoutSeconds`Optional + +```typescript +public readonly timeoutSeconds: number; +``` + +- *Type:* number +- *Default:* 30 seconds. + +TimeoutSeconds specifies the timeout for this webhook. + +After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 30 seconds. + +--- + +### Volume + +Volume represents a named volume in a pod that may be accessed by any container in the pod. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const volume: k8s.Volume = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| name | string | Volume's name. | +| awsElasticBlockStore | @smallcase/cdk8s-botkube.k8s.AwsElasticBlockStoreVolumeSource | AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. | +| azureDisk | @smallcase/cdk8s-botkube.k8s.AzureDiskVolumeSource | AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. | +| azureFile | @smallcase/cdk8s-botkube.k8s.AzureFileVolumeSource | AzureFile represents an Azure File Service mount on the host and bind mount to the pod. | +| cephfs | @smallcase/cdk8s-botkube.k8s.CephFsVolumeSource | CephFS represents a Ceph FS mount on the host that shares a pod's lifetime. | +| cinder | @smallcase/cdk8s-botkube.k8s.CinderVolumeSource | Cinder represents a cinder volume attached and mounted on kubelets host machine. | +| configMap | @smallcase/cdk8s-botkube.k8s.ConfigMapVolumeSource | ConfigMap represents a configMap that should populate this volume. | +| csi | @smallcase/cdk8s-botkube.k8s.CsiVolumeSource | CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). | +| downwardApi | @smallcase/cdk8s-botkube.k8s.DownwardApiVolumeSource | DownwardAPI represents downward API about the pod that should populate this volume. | +| emptyDir | @smallcase/cdk8s-botkube.k8s.EmptyDirVolumeSource | EmptyDir represents a temporary directory that shares a pod's lifetime. | +| ephemeral | @smallcase/cdk8s-botkube.k8s.EphemeralVolumeSource | Ephemeral represents a volume that is handled by a cluster storage driver. | +| fc | @smallcase/cdk8s-botkube.k8s.FcVolumeSource | FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. | +| flexVolume | @smallcase/cdk8s-botkube.k8s.FlexVolumeSource | FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. | +| flocker | @smallcase/cdk8s-botkube.k8s.FlockerVolumeSource | Flocker represents a Flocker volume attached to a kubelet's host machine. | +| gcePersistentDisk | @smallcase/cdk8s-botkube.k8s.GcePersistentDiskVolumeSource | GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. | +| gitRepo | @smallcase/cdk8s-botkube.k8s.GitRepoVolumeSource | GitRepo represents a git repository at a particular revision. | +| glusterfs | @smallcase/cdk8s-botkube.k8s.GlusterfsVolumeSource | Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. | +| hostPath | @smallcase/cdk8s-botkube.k8s.HostPathVolumeSource | HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. | +| iscsi | @smallcase/cdk8s-botkube.k8s.IscsiVolumeSource | ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. | +| nfs | @smallcase/cdk8s-botkube.k8s.NfsVolumeSource | NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs. | +| persistentVolumeClaim | @smallcase/cdk8s-botkube.k8s.PersistentVolumeClaimVolumeSource | PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. | +| photonPersistentDisk | @smallcase/cdk8s-botkube.k8s.PhotonPersistentDiskVolumeSource | PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. | +| portworxVolume | @smallcase/cdk8s-botkube.k8s.PortworxVolumeSource | PortworxVolume represents a portworx volume attached and mounted on kubelets host machine. | +| projected | @smallcase/cdk8s-botkube.k8s.ProjectedVolumeSource | Items for all in one resources secrets, configmaps, and downward API. | +| quobyte | @smallcase/cdk8s-botkube.k8s.QuobyteVolumeSource | Quobyte represents a Quobyte mount on the host that shares a pod's lifetime. | +| rbd | @smallcase/cdk8s-botkube.k8s.RbdVolumeSource | RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. | +| scaleIo | @smallcase/cdk8s-botkube.k8s.ScaleIoVolumeSource | ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. | +| secret | @smallcase/cdk8s-botkube.k8s.SecretVolumeSource | Secret represents a secret that should populate this volume. | +| storageos | @smallcase/cdk8s-botkube.k8s.StorageOsVolumeSource | StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. | +| vsphereVolume | @smallcase/cdk8s-botkube.k8s.VsphereVirtualDiskVolumeSource | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. | + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +Volume's name. + +Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +--- + +##### `awsElasticBlockStore`Optional + +```typescript +public readonly awsElasticBlockStore: AwsElasticBlockStoreVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.AwsElasticBlockStoreVolumeSource + +AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. + +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + +--- + +##### `azureDisk`Optional + +```typescript +public readonly azureDisk: AzureDiskVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.AzureDiskVolumeSource + +AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + +--- + +##### `azureFile`Optional + +```typescript +public readonly azureFile: AzureFileVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.AzureFileVolumeSource + +AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + +--- + +##### `cephfs`Optional + +```typescript +public readonly cephfs: CephFsVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CephFsVolumeSource + +CephFS represents a Ceph FS mount on the host that shares a pod's lifetime. + +--- + +##### `cinder`Optional + +```typescript +public readonly cinder: CinderVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CinderVolumeSource + +Cinder represents a cinder volume attached and mounted on kubelets host machine. + +More info: https://examples.k8s.io/mysql-cinder-pd/README.md + +--- + +##### `configMap`Optional + +```typescript +public readonly configMap: ConfigMapVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ConfigMapVolumeSource + +ConfigMap represents a configMap that should populate this volume. + +--- + +##### `csi`Optional + +```typescript +public readonly csi: CsiVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.CsiVolumeSource + +CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). + +--- + +##### `downwardApi`Optional + +```typescript +public readonly downwardApi: DownwardApiVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.DownwardApiVolumeSource + +DownwardAPI represents downward API about the pod that should populate this volume. + +--- + +##### `emptyDir`Optional + +```typescript +public readonly emptyDir: EmptyDirVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EmptyDirVolumeSource + +EmptyDir represents a temporary directory that shares a pod's lifetime. + +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + +--- + +##### `ephemeral`Optional + +```typescript +public readonly ephemeral: EphemeralVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.EphemeralVolumeSource + +Ephemeral represents a volume that is handled by a cluster storage driver. + +The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. + +Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity +tracking are needed, +c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through +a PersistentVolumeClaim (see EphemeralVolumeSource for more +information on the connection between this volume type +and PersistentVolumeClaim). + +Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. + +Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. + +A pod can use both types of ephemeral volumes and persistent volumes at the same time. + +This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled. + +--- + +##### `fc`Optional + +```typescript +public readonly fc: FcVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.FcVolumeSource + +FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + +--- + +##### `flexVolume`Optional + +```typescript +public readonly flexVolume: FlexVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.FlexVolumeSource + +FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. + +--- + +##### `flocker`Optional + +```typescript +public readonly flocker: FlockerVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.FlockerVolumeSource + +Flocker represents a Flocker volume attached to a kubelet's host machine. + +This depends on the Flocker control service being running + +--- + +##### `gcePersistentDisk`Optional + +```typescript +public readonly gcePersistentDisk: GcePersistentDiskVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.GcePersistentDiskVolumeSource + +GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. + +More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + +--- + +##### `gitRepo`Optional + +```typescript +public readonly gitRepo: GitRepoVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.GitRepoVolumeSource + +GitRepo represents a git repository at a particular revision. + +DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. + +--- + +##### `glusterfs`Optional + +```typescript +public readonly glusterfs: GlusterfsVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.GlusterfsVolumeSource + +Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. + +More info: https://examples.k8s.io/volumes/glusterfs/README.md + +--- + +##### `hostPath`Optional + +```typescript +public readonly hostPath: HostPathVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.HostPathVolumeSource + +HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. + +This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + +--- + +##### `iscsi`Optional + +```typescript +public readonly iscsi: IscsiVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.IscsiVolumeSource + +ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. + +More info: https://examples.k8s.io/volumes/iscsi/README.md + +--- + +##### `nfs`Optional + +```typescript +public readonly nfs: NfsVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NfsVolumeSource + +NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs. + +--- + +##### `persistentVolumeClaim`Optional + +```typescript +public readonly persistentVolumeClaim: PersistentVolumeClaimVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PersistentVolumeClaimVolumeSource + +PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. + +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + +--- + +##### `photonPersistentDisk`Optional + +```typescript +public readonly photonPersistentDisk: PhotonPersistentDiskVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PhotonPersistentDiskVolumeSource + +PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. + +--- + +##### `portworxVolume`Optional + +```typescript +public readonly portworxVolume: PortworxVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PortworxVolumeSource + +PortworxVolume represents a portworx volume attached and mounted on kubelets host machine. + +--- + +##### `projected`Optional + +```typescript +public readonly projected: ProjectedVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ProjectedVolumeSource + +Items for all in one resources secrets, configmaps, and downward API. + +--- + +##### `quobyte`Optional + +```typescript +public readonly quobyte: QuobyteVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.QuobyteVolumeSource + +Quobyte represents a Quobyte mount on the host that shares a pod's lifetime. + +--- + +##### `rbd`Optional + +```typescript +public readonly rbd: RbdVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.RbdVolumeSource + +RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. + +More info: https://examples.k8s.io/volumes/rbd/README.md + +--- + +##### `scaleIo`Optional + +```typescript +public readonly scaleIo: ScaleIoVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ScaleIoVolumeSource + +ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + +--- + +##### `secret`Optional + +```typescript +public readonly secret: SecretVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecretVolumeSource + +Secret represents a secret that should populate this volume. + +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + +--- + +##### `storageos`Optional + +```typescript +public readonly storageos: StorageOsVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.StorageOsVolumeSource + +StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. + +--- + +##### `vsphereVolume`Optional + +```typescript +public readonly vsphereVolume: VsphereVirtualDiskVolumeSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VsphereVirtualDiskVolumeSource + +VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. + +--- + +### VolumeAttachmentSource + +VolumeAttachmentSource represents a volume that should be attached. + +Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const volumeAttachmentSource: k8s.VolumeAttachmentSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| inlineVolumeSpec | @smallcase/cdk8s-botkube.k8s.PersistentVolumeSpec | inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. | +| persistentVolumeName | string | Name of the persistent volume to attach. | + +--- + +##### `inlineVolumeSpec`Optional + +```typescript +public readonly inlineVolumeSpec: PersistentVolumeSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PersistentVolumeSpec + +inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. + +This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature. + +--- + +##### `persistentVolumeName`Optional + +```typescript +public readonly persistentVolumeName: string; +``` + +- *Type:* string + +Name of the persistent volume to attach. + +--- + +### VolumeAttachmentSourceV1Alpha1 + +VolumeAttachmentSource represents a volume that should be attached. + +Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const volumeAttachmentSourceV1Alpha1: k8s.VolumeAttachmentSourceV1Alpha1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| inlineVolumeSpec | @smallcase/cdk8s-botkube.k8s.PersistentVolumeSpec | inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. | +| persistentVolumeName | string | Name of the persistent volume to attach. | + +--- + +##### `inlineVolumeSpec`Optional + +```typescript +public readonly inlineVolumeSpec: PersistentVolumeSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PersistentVolumeSpec + +inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. + +This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is alpha-level and is only honored by servers that enabled the CSIMigration feature. + +--- + +##### `persistentVolumeName`Optional + +```typescript +public readonly persistentVolumeName: string; +``` + +- *Type:* string + +Name of the persistent volume to attach. + +--- + +### VolumeAttachmentSourceV1Beta1 + +VolumeAttachmentSource represents a volume that should be attached. + +Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const volumeAttachmentSourceV1Beta1: k8s.VolumeAttachmentSourceV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| inlineVolumeSpec | @smallcase/cdk8s-botkube.k8s.PersistentVolumeSpec | inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. | +| persistentVolumeName | string | Name of the persistent volume to attach. | + +--- + +##### `inlineVolumeSpec`Optional + +```typescript +public readonly inlineVolumeSpec: PersistentVolumeSpec; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PersistentVolumeSpec + +inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. + +This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature. + +--- + +##### `persistentVolumeName`Optional + +```typescript +public readonly persistentVolumeName: string; +``` + +- *Type:* string + +Name of the persistent volume to attach. + +--- + +### VolumeAttachmentSpec + +VolumeAttachmentSpec is the specification of a VolumeAttachment request. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const volumeAttachmentSpec: k8s.VolumeAttachmentSpec = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attacher | string | Attacher indicates the name of the volume driver that MUST handle this request. | +| nodeName | string | The node that the volume should be attached to. | +| source | @smallcase/cdk8s-botkube.k8s.VolumeAttachmentSource | Source represents the volume that should be attached. | + +--- + +##### `attacher`Required + +```typescript +public readonly attacher: string; +``` + +- *Type:* string + +Attacher indicates the name of the volume driver that MUST handle this request. + +This is the name returned by GetPluginName(). + +--- + +##### `nodeName`Required + +```typescript +public readonly nodeName: string; +``` + +- *Type:* string + +The node that the volume should be attached to. + +--- + +##### `source`Required + +```typescript +public readonly source: VolumeAttachmentSource; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VolumeAttachmentSource + +Source represents the volume that should be attached. + +--- + +### VolumeAttachmentSpecV1Alpha1 + +VolumeAttachmentSpec is the specification of a VolumeAttachment request. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const volumeAttachmentSpecV1Alpha1: k8s.VolumeAttachmentSpecV1Alpha1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attacher | string | Attacher indicates the name of the volume driver that MUST handle this request. | +| nodeName | string | The node that the volume should be attached to. | +| source | @smallcase/cdk8s-botkube.k8s.VolumeAttachmentSourceV1Alpha1 | Source represents the volume that should be attached. | + +--- + +##### `attacher`Required + +```typescript +public readonly attacher: string; +``` + +- *Type:* string + +Attacher indicates the name of the volume driver that MUST handle this request. + +This is the name returned by GetPluginName(). + +--- + +##### `nodeName`Required + +```typescript +public readonly nodeName: string; +``` + +- *Type:* string + +The node that the volume should be attached to. + +--- + +##### `source`Required + +```typescript +public readonly source: VolumeAttachmentSourceV1Alpha1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VolumeAttachmentSourceV1Alpha1 + +Source represents the volume that should be attached. + +--- + +### VolumeAttachmentSpecV1Beta1 + +VolumeAttachmentSpec is the specification of a VolumeAttachment request. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const volumeAttachmentSpecV1Beta1: k8s.VolumeAttachmentSpecV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| attacher | string | Attacher indicates the name of the volume driver that MUST handle this request. | +| nodeName | string | The node that the volume should be attached to. | +| source | @smallcase/cdk8s-botkube.k8s.VolumeAttachmentSourceV1Beta1 | Source represents the volume that should be attached. | + +--- + +##### `attacher`Required + +```typescript +public readonly attacher: string; +``` + +- *Type:* string + +Attacher indicates the name of the volume driver that MUST handle this request. + +This is the name returned by GetPluginName(). + +--- + +##### `nodeName`Required + +```typescript +public readonly nodeName: string; +``` + +- *Type:* string + +The node that the volume should be attached to. + +--- + +##### `source`Required + +```typescript +public readonly source: VolumeAttachmentSourceV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.VolumeAttachmentSourceV1Beta1 + +Source represents the volume that should be attached. + +--- + +### VolumeDevice + +volumeDevice describes a mapping of a raw block device within a container. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const volumeDevice: k8s.VolumeDevice = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| devicePath | string | devicePath is the path inside of the container that the device will be mapped to. | +| name | string | name must match the name of a persistentVolumeClaim in the pod. | + +--- + +##### `devicePath`Required + +```typescript +public readonly devicePath: string; +``` + +- *Type:* string + +devicePath is the path inside of the container that the device will be mapped to. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +name must match the name of a persistentVolumeClaim in the pod. + +--- + +### VolumeMount + +VolumeMount describes a mounting of a Volume within a container. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const volumeMount: k8s.VolumeMount = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| mountPath | string | Path within the container at which the volume should be mounted. | +| name | string | This must match the Name of a Volume. | +| mountPropagation | string | mountPropagation determines how mounts are propagated from the host to container and the other way around. | +| readOnly | boolean | Mounted read-only if true, read-write otherwise (false or unspecified). | +| subPath | string | Path within the volume from which the container's volume should be mounted. | +| subPathExpr | string | Expanded path within the volume from which the container's volume should be mounted. | + +--- + +##### `mountPath`Required + +```typescript +public readonly mountPath: string; +``` + +- *Type:* string + +Path within the container at which the volume should be mounted. + +Must not contain ':'. + +--- + +##### `name`Required + +```typescript +public readonly name: string; +``` + +- *Type:* string + +This must match the Name of a Volume. + +--- + +##### `mountPropagation`Optional + +```typescript +public readonly mountPropagation: string; +``` + +- *Type:* string + +mountPropagation determines how mounts are propagated from the host to container and the other way around. + +When not set, MountPropagationNone is used. This field is beta in 1.10. + +--- + +##### `readOnly`Optional + +```typescript +public readonly readOnly: boolean; +``` + +- *Type:* boolean +- *Default:* false. + +Mounted read-only if true, read-write otherwise (false or unspecified). + +Defaults to false. + +--- + +##### `subPath`Optional + +```typescript +public readonly subPath: string; +``` + +- *Type:* string +- *Default:* volume's root). + +Path within the volume from which the container's volume should be mounted. + +Defaults to "" (volume's root). + +--- + +##### `subPathExpr`Optional + +```typescript +public readonly subPathExpr: string; +``` + +- *Type:* string +- *Default:* volume's root). SubPathExpr and SubPath are mutually exclusive. + +Expanded path within the volume from which the container's volume should be mounted. + +Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. + +--- + +### VolumeNodeAffinity + +VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const volumeNodeAffinity: k8s.VolumeNodeAffinity = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| required | @smallcase/cdk8s-botkube.k8s.NodeSelector | Required specifies hard node constraints that must be met. | + +--- + +##### `required`Optional + +```typescript +public readonly required: NodeSelector; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.NodeSelector + +Required specifies hard node constraints that must be met. + +--- + +### VolumeNodeResources + +VolumeNodeResources is a set of resource limits for scheduling of volumes. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const volumeNodeResources: k8s.VolumeNodeResources = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| count | number | Maximum number of unique volumes managed by the CSI driver that can be used on a node. | + +--- + +##### `count`Optional + +```typescript +public readonly count: number; +``` + +- *Type:* number + +Maximum number of unique volumes managed by the CSI driver that can be used on a node. + +A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded. + +--- + +### VolumeNodeResourcesV1Beta1 + +VolumeNodeResources is a set of resource limits for scheduling of volumes. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const volumeNodeResourcesV1Beta1: k8s.VolumeNodeResourcesV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| count | number | Maximum number of unique volumes managed by the CSI driver that can be used on a node. | + +--- + +##### `count`Optional + +```typescript +public readonly count: number; +``` + +- *Type:* number + +Maximum number of unique volumes managed by the CSI driver that can be used on a node. + +A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is nil, then the supported number of volumes on this node is unbounded. + +--- + +### VolumeProjection + +Projection that may be projected along with other supported volume types. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const volumeProjection: k8s.VolumeProjection = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| configMap | @smallcase/cdk8s-botkube.k8s.ConfigMapProjection | information about the configMap data to project. | +| downwardApi | @smallcase/cdk8s-botkube.k8s.DownwardApiProjection | information about the downwardAPI data to project. | +| secret | @smallcase/cdk8s-botkube.k8s.SecretProjection | information about the secret data to project. | +| serviceAccountToken | @smallcase/cdk8s-botkube.k8s.ServiceAccountTokenProjection | information about the serviceAccountToken data to project. | + +--- + +##### `configMap`Optional + +```typescript +public readonly configMap: ConfigMapProjection; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ConfigMapProjection + +information about the configMap data to project. + +--- + +##### `downwardApi`Optional + +```typescript +public readonly downwardApi: DownwardApiProjection; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.DownwardApiProjection + +information about the downwardAPI data to project. + +--- + +##### `secret`Optional + +```typescript +public readonly secret: SecretProjection; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.SecretProjection + +information about the secret data to project. + +--- + +##### `serviceAccountToken`Optional + +```typescript +public readonly serviceAccountToken: ServiceAccountTokenProjection; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ServiceAccountTokenProjection + +information about the serviceAccountToken data to project. + +--- + +### VsphereVirtualDiskVolumeSource + +Represents a vSphere volume resource. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const vsphereVirtualDiskVolumeSource: k8s.VsphereVirtualDiskVolumeSource = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| volumePath | string | Path that identifies vSphere volume vmdk. | +| fsType | string | Filesystem type to mount. | +| storagePolicyId | string | Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. | +| storagePolicyName | string | Storage Policy Based Management (SPBM) profile name. | + +--- + +##### `volumePath`Required + +```typescript +public readonly volumePath: string; +``` + +- *Type:* string + +Path that identifies vSphere volume vmdk. + +--- + +##### `fsType`Optional + +```typescript +public readonly fsType: string; +``` + +- *Type:* string + +Filesystem type to mount. + +Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + +--- + +##### `storagePolicyId`Optional + +```typescript +public readonly storagePolicyId: string; +``` + +- *Type:* string + +Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. + +--- + +##### `storagePolicyName`Optional + +```typescript +public readonly storagePolicyName: string; +``` + +- *Type:* string + +Storage Policy Based Management (SPBM) profile name. + +--- + +### WebhookClientConfig + +WebhookClientConfig contains the information to make a TLS connection with the webhook. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const webhookClientConfig: k8s.WebhookClientConfig = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| caBundle | string | `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. | +| service | @smallcase/cdk8s-botkube.k8s.ServiceReference | `service` is a reference to the service for this webhook. Either `service` or `url` must be specified. | +| url | string | `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). | + +--- + +##### `caBundle`Optional + +```typescript +public readonly caBundle: string; +``` + +- *Type:* string + +`caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. + +If unspecified, system trust roots on the apiserver are used. + +--- + +##### `service`Optional + +```typescript +public readonly service: ServiceReference; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ServiceReference + +`service` is a reference to the service for this webhook. Either `service` or `url` must be specified. + +If the webhook is running within the cluster, then you should use `service`. + +--- + +##### `url`Optional + +```typescript +public readonly url: string; +``` + +- *Type:* string + +`url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). + +Exactly one of `url` or `service` must be specified. + +The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. + +Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. + +The scheme must be "https"; the URL must begin with "https://". + +A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. + +Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. + +--- + +### WebhookClientConfigV1Beta1 + +WebhookClientConfig contains the information to make a TLS connection with the webhook. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const webhookClientConfigV1Beta1: k8s.WebhookClientConfigV1Beta1 = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| caBundle | string | `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. | +| service | @smallcase/cdk8s-botkube.k8s.ServiceReferenceV1Beta1 | `service` is a reference to the service for this webhook. Either `service` or `url` must be specified. | +| url | string | `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). | + +--- + +##### `caBundle`Optional + +```typescript +public readonly caBundle: string; +``` + +- *Type:* string + +`caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. + +If unspecified, system trust roots on the apiserver are used. + +--- + +##### `service`Optional + +```typescript +public readonly service: ServiceReferenceV1Beta1; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.ServiceReferenceV1Beta1 + +`service` is a reference to the service for this webhook. Either `service` or `url` must be specified. + +If the webhook is running within the cluster, then you should use `service`. + +--- + +##### `url`Optional + +```typescript +public readonly url: string; +``` + +- *Type:* string + +`url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). + +Exactly one of `url` or `service` must be specified. + +The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. + +Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. + +The scheme must be "https"; the URL must begin with "https://". + +A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. + +Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. + +--- + +### WebhookConversion + +WebhookConversion describes how to call a conversion webhook. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const webhookConversion: k8s.WebhookConversion = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| conversionReviewVersions | string[] | conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. | +| clientConfig | @smallcase/cdk8s-botkube.k8s.WebhookClientConfig | clientConfig is the instructions for how to call the webhook if strategy is `Webhook`. | + +--- + +##### `conversionReviewVersions`Required + +```typescript +public readonly conversionReviewVersions: string[]; +``` + +- *Type:* string[] + +conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. + +The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. + +--- + +##### `clientConfig`Optional + +```typescript +public readonly clientConfig: WebhookClientConfig; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.WebhookClientConfig + +clientConfig is the instructions for how to call the webhook if strategy is `Webhook`. + +--- + +### WeightedPodAffinityTerm + +The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s). + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const weightedPodAffinityTerm: k8s.WeightedPodAffinityTerm = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| podAffinityTerm | @smallcase/cdk8s-botkube.k8s.PodAffinityTerm | Required. | +| weight | number | weight associated with matching the corresponding podAffinityTerm, in the range 1-100. | + +--- + +##### `podAffinityTerm`Required + +```typescript +public readonly podAffinityTerm: PodAffinityTerm; +``` + +- *Type:* @smallcase/cdk8s-botkube.k8s.PodAffinityTerm + +Required. + +A pod affinity term, associated with the corresponding weight. + +--- + +##### `weight`Required + +```typescript +public readonly weight: number; +``` + +- *Type:* number + +weight associated with matching the corresponding podAffinityTerm, in the range 1-100. + +--- + +### WindowsSecurityContextOptions + +WindowsSecurityContextOptions contain Windows-specific options and credentials. + +#### Initializer + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +const windowsSecurityContextOptions: k8s.WindowsSecurityContextOptions = { ... } +``` + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| gmsaCredentialSpec | string | GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. | +| gmsaCredentialSpecName | string | GMSACredentialSpecName is the name of the GMSA credential spec to use. | +| runAsUserName | string | The UserName in Windows to run the entrypoint of the container process. | + +--- + +##### `gmsaCredentialSpec`Optional + +```typescript +public readonly gmsaCredentialSpec: string; +``` + +- *Type:* string + +GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. + +--- + +##### `gmsaCredentialSpecName`Optional + +```typescript +public readonly gmsaCredentialSpecName: string; +``` + +- *Type:* string + +GMSACredentialSpecName is the name of the GMSA credential spec to use. + +--- + +##### `runAsUserName`Optional + +```typescript +public readonly runAsUserName: string; +``` + +- *Type:* string +- *Default:* the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +The UserName in Windows to run the entrypoint of the container process. + +Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + +--- + +## Classes + +### IntOrString + + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| fromNumber | *No description.* | +| fromString | *No description.* | + +--- + +##### `fromNumber` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.IntOrString.fromNumber(value: number) +``` + +###### `value`Required + +- *Type:* number + +--- + +##### `fromString` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.IntOrString.fromString(value: string) +``` + +###### `value`Required + +- *Type:* string + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| value | any | *No description.* | + +--- + +##### `value`Required + +```typescript +public readonly value: any; +``` + +- *Type:* any + +--- + + +### Quantity + + +#### Static Functions + +| **Name** | **Description** | +| --- | --- | +| fromNumber | *No description.* | +| fromString | *No description.* | + +--- + +##### `fromNumber` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.Quantity.fromNumber(value: number) +``` + +###### `value`Required + +- *Type:* number + +--- + +##### `fromString` + +```typescript +import { k8s } from '@smallcase/cdk8s-botkube' + +k8s.Quantity.fromString(value: string) +``` + +###### `value`Required + +- *Type:* string + +--- + +#### Properties + +| **Name** | **Type** | **Description** | +| --- | --- | --- | +| value | any | *No description.* | + +--- + +##### `value`Required + +```typescript +public readonly value: any; +``` + +- *Type:* any + +--- + + + +## Enums + +### IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind + +Kind is a string value representing the REST resource this object represents. + +Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +#### Members + +| **Name** | **Description** | +| --- | --- | +| DELETE_OPTIONS | DeleteOptions. | + +--- + +##### `DELETE_OPTIONS` + +DeleteOptions. + +--- + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6f3aae8 --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +# CDK8S BotKube + +`cdk8s-botkube` is an open-source construct library for cdk8s to deploy a configurable instance of BotKube to your Kubernetes cluster. BotKube is a messaging bot for monitoring and debugging Kubernetes clusters. +You provide the configuration for BotKube, our construct library does the rest of the magic. + +[Official website](https://www.botkube.io/) + +## Installation + +Install using NPM: + +``` +npm install @smallcase/cdk8s-botkube +``` + +Using yarn + +``` +yarn add @smallcase/cdk8s-botkube +``` + +### Configuration Helper + +| Property | Type | Default | Description | +| ------------- | ------------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------- | +| secretName | string | botkube-communication-secret | Your BotKube communication secret name (Read below to see how to define your secret) | +| configMapData | string | [./configmap.yaml](./configmap.yaml) | YAML formatted string defining your BotKube monitoring config (Read below to see how to define your config) | +| replicas | number | 1 | Number of pod replicas for deployment | +| nodeSelector | { [key: string]: string } | {} | Node selectors for the BotKube deployment | +| tolerations | k8s.Toleration[] | [] | Tolerations for the BotKube deployment | + +## Setting Up Secrets: + +Since the communication configuration contains sensitive information like webhook and application tokens we recommend you deploy the configuration as a secret. + +Template: + +``` +apiVersion: v1 +kind: Secret +metadata: + name: botkube-communication-secret + labels: + app: botkube +type: Opaque +stringData: + comm_config.yaml: | + ... +``` + +Fill in the communication secret as per your requirements, have a look at BotKube's official documentation [here](https://www.botkube.io/configuration/#comm_configyaml-syntax) to get an idea of the syntax. + +## Setting Up the Resource Config + +You can customize alerts from BotKube as per your needs by tweaking its config. You can leave this field empty and a [default config](./configmap.yaml) will be added, or you can specify a custom YAML config. See resource config syntax [here](https://www.botkube.io/configuration/#resource_configyaml-syntax). + +## Using the construct + +Import the library in your CDK8s project and pass the necessary parameters to the construct. + +Example: + +``` +new BotKube(this, 'botkube-default', { + secretName: 'my-secret-name', + configMapData: 'Foo', + replicas: 2 +}); +``` diff --git a/configmap.yaml b/configmap.yaml new file mode 100644 index 0000000..0552220 --- /dev/null +++ b/configmap.yaml @@ -0,0 +1,76 @@ +## Resources you want to watch +resources: +- name: RESOURCE # K8s Resource you want to monitor. + # Resource name must be in + # group/version/resource (G/V/R) format + # for core resources with no group, + # ignore group fron g/v/r and use v/r + # resource name should be plural + # (e.g v1/pods, v1.ingresses, etc) + + namespaces: + include: # List of namespaces to monitor for + # the RESOURCE events + - namespace/all # Use all to monitor all the resources + + ignore: # List of namespaces to be ignored + # used only with include: all + - # example : include [all], ignore [x,y,z] + + events: # List of lifecycle events you want to + - create # receive notifications about + - update # Valid options are: + - delete # create, update, delete, error OR all + - error + + updateSetting: # Set include diff with the update event + # about the changes in specific fields + includeDiff: true # updateSettings are ignored if `update` + # events are not configured for the resource + + fields: + - JSONPath # List of JSONPath expressions to monitor + # changes in specific fields +- name: apps/v1/deployments + namespaces: + include: + - dev + - qa + - default + ignore: + - kube-system + - prod + updateSetting: + includeDiff: true + fields: + - spec.template.spec.containers[*].image + - status.availableReplicas + events: + - all + +# Check true if you want to receive recommendations +# about the best practices for the created resource +recommendations: true + +# Cluster Setting to manage command execution access +settings: + # Set cluster name to differentiate incoming messages + clustername: not-configured + # Kubectl executor configs + kubectl: + # Set true to enable kubectl commands execution + enabled: false + # List of allowed commands + commands: + # kubectl method which are allowed with BotKube command + verbs: ["api-resources", "api-versions", "cluster-info", "describe", "diff", "explain", "get", "logs", "top", "auth"] + # resources on which kubectl methods are allowed with BotKube commands + resources: ["deployments", "pods" , "namespaces", "daemonsets", "statefulsets", "storageclasses", "nodes"] + # set Namespace to execute botkube kubectl commands by default + defaultNamespace: default + # Set true to enable commands execution from configured channel only + restrictAccess: false + # Set true to enable config watcher + configwatcher: true + # Set false to disable upgrade notification + upgradeNotifier: true \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..dfafc27 --- /dev/null +++ b/package.json @@ -0,0 +1,126 @@ +{ + "name": "@smallcase/cdk8s-botkube", + "repository": { + "type": "git", + "url": "https://github.com/smallcase/cdk8s-botkube.git" + }, + "scripts": { + "build": "npx projen build", + "bump": "npx projen bump", + "clobber": "npx projen clobber", + "compat": "npx projen compat", + "compile": "npx projen compile", + "default": "npx projen default", + "docgen": "npx projen docgen", + "eject": "npx projen eject", + "eslint": "npx projen eslint", + "package": "npx projen package", + "package-all": "npx projen package-all", + "package:js": "npx projen package:js", + "post-compile": "npx projen post-compile", + "post-upgrade": "npx projen post-upgrade", + "pre-compile": "npx projen pre-compile", + "release": "npx projen release", + "test": "npx projen test", + "test:update": "npx projen test:update", + "test:watch": "npx projen test:watch", + "unbump": "npx projen unbump", + "upgrade": "npx projen upgrade", + "upgrade-projen": "npx projen upgrade-projen", + "watch": "npx projen watch", + "projen": "npx projen" + }, + "author": { + "name": "majordwarf", + "email": "tejas.tank@smallcase.com", + "organization": false + }, + "devDependencies": { + "@types/jest": "^27.4.1", + "@types/node": "^12", + "@typescript-eslint/eslint-plugin": "^5", + "@typescript-eslint/parser": "^5", + "cdk8s": "1.4.10", + "constructs": "3.3.196", + "eslint": "^8", + "eslint-import-resolver-node": "^0.3.6", + "eslint-import-resolver-typescript": "^2.7.0", + "eslint-plugin-import": "^2.25.4", + "jest": "^27.5.1", + "jest-junit": "^13", + "jsii": "^1.55.1", + "jsii-diff": "^1.55.1", + "jsii-docgen": "^6.2.4", + "jsii-pacmak": "^1.55.1", + "json-schema": "^0.4.0", + "npm-check-updates": "^12", + "projen": "^0.53.15", + "standard-version": "^9", + "ts-jest": "^27.1.4", + "typescript": "^4.6.3" + }, + "peerDependencies": { + "cdk8s": "^1.4.10", + "constructs": "^3.3.196" + }, + "keywords": [ + "cdk" + ], + "main": "lib/index.js", + "license": "Apache-2.0", + "publishConfig": { + "access": "public" + }, + "version": "0.0.0", + "jest": { + "testMatch": [ + "/src/**/__tests__/**/*.ts?(x)", + "/(test|src)/**/?(*.)+(spec|test).ts?(x)" + ], + "clearMocks": true, + "collectCoverage": true, + "coverageReporters": [ + "json", + "lcov", + "clover", + "cobertura", + "text" + ], + "coverageDirectory": "coverage", + "coveragePathIgnorePatterns": [ + "/node_modules/" + ], + "testPathIgnorePatterns": [ + "/node_modules/" + ], + "watchPathIgnorePatterns": [ + "/node_modules/" + ], + "reporters": [ + "default", + [ + "jest-junit", + { + "outputDirectory": "test-reports" + } + ] + ], + "preset": "ts-jest", + "globals": { + "ts-jest": { + "tsconfig": "tsconfig.dev.json" + } + } + }, + "types": "lib/index.d.ts", + "stability": "stable", + "jsii": { + "outdir": "dist", + "targets": {}, + "tsc": { + "outDir": "lib", + "rootDir": "src" + } + }, + "//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"npx projen\"." +} \ No newline at end of file diff --git a/src/imports/k8s.ts b/src/imports/k8s.ts new file mode 100644 index 0000000..1b5e1c6 --- /dev/null +++ b/src/imports/k8s.ts @@ -0,0 +1,35399 @@ +// generated by cdk8s +import { ApiObject, GroupVersionKind } from 'cdk8s'; +import { Construct } from 'constructs'; + +/** + * MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration + */ +export class KubeMutatingWebhookConfiguration extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'admissionregistration.k8s.io/v1', + kind: 'MutatingWebhookConfiguration', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeMutatingWebhookConfigurationProps = {}): any { + return { + ...KubeMutatingWebhookConfiguration.GVK, + ...toJson_KubeMutatingWebhookConfigurationProps(props), + }; + } + + /** + * Defines a "io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeMutatingWebhookConfigurationProps = {}) { + super(scope, id, { + ...KubeMutatingWebhookConfiguration.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeMutatingWebhookConfiguration.GVK, + ...toJson_KubeMutatingWebhookConfigurationProps(resolved), + }; + } +} + +/** + * MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList + */ +export class KubeMutatingWebhookConfigurationList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'admissionregistration.k8s.io/v1', + kind: 'MutatingWebhookConfigurationList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeMutatingWebhookConfigurationListProps): any { + return { + ...KubeMutatingWebhookConfigurationList.GVK, + ...toJson_KubeMutatingWebhookConfigurationListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeMutatingWebhookConfigurationListProps) { + super(scope, id, { + ...KubeMutatingWebhookConfigurationList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeMutatingWebhookConfigurationList.GVK, + ...toJson_KubeMutatingWebhookConfigurationListProps(resolved), + }; + } +} + +/** + * ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration + */ +export class KubeValidatingWebhookConfiguration extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'admissionregistration.k8s.io/v1', + kind: 'ValidatingWebhookConfiguration', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeValidatingWebhookConfigurationProps = {}): any { + return { + ...KubeValidatingWebhookConfiguration.GVK, + ...toJson_KubeValidatingWebhookConfigurationProps(props), + }; + } + + /** + * Defines a "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeValidatingWebhookConfigurationProps = {}) { + super(scope, id, { + ...KubeValidatingWebhookConfiguration.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeValidatingWebhookConfiguration.GVK, + ...toJson_KubeValidatingWebhookConfigurationProps(resolved), + }; + } +} + +/** + * ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList + */ +export class KubeValidatingWebhookConfigurationList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'admissionregistration.k8s.io/v1', + kind: 'ValidatingWebhookConfigurationList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeValidatingWebhookConfigurationListProps): any { + return { + ...KubeValidatingWebhookConfigurationList.GVK, + ...toJson_KubeValidatingWebhookConfigurationListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeValidatingWebhookConfigurationListProps) { + super(scope, id, { + ...KubeValidatingWebhookConfigurationList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeValidatingWebhookConfigurationList.GVK, + ...toJson_KubeValidatingWebhookConfigurationListProps(resolved), + }; + } +} + +/** + * MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. Deprecated in v1.16, planned for removal in v1.19. Use admissionregistration.k8s.io/v1 MutatingWebhookConfiguration instead. + * + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfiguration + */ +export class KubeMutatingWebhookConfigurationV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfiguration" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'admissionregistration.k8s.io/v1beta1', + kind: 'MutatingWebhookConfiguration', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfiguration". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeMutatingWebhookConfigurationV1Beta1Props = {}): any { + return { + ...KubeMutatingWebhookConfigurationV1Beta1.GVK, + ...toJson_KubeMutatingWebhookConfigurationV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfiguration" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeMutatingWebhookConfigurationV1Beta1Props = {}) { + super(scope, id, { + ...KubeMutatingWebhookConfigurationV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeMutatingWebhookConfigurationV1Beta1.GVK, + ...toJson_KubeMutatingWebhookConfigurationV1Beta1Props(resolved), + }; + } +} + +/** + * MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfigurationList + */ +export class KubeMutatingWebhookConfigurationListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfigurationList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'admissionregistration.k8s.io/v1beta1', + kind: 'MutatingWebhookConfigurationList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfigurationList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeMutatingWebhookConfigurationListV1Beta1Props): any { + return { + ...KubeMutatingWebhookConfigurationListV1Beta1.GVK, + ...toJson_KubeMutatingWebhookConfigurationListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfigurationList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeMutatingWebhookConfigurationListV1Beta1Props) { + super(scope, id, { + ...KubeMutatingWebhookConfigurationListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeMutatingWebhookConfigurationListV1Beta1.GVK, + ...toJson_KubeMutatingWebhookConfigurationListV1Beta1Props(resolved), + }; + } +} + +/** + * ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. Deprecated in v1.16, planned for removal in v1.19. Use admissionregistration.k8s.io/v1 ValidatingWebhookConfiguration instead. + * + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfiguration + */ +export class KubeValidatingWebhookConfigurationV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfiguration" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'admissionregistration.k8s.io/v1beta1', + kind: 'ValidatingWebhookConfiguration', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfiguration". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeValidatingWebhookConfigurationV1Beta1Props = {}): any { + return { + ...KubeValidatingWebhookConfigurationV1Beta1.GVK, + ...toJson_KubeValidatingWebhookConfigurationV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfiguration" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeValidatingWebhookConfigurationV1Beta1Props = {}) { + super(scope, id, { + ...KubeValidatingWebhookConfigurationV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeValidatingWebhookConfigurationV1Beta1.GVK, + ...toJson_KubeValidatingWebhookConfigurationV1Beta1Props(resolved), + }; + } +} + +/** + * ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfigurationList + */ +export class KubeValidatingWebhookConfigurationListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfigurationList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'admissionregistration.k8s.io/v1beta1', + kind: 'ValidatingWebhookConfigurationList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfigurationList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeValidatingWebhookConfigurationListV1Beta1Props): any { + return { + ...KubeValidatingWebhookConfigurationListV1Beta1.GVK, + ...toJson_KubeValidatingWebhookConfigurationListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfigurationList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeValidatingWebhookConfigurationListV1Beta1Props) { + super(scope, id, { + ...KubeValidatingWebhookConfigurationListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeValidatingWebhookConfigurationListV1Beta1.GVK, + ...toJson_KubeValidatingWebhookConfigurationListV1Beta1Props(resolved), + }; + } +} + +/** + * + Storage version of a specific resource. + * + * @schema io.k8s.api.apiserverinternal.v1alpha1.StorageVersion + */ +export class KubeStorageVersionV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersion" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'internal.apiserver.k8s.io/v1alpha1', + kind: 'StorageVersion', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersion". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeStorageVersionV1Alpha1Props): any { + return { + ...KubeStorageVersionV1Alpha1.GVK, + ...toJson_KubeStorageVersionV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.apiserverinternal.v1alpha1.StorageVersion" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeStorageVersionV1Alpha1Props) { + super(scope, id, { + ...KubeStorageVersionV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeStorageVersionV1Alpha1.GVK, + ...toJson_KubeStorageVersionV1Alpha1Props(resolved), + }; + } +} + +/** + * A list of StorageVersions. + * + * @schema io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList + */ +export class KubeStorageVersionListV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'internal.apiserver.k8s.io/v1alpha1', + kind: 'StorageVersionList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeStorageVersionListV1Alpha1Props): any { + return { + ...KubeStorageVersionListV1Alpha1.GVK, + ...toJson_KubeStorageVersionListV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeStorageVersionListV1Alpha1Props) { + super(scope, id, { + ...KubeStorageVersionListV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeStorageVersionListV1Alpha1.GVK, + ...toJson_KubeStorageVersionListV1Alpha1Props(resolved), + }; + } +} + +/** + * ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers. + * + * @schema io.k8s.api.apps.v1.ControllerRevision + */ +export class KubeControllerRevision extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.apps.v1.ControllerRevision" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apps/v1', + kind: 'ControllerRevision', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.apps.v1.ControllerRevision". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeControllerRevisionProps): any { + return { + ...KubeControllerRevision.GVK, + ...toJson_KubeControllerRevisionProps(props), + }; + } + + /** + * Defines a "io.k8s.api.apps.v1.ControllerRevision" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeControllerRevisionProps) { + super(scope, id, { + ...KubeControllerRevision.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeControllerRevision.GVK, + ...toJson_KubeControllerRevisionProps(resolved), + }; + } +} + +/** + * ControllerRevisionList is a resource containing a list of ControllerRevision objects. + * + * @schema io.k8s.api.apps.v1.ControllerRevisionList + */ +export class KubeControllerRevisionList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.apps.v1.ControllerRevisionList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apps/v1', + kind: 'ControllerRevisionList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.apps.v1.ControllerRevisionList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeControllerRevisionListProps): any { + return { + ...KubeControllerRevisionList.GVK, + ...toJson_KubeControllerRevisionListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.apps.v1.ControllerRevisionList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeControllerRevisionListProps) { + super(scope, id, { + ...KubeControllerRevisionList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeControllerRevisionList.GVK, + ...toJson_KubeControllerRevisionListProps(resolved), + }; + } +} + +/** + * DaemonSet represents the configuration of a daemon set. + * + * @schema io.k8s.api.apps.v1.DaemonSet + */ +export class KubeDaemonSet extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.apps.v1.DaemonSet" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apps/v1', + kind: 'DaemonSet', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.apps.v1.DaemonSet". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeDaemonSetProps = {}): any { + return { + ...KubeDaemonSet.GVK, + ...toJson_KubeDaemonSetProps(props), + }; + } + + /** + * Defines a "io.k8s.api.apps.v1.DaemonSet" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeDaemonSetProps = {}) { + super(scope, id, { + ...KubeDaemonSet.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeDaemonSet.GVK, + ...toJson_KubeDaemonSetProps(resolved), + }; + } +} + +/** + * DaemonSetList is a collection of daemon sets. + * + * @schema io.k8s.api.apps.v1.DaemonSetList + */ +export class KubeDaemonSetList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.apps.v1.DaemonSetList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apps/v1', + kind: 'DaemonSetList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.apps.v1.DaemonSetList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeDaemonSetListProps): any { + return { + ...KubeDaemonSetList.GVK, + ...toJson_KubeDaemonSetListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.apps.v1.DaemonSetList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeDaemonSetListProps) { + super(scope, id, { + ...KubeDaemonSetList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeDaemonSetList.GVK, + ...toJson_KubeDaemonSetListProps(resolved), + }; + } +} + +/** + * Deployment enables declarative updates for Pods and ReplicaSets. + * + * @schema io.k8s.api.apps.v1.Deployment + */ +export class KubeDeployment extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.apps.v1.Deployment" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apps/v1', + kind: 'Deployment', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.apps.v1.Deployment". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeDeploymentProps = {}): any { + return { + ...KubeDeployment.GVK, + ...toJson_KubeDeploymentProps(props), + }; + } + + /** + * Defines a "io.k8s.api.apps.v1.Deployment" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeDeploymentProps = {}) { + super(scope, id, { + ...KubeDeployment.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeDeployment.GVK, + ...toJson_KubeDeploymentProps(resolved), + }; + } +} + +/** + * DeploymentList is a list of Deployments. + * + * @schema io.k8s.api.apps.v1.DeploymentList + */ +export class KubeDeploymentList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.apps.v1.DeploymentList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apps/v1', + kind: 'DeploymentList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.apps.v1.DeploymentList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeDeploymentListProps): any { + return { + ...KubeDeploymentList.GVK, + ...toJson_KubeDeploymentListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.apps.v1.DeploymentList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeDeploymentListProps) { + super(scope, id, { + ...KubeDeploymentList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeDeploymentList.GVK, + ...toJson_KubeDeploymentListProps(resolved), + }; + } +} + +/** + * ReplicaSet ensures that a specified number of pod replicas are running at any given time. + * + * @schema io.k8s.api.apps.v1.ReplicaSet + */ +export class KubeReplicaSet extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.apps.v1.ReplicaSet" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apps/v1', + kind: 'ReplicaSet', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.apps.v1.ReplicaSet". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeReplicaSetProps = {}): any { + return { + ...KubeReplicaSet.GVK, + ...toJson_KubeReplicaSetProps(props), + }; + } + + /** + * Defines a "io.k8s.api.apps.v1.ReplicaSet" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeReplicaSetProps = {}) { + super(scope, id, { + ...KubeReplicaSet.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeReplicaSet.GVK, + ...toJson_KubeReplicaSetProps(resolved), + }; + } +} + +/** + * ReplicaSetList is a collection of ReplicaSets. + * + * @schema io.k8s.api.apps.v1.ReplicaSetList + */ +export class KubeReplicaSetList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.apps.v1.ReplicaSetList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apps/v1', + kind: 'ReplicaSetList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.apps.v1.ReplicaSetList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeReplicaSetListProps): any { + return { + ...KubeReplicaSetList.GVK, + ...toJson_KubeReplicaSetListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.apps.v1.ReplicaSetList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeReplicaSetListProps) { + super(scope, id, { + ...KubeReplicaSetList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeReplicaSetList.GVK, + ...toJson_KubeReplicaSetListProps(resolved), + }; + } +} + +/** + * StatefulSet represents a set of pods with consistent identities. Identities are defined as: + - Network: A single stable DNS and hostname. + - Storage: As many VolumeClaims as requested. +The StatefulSet guarantees that a given network identity will always map to the same storage identity. + * + * @schema io.k8s.api.apps.v1.StatefulSet + */ +export class KubeStatefulSet extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.apps.v1.StatefulSet" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apps/v1', + kind: 'StatefulSet', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.apps.v1.StatefulSet". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeStatefulSetProps = {}): any { + return { + ...KubeStatefulSet.GVK, + ...toJson_KubeStatefulSetProps(props), + }; + } + + /** + * Defines a "io.k8s.api.apps.v1.StatefulSet" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeStatefulSetProps = {}) { + super(scope, id, { + ...KubeStatefulSet.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeStatefulSet.GVK, + ...toJson_KubeStatefulSetProps(resolved), + }; + } +} + +/** + * StatefulSetList is a collection of StatefulSets. + * + * @schema io.k8s.api.apps.v1.StatefulSetList + */ +export class KubeStatefulSetList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.apps.v1.StatefulSetList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apps/v1', + kind: 'StatefulSetList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.apps.v1.StatefulSetList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeStatefulSetListProps): any { + return { + ...KubeStatefulSetList.GVK, + ...toJson_KubeStatefulSetListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.apps.v1.StatefulSetList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeStatefulSetListProps) { + super(scope, id, { + ...KubeStatefulSetList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeStatefulSetList.GVK, + ...toJson_KubeStatefulSetListProps(resolved), + }; + } +} + +/** + * TokenRequest requests a token for a given service account. + * + * @schema io.k8s.api.authentication.v1.TokenRequest + */ +export class KubeTokenRequest extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.authentication.v1.TokenRequest" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'authentication.k8s.io/v1', + kind: 'TokenRequest', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.authentication.v1.TokenRequest". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeTokenRequestProps): any { + return { + ...KubeTokenRequest.GVK, + ...toJson_KubeTokenRequestProps(props), + }; + } + + /** + * Defines a "io.k8s.api.authentication.v1.TokenRequest" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeTokenRequestProps) { + super(scope, id, { + ...KubeTokenRequest.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeTokenRequest.GVK, + ...toJson_KubeTokenRequestProps(resolved), + }; + } +} + +/** + * TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver. + * + * @schema io.k8s.api.authentication.v1.TokenReview + */ +export class KubeTokenReview extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.authentication.v1.TokenReview" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'authentication.k8s.io/v1', + kind: 'TokenReview', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.authentication.v1.TokenReview". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeTokenReviewProps): any { + return { + ...KubeTokenReview.GVK, + ...toJson_KubeTokenReviewProps(props), + }; + } + + /** + * Defines a "io.k8s.api.authentication.v1.TokenReview" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeTokenReviewProps) { + super(scope, id, { + ...KubeTokenReview.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeTokenReview.GVK, + ...toJson_KubeTokenReviewProps(resolved), + }; + } +} + +/** + * TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver. + * + * @schema io.k8s.api.authentication.v1beta1.TokenReview + */ +export class KubeTokenReviewV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.authentication.v1beta1.TokenReview" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'authentication.k8s.io/v1beta1', + kind: 'TokenReview', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.authentication.v1beta1.TokenReview". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeTokenReviewV1Beta1Props): any { + return { + ...KubeTokenReviewV1Beta1.GVK, + ...toJson_KubeTokenReviewV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.authentication.v1beta1.TokenReview" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeTokenReviewV1Beta1Props) { + super(scope, id, { + ...KubeTokenReviewV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeTokenReviewV1Beta1.GVK, + ...toJson_KubeTokenReviewV1Beta1Props(resolved), + }; + } +} + +/** + * LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking. + * + * @schema io.k8s.api.authorization.v1.LocalSubjectAccessReview + */ +export class KubeLocalSubjectAccessReview extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.authorization.v1.LocalSubjectAccessReview" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'authorization.k8s.io/v1', + kind: 'LocalSubjectAccessReview', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.authorization.v1.LocalSubjectAccessReview". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeLocalSubjectAccessReviewProps): any { + return { + ...KubeLocalSubjectAccessReview.GVK, + ...toJson_KubeLocalSubjectAccessReviewProps(props), + }; + } + + /** + * Defines a "io.k8s.api.authorization.v1.LocalSubjectAccessReview" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeLocalSubjectAccessReviewProps) { + super(scope, id, { + ...KubeLocalSubjectAccessReview.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeLocalSubjectAccessReview.GVK, + ...toJson_KubeLocalSubjectAccessReviewProps(resolved), + }; + } +} + +/** + * SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action + * + * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReview + */ +export class KubeSelfSubjectAccessReview extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.authorization.v1.SelfSubjectAccessReview" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'authorization.k8s.io/v1', + kind: 'SelfSubjectAccessReview', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.authorization.v1.SelfSubjectAccessReview". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeSelfSubjectAccessReviewProps): any { + return { + ...KubeSelfSubjectAccessReview.GVK, + ...toJson_KubeSelfSubjectAccessReviewProps(props), + }; + } + + /** + * Defines a "io.k8s.api.authorization.v1.SelfSubjectAccessReview" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeSelfSubjectAccessReviewProps) { + super(scope, id, { + ...KubeSelfSubjectAccessReview.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeSelfSubjectAccessReview.GVK, + ...toJson_KubeSelfSubjectAccessReviewProps(resolved), + }; + } +} + +/** + * SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server. + * + * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReview + */ +export class KubeSelfSubjectRulesReview extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.authorization.v1.SelfSubjectRulesReview" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'authorization.k8s.io/v1', + kind: 'SelfSubjectRulesReview', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.authorization.v1.SelfSubjectRulesReview". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeSelfSubjectRulesReviewProps): any { + return { + ...KubeSelfSubjectRulesReview.GVK, + ...toJson_KubeSelfSubjectRulesReviewProps(props), + }; + } + + /** + * Defines a "io.k8s.api.authorization.v1.SelfSubjectRulesReview" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeSelfSubjectRulesReviewProps) { + super(scope, id, { + ...KubeSelfSubjectRulesReview.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeSelfSubjectRulesReview.GVK, + ...toJson_KubeSelfSubjectRulesReviewProps(resolved), + }; + } +} + +/** + * SubjectAccessReview checks whether or not a user or group can perform an action. + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReview + */ +export class KubeSubjectAccessReview extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.authorization.v1.SubjectAccessReview" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'authorization.k8s.io/v1', + kind: 'SubjectAccessReview', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.authorization.v1.SubjectAccessReview". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeSubjectAccessReviewProps): any { + return { + ...KubeSubjectAccessReview.GVK, + ...toJson_KubeSubjectAccessReviewProps(props), + }; + } + + /** + * Defines a "io.k8s.api.authorization.v1.SubjectAccessReview" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeSubjectAccessReviewProps) { + super(scope, id, { + ...KubeSubjectAccessReview.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeSubjectAccessReview.GVK, + ...toJson_KubeSubjectAccessReviewProps(resolved), + }; + } +} + +/** + * LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking. + * + * @schema io.k8s.api.authorization.v1beta1.LocalSubjectAccessReview + */ +export class KubeLocalSubjectAccessReviewV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.authorization.v1beta1.LocalSubjectAccessReview" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'authorization.k8s.io/v1beta1', + kind: 'LocalSubjectAccessReview', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.authorization.v1beta1.LocalSubjectAccessReview". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeLocalSubjectAccessReviewV1Beta1Props): any { + return { + ...KubeLocalSubjectAccessReviewV1Beta1.GVK, + ...toJson_KubeLocalSubjectAccessReviewV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.authorization.v1beta1.LocalSubjectAccessReview" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeLocalSubjectAccessReviewV1Beta1Props) { + super(scope, id, { + ...KubeLocalSubjectAccessReviewV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeLocalSubjectAccessReviewV1Beta1.GVK, + ...toJson_KubeLocalSubjectAccessReviewV1Beta1Props(resolved), + }; + } +} + +/** + * SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action + * + * @schema io.k8s.api.authorization.v1beta1.SelfSubjectAccessReview + */ +export class KubeSelfSubjectAccessReviewV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.authorization.v1beta1.SelfSubjectAccessReview" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'authorization.k8s.io/v1beta1', + kind: 'SelfSubjectAccessReview', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.authorization.v1beta1.SelfSubjectAccessReview". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeSelfSubjectAccessReviewV1Beta1Props): any { + return { + ...KubeSelfSubjectAccessReviewV1Beta1.GVK, + ...toJson_KubeSelfSubjectAccessReviewV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.authorization.v1beta1.SelfSubjectAccessReview" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeSelfSubjectAccessReviewV1Beta1Props) { + super(scope, id, { + ...KubeSelfSubjectAccessReviewV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeSelfSubjectAccessReviewV1Beta1.GVK, + ...toJson_KubeSelfSubjectAccessReviewV1Beta1Props(resolved), + }; + } +} + +/** + * SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server. + * + * @schema io.k8s.api.authorization.v1beta1.SelfSubjectRulesReview + */ +export class KubeSelfSubjectRulesReviewV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.authorization.v1beta1.SelfSubjectRulesReview" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'authorization.k8s.io/v1beta1', + kind: 'SelfSubjectRulesReview', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.authorization.v1beta1.SelfSubjectRulesReview". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeSelfSubjectRulesReviewV1Beta1Props): any { + return { + ...KubeSelfSubjectRulesReviewV1Beta1.GVK, + ...toJson_KubeSelfSubjectRulesReviewV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.authorization.v1beta1.SelfSubjectRulesReview" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeSelfSubjectRulesReviewV1Beta1Props) { + super(scope, id, { + ...KubeSelfSubjectRulesReviewV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeSelfSubjectRulesReviewV1Beta1.GVK, + ...toJson_KubeSelfSubjectRulesReviewV1Beta1Props(resolved), + }; + } +} + +/** + * SubjectAccessReview checks whether or not a user or group can perform an action. + * + * @schema io.k8s.api.authorization.v1beta1.SubjectAccessReview + */ +export class KubeSubjectAccessReviewV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.authorization.v1beta1.SubjectAccessReview" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'authorization.k8s.io/v1beta1', + kind: 'SubjectAccessReview', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.authorization.v1beta1.SubjectAccessReview". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeSubjectAccessReviewV1Beta1Props): any { + return { + ...KubeSubjectAccessReviewV1Beta1.GVK, + ...toJson_KubeSubjectAccessReviewV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.authorization.v1beta1.SubjectAccessReview" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeSubjectAccessReviewV1Beta1Props) { + super(scope, id, { + ...KubeSubjectAccessReviewV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeSubjectAccessReviewV1Beta1.GVK, + ...toJson_KubeSubjectAccessReviewV1Beta1Props(resolved), + }; + } +} + +/** + * configuration of a horizontal pod autoscaler. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler + */ +export class KubeHorizontalPodAutoscaler extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'autoscaling/v1', + kind: 'HorizontalPodAutoscaler', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeHorizontalPodAutoscalerProps = {}): any { + return { + ...KubeHorizontalPodAutoscaler.GVK, + ...toJson_KubeHorizontalPodAutoscalerProps(props), + }; + } + + /** + * Defines a "io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeHorizontalPodAutoscalerProps = {}) { + super(scope, id, { + ...KubeHorizontalPodAutoscaler.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeHorizontalPodAutoscaler.GVK, + ...toJson_KubeHorizontalPodAutoscalerProps(resolved), + }; + } +} + +/** + * list of horizontal pod autoscaler objects. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList + */ +export class KubeHorizontalPodAutoscalerList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'autoscaling/v1', + kind: 'HorizontalPodAutoscalerList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeHorizontalPodAutoscalerListProps): any { + return { + ...KubeHorizontalPodAutoscalerList.GVK, + ...toJson_KubeHorizontalPodAutoscalerListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeHorizontalPodAutoscalerListProps) { + super(scope, id, { + ...KubeHorizontalPodAutoscalerList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeHorizontalPodAutoscalerList.GVK, + ...toJson_KubeHorizontalPodAutoscalerListProps(resolved), + }; + } +} + +/** + * Scale represents a scaling request for a resource. + * + * @schema io.k8s.api.autoscaling.v1.Scale + */ +export class KubeScale extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.autoscaling.v1.Scale" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'autoscaling/v1', + kind: 'Scale', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v1.Scale". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeScaleProps = {}): any { + return { + ...KubeScale.GVK, + ...toJson_KubeScaleProps(props), + }; + } + + /** + * Defines a "io.k8s.api.autoscaling.v1.Scale" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeScaleProps = {}) { + super(scope, id, { + ...KubeScale.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeScale.GVK, + ...toJson_KubeScaleProps(resolved), + }; + } +} + +/** + * HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified. + * + * @schema io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscaler + */ +export class KubeHorizontalPodAutoscalerV2Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscaler" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'autoscaling/v2beta1', + kind: 'HorizontalPodAutoscaler', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscaler". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeHorizontalPodAutoscalerV2Beta1Props = {}): any { + return { + ...KubeHorizontalPodAutoscalerV2Beta1.GVK, + ...toJson_KubeHorizontalPodAutoscalerV2Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscaler" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeHorizontalPodAutoscalerV2Beta1Props = {}) { + super(scope, id, { + ...KubeHorizontalPodAutoscalerV2Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeHorizontalPodAutoscalerV2Beta1.GVK, + ...toJson_KubeHorizontalPodAutoscalerV2Beta1Props(resolved), + }; + } +} + +/** + * HorizontalPodAutoscaler is a list of horizontal pod autoscaler objects. + * + * @schema io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerList + */ +export class KubeHorizontalPodAutoscalerListV2Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'autoscaling/v2beta1', + kind: 'HorizontalPodAutoscalerList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeHorizontalPodAutoscalerListV2Beta1Props): any { + return { + ...KubeHorizontalPodAutoscalerListV2Beta1.GVK, + ...toJson_KubeHorizontalPodAutoscalerListV2Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeHorizontalPodAutoscalerListV2Beta1Props) { + super(scope, id, { + ...KubeHorizontalPodAutoscalerListV2Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeHorizontalPodAutoscalerListV2Beta1.GVK, + ...toJson_KubeHorizontalPodAutoscalerListV2Beta1Props(resolved), + }; + } +} + +/** + * HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified. + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscaler + */ +export class KubeHorizontalPodAutoscalerV2Beta2 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscaler" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'autoscaling/v2beta2', + kind: 'HorizontalPodAutoscaler', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscaler". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeHorizontalPodAutoscalerV2Beta2Props = {}): any { + return { + ...KubeHorizontalPodAutoscalerV2Beta2.GVK, + ...toJson_KubeHorizontalPodAutoscalerV2Beta2Props(props), + }; + } + + /** + * Defines a "io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscaler" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeHorizontalPodAutoscalerV2Beta2Props = {}) { + super(scope, id, { + ...KubeHorizontalPodAutoscalerV2Beta2.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeHorizontalPodAutoscalerV2Beta2.GVK, + ...toJson_KubeHorizontalPodAutoscalerV2Beta2Props(resolved), + }; + } +} + +/** + * HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects. + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerList + */ +export class KubeHorizontalPodAutoscalerListV2Beta2 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'autoscaling/v2beta2', + kind: 'HorizontalPodAutoscalerList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeHorizontalPodAutoscalerListV2Beta2Props): any { + return { + ...KubeHorizontalPodAutoscalerListV2Beta2.GVK, + ...toJson_KubeHorizontalPodAutoscalerListV2Beta2Props(props), + }; + } + + /** + * Defines a "io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeHorizontalPodAutoscalerListV2Beta2Props) { + super(scope, id, { + ...KubeHorizontalPodAutoscalerListV2Beta2.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeHorizontalPodAutoscalerListV2Beta2.GVK, + ...toJson_KubeHorizontalPodAutoscalerListV2Beta2Props(resolved), + }; + } +} + +/** + * CronJob represents the configuration of a single cron job. + * + * @schema io.k8s.api.batch.v1.CronJob + */ +export class KubeCronJob extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.batch.v1.CronJob" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'batch/v1', + kind: 'CronJob', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.batch.v1.CronJob". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCronJobProps = {}): any { + return { + ...KubeCronJob.GVK, + ...toJson_KubeCronJobProps(props), + }; + } + + /** + * Defines a "io.k8s.api.batch.v1.CronJob" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCronJobProps = {}) { + super(scope, id, { + ...KubeCronJob.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCronJob.GVK, + ...toJson_KubeCronJobProps(resolved), + }; + } +} + +/** + * CronJobList is a collection of cron jobs. + * + * @schema io.k8s.api.batch.v1.CronJobList + */ +export class KubeCronJobList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.batch.v1.CronJobList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'batch/v1', + kind: 'CronJobList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.batch.v1.CronJobList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCronJobListProps): any { + return { + ...KubeCronJobList.GVK, + ...toJson_KubeCronJobListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.batch.v1.CronJobList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCronJobListProps) { + super(scope, id, { + ...KubeCronJobList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCronJobList.GVK, + ...toJson_KubeCronJobListProps(resolved), + }; + } +} + +/** + * Job represents the configuration of a single job. + * + * @schema io.k8s.api.batch.v1.Job + */ +export class KubeJob extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.batch.v1.Job" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'batch/v1', + kind: 'Job', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.batch.v1.Job". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeJobProps = {}): any { + return { + ...KubeJob.GVK, + ...toJson_KubeJobProps(props), + }; + } + + /** + * Defines a "io.k8s.api.batch.v1.Job" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeJobProps = {}) { + super(scope, id, { + ...KubeJob.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeJob.GVK, + ...toJson_KubeJobProps(resolved), + }; + } +} + +/** + * JobList is a collection of jobs. + * + * @schema io.k8s.api.batch.v1.JobList + */ +export class KubeJobList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.batch.v1.JobList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'batch/v1', + kind: 'JobList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.batch.v1.JobList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeJobListProps): any { + return { + ...KubeJobList.GVK, + ...toJson_KubeJobListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.batch.v1.JobList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeJobListProps) { + super(scope, id, { + ...KubeJobList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeJobList.GVK, + ...toJson_KubeJobListProps(resolved), + }; + } +} + +/** + * CronJob represents the configuration of a single cron job. + * + * @schema io.k8s.api.batch.v1beta1.CronJob + */ +export class KubeCronJobV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.batch.v1beta1.CronJob" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'batch/v1beta1', + kind: 'CronJob', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.batch.v1beta1.CronJob". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCronJobV1Beta1Props = {}): any { + return { + ...KubeCronJobV1Beta1.GVK, + ...toJson_KubeCronJobV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.batch.v1beta1.CronJob" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCronJobV1Beta1Props = {}) { + super(scope, id, { + ...KubeCronJobV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCronJobV1Beta1.GVK, + ...toJson_KubeCronJobV1Beta1Props(resolved), + }; + } +} + +/** + * CronJobList is a collection of cron jobs. + * + * @schema io.k8s.api.batch.v1beta1.CronJobList + */ +export class KubeCronJobListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.batch.v1beta1.CronJobList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'batch/v1beta1', + kind: 'CronJobList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.batch.v1beta1.CronJobList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCronJobListV1Beta1Props): any { + return { + ...KubeCronJobListV1Beta1.GVK, + ...toJson_KubeCronJobListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.batch.v1beta1.CronJobList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCronJobListV1Beta1Props) { + super(scope, id, { + ...KubeCronJobListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCronJobListV1Beta1.GVK, + ...toJson_KubeCronJobListV1Beta1Props(resolved), + }; + } +} + +/** + * CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request, and having it asynchronously approved and issued. + +Kubelets use this API to obtain: + 1. client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client-kubelet" signerName). + 2. serving certificates for TLS endpoints kube-apiserver can connect to securely (with the "kubernetes.io/kubelet-serving" signerName). + +This API can be used to request client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client" signerName), or to obtain certificates from custom non-Kubernetes signers. + * + * @schema io.k8s.api.certificates.v1.CertificateSigningRequest + */ +export class KubeCertificateSigningRequest extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.certificates.v1.CertificateSigningRequest" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'certificates.k8s.io/v1', + kind: 'CertificateSigningRequest', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.certificates.v1.CertificateSigningRequest". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCertificateSigningRequestProps): any { + return { + ...KubeCertificateSigningRequest.GVK, + ...toJson_KubeCertificateSigningRequestProps(props), + }; + } + + /** + * Defines a "io.k8s.api.certificates.v1.CertificateSigningRequest" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCertificateSigningRequestProps) { + super(scope, id, { + ...KubeCertificateSigningRequest.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCertificateSigningRequest.GVK, + ...toJson_KubeCertificateSigningRequestProps(resolved), + }; + } +} + +/** + * CertificateSigningRequestList is a collection of CertificateSigningRequest objects + * + * @schema io.k8s.api.certificates.v1.CertificateSigningRequestList + */ +export class KubeCertificateSigningRequestList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.certificates.v1.CertificateSigningRequestList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'certificates.k8s.io/v1', + kind: 'CertificateSigningRequestList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.certificates.v1.CertificateSigningRequestList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCertificateSigningRequestListProps): any { + return { + ...KubeCertificateSigningRequestList.GVK, + ...toJson_KubeCertificateSigningRequestListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.certificates.v1.CertificateSigningRequestList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCertificateSigningRequestListProps) { + super(scope, id, { + ...KubeCertificateSigningRequestList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCertificateSigningRequestList.GVK, + ...toJson_KubeCertificateSigningRequestListProps(resolved), + }; + } +} + +/** + * Describes a certificate signing request + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequest + */ +export class KubeCertificateSigningRequestV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.certificates.v1beta1.CertificateSigningRequest" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'certificates.k8s.io/v1beta1', + kind: 'CertificateSigningRequest', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.certificates.v1beta1.CertificateSigningRequest". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCertificateSigningRequestV1Beta1Props = {}): any { + return { + ...KubeCertificateSigningRequestV1Beta1.GVK, + ...toJson_KubeCertificateSigningRequestV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.certificates.v1beta1.CertificateSigningRequest" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCertificateSigningRequestV1Beta1Props = {}) { + super(scope, id, { + ...KubeCertificateSigningRequestV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCertificateSigningRequestV1Beta1.GVK, + ...toJson_KubeCertificateSigningRequestV1Beta1Props(resolved), + }; + } +} + +/** + * + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestList + */ +export class KubeCertificateSigningRequestListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.certificates.v1beta1.CertificateSigningRequestList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'certificates.k8s.io/v1beta1', + kind: 'CertificateSigningRequestList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.certificates.v1beta1.CertificateSigningRequestList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCertificateSigningRequestListV1Beta1Props): any { + return { + ...KubeCertificateSigningRequestListV1Beta1.GVK, + ...toJson_KubeCertificateSigningRequestListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.certificates.v1beta1.CertificateSigningRequestList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCertificateSigningRequestListV1Beta1Props) { + super(scope, id, { + ...KubeCertificateSigningRequestListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCertificateSigningRequestListV1Beta1.GVK, + ...toJson_KubeCertificateSigningRequestListV1Beta1Props(resolved), + }; + } +} + +/** + * Lease defines a lease concept. + * + * @schema io.k8s.api.coordination.v1.Lease + */ +export class KubeLease extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.coordination.v1.Lease" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'coordination.k8s.io/v1', + kind: 'Lease', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.coordination.v1.Lease". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeLeaseProps = {}): any { + return { + ...KubeLease.GVK, + ...toJson_KubeLeaseProps(props), + }; + } + + /** + * Defines a "io.k8s.api.coordination.v1.Lease" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeLeaseProps = {}) { + super(scope, id, { + ...KubeLease.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeLease.GVK, + ...toJson_KubeLeaseProps(resolved), + }; + } +} + +/** + * LeaseList is a list of Lease objects. + * + * @schema io.k8s.api.coordination.v1.LeaseList + */ +export class KubeLeaseList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.coordination.v1.LeaseList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'coordination.k8s.io/v1', + kind: 'LeaseList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.coordination.v1.LeaseList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeLeaseListProps): any { + return { + ...KubeLeaseList.GVK, + ...toJson_KubeLeaseListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.coordination.v1.LeaseList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeLeaseListProps) { + super(scope, id, { + ...KubeLeaseList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeLeaseList.GVK, + ...toJson_KubeLeaseListProps(resolved), + }; + } +} + +/** + * Lease defines a lease concept. + * + * @schema io.k8s.api.coordination.v1beta1.Lease + */ +export class KubeLeaseV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.coordination.v1beta1.Lease" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'coordination.k8s.io/v1beta1', + kind: 'Lease', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.coordination.v1beta1.Lease". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeLeaseV1Beta1Props = {}): any { + return { + ...KubeLeaseV1Beta1.GVK, + ...toJson_KubeLeaseV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.coordination.v1beta1.Lease" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeLeaseV1Beta1Props = {}) { + super(scope, id, { + ...KubeLeaseV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeLeaseV1Beta1.GVK, + ...toJson_KubeLeaseV1Beta1Props(resolved), + }; + } +} + +/** + * LeaseList is a list of Lease objects. + * + * @schema io.k8s.api.coordination.v1beta1.LeaseList + */ +export class KubeLeaseListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.coordination.v1beta1.LeaseList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'coordination.k8s.io/v1beta1', + kind: 'LeaseList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.coordination.v1beta1.LeaseList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeLeaseListV1Beta1Props): any { + return { + ...KubeLeaseListV1Beta1.GVK, + ...toJson_KubeLeaseListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.coordination.v1beta1.LeaseList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeLeaseListV1Beta1Props) { + super(scope, id, { + ...KubeLeaseListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeLeaseListV1Beta1.GVK, + ...toJson_KubeLeaseListV1Beta1Props(resolved), + }; + } +} + +/** + * Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead. + * + * @schema io.k8s.api.core.v1.Binding + */ +export class KubeBinding extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.Binding" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'Binding', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.Binding". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeBindingProps): any { + return { + ...KubeBinding.GVK, + ...toJson_KubeBindingProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.Binding" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeBindingProps) { + super(scope, id, { + ...KubeBinding.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeBinding.GVK, + ...toJson_KubeBindingProps(resolved), + }; + } +} + +/** + * ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+ + * + * @schema io.k8s.api.core.v1.ComponentStatus + */ +export class KubeComponentStatus extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.ComponentStatus" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'ComponentStatus', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.ComponentStatus". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeComponentStatusProps = {}): any { + return { + ...KubeComponentStatus.GVK, + ...toJson_KubeComponentStatusProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.ComponentStatus" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeComponentStatusProps = {}) { + super(scope, id, { + ...KubeComponentStatus.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeComponentStatus.GVK, + ...toJson_KubeComponentStatusProps(resolved), + }; + } +} + +/** + * Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+ + * + * @schema io.k8s.api.core.v1.ComponentStatusList + */ +export class KubeComponentStatusList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.ComponentStatusList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'ComponentStatusList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.ComponentStatusList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeComponentStatusListProps): any { + return { + ...KubeComponentStatusList.GVK, + ...toJson_KubeComponentStatusListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.ComponentStatusList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeComponentStatusListProps) { + super(scope, id, { + ...KubeComponentStatusList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeComponentStatusList.GVK, + ...toJson_KubeComponentStatusListProps(resolved), + }; + } +} + +/** + * ConfigMap holds configuration data for pods to consume. + * + * @schema io.k8s.api.core.v1.ConfigMap + */ +export class KubeConfigMap extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.ConfigMap" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'ConfigMap', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.ConfigMap". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeConfigMapProps = {}): any { + return { + ...KubeConfigMap.GVK, + ...toJson_KubeConfigMapProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.ConfigMap" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeConfigMapProps = {}) { + super(scope, id, { + ...KubeConfigMap.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeConfigMap.GVK, + ...toJson_KubeConfigMapProps(resolved), + }; + } +} + +/** + * ConfigMapList is a resource containing a list of ConfigMap objects. + * + * @schema io.k8s.api.core.v1.ConfigMapList + */ +export class KubeConfigMapList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.ConfigMapList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'ConfigMapList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.ConfigMapList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeConfigMapListProps): any { + return { + ...KubeConfigMapList.GVK, + ...toJson_KubeConfigMapListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.ConfigMapList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeConfigMapListProps) { + super(scope, id, { + ...KubeConfigMapList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeConfigMapList.GVK, + ...toJson_KubeConfigMapListProps(resolved), + }; + } +} + +/** + * Endpoints is a collection of endpoints that implement the actual service. Example: + Name: "mysvc", + Subsets: [ + { + Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + }, + { + Addresses: [{"ip": "10.10.3.3"}], + Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] + }, + ] + * + * @schema io.k8s.api.core.v1.Endpoints + */ +export class KubeEndpoints extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.Endpoints" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'Endpoints', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.Endpoints". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeEndpointsProps = {}): any { + return { + ...KubeEndpoints.GVK, + ...toJson_KubeEndpointsProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.Endpoints" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeEndpointsProps = {}) { + super(scope, id, { + ...KubeEndpoints.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeEndpoints.GVK, + ...toJson_KubeEndpointsProps(resolved), + }; + } +} + +/** + * EndpointsList is a list of endpoints. + * + * @schema io.k8s.api.core.v1.EndpointsList + */ +export class KubeEndpointsList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.EndpointsList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'EndpointsList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.EndpointsList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeEndpointsListProps): any { + return { + ...KubeEndpointsList.GVK, + ...toJson_KubeEndpointsListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.EndpointsList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeEndpointsListProps) { + super(scope, id, { + ...KubeEndpointsList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeEndpointsList.GVK, + ...toJson_KubeEndpointsListProps(resolved), + }; + } +} + +/** + * A list of ephemeral containers used with the Pod ephemeralcontainers subresource. + * + * @schema io.k8s.api.core.v1.EphemeralContainers + */ +export class KubeEphemeralContainers extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.EphemeralContainers" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'EphemeralContainers', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.EphemeralContainers". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeEphemeralContainersProps): any { + return { + ...KubeEphemeralContainers.GVK, + ...toJson_KubeEphemeralContainersProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.EphemeralContainers" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeEphemeralContainersProps) { + super(scope, id, { + ...KubeEphemeralContainers.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeEphemeralContainers.GVK, + ...toJson_KubeEphemeralContainersProps(resolved), + }; + } +} + +/** + * Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data. + * + * @schema io.k8s.api.events.v1.Event + */ +export class KubeEvent extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.events.v1.Event" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'events.k8s.io/v1', + kind: 'Event', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.events.v1.Event". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeEventProps): any { + return { + ...KubeEvent.GVK, + ...toJson_KubeEventProps(props), + }; + } + + /** + * Defines a "io.k8s.api.events.v1.Event" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeEventProps) { + super(scope, id, { + ...KubeEvent.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeEvent.GVK, + ...toJson_KubeEventProps(resolved), + }; + } +} + +/** + * EventList is a list of Event objects. + * + * @schema io.k8s.api.events.v1.EventList + */ +export class KubeEventList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.events.v1.EventList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'events.k8s.io/v1', + kind: 'EventList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.events.v1.EventList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeEventListProps): any { + return { + ...KubeEventList.GVK, + ...toJson_KubeEventListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.events.v1.EventList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeEventListProps) { + super(scope, id, { + ...KubeEventList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeEventList.GVK, + ...toJson_KubeEventListProps(resolved), + }; + } +} + +/** + * LimitRange sets resource usage limits for each kind of resource in a Namespace. + * + * @schema io.k8s.api.core.v1.LimitRange + */ +export class KubeLimitRange extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.LimitRange" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'LimitRange', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.LimitRange". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeLimitRangeProps = {}): any { + return { + ...KubeLimitRange.GVK, + ...toJson_KubeLimitRangeProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.LimitRange" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeLimitRangeProps = {}) { + super(scope, id, { + ...KubeLimitRange.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeLimitRange.GVK, + ...toJson_KubeLimitRangeProps(resolved), + }; + } +} + +/** + * LimitRangeList is a list of LimitRange items. + * + * @schema io.k8s.api.core.v1.LimitRangeList + */ +export class KubeLimitRangeList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.LimitRangeList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'LimitRangeList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.LimitRangeList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeLimitRangeListProps): any { + return { + ...KubeLimitRangeList.GVK, + ...toJson_KubeLimitRangeListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.LimitRangeList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeLimitRangeListProps) { + super(scope, id, { + ...KubeLimitRangeList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeLimitRangeList.GVK, + ...toJson_KubeLimitRangeListProps(resolved), + }; + } +} + +/** + * Namespace provides a scope for Names. Use of multiple namespaces is optional. + * + * @schema io.k8s.api.core.v1.Namespace + */ +export class KubeNamespace extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.Namespace" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'Namespace', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.Namespace". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeNamespaceProps = {}): any { + return { + ...KubeNamespace.GVK, + ...toJson_KubeNamespaceProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.Namespace" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeNamespaceProps = {}) { + super(scope, id, { + ...KubeNamespace.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeNamespace.GVK, + ...toJson_KubeNamespaceProps(resolved), + }; + } +} + +/** + * NamespaceList is a list of Namespaces. + * + * @schema io.k8s.api.core.v1.NamespaceList + */ +export class KubeNamespaceList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.NamespaceList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'NamespaceList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.NamespaceList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeNamespaceListProps): any { + return { + ...KubeNamespaceList.GVK, + ...toJson_KubeNamespaceListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.NamespaceList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeNamespaceListProps) { + super(scope, id, { + ...KubeNamespaceList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeNamespaceList.GVK, + ...toJson_KubeNamespaceListProps(resolved), + }; + } +} + +/** + * Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd). + * + * @schema io.k8s.api.core.v1.Node + */ +export class KubeNode extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.Node" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'Node', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.Node". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeNodeProps = {}): any { + return { + ...KubeNode.GVK, + ...toJson_KubeNodeProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.Node" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeNodeProps = {}) { + super(scope, id, { + ...KubeNode.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeNode.GVK, + ...toJson_KubeNodeProps(resolved), + }; + } +} + +/** + * NodeList is the whole list of all Nodes which have been registered with master. + * + * @schema io.k8s.api.core.v1.NodeList + */ +export class KubeNodeList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.NodeList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'NodeList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.NodeList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeNodeListProps): any { + return { + ...KubeNodeList.GVK, + ...toJson_KubeNodeListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.NodeList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeNodeListProps) { + super(scope, id, { + ...KubeNodeList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeNodeList.GVK, + ...toJson_KubeNodeListProps(resolved), + }; + } +} + +/** + * PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes + * + * @schema io.k8s.api.core.v1.PersistentVolume + */ +export class KubePersistentVolume extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolume" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'PersistentVolume', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.PersistentVolume". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePersistentVolumeProps = {}): any { + return { + ...KubePersistentVolume.GVK, + ...toJson_KubePersistentVolumeProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.PersistentVolume" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePersistentVolumeProps = {}) { + super(scope, id, { + ...KubePersistentVolume.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePersistentVolume.GVK, + ...toJson_KubePersistentVolumeProps(resolved), + }; + } +} + +/** + * PersistentVolumeClaim is a user's request for and claim to a persistent volume + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaim + */ +export class KubePersistentVolumeClaim extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolumeClaim" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'PersistentVolumeClaim', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.PersistentVolumeClaim". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePersistentVolumeClaimProps = {}): any { + return { + ...KubePersistentVolumeClaim.GVK, + ...toJson_KubePersistentVolumeClaimProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.PersistentVolumeClaim" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePersistentVolumeClaimProps = {}) { + super(scope, id, { + ...KubePersistentVolumeClaim.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePersistentVolumeClaim.GVK, + ...toJson_KubePersistentVolumeClaimProps(resolved), + }; + } +} + +/** + * PersistentVolumeClaimList is a list of PersistentVolumeClaim items. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimList + */ +export class KubePersistentVolumeClaimList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolumeClaimList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'PersistentVolumeClaimList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.PersistentVolumeClaimList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePersistentVolumeClaimListProps): any { + return { + ...KubePersistentVolumeClaimList.GVK, + ...toJson_KubePersistentVolumeClaimListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.PersistentVolumeClaimList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePersistentVolumeClaimListProps) { + super(scope, id, { + ...KubePersistentVolumeClaimList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePersistentVolumeClaimList.GVK, + ...toJson_KubePersistentVolumeClaimListProps(resolved), + }; + } +} + +/** + * PersistentVolumeList is a list of PersistentVolume items. + * + * @schema io.k8s.api.core.v1.PersistentVolumeList + */ +export class KubePersistentVolumeList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.PersistentVolumeList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'PersistentVolumeList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.PersistentVolumeList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePersistentVolumeListProps): any { + return { + ...KubePersistentVolumeList.GVK, + ...toJson_KubePersistentVolumeListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.PersistentVolumeList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePersistentVolumeListProps) { + super(scope, id, { + ...KubePersistentVolumeList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePersistentVolumeList.GVK, + ...toJson_KubePersistentVolumeListProps(resolved), + }; + } +} + +/** + * Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts. + * + * @schema io.k8s.api.core.v1.Pod + */ +export class KubePod extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.Pod" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'Pod', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.Pod". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePodProps = {}): any { + return { + ...KubePod.GVK, + ...toJson_KubePodProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.Pod" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePodProps = {}) { + super(scope, id, { + ...KubePod.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePod.GVK, + ...toJson_KubePodProps(resolved), + }; + } +} + +/** + * PodList is a list of Pods. + * + * @schema io.k8s.api.core.v1.PodList + */ +export class KubePodList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.PodList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'PodList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.PodList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePodListProps): any { + return { + ...KubePodList.GVK, + ...toJson_KubePodListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.PodList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePodListProps) { + super(scope, id, { + ...KubePodList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePodList.GVK, + ...toJson_KubePodListProps(resolved), + }; + } +} + +/** + * PodTemplate describes a template for creating copies of a predefined pod. + * + * @schema io.k8s.api.core.v1.PodTemplate + */ +export class KubePodTemplate extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.PodTemplate" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'PodTemplate', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.PodTemplate". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePodTemplateProps = {}): any { + return { + ...KubePodTemplate.GVK, + ...toJson_KubePodTemplateProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.PodTemplate" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePodTemplateProps = {}) { + super(scope, id, { + ...KubePodTemplate.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePodTemplate.GVK, + ...toJson_KubePodTemplateProps(resolved), + }; + } +} + +/** + * PodTemplateList is a list of PodTemplates. + * + * @schema io.k8s.api.core.v1.PodTemplateList + */ +export class KubePodTemplateList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.PodTemplateList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'PodTemplateList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.PodTemplateList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePodTemplateListProps): any { + return { + ...KubePodTemplateList.GVK, + ...toJson_KubePodTemplateListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.PodTemplateList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePodTemplateListProps) { + super(scope, id, { + ...KubePodTemplateList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePodTemplateList.GVK, + ...toJson_KubePodTemplateListProps(resolved), + }; + } +} + +/** + * ReplicationController represents the configuration of a replication controller. + * + * @schema io.k8s.api.core.v1.ReplicationController + */ +export class KubeReplicationController extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.ReplicationController" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'ReplicationController', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.ReplicationController". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeReplicationControllerProps = {}): any { + return { + ...KubeReplicationController.GVK, + ...toJson_KubeReplicationControllerProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.ReplicationController" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeReplicationControllerProps = {}) { + super(scope, id, { + ...KubeReplicationController.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeReplicationController.GVK, + ...toJson_KubeReplicationControllerProps(resolved), + }; + } +} + +/** + * ReplicationControllerList is a collection of replication controllers. + * + * @schema io.k8s.api.core.v1.ReplicationControllerList + */ +export class KubeReplicationControllerList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.ReplicationControllerList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'ReplicationControllerList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.ReplicationControllerList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeReplicationControllerListProps): any { + return { + ...KubeReplicationControllerList.GVK, + ...toJson_KubeReplicationControllerListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.ReplicationControllerList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeReplicationControllerListProps) { + super(scope, id, { + ...KubeReplicationControllerList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeReplicationControllerList.GVK, + ...toJson_KubeReplicationControllerListProps(resolved), + }; + } +} + +/** + * ResourceQuota sets aggregate quota restrictions enforced per namespace + * + * @schema io.k8s.api.core.v1.ResourceQuota + */ +export class KubeResourceQuota extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.ResourceQuota" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'ResourceQuota', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.ResourceQuota". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeResourceQuotaProps = {}): any { + return { + ...KubeResourceQuota.GVK, + ...toJson_KubeResourceQuotaProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.ResourceQuota" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeResourceQuotaProps = {}) { + super(scope, id, { + ...KubeResourceQuota.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeResourceQuota.GVK, + ...toJson_KubeResourceQuotaProps(resolved), + }; + } +} + +/** + * ResourceQuotaList is a list of ResourceQuota items. + * + * @schema io.k8s.api.core.v1.ResourceQuotaList + */ +export class KubeResourceQuotaList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.ResourceQuotaList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'ResourceQuotaList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.ResourceQuotaList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeResourceQuotaListProps): any { + return { + ...KubeResourceQuotaList.GVK, + ...toJson_KubeResourceQuotaListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.ResourceQuotaList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeResourceQuotaListProps) { + super(scope, id, { + ...KubeResourceQuotaList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeResourceQuotaList.GVK, + ...toJson_KubeResourceQuotaListProps(resolved), + }; + } +} + +/** + * Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes. + * + * @schema io.k8s.api.core.v1.Secret + */ +export class KubeSecret extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.Secret" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'Secret', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.Secret". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeSecretProps = {}): any { + return { + ...KubeSecret.GVK, + ...toJson_KubeSecretProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.Secret" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeSecretProps = {}) { + super(scope, id, { + ...KubeSecret.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeSecret.GVK, + ...toJson_KubeSecretProps(resolved), + }; + } +} + +/** + * SecretList is a list of Secret. + * + * @schema io.k8s.api.core.v1.SecretList + */ +export class KubeSecretList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.SecretList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'SecretList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.SecretList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeSecretListProps): any { + return { + ...KubeSecretList.GVK, + ...toJson_KubeSecretListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.SecretList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeSecretListProps) { + super(scope, id, { + ...KubeSecretList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeSecretList.GVK, + ...toJson_KubeSecretListProps(resolved), + }; + } +} + +/** + * Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy. + * + * @schema io.k8s.api.core.v1.Service + */ +export class KubeService extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.Service" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'Service', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.Service". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeServiceProps = {}): any { + return { + ...KubeService.GVK, + ...toJson_KubeServiceProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.Service" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeServiceProps = {}) { + super(scope, id, { + ...KubeService.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeService.GVK, + ...toJson_KubeServiceProps(resolved), + }; + } +} + +/** + * ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets + * + * @schema io.k8s.api.core.v1.ServiceAccount + */ +export class KubeServiceAccount extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceAccount" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'ServiceAccount', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.ServiceAccount". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeServiceAccountProps = {}): any { + return { + ...KubeServiceAccount.GVK, + ...toJson_KubeServiceAccountProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.ServiceAccount" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeServiceAccountProps = {}) { + super(scope, id, { + ...KubeServiceAccount.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeServiceAccount.GVK, + ...toJson_KubeServiceAccountProps(resolved), + }; + } +} + +/** + * ServiceAccountList is a list of ServiceAccount objects + * + * @schema io.k8s.api.core.v1.ServiceAccountList + */ +export class KubeServiceAccountList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceAccountList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'ServiceAccountList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.ServiceAccountList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeServiceAccountListProps): any { + return { + ...KubeServiceAccountList.GVK, + ...toJson_KubeServiceAccountListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.ServiceAccountList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeServiceAccountListProps) { + super(scope, id, { + ...KubeServiceAccountList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeServiceAccountList.GVK, + ...toJson_KubeServiceAccountListProps(resolved), + }; + } +} + +/** + * ServiceList holds a list of services. + * + * @schema io.k8s.api.core.v1.ServiceList + */ +export class KubeServiceList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.core.v1.ServiceList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'ServiceList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.core.v1.ServiceList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeServiceListProps): any { + return { + ...KubeServiceList.GVK, + ...toJson_KubeServiceListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.core.v1.ServiceList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeServiceListProps) { + super(scope, id, { + ...KubeServiceList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeServiceList.GVK, + ...toJson_KubeServiceListProps(resolved), + }; + } +} + +/** + * EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. + * + * @schema io.k8s.api.discovery.v1.EndpointSlice + */ +export class KubeEndpointSlice extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.discovery.v1.EndpointSlice" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'discovery.k8s.io/v1', + kind: 'EndpointSlice', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.discovery.v1.EndpointSlice". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeEndpointSliceProps): any { + return { + ...KubeEndpointSlice.GVK, + ...toJson_KubeEndpointSliceProps(props), + }; + } + + /** + * Defines a "io.k8s.api.discovery.v1.EndpointSlice" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeEndpointSliceProps) { + super(scope, id, { + ...KubeEndpointSlice.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeEndpointSlice.GVK, + ...toJson_KubeEndpointSliceProps(resolved), + }; + } +} + +/** + * EndpointSliceList represents a list of endpoint slices + * + * @schema io.k8s.api.discovery.v1.EndpointSliceList + */ +export class KubeEndpointSliceList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.discovery.v1.EndpointSliceList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'discovery.k8s.io/v1', + kind: 'EndpointSliceList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.discovery.v1.EndpointSliceList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeEndpointSliceListProps): any { + return { + ...KubeEndpointSliceList.GVK, + ...toJson_KubeEndpointSliceListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.discovery.v1.EndpointSliceList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeEndpointSliceListProps) { + super(scope, id, { + ...KubeEndpointSliceList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeEndpointSliceList.GVK, + ...toJson_KubeEndpointSliceListProps(resolved), + }; + } +} + +/** + * EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSlice + */ +export class KubeEndpointSliceV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.discovery.v1beta1.EndpointSlice" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'discovery.k8s.io/v1beta1', + kind: 'EndpointSlice', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.discovery.v1beta1.EndpointSlice". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeEndpointSliceV1Beta1Props): any { + return { + ...KubeEndpointSliceV1Beta1.GVK, + ...toJson_KubeEndpointSliceV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.discovery.v1beta1.EndpointSlice" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeEndpointSliceV1Beta1Props) { + super(scope, id, { + ...KubeEndpointSliceV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeEndpointSliceV1Beta1.GVK, + ...toJson_KubeEndpointSliceV1Beta1Props(resolved), + }; + } +} + +/** + * EndpointSliceList represents a list of endpoint slices + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSliceList + */ +export class KubeEndpointSliceListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.discovery.v1beta1.EndpointSliceList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'discovery.k8s.io/v1beta1', + kind: 'EndpointSliceList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.discovery.v1beta1.EndpointSliceList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeEndpointSliceListV1Beta1Props): any { + return { + ...KubeEndpointSliceListV1Beta1.GVK, + ...toJson_KubeEndpointSliceListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.discovery.v1beta1.EndpointSliceList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeEndpointSliceListV1Beta1Props) { + super(scope, id, { + ...KubeEndpointSliceListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeEndpointSliceListV1Beta1.GVK, + ...toJson_KubeEndpointSliceListV1Beta1Props(resolved), + }; + } +} + +/** + * Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data. + * + * @schema io.k8s.api.events.v1beta1.Event + */ +export class KubeEventV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.events.v1beta1.Event" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'events.k8s.io/v1beta1', + kind: 'Event', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.events.v1beta1.Event". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeEventV1Beta1Props): any { + return { + ...KubeEventV1Beta1.GVK, + ...toJson_KubeEventV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.events.v1beta1.Event" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeEventV1Beta1Props) { + super(scope, id, { + ...KubeEventV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeEventV1Beta1.GVK, + ...toJson_KubeEventV1Beta1Props(resolved), + }; + } +} + +/** + * EventList is a list of Event objects. + * + * @schema io.k8s.api.events.v1beta1.EventList + */ +export class KubeEventListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.events.v1beta1.EventList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'events.k8s.io/v1beta1', + kind: 'EventList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.events.v1beta1.EventList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeEventListV1Beta1Props): any { + return { + ...KubeEventListV1Beta1.GVK, + ...toJson_KubeEventListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.events.v1beta1.EventList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeEventListV1Beta1Props) { + super(scope, id, { + ...KubeEventListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeEventListV1Beta1.GVK, + ...toJson_KubeEventListV1Beta1Props(resolved), + }; + } +} + +/** + * Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. + * + * @schema io.k8s.api.networking.v1beta1.Ingress + */ +export class KubeIngressV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.Ingress" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'networking.k8s.io/v1beta1', + kind: 'Ingress', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.networking.v1beta1.Ingress". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeIngressV1Beta1Props = {}): any { + return { + ...KubeIngressV1Beta1.GVK, + ...toJson_KubeIngressV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.networking.v1beta1.Ingress" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeIngressV1Beta1Props = {}) { + super(scope, id, { + ...KubeIngressV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeIngressV1Beta1.GVK, + ...toJson_KubeIngressV1Beta1Props(resolved), + }; + } +} + +/** + * IngressList is a collection of Ingress. + * + * @schema io.k8s.api.networking.v1beta1.IngressList + */ +export class KubeIngressListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.IngressList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'networking.k8s.io/v1beta1', + kind: 'IngressList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.networking.v1beta1.IngressList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeIngressListV1Beta1Props): any { + return { + ...KubeIngressListV1Beta1.GVK, + ...toJson_KubeIngressListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.networking.v1beta1.IngressList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeIngressListV1Beta1Props) { + super(scope, id, { + ...KubeIngressListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeIngressListV1Beta1.GVK, + ...toJson_KubeIngressListV1Beta1Props(resolved), + }; + } +} + +/** + * FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher". + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowSchema + */ +export class KubeFlowSchemaV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1beta1.FlowSchema" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'flowcontrol.apiserver.k8s.io/v1beta1', + kind: 'FlowSchema', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.flowcontrol.v1beta1.FlowSchema". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeFlowSchemaV1Beta1Props = {}): any { + return { + ...KubeFlowSchemaV1Beta1.GVK, + ...toJson_KubeFlowSchemaV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.flowcontrol.v1beta1.FlowSchema" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeFlowSchemaV1Beta1Props = {}) { + super(scope, id, { + ...KubeFlowSchemaV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeFlowSchemaV1Beta1.GVK, + ...toJson_KubeFlowSchemaV1Beta1Props(resolved), + }; + } +} + +/** + * FlowSchemaList is a list of FlowSchema objects. + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowSchemaList + */ +export class KubeFlowSchemaListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1beta1.FlowSchemaList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'flowcontrol.apiserver.k8s.io/v1beta1', + kind: 'FlowSchemaList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.flowcontrol.v1beta1.FlowSchemaList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeFlowSchemaListV1Beta1Props): any { + return { + ...KubeFlowSchemaListV1Beta1.GVK, + ...toJson_KubeFlowSchemaListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.flowcontrol.v1beta1.FlowSchemaList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeFlowSchemaListV1Beta1Props) { + super(scope, id, { + ...KubeFlowSchemaListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeFlowSchemaListV1Beta1.GVK, + ...toJson_KubeFlowSchemaListV1Beta1Props(resolved), + }; + } +} + +/** + * PriorityLevelConfiguration represents the configuration of a priority level. + * + * @schema io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfiguration + */ +export class KubePriorityLevelConfigurationV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfiguration" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'flowcontrol.apiserver.k8s.io/v1beta1', + kind: 'PriorityLevelConfiguration', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfiguration". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePriorityLevelConfigurationV1Beta1Props = {}): any { + return { + ...KubePriorityLevelConfigurationV1Beta1.GVK, + ...toJson_KubePriorityLevelConfigurationV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfiguration" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePriorityLevelConfigurationV1Beta1Props = {}) { + super(scope, id, { + ...KubePriorityLevelConfigurationV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePriorityLevelConfigurationV1Beta1.GVK, + ...toJson_KubePriorityLevelConfigurationV1Beta1Props(resolved), + }; + } +} + +/** + * PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. + * + * @schema io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationList + */ +export class KubePriorityLevelConfigurationListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'flowcontrol.apiserver.k8s.io/v1beta1', + kind: 'PriorityLevelConfigurationList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePriorityLevelConfigurationListV1Beta1Props): any { + return { + ...KubePriorityLevelConfigurationListV1Beta1.GVK, + ...toJson_KubePriorityLevelConfigurationListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePriorityLevelConfigurationListV1Beta1Props) { + super(scope, id, { + ...KubePriorityLevelConfigurationListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePriorityLevelConfigurationListV1Beta1.GVK, + ...toJson_KubePriorityLevelConfigurationListV1Beta1Props(resolved), + }; + } +} + +/** + * Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. + * + * @schema io.k8s.api.networking.v1.Ingress + */ +export class KubeIngress extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.networking.v1.Ingress" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'networking.k8s.io/v1', + kind: 'Ingress', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.networking.v1.Ingress". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeIngressProps = {}): any { + return { + ...KubeIngress.GVK, + ...toJson_KubeIngressProps(props), + }; + } + + /** + * Defines a "io.k8s.api.networking.v1.Ingress" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeIngressProps = {}) { + super(scope, id, { + ...KubeIngress.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeIngress.GVK, + ...toJson_KubeIngressProps(resolved), + }; + } +} + +/** + * IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class. + * + * @schema io.k8s.api.networking.v1.IngressClass + */ +export class KubeIngressClass extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressClass" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'networking.k8s.io/v1', + kind: 'IngressClass', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.networking.v1.IngressClass". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeIngressClassProps = {}): any { + return { + ...KubeIngressClass.GVK, + ...toJson_KubeIngressClassProps(props), + }; + } + + /** + * Defines a "io.k8s.api.networking.v1.IngressClass" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeIngressClassProps = {}) { + super(scope, id, { + ...KubeIngressClass.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeIngressClass.GVK, + ...toJson_KubeIngressClassProps(resolved), + }; + } +} + +/** + * IngressClassList is a collection of IngressClasses. + * + * @schema io.k8s.api.networking.v1.IngressClassList + */ +export class KubeIngressClassList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressClassList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'networking.k8s.io/v1', + kind: 'IngressClassList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.networking.v1.IngressClassList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeIngressClassListProps): any { + return { + ...KubeIngressClassList.GVK, + ...toJson_KubeIngressClassListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.networking.v1.IngressClassList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeIngressClassListProps) { + super(scope, id, { + ...KubeIngressClassList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeIngressClassList.GVK, + ...toJson_KubeIngressClassListProps(resolved), + }; + } +} + +/** + * IngressList is a collection of Ingress. + * + * @schema io.k8s.api.networking.v1.IngressList + */ +export class KubeIngressList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.networking.v1.IngressList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'networking.k8s.io/v1', + kind: 'IngressList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.networking.v1.IngressList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeIngressListProps): any { + return { + ...KubeIngressList.GVK, + ...toJson_KubeIngressListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.networking.v1.IngressList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeIngressListProps) { + super(scope, id, { + ...KubeIngressList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeIngressList.GVK, + ...toJson_KubeIngressListProps(resolved), + }; + } +} + +/** + * NetworkPolicy describes what network traffic is allowed for a set of Pods + * + * @schema io.k8s.api.networking.v1.NetworkPolicy + */ +export class KubeNetworkPolicy extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.networking.v1.NetworkPolicy" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'networking.k8s.io/v1', + kind: 'NetworkPolicy', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.networking.v1.NetworkPolicy". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeNetworkPolicyProps = {}): any { + return { + ...KubeNetworkPolicy.GVK, + ...toJson_KubeNetworkPolicyProps(props), + }; + } + + /** + * Defines a "io.k8s.api.networking.v1.NetworkPolicy" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeNetworkPolicyProps = {}) { + super(scope, id, { + ...KubeNetworkPolicy.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeNetworkPolicy.GVK, + ...toJson_KubeNetworkPolicyProps(resolved), + }; + } +} + +/** + * NetworkPolicyList is a list of NetworkPolicy objects. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyList + */ +export class KubeNetworkPolicyList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.networking.v1.NetworkPolicyList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'networking.k8s.io/v1', + kind: 'NetworkPolicyList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.networking.v1.NetworkPolicyList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeNetworkPolicyListProps): any { + return { + ...KubeNetworkPolicyList.GVK, + ...toJson_KubeNetworkPolicyListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.networking.v1.NetworkPolicyList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeNetworkPolicyListProps) { + super(scope, id, { + ...KubeNetworkPolicyList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeNetworkPolicyList.GVK, + ...toJson_KubeNetworkPolicyListProps(resolved), + }; + } +} + +/** + * IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class. + * + * @schema io.k8s.api.networking.v1beta1.IngressClass + */ +export class KubeIngressClassV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.IngressClass" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'networking.k8s.io/v1beta1', + kind: 'IngressClass', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.networking.v1beta1.IngressClass". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeIngressClassV1Beta1Props = {}): any { + return { + ...KubeIngressClassV1Beta1.GVK, + ...toJson_KubeIngressClassV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.networking.v1beta1.IngressClass" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeIngressClassV1Beta1Props = {}) { + super(scope, id, { + ...KubeIngressClassV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeIngressClassV1Beta1.GVK, + ...toJson_KubeIngressClassV1Beta1Props(resolved), + }; + } +} + +/** + * IngressClassList is a collection of IngressClasses. + * + * @schema io.k8s.api.networking.v1beta1.IngressClassList + */ +export class KubeIngressClassListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.networking.v1beta1.IngressClassList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'networking.k8s.io/v1beta1', + kind: 'IngressClassList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.networking.v1beta1.IngressClassList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeIngressClassListV1Beta1Props): any { + return { + ...KubeIngressClassListV1Beta1.GVK, + ...toJson_KubeIngressClassListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.networking.v1beta1.IngressClassList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeIngressClassListV1Beta1Props) { + super(scope, id, { + ...KubeIngressClassListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeIngressClassListV1Beta1.GVK, + ...toJson_KubeIngressClassListV1Beta1Props(resolved), + }; + } +} + +/** + * RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://kubernetes.io/docs/concepts/containers/runtime-class/ + * + * @schema io.k8s.api.node.v1.RuntimeClass + */ +export class KubeRuntimeClass extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.node.v1.RuntimeClass" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'node.k8s.io/v1', + kind: 'RuntimeClass', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.node.v1.RuntimeClass". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRuntimeClassProps): any { + return { + ...KubeRuntimeClass.GVK, + ...toJson_KubeRuntimeClassProps(props), + }; + } + + /** + * Defines a "io.k8s.api.node.v1.RuntimeClass" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRuntimeClassProps) { + super(scope, id, { + ...KubeRuntimeClass.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRuntimeClass.GVK, + ...toJson_KubeRuntimeClassProps(resolved), + }; + } +} + +/** + * RuntimeClassList is a list of RuntimeClass objects. + * + * @schema io.k8s.api.node.v1.RuntimeClassList + */ +export class KubeRuntimeClassList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.node.v1.RuntimeClassList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'node.k8s.io/v1', + kind: 'RuntimeClassList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.node.v1.RuntimeClassList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRuntimeClassListProps): any { + return { + ...KubeRuntimeClassList.GVK, + ...toJson_KubeRuntimeClassListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.node.v1.RuntimeClassList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRuntimeClassListProps) { + super(scope, id, { + ...KubeRuntimeClassList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRuntimeClassList.GVK, + ...toJson_KubeRuntimeClassListProps(resolved), + }; + } +} + +/** + * RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are (currently) manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md + * + * @schema io.k8s.api.node.v1alpha1.RuntimeClass + */ +export class KubeRuntimeClassV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.node.v1alpha1.RuntimeClass" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'node.k8s.io/v1alpha1', + kind: 'RuntimeClass', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.node.v1alpha1.RuntimeClass". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRuntimeClassV1Alpha1Props): any { + return { + ...KubeRuntimeClassV1Alpha1.GVK, + ...toJson_KubeRuntimeClassV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.node.v1alpha1.RuntimeClass" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRuntimeClassV1Alpha1Props) { + super(scope, id, { + ...KubeRuntimeClassV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRuntimeClassV1Alpha1.GVK, + ...toJson_KubeRuntimeClassV1Alpha1Props(resolved), + }; + } +} + +/** + * RuntimeClassList is a list of RuntimeClass objects. + * + * @schema io.k8s.api.node.v1alpha1.RuntimeClassList + */ +export class KubeRuntimeClassListV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.node.v1alpha1.RuntimeClassList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'node.k8s.io/v1alpha1', + kind: 'RuntimeClassList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.node.v1alpha1.RuntimeClassList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRuntimeClassListV1Alpha1Props): any { + return { + ...KubeRuntimeClassListV1Alpha1.GVK, + ...toJson_KubeRuntimeClassListV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.node.v1alpha1.RuntimeClassList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRuntimeClassListV1Alpha1Props) { + super(scope, id, { + ...KubeRuntimeClassListV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRuntimeClassListV1Alpha1.GVK, + ...toJson_KubeRuntimeClassListV1Alpha1Props(resolved), + }; + } +} + +/** + * RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are (currently) manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md + * + * @schema io.k8s.api.node.v1beta1.RuntimeClass + */ +export class KubeRuntimeClassV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.node.v1beta1.RuntimeClass" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'node.k8s.io/v1beta1', + kind: 'RuntimeClass', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.node.v1beta1.RuntimeClass". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRuntimeClassV1Beta1Props): any { + return { + ...KubeRuntimeClassV1Beta1.GVK, + ...toJson_KubeRuntimeClassV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.node.v1beta1.RuntimeClass" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRuntimeClassV1Beta1Props) { + super(scope, id, { + ...KubeRuntimeClassV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRuntimeClassV1Beta1.GVK, + ...toJson_KubeRuntimeClassV1Beta1Props(resolved), + }; + } +} + +/** + * RuntimeClassList is a list of RuntimeClass objects. + * + * @schema io.k8s.api.node.v1beta1.RuntimeClassList + */ +export class KubeRuntimeClassListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.node.v1beta1.RuntimeClassList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'node.k8s.io/v1beta1', + kind: 'RuntimeClassList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.node.v1beta1.RuntimeClassList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRuntimeClassListV1Beta1Props): any { + return { + ...KubeRuntimeClassListV1Beta1.GVK, + ...toJson_KubeRuntimeClassListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.node.v1beta1.RuntimeClassList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRuntimeClassListV1Beta1Props) { + super(scope, id, { + ...KubeRuntimeClassListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRuntimeClassListV1Beta1.GVK, + ...toJson_KubeRuntimeClassListV1Beta1Props(resolved), + }; + } +} + +/** + * PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods + * + * @schema io.k8s.api.policy.v1.PodDisruptionBudget + */ +export class KubePodDisruptionBudget extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.policy.v1.PodDisruptionBudget" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'policy/v1', + kind: 'PodDisruptionBudget', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.policy.v1.PodDisruptionBudget". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePodDisruptionBudgetProps = {}): any { + return { + ...KubePodDisruptionBudget.GVK, + ...toJson_KubePodDisruptionBudgetProps(props), + }; + } + + /** + * Defines a "io.k8s.api.policy.v1.PodDisruptionBudget" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePodDisruptionBudgetProps = {}) { + super(scope, id, { + ...KubePodDisruptionBudget.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePodDisruptionBudget.GVK, + ...toJson_KubePodDisruptionBudgetProps(resolved), + }; + } +} + +/** + * PodDisruptionBudgetList is a collection of PodDisruptionBudgets. + * + * @schema io.k8s.api.policy.v1.PodDisruptionBudgetList + */ +export class KubePodDisruptionBudgetList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.policy.v1.PodDisruptionBudgetList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'policy/v1', + kind: 'PodDisruptionBudgetList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.policy.v1.PodDisruptionBudgetList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePodDisruptionBudgetListProps): any { + return { + ...KubePodDisruptionBudgetList.GVK, + ...toJson_KubePodDisruptionBudgetListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.policy.v1.PodDisruptionBudgetList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePodDisruptionBudgetListProps) { + super(scope, id, { + ...KubePodDisruptionBudgetList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePodDisruptionBudgetList.GVK, + ...toJson_KubePodDisruptionBudgetListProps(resolved), + }; + } +} + +/** + * Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods//evictions. + * + * @schema io.k8s.api.policy.v1beta1.Eviction + */ +export class KubeEvictionV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.Eviction" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'policy/v1beta1', + kind: 'Eviction', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.Eviction". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeEvictionV1Beta1Props = {}): any { + return { + ...KubeEvictionV1Beta1.GVK, + ...toJson_KubeEvictionV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.policy.v1beta1.Eviction" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeEvictionV1Beta1Props = {}) { + super(scope, id, { + ...KubeEvictionV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeEvictionV1Beta1.GVK, + ...toJson_KubeEvictionV1Beta1Props(resolved), + }; + } +} + +/** + * PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudget + */ +export class KubePodDisruptionBudgetV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.PodDisruptionBudget" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'policy/v1beta1', + kind: 'PodDisruptionBudget', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.PodDisruptionBudget". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePodDisruptionBudgetV1Beta1Props = {}): any { + return { + ...KubePodDisruptionBudgetV1Beta1.GVK, + ...toJson_KubePodDisruptionBudgetV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.policy.v1beta1.PodDisruptionBudget" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePodDisruptionBudgetV1Beta1Props = {}) { + super(scope, id, { + ...KubePodDisruptionBudgetV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePodDisruptionBudgetV1Beta1.GVK, + ...toJson_KubePodDisruptionBudgetV1Beta1Props(resolved), + }; + } +} + +/** + * PodDisruptionBudgetList is a collection of PodDisruptionBudgets. + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetList + */ +export class KubePodDisruptionBudgetListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.PodDisruptionBudgetList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'policy/v1beta1', + kind: 'PodDisruptionBudgetList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.PodDisruptionBudgetList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePodDisruptionBudgetListV1Beta1Props): any { + return { + ...KubePodDisruptionBudgetListV1Beta1.GVK, + ...toJson_KubePodDisruptionBudgetListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.policy.v1beta1.PodDisruptionBudgetList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePodDisruptionBudgetListV1Beta1Props) { + super(scope, id, { + ...KubePodDisruptionBudgetListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePodDisruptionBudgetListV1Beta1.GVK, + ...toJson_KubePodDisruptionBudgetListV1Beta1Props(resolved), + }; + } +} + +/** + * PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. Deprecated in 1.21. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicy + */ +export class KubePodSecurityPolicyV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.PodSecurityPolicy" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'policy/v1beta1', + kind: 'PodSecurityPolicy', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.PodSecurityPolicy". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePodSecurityPolicyV1Beta1Props = {}): any { + return { + ...KubePodSecurityPolicyV1Beta1.GVK, + ...toJson_KubePodSecurityPolicyV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.policy.v1beta1.PodSecurityPolicy" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePodSecurityPolicyV1Beta1Props = {}) { + super(scope, id, { + ...KubePodSecurityPolicyV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePodSecurityPolicyV1Beta1.GVK, + ...toJson_KubePodSecurityPolicyV1Beta1Props(resolved), + }; + } +} + +/** + * PodSecurityPolicyList is a list of PodSecurityPolicy objects. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicyList + */ +export class KubePodSecurityPolicyListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.policy.v1beta1.PodSecurityPolicyList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'policy/v1beta1', + kind: 'PodSecurityPolicyList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.policy.v1beta1.PodSecurityPolicyList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePodSecurityPolicyListV1Beta1Props): any { + return { + ...KubePodSecurityPolicyListV1Beta1.GVK, + ...toJson_KubePodSecurityPolicyListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.policy.v1beta1.PodSecurityPolicyList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePodSecurityPolicyListV1Beta1Props) { + super(scope, id, { + ...KubePodSecurityPolicyListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePodSecurityPolicyListV1Beta1.GVK, + ...toJson_KubePodSecurityPolicyListV1Beta1Props(resolved), + }; + } +} + +/** + * ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. + * + * @schema io.k8s.api.rbac.v1.ClusterRole + */ +export class KubeClusterRole extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRole" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1', + kind: 'ClusterRole', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.ClusterRole". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeClusterRoleProps = {}): any { + return { + ...KubeClusterRole.GVK, + ...toJson_KubeClusterRoleProps(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1.ClusterRole" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeClusterRoleProps = {}) { + super(scope, id, { + ...KubeClusterRole.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeClusterRole.GVK, + ...toJson_KubeClusterRoleProps(resolved), + }; + } +} + +/** + * ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBinding + */ +export class KubeClusterRoleBinding extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleBinding" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1', + kind: 'ClusterRoleBinding', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.ClusterRoleBinding". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeClusterRoleBindingProps): any { + return { + ...KubeClusterRoleBinding.GVK, + ...toJson_KubeClusterRoleBindingProps(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1.ClusterRoleBinding" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeClusterRoleBindingProps) { + super(scope, id, { + ...KubeClusterRoleBinding.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeClusterRoleBinding.GVK, + ...toJson_KubeClusterRoleBindingProps(resolved), + }; + } +} + +/** + * ClusterRoleBindingList is a collection of ClusterRoleBindings + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBindingList + */ +export class KubeClusterRoleBindingList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleBindingList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1', + kind: 'ClusterRoleBindingList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.ClusterRoleBindingList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeClusterRoleBindingListProps): any { + return { + ...KubeClusterRoleBindingList.GVK, + ...toJson_KubeClusterRoleBindingListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1.ClusterRoleBindingList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeClusterRoleBindingListProps) { + super(scope, id, { + ...KubeClusterRoleBindingList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeClusterRoleBindingList.GVK, + ...toJson_KubeClusterRoleBindingListProps(resolved), + }; + } +} + +/** + * ClusterRoleList is a collection of ClusterRoles + * + * @schema io.k8s.api.rbac.v1.ClusterRoleList + */ +export class KubeClusterRoleList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1.ClusterRoleList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1', + kind: 'ClusterRoleList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.ClusterRoleList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeClusterRoleListProps): any { + return { + ...KubeClusterRoleList.GVK, + ...toJson_KubeClusterRoleListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1.ClusterRoleList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeClusterRoleListProps) { + super(scope, id, { + ...KubeClusterRoleList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeClusterRoleList.GVK, + ...toJson_KubeClusterRoleListProps(resolved), + }; + } +} + +/** + * Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. + * + * @schema io.k8s.api.rbac.v1.Role + */ +export class KubeRole extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1.Role" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1', + kind: 'Role', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.Role". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRoleProps = {}): any { + return { + ...KubeRole.GVK, + ...toJson_KubeRoleProps(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1.Role" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRoleProps = {}) { + super(scope, id, { + ...KubeRole.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRole.GVK, + ...toJson_KubeRoleProps(resolved), + }; + } +} + +/** + * RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. + * + * @schema io.k8s.api.rbac.v1.RoleBinding + */ +export class KubeRoleBinding extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1.RoleBinding" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1', + kind: 'RoleBinding', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.RoleBinding". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRoleBindingProps): any { + return { + ...KubeRoleBinding.GVK, + ...toJson_KubeRoleBindingProps(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1.RoleBinding" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRoleBindingProps) { + super(scope, id, { + ...KubeRoleBinding.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRoleBinding.GVK, + ...toJson_KubeRoleBindingProps(resolved), + }; + } +} + +/** + * RoleBindingList is a collection of RoleBindings + * + * @schema io.k8s.api.rbac.v1.RoleBindingList + */ +export class KubeRoleBindingList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1.RoleBindingList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1', + kind: 'RoleBindingList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.RoleBindingList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRoleBindingListProps): any { + return { + ...KubeRoleBindingList.GVK, + ...toJson_KubeRoleBindingListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1.RoleBindingList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRoleBindingListProps) { + super(scope, id, { + ...KubeRoleBindingList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRoleBindingList.GVK, + ...toJson_KubeRoleBindingListProps(resolved), + }; + } +} + +/** + * RoleList is a collection of Roles + * + * @schema io.k8s.api.rbac.v1.RoleList + */ +export class KubeRoleList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1.RoleList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1', + kind: 'RoleList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1.RoleList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRoleListProps): any { + return { + ...KubeRoleList.GVK, + ...toJson_KubeRoleListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1.RoleList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRoleListProps) { + super(scope, id, { + ...KubeRoleList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRoleList.GVK, + ...toJson_KubeRoleListProps(resolved), + }; + } +} + +/** + * ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRole, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRole + */ +export class KubeClusterRoleV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.ClusterRole" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1alpha1', + kind: 'ClusterRole', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.ClusterRole". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeClusterRoleV1Alpha1Props = {}): any { + return { + ...KubeClusterRoleV1Alpha1.GVK, + ...toJson_KubeClusterRoleV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1alpha1.ClusterRole" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeClusterRoleV1Alpha1Props = {}) { + super(scope, id, { + ...KubeClusterRoleV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeClusterRoleV1Alpha1.GVK, + ...toJson_KubeClusterRoleV1Alpha1Props(resolved), + }; + } +} + +/** + * ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBinding, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRoleBinding + */ +export class KubeClusterRoleBindingV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.ClusterRoleBinding" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1alpha1', + kind: 'ClusterRoleBinding', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.ClusterRoleBinding". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeClusterRoleBindingV1Alpha1Props): any { + return { + ...KubeClusterRoleBindingV1Alpha1.GVK, + ...toJson_KubeClusterRoleBindingV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1alpha1.ClusterRoleBinding" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeClusterRoleBindingV1Alpha1Props) { + super(scope, id, { + ...KubeClusterRoleBindingV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeClusterRoleBindingV1Alpha1.GVK, + ...toJson_KubeClusterRoleBindingV1Alpha1Props(resolved), + }; + } +} + +/** + * ClusterRoleBindingList is a collection of ClusterRoleBindings. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBindings, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRoleBindingList + */ +export class KubeClusterRoleBindingListV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.ClusterRoleBindingList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1alpha1', + kind: 'ClusterRoleBindingList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.ClusterRoleBindingList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeClusterRoleBindingListV1Alpha1Props): any { + return { + ...KubeClusterRoleBindingListV1Alpha1.GVK, + ...toJson_KubeClusterRoleBindingListV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1alpha1.ClusterRoleBindingList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeClusterRoleBindingListV1Alpha1Props) { + super(scope, id, { + ...KubeClusterRoleBindingListV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeClusterRoleBindingListV1Alpha1.GVK, + ...toJson_KubeClusterRoleBindingListV1Alpha1Props(resolved), + }; + } +} + +/** + * ClusterRoleList is a collection of ClusterRoles. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoles, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRoleList + */ +export class KubeClusterRoleListV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.ClusterRoleList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1alpha1', + kind: 'ClusterRoleList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.ClusterRoleList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeClusterRoleListV1Alpha1Props): any { + return { + ...KubeClusterRoleListV1Alpha1.GVK, + ...toJson_KubeClusterRoleListV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1alpha1.ClusterRoleList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeClusterRoleListV1Alpha1Props) { + super(scope, id, { + ...KubeClusterRoleListV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeClusterRoleListV1Alpha1.GVK, + ...toJson_KubeClusterRoleListV1Alpha1Props(resolved), + }; + } +} + +/** + * Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 Role, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.Role + */ +export class KubeRoleV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.Role" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1alpha1', + kind: 'Role', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.Role". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRoleV1Alpha1Props = {}): any { + return { + ...KubeRoleV1Alpha1.GVK, + ...toJson_KubeRoleV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1alpha1.Role" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRoleV1Alpha1Props = {}) { + super(scope, id, { + ...KubeRoleV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRoleV1Alpha1.GVK, + ...toJson_KubeRoleV1Alpha1Props(resolved), + }; + } +} + +/** + * RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBinding, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.RoleBinding + */ +export class KubeRoleBindingV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.RoleBinding" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1alpha1', + kind: 'RoleBinding', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.RoleBinding". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRoleBindingV1Alpha1Props): any { + return { + ...KubeRoleBindingV1Alpha1.GVK, + ...toJson_KubeRoleBindingV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1alpha1.RoleBinding" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRoleBindingV1Alpha1Props) { + super(scope, id, { + ...KubeRoleBindingV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRoleBindingV1Alpha1.GVK, + ...toJson_KubeRoleBindingV1Alpha1Props(resolved), + }; + } +} + +/** + * RoleBindingList is a collection of RoleBindings Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBindingList, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.RoleBindingList + */ +export class KubeRoleBindingListV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.RoleBindingList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1alpha1', + kind: 'RoleBindingList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.RoleBindingList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRoleBindingListV1Alpha1Props): any { + return { + ...KubeRoleBindingListV1Alpha1.GVK, + ...toJson_KubeRoleBindingListV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1alpha1.RoleBindingList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRoleBindingListV1Alpha1Props) { + super(scope, id, { + ...KubeRoleBindingListV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRoleBindingListV1Alpha1.GVK, + ...toJson_KubeRoleBindingListV1Alpha1Props(resolved), + }; + } +} + +/** + * RoleList is a collection of Roles. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleList, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.RoleList + */ +export class KubeRoleListV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1alpha1.RoleList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1alpha1', + kind: 'RoleList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1alpha1.RoleList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRoleListV1Alpha1Props): any { + return { + ...KubeRoleListV1Alpha1.GVK, + ...toJson_KubeRoleListV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1alpha1.RoleList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRoleListV1Alpha1Props) { + super(scope, id, { + ...KubeRoleListV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRoleListV1Alpha1.GVK, + ...toJson_KubeRoleListV1Alpha1Props(resolved), + }; + } +} + +/** + * ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRole, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRole + */ +export class KubeClusterRoleV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.ClusterRole" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1beta1', + kind: 'ClusterRole', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.ClusterRole". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeClusterRoleV1Beta1Props = {}): any { + return { + ...KubeClusterRoleV1Beta1.GVK, + ...toJson_KubeClusterRoleV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1beta1.ClusterRole" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeClusterRoleV1Beta1Props = {}) { + super(scope, id, { + ...KubeClusterRoleV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeClusterRoleV1Beta1.GVK, + ...toJson_KubeClusterRoleV1Beta1Props(resolved), + }; + } +} + +/** + * ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBinding, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRoleBinding + */ +export class KubeClusterRoleBindingV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.ClusterRoleBinding" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1beta1', + kind: 'ClusterRoleBinding', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.ClusterRoleBinding". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeClusterRoleBindingV1Beta1Props): any { + return { + ...KubeClusterRoleBindingV1Beta1.GVK, + ...toJson_KubeClusterRoleBindingV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1beta1.ClusterRoleBinding" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeClusterRoleBindingV1Beta1Props) { + super(scope, id, { + ...KubeClusterRoleBindingV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeClusterRoleBindingV1Beta1.GVK, + ...toJson_KubeClusterRoleBindingV1Beta1Props(resolved), + }; + } +} + +/** + * ClusterRoleBindingList is a collection of ClusterRoleBindings. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBindingList, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRoleBindingList + */ +export class KubeClusterRoleBindingListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.ClusterRoleBindingList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1beta1', + kind: 'ClusterRoleBindingList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.ClusterRoleBindingList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeClusterRoleBindingListV1Beta1Props): any { + return { + ...KubeClusterRoleBindingListV1Beta1.GVK, + ...toJson_KubeClusterRoleBindingListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1beta1.ClusterRoleBindingList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeClusterRoleBindingListV1Beta1Props) { + super(scope, id, { + ...KubeClusterRoleBindingListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeClusterRoleBindingListV1Beta1.GVK, + ...toJson_KubeClusterRoleBindingListV1Beta1Props(resolved), + }; + } +} + +/** + * ClusterRoleList is a collection of ClusterRoles. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoles, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRoleList + */ +export class KubeClusterRoleListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.ClusterRoleList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1beta1', + kind: 'ClusterRoleList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.ClusterRoleList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeClusterRoleListV1Beta1Props): any { + return { + ...KubeClusterRoleListV1Beta1.GVK, + ...toJson_KubeClusterRoleListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1beta1.ClusterRoleList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeClusterRoleListV1Beta1Props) { + super(scope, id, { + ...KubeClusterRoleListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeClusterRoleListV1Beta1.GVK, + ...toJson_KubeClusterRoleListV1Beta1Props(resolved), + }; + } +} + +/** + * Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 Role, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.Role + */ +export class KubeRoleV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.Role" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1beta1', + kind: 'Role', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.Role". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRoleV1Beta1Props = {}): any { + return { + ...KubeRoleV1Beta1.GVK, + ...toJson_KubeRoleV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1beta1.Role" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRoleV1Beta1Props = {}) { + super(scope, id, { + ...KubeRoleV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRoleV1Beta1.GVK, + ...toJson_KubeRoleV1Beta1Props(resolved), + }; + } +} + +/** + * RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBinding, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.RoleBinding + */ +export class KubeRoleBindingV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.RoleBinding" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1beta1', + kind: 'RoleBinding', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.RoleBinding". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRoleBindingV1Beta1Props): any { + return { + ...KubeRoleBindingV1Beta1.GVK, + ...toJson_KubeRoleBindingV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1beta1.RoleBinding" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRoleBindingV1Beta1Props) { + super(scope, id, { + ...KubeRoleBindingV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRoleBindingV1Beta1.GVK, + ...toJson_KubeRoleBindingV1Beta1Props(resolved), + }; + } +} + +/** + * RoleBindingList is a collection of RoleBindings Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBindingList, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.RoleBindingList + */ +export class KubeRoleBindingListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.RoleBindingList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1beta1', + kind: 'RoleBindingList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.RoleBindingList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRoleBindingListV1Beta1Props): any { + return { + ...KubeRoleBindingListV1Beta1.GVK, + ...toJson_KubeRoleBindingListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1beta1.RoleBindingList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRoleBindingListV1Beta1Props) { + super(scope, id, { + ...KubeRoleBindingListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRoleBindingListV1Beta1.GVK, + ...toJson_KubeRoleBindingListV1Beta1Props(resolved), + }; + } +} + +/** + * RoleList is a collection of Roles Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleList, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.RoleList + */ +export class KubeRoleListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.rbac.v1beta1.RoleList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'rbac.authorization.k8s.io/v1beta1', + kind: 'RoleList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.rbac.v1beta1.RoleList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeRoleListV1Beta1Props): any { + return { + ...KubeRoleListV1Beta1.GVK, + ...toJson_KubeRoleListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.rbac.v1beta1.RoleList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeRoleListV1Beta1Props) { + super(scope, id, { + ...KubeRoleListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeRoleListV1Beta1.GVK, + ...toJson_KubeRoleListV1Beta1Props(resolved), + }; + } +} + +/** + * PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. + * + * @schema io.k8s.api.scheduling.v1.PriorityClass + */ +export class KubePriorityClass extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.scheduling.v1.PriorityClass" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'scheduling.k8s.io/v1', + kind: 'PriorityClass', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1.PriorityClass". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePriorityClassProps): any { + return { + ...KubePriorityClass.GVK, + ...toJson_KubePriorityClassProps(props), + }; + } + + /** + * Defines a "io.k8s.api.scheduling.v1.PriorityClass" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePriorityClassProps) { + super(scope, id, { + ...KubePriorityClass.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePriorityClass.GVK, + ...toJson_KubePriorityClassProps(resolved), + }; + } +} + +/** + * PriorityClassList is a collection of priority classes. + * + * @schema io.k8s.api.scheduling.v1.PriorityClassList + */ +export class KubePriorityClassList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.scheduling.v1.PriorityClassList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'scheduling.k8s.io/v1', + kind: 'PriorityClassList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1.PriorityClassList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePriorityClassListProps): any { + return { + ...KubePriorityClassList.GVK, + ...toJson_KubePriorityClassListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.scheduling.v1.PriorityClassList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePriorityClassListProps) { + super(scope, id, { + ...KubePriorityClassList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePriorityClassList.GVK, + ...toJson_KubePriorityClassListProps(resolved), + }; + } +} + +/** + * DEPRECATED - This group version of PriorityClass is deprecated by scheduling.k8s.io/v1/PriorityClass. PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. + * + * @schema io.k8s.api.scheduling.v1alpha1.PriorityClass + */ +export class KubePriorityClassV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.scheduling.v1alpha1.PriorityClass" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'scheduling.k8s.io/v1alpha1', + kind: 'PriorityClass', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1alpha1.PriorityClass". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePriorityClassV1Alpha1Props): any { + return { + ...KubePriorityClassV1Alpha1.GVK, + ...toJson_KubePriorityClassV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.scheduling.v1alpha1.PriorityClass" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePriorityClassV1Alpha1Props) { + super(scope, id, { + ...KubePriorityClassV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePriorityClassV1Alpha1.GVK, + ...toJson_KubePriorityClassV1Alpha1Props(resolved), + }; + } +} + +/** + * PriorityClassList is a collection of priority classes. + * + * @schema io.k8s.api.scheduling.v1alpha1.PriorityClassList + */ +export class KubePriorityClassListV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.scheduling.v1alpha1.PriorityClassList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'scheduling.k8s.io/v1alpha1', + kind: 'PriorityClassList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1alpha1.PriorityClassList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePriorityClassListV1Alpha1Props): any { + return { + ...KubePriorityClassListV1Alpha1.GVK, + ...toJson_KubePriorityClassListV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.scheduling.v1alpha1.PriorityClassList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePriorityClassListV1Alpha1Props) { + super(scope, id, { + ...KubePriorityClassListV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePriorityClassListV1Alpha1.GVK, + ...toJson_KubePriorityClassListV1Alpha1Props(resolved), + }; + } +} + +/** + * DEPRECATED - This group version of PriorityClass is deprecated by scheduling.k8s.io/v1/PriorityClass. PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. + * + * @schema io.k8s.api.scheduling.v1beta1.PriorityClass + */ +export class KubePriorityClassV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.scheduling.v1beta1.PriorityClass" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'scheduling.k8s.io/v1beta1', + kind: 'PriorityClass', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1beta1.PriorityClass". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePriorityClassV1Beta1Props): any { + return { + ...KubePriorityClassV1Beta1.GVK, + ...toJson_KubePriorityClassV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.scheduling.v1beta1.PriorityClass" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePriorityClassV1Beta1Props) { + super(scope, id, { + ...KubePriorityClassV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePriorityClassV1Beta1.GVK, + ...toJson_KubePriorityClassV1Beta1Props(resolved), + }; + } +} + +/** + * PriorityClassList is a collection of priority classes. + * + * @schema io.k8s.api.scheduling.v1beta1.PriorityClassList + */ +export class KubePriorityClassListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.scheduling.v1beta1.PriorityClassList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'scheduling.k8s.io/v1beta1', + kind: 'PriorityClassList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.scheduling.v1beta1.PriorityClassList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubePriorityClassListV1Beta1Props): any { + return { + ...KubePriorityClassListV1Beta1.GVK, + ...toJson_KubePriorityClassListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.scheduling.v1beta1.PriorityClassList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubePriorityClassListV1Beta1Props) { + super(scope, id, { + ...KubePriorityClassListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubePriorityClassListV1Beta1.GVK, + ...toJson_KubePriorityClassListV1Beta1Props(resolved), + }; + } +} + +/** + * CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. + * + * @schema io.k8s.api.storage.v1.CSIDriver + */ +export class KubeCsiDriver extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSIDriver" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1', + kind: 'CSIDriver', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1.CSIDriver". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCsiDriverProps): any { + return { + ...KubeCsiDriver.GVK, + ...toJson_KubeCsiDriverProps(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1.CSIDriver" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCsiDriverProps) { + super(scope, id, { + ...KubeCsiDriver.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCsiDriver.GVK, + ...toJson_KubeCsiDriverProps(resolved), + }; + } +} + +/** + * CSIDriverList is a collection of CSIDriver objects. + * + * @schema io.k8s.api.storage.v1.CSIDriverList + */ +export class KubeCsiDriverList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSIDriverList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1', + kind: 'CSIDriverList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1.CSIDriverList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCsiDriverListProps): any { + return { + ...KubeCsiDriverList.GVK, + ...toJson_KubeCsiDriverListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1.CSIDriverList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCsiDriverListProps) { + super(scope, id, { + ...KubeCsiDriverList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCsiDriverList.GVK, + ...toJson_KubeCsiDriverListProps(resolved), + }; + } +} + +/** + * CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. + * + * @schema io.k8s.api.storage.v1.CSINode + */ +export class KubeCsiNode extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSINode" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1', + kind: 'CSINode', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1.CSINode". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCsiNodeProps): any { + return { + ...KubeCsiNode.GVK, + ...toJson_KubeCsiNodeProps(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1.CSINode" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCsiNodeProps) { + super(scope, id, { + ...KubeCsiNode.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCsiNode.GVK, + ...toJson_KubeCsiNodeProps(resolved), + }; + } +} + +/** + * CSINodeList is a collection of CSINode objects. + * + * @schema io.k8s.api.storage.v1.CSINodeList + */ +export class KubeCsiNodeList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1.CSINodeList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1', + kind: 'CSINodeList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1.CSINodeList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCsiNodeListProps): any { + return { + ...KubeCsiNodeList.GVK, + ...toJson_KubeCsiNodeListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1.CSINodeList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCsiNodeListProps) { + super(scope, id, { + ...KubeCsiNodeList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCsiNodeList.GVK, + ...toJson_KubeCsiNodeListProps(resolved), + }; + } +} + +/** + * StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. + +StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name. + * + * @schema io.k8s.api.storage.v1.StorageClass + */ +export class KubeStorageClass extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1.StorageClass" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1', + kind: 'StorageClass', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1.StorageClass". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeStorageClassProps): any { + return { + ...KubeStorageClass.GVK, + ...toJson_KubeStorageClassProps(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1.StorageClass" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeStorageClassProps) { + super(scope, id, { + ...KubeStorageClass.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeStorageClass.GVK, + ...toJson_KubeStorageClassProps(resolved), + }; + } +} + +/** + * StorageClassList is a collection of storage classes. + * + * @schema io.k8s.api.storage.v1.StorageClassList + */ +export class KubeStorageClassList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1.StorageClassList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1', + kind: 'StorageClassList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1.StorageClassList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeStorageClassListProps): any { + return { + ...KubeStorageClassList.GVK, + ...toJson_KubeStorageClassListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1.StorageClassList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeStorageClassListProps) { + super(scope, id, { + ...KubeStorageClassList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeStorageClassList.GVK, + ...toJson_KubeStorageClassListProps(resolved), + }; + } +} + +/** + * VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + +VolumeAttachment objects are non-namespaced. + * + * @schema io.k8s.api.storage.v1.VolumeAttachment + */ +export class KubeVolumeAttachment extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1.VolumeAttachment" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1', + kind: 'VolumeAttachment', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1.VolumeAttachment". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeVolumeAttachmentProps): any { + return { + ...KubeVolumeAttachment.GVK, + ...toJson_KubeVolumeAttachmentProps(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1.VolumeAttachment" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeVolumeAttachmentProps) { + super(scope, id, { + ...KubeVolumeAttachment.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeVolumeAttachment.GVK, + ...toJson_KubeVolumeAttachmentProps(resolved), + }; + } +} + +/** + * VolumeAttachmentList is a collection of VolumeAttachment objects. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentList + */ +export class KubeVolumeAttachmentList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1.VolumeAttachmentList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1', + kind: 'VolumeAttachmentList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1.VolumeAttachmentList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeVolumeAttachmentListProps): any { + return { + ...KubeVolumeAttachmentList.GVK, + ...toJson_KubeVolumeAttachmentListProps(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1.VolumeAttachmentList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeVolumeAttachmentListProps) { + super(scope, id, { + ...KubeVolumeAttachmentList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeVolumeAttachmentList.GVK, + ...toJson_KubeVolumeAttachmentListProps(resolved), + }; + } +} + +/** + * CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes. + +For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123" + +The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero + +The producer of these objects can decide which approach is more suitable. + +They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity. + * + * @schema io.k8s.api.storage.v1alpha1.CSIStorageCapacity + */ +export class KubeCsiStorageCapacityV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.CSIStorageCapacity" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1alpha1', + kind: 'CSIStorageCapacity', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1alpha1.CSIStorageCapacity". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCsiStorageCapacityV1Alpha1Props): any { + return { + ...KubeCsiStorageCapacityV1Alpha1.GVK, + ...toJson_KubeCsiStorageCapacityV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1alpha1.CSIStorageCapacity" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCsiStorageCapacityV1Alpha1Props) { + super(scope, id, { + ...KubeCsiStorageCapacityV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCsiStorageCapacityV1Alpha1.GVK, + ...toJson_KubeCsiStorageCapacityV1Alpha1Props(resolved), + }; + } +} + +/** + * CSIStorageCapacityList is a collection of CSIStorageCapacity objects. + * + * @schema io.k8s.api.storage.v1alpha1.CSIStorageCapacityList + */ +export class KubeCsiStorageCapacityListV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.CSIStorageCapacityList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1alpha1', + kind: 'CSIStorageCapacityList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1alpha1.CSIStorageCapacityList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCsiStorageCapacityListV1Alpha1Props): any { + return { + ...KubeCsiStorageCapacityListV1Alpha1.GVK, + ...toJson_KubeCsiStorageCapacityListV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1alpha1.CSIStorageCapacityList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCsiStorageCapacityListV1Alpha1Props) { + super(scope, id, { + ...KubeCsiStorageCapacityListV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCsiStorageCapacityListV1Alpha1.GVK, + ...toJson_KubeCsiStorageCapacityListV1Alpha1Props(resolved), + }; + } +} + +/** + * VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + +VolumeAttachment objects are non-namespaced. + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachment + */ +export class KubeVolumeAttachmentV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.VolumeAttachment" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1alpha1', + kind: 'VolumeAttachment', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1alpha1.VolumeAttachment". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeVolumeAttachmentV1Alpha1Props): any { + return { + ...KubeVolumeAttachmentV1Alpha1.GVK, + ...toJson_KubeVolumeAttachmentV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1alpha1.VolumeAttachment" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeVolumeAttachmentV1Alpha1Props) { + super(scope, id, { + ...KubeVolumeAttachmentV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeVolumeAttachmentV1Alpha1.GVK, + ...toJson_KubeVolumeAttachmentV1Alpha1Props(resolved), + }; + } +} + +/** + * VolumeAttachmentList is a collection of VolumeAttachment objects. + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachmentList + */ +export class KubeVolumeAttachmentListV1Alpha1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1alpha1.VolumeAttachmentList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1alpha1', + kind: 'VolumeAttachmentList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1alpha1.VolumeAttachmentList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeVolumeAttachmentListV1Alpha1Props): any { + return { + ...KubeVolumeAttachmentListV1Alpha1.GVK, + ...toJson_KubeVolumeAttachmentListV1Alpha1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1alpha1.VolumeAttachmentList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeVolumeAttachmentListV1Alpha1Props) { + super(scope, id, { + ...KubeVolumeAttachmentListV1Alpha1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeVolumeAttachmentListV1Alpha1.GVK, + ...toJson_KubeVolumeAttachmentListV1Alpha1Props(resolved), + }; + } +} + +/** + * CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriver + */ +export class KubeCsiDriverV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSIDriver" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1beta1', + kind: 'CSIDriver', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSIDriver". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCsiDriverV1Beta1Props): any { + return { + ...KubeCsiDriverV1Beta1.GVK, + ...toJson_KubeCsiDriverV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1beta1.CSIDriver" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCsiDriverV1Beta1Props) { + super(scope, id, { + ...KubeCsiDriverV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCsiDriverV1Beta1.GVK, + ...toJson_KubeCsiDriverV1Beta1Props(resolved), + }; + } +} + +/** + * CSIDriverList is a collection of CSIDriver objects. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverList + */ +export class KubeCsiDriverListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSIDriverList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1beta1', + kind: 'CSIDriverList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSIDriverList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCsiDriverListV1Beta1Props): any { + return { + ...KubeCsiDriverListV1Beta1.GVK, + ...toJson_KubeCsiDriverListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1beta1.CSIDriverList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCsiDriverListV1Beta1Props) { + super(scope, id, { + ...KubeCsiDriverListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCsiDriverListV1Beta1.GVK, + ...toJson_KubeCsiDriverListV1Beta1Props(resolved), + }; + } +} + +/** + * DEPRECATED - This group version of CSINode is deprecated by storage/v1/CSINode. See the release notes for more information. CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. + * + * @schema io.k8s.api.storage.v1beta1.CSINode + */ +export class KubeCsiNodeV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSINode" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1beta1', + kind: 'CSINode', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSINode". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCsiNodeV1Beta1Props): any { + return { + ...KubeCsiNodeV1Beta1.GVK, + ...toJson_KubeCsiNodeV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1beta1.CSINode" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCsiNodeV1Beta1Props) { + super(scope, id, { + ...KubeCsiNodeV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCsiNodeV1Beta1.GVK, + ...toJson_KubeCsiNodeV1Beta1Props(resolved), + }; + } +} + +/** + * CSINodeList is a collection of CSINode objects. + * + * @schema io.k8s.api.storage.v1beta1.CSINodeList + */ +export class KubeCsiNodeListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSINodeList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1beta1', + kind: 'CSINodeList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSINodeList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCsiNodeListV1Beta1Props): any { + return { + ...KubeCsiNodeListV1Beta1.GVK, + ...toJson_KubeCsiNodeListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1beta1.CSINodeList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCsiNodeListV1Beta1Props) { + super(scope, id, { + ...KubeCsiNodeListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCsiNodeListV1Beta1.GVK, + ...toJson_KubeCsiNodeListV1Beta1Props(resolved), + }; + } +} + +/** + * CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes. + +For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123" + +The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero + +The producer of these objects can decide which approach is more suitable. + +They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity. + * + * @schema io.k8s.api.storage.v1beta1.CSIStorageCapacity + */ +export class KubeCsiStorageCapacityV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSIStorageCapacity" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1beta1', + kind: 'CSIStorageCapacity', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSIStorageCapacity". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCsiStorageCapacityV1Beta1Props): any { + return { + ...KubeCsiStorageCapacityV1Beta1.GVK, + ...toJson_KubeCsiStorageCapacityV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1beta1.CSIStorageCapacity" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCsiStorageCapacityV1Beta1Props) { + super(scope, id, { + ...KubeCsiStorageCapacityV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCsiStorageCapacityV1Beta1.GVK, + ...toJson_KubeCsiStorageCapacityV1Beta1Props(resolved), + }; + } +} + +/** + * CSIStorageCapacityList is a collection of CSIStorageCapacity objects. + * + * @schema io.k8s.api.storage.v1beta1.CSIStorageCapacityList + */ +export class KubeCsiStorageCapacityListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.CSIStorageCapacityList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1beta1', + kind: 'CSIStorageCapacityList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.CSIStorageCapacityList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCsiStorageCapacityListV1Beta1Props): any { + return { + ...KubeCsiStorageCapacityListV1Beta1.GVK, + ...toJson_KubeCsiStorageCapacityListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1beta1.CSIStorageCapacityList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCsiStorageCapacityListV1Beta1Props) { + super(scope, id, { + ...KubeCsiStorageCapacityListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCsiStorageCapacityListV1Beta1.GVK, + ...toJson_KubeCsiStorageCapacityListV1Beta1Props(resolved), + }; + } +} + +/** + * StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. + +StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name. + * + * @schema io.k8s.api.storage.v1beta1.StorageClass + */ +export class KubeStorageClassV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.StorageClass" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1beta1', + kind: 'StorageClass', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.StorageClass". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeStorageClassV1Beta1Props): any { + return { + ...KubeStorageClassV1Beta1.GVK, + ...toJson_KubeStorageClassV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1beta1.StorageClass" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeStorageClassV1Beta1Props) { + super(scope, id, { + ...KubeStorageClassV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeStorageClassV1Beta1.GVK, + ...toJson_KubeStorageClassV1Beta1Props(resolved), + }; + } +} + +/** + * StorageClassList is a collection of storage classes. + * + * @schema io.k8s.api.storage.v1beta1.StorageClassList + */ +export class KubeStorageClassListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.StorageClassList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1beta1', + kind: 'StorageClassList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.StorageClassList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeStorageClassListV1Beta1Props): any { + return { + ...KubeStorageClassListV1Beta1.GVK, + ...toJson_KubeStorageClassListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1beta1.StorageClassList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeStorageClassListV1Beta1Props) { + super(scope, id, { + ...KubeStorageClassListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeStorageClassListV1Beta1.GVK, + ...toJson_KubeStorageClassListV1Beta1Props(resolved), + }; + } +} + +/** + * VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + +VolumeAttachment objects are non-namespaced. + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachment + */ +export class KubeVolumeAttachmentV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.VolumeAttachment" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1beta1', + kind: 'VolumeAttachment', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.VolumeAttachment". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeVolumeAttachmentV1Beta1Props): any { + return { + ...KubeVolumeAttachmentV1Beta1.GVK, + ...toJson_KubeVolumeAttachmentV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1beta1.VolumeAttachment" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeVolumeAttachmentV1Beta1Props) { + super(scope, id, { + ...KubeVolumeAttachmentV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeVolumeAttachmentV1Beta1.GVK, + ...toJson_KubeVolumeAttachmentV1Beta1Props(resolved), + }; + } +} + +/** + * VolumeAttachmentList is a collection of VolumeAttachment objects. + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachmentList + */ +export class KubeVolumeAttachmentListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.api.storage.v1beta1.VolumeAttachmentList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'storage.k8s.io/v1beta1', + kind: 'VolumeAttachmentList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.api.storage.v1beta1.VolumeAttachmentList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeVolumeAttachmentListV1Beta1Props): any { + return { + ...KubeVolumeAttachmentListV1Beta1.GVK, + ...toJson_KubeVolumeAttachmentListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.api.storage.v1beta1.VolumeAttachmentList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeVolumeAttachmentListV1Beta1Props) { + super(scope, id, { + ...KubeVolumeAttachmentListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeVolumeAttachmentListV1Beta1.GVK, + ...toJson_KubeVolumeAttachmentListV1Beta1Props(resolved), + }; + } +} + +/** + * CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition + */ +export class KubeCustomResourceDefinition extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apiextensions.k8s.io/v1', + kind: 'CustomResourceDefinition', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCustomResourceDefinitionProps): any { + return { + ...KubeCustomResourceDefinition.GVK, + ...toJson_KubeCustomResourceDefinitionProps(props), + }; + } + + /** + * Defines a "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCustomResourceDefinitionProps) { + super(scope, id, { + ...KubeCustomResourceDefinition.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCustomResourceDefinition.GVK, + ...toJson_KubeCustomResourceDefinitionProps(resolved), + }; + } +} + +/** + * CustomResourceDefinitionList is a list of CustomResourceDefinition objects. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList + */ +export class KubeCustomResourceDefinitionList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apiextensions.k8s.io/v1', + kind: 'CustomResourceDefinitionList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCustomResourceDefinitionListProps): any { + return { + ...KubeCustomResourceDefinitionList.GVK, + ...toJson_KubeCustomResourceDefinitionListProps(props), + }; + } + + /** + * Defines a "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCustomResourceDefinitionListProps) { + super(scope, id, { + ...KubeCustomResourceDefinitionList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCustomResourceDefinitionList.GVK, + ...toJson_KubeCustomResourceDefinitionListProps(resolved), + }; + } +} + +/** + * CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>. Deprecated in v1.16, planned for removal in v1.22. Use apiextensions.k8s.io/v1 CustomResourceDefinition instead. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinition + */ +export class KubeCustomResourceDefinitionV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinition" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apiextensions.k8s.io/v1beta1', + kind: 'CustomResourceDefinition', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinition". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCustomResourceDefinitionV1Beta1Props): any { + return { + ...KubeCustomResourceDefinitionV1Beta1.GVK, + ...toJson_KubeCustomResourceDefinitionV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinition" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCustomResourceDefinitionV1Beta1Props) { + super(scope, id, { + ...KubeCustomResourceDefinitionV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCustomResourceDefinitionV1Beta1.GVK, + ...toJson_KubeCustomResourceDefinitionV1Beta1Props(resolved), + }; + } +} + +/** + * CustomResourceDefinitionList is a list of CustomResourceDefinition objects. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionList + */ +export class KubeCustomResourceDefinitionListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apiextensions.k8s.io/v1beta1', + kind: 'CustomResourceDefinitionList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeCustomResourceDefinitionListV1Beta1Props): any { + return { + ...KubeCustomResourceDefinitionListV1Beta1.GVK, + ...toJson_KubeCustomResourceDefinitionListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeCustomResourceDefinitionListV1Beta1Props) { + super(scope, id, { + ...KubeCustomResourceDefinitionListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeCustomResourceDefinitionListV1Beta1.GVK, + ...toJson_KubeCustomResourceDefinitionListV1Beta1Props(resolved), + }; + } +} + +/** + * Status is a return value for calls that don't return other objects. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status + */ +export class KubeStatus extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.apimachinery.pkg.apis.meta.v1.Status" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'v1', + kind: 'Status', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.apimachinery.pkg.apis.meta.v1.Status". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeStatusProps = {}): any { + return { + ...KubeStatus.GVK, + ...toJson_KubeStatusProps(props), + }; + } + + /** + * Defines a "io.k8s.apimachinery.pkg.apis.meta.v1.Status" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeStatusProps = {}) { + super(scope, id, { + ...KubeStatus.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeStatus.GVK, + ...toJson_KubeStatusProps(resolved), + }; + } +} + +/** + * APIService represents a server for a particular GroupVersion. Name must be "version.group". + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService + */ +export class KubeApiService extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apiregistration.k8s.io/v1', + kind: 'APIService', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeApiServiceProps = {}): any { + return { + ...KubeApiService.GVK, + ...toJson_KubeApiServiceProps(props), + }; + } + + /** + * Defines a "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeApiServiceProps = {}) { + super(scope, id, { + ...KubeApiService.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeApiService.GVK, + ...toJson_KubeApiServiceProps(resolved), + }; + } +} + +/** + * APIServiceList is a list of APIService objects. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList + */ +export class KubeApiServiceList extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apiregistration.k8s.io/v1', + kind: 'APIServiceList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeApiServiceListProps): any { + return { + ...KubeApiServiceList.GVK, + ...toJson_KubeApiServiceListProps(props), + }; + } + + /** + * Defines a "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeApiServiceListProps) { + super(scope, id, { + ...KubeApiServiceList.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeApiServiceList.GVK, + ...toJson_KubeApiServiceListProps(resolved), + }; + } +} + +/** + * APIService represents a server for a particular GroupVersion. Name must be "version.group". + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIService + */ +export class KubeApiServiceV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIService" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apiregistration.k8s.io/v1beta1', + kind: 'APIService', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIService". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeApiServiceV1Beta1Props = {}): any { + return { + ...KubeApiServiceV1Beta1.GVK, + ...toJson_KubeApiServiceV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIService" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeApiServiceV1Beta1Props = {}) { + super(scope, id, { + ...KubeApiServiceV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeApiServiceV1Beta1.GVK, + ...toJson_KubeApiServiceV1Beta1Props(resolved), + }; + } +} + +/** + * APIServiceList is a list of APIService objects. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceList + */ +export class KubeApiServiceListV1Beta1 extends ApiObject { + /** + * Returns the apiVersion and kind for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceList" + */ + public static readonly GVK: GroupVersionKind = { + apiVersion: 'apiregistration.k8s.io/v1beta1', + kind: 'APIServiceList', + }; + + /** + * Renders a Kubernetes manifest for "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceList". + * + * This can be used to inline resource manifests inside other objects (e.g. as templates). + * + * @param props initialization props + */ + public static manifest(props: KubeApiServiceListV1Beta1Props): any { + return { + ...KubeApiServiceListV1Beta1.GVK, + ...toJson_KubeApiServiceListV1Beta1Props(props), + }; + } + + /** + * Defines a "io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceList" API object + * @param scope the scope in which to define this object + * @param id a scope-local name for the object + * @param props initialization props + */ + public constructor(scope: Construct, id: string, props: KubeApiServiceListV1Beta1Props) { + super(scope, id, { + ...KubeApiServiceListV1Beta1.GVK, + ...props, + }); + } + + /** + * Renders the object to Kubernetes JSON. + */ + public toJson(): any { + const resolved = super.toJson(); + + return { + ...KubeApiServiceListV1Beta1.GVK, + ...toJson_KubeApiServiceListV1Beta1Props(resolved), + }; + } +} + +/** + * MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration + */ +export interface KubeMutatingWebhookConfigurationProps { + /** + * Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Webhooks is a list of webhooks and the affected resources and operations. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration#webhooks + */ + readonly webhooks?: MutatingWebhook[]; + +} + +/** + * Converts an object of type 'KubeMutatingWebhookConfigurationProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeMutatingWebhookConfigurationProps(obj: KubeMutatingWebhookConfigurationProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'webhooks': obj.webhooks?.map(y => toJson_MutatingWebhook(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList + */ +export interface KubeMutatingWebhookConfigurationListProps { + /** + * List of MutatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList#items + */ + readonly items: KubeMutatingWebhookConfigurationProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeMutatingWebhookConfigurationListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeMutatingWebhookConfigurationListProps(obj: KubeMutatingWebhookConfigurationListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeMutatingWebhookConfigurationProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration + */ +export interface KubeValidatingWebhookConfigurationProps { + /** + * Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Webhooks is a list of webhooks and the affected resources and operations. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration#webhooks + */ + readonly webhooks?: ValidatingWebhook[]; + +} + +/** + * Converts an object of type 'KubeValidatingWebhookConfigurationProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeValidatingWebhookConfigurationProps(obj: KubeValidatingWebhookConfigurationProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'webhooks': obj.webhooks?.map(y => toJson_ValidatingWebhook(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList + */ +export interface KubeValidatingWebhookConfigurationListProps { + /** + * List of ValidatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList#items + */ + readonly items: KubeValidatingWebhookConfigurationProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeValidatingWebhookConfigurationListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeValidatingWebhookConfigurationListProps(obj: KubeValidatingWebhookConfigurationListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeValidatingWebhookConfigurationProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. Deprecated in v1.16, planned for removal in v1.19. Use admissionregistration.k8s.io/v1 MutatingWebhookConfiguration instead. + * + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfiguration + */ +export interface KubeMutatingWebhookConfigurationV1Beta1Props { + /** + * Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + * + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfiguration#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Webhooks is a list of webhooks and the affected resources and operations. + * + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfiguration#webhooks + */ + readonly webhooks?: MutatingWebhookV1Beta1[]; + +} + +/** + * Converts an object of type 'KubeMutatingWebhookConfigurationV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeMutatingWebhookConfigurationV1Beta1Props(obj: KubeMutatingWebhookConfigurationV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'webhooks': obj.webhooks?.map(y => toJson_MutatingWebhookV1Beta1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfigurationList + */ +export interface KubeMutatingWebhookConfigurationListV1Beta1Props { + /** + * List of MutatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfigurationList#items + */ + readonly items: KubeMutatingWebhookConfigurationV1Beta1Props[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhookConfigurationList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeMutatingWebhookConfigurationListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeMutatingWebhookConfigurationListV1Beta1Props(obj: KubeMutatingWebhookConfigurationListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeMutatingWebhookConfigurationV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. Deprecated in v1.16, planned for removal in v1.19. Use admissionregistration.k8s.io/v1 ValidatingWebhookConfiguration instead. + * + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfiguration + */ +export interface KubeValidatingWebhookConfigurationV1Beta1Props { + /** + * Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + * + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfiguration#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Webhooks is a list of webhooks and the affected resources and operations. + * + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfiguration#webhooks + */ + readonly webhooks?: ValidatingWebhookV1Beta1[]; + +} + +/** + * Converts an object of type 'KubeValidatingWebhookConfigurationV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeValidatingWebhookConfigurationV1Beta1Props(obj: KubeValidatingWebhookConfigurationV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'webhooks': obj.webhooks?.map(y => toJson_ValidatingWebhookV1Beta1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfigurationList + */ +export interface KubeValidatingWebhookConfigurationListV1Beta1Props { + /** + * List of ValidatingWebhookConfiguration. + * + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfigurationList#items + */ + readonly items: KubeValidatingWebhookConfigurationV1Beta1Props[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhookConfigurationList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeValidatingWebhookConfigurationListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeValidatingWebhookConfigurationListV1Beta1Props(obj: KubeValidatingWebhookConfigurationListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeValidatingWebhookConfigurationV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * + * Storage version of a specific resource. + * + * @schema io.k8s.api.apiserverinternal.v1alpha1.StorageVersion + */ +export interface KubeStorageVersionV1Alpha1Props { + /** + * The name is .. + * + * @schema io.k8s.api.apiserverinternal.v1alpha1.StorageVersion#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec is an empty spec. It is here to comply with Kubernetes API style. + * + * @schema io.k8s.api.apiserverinternal.v1alpha1.StorageVersion#spec + */ + readonly spec: any; + +} + +/** + * Converts an object of type 'KubeStorageVersionV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeStorageVersionV1Alpha1Props(obj: KubeStorageVersionV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': obj.spec, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * A list of StorageVersions. + * + * @schema io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList + */ +export interface KubeStorageVersionListV1Alpha1Props { + /** + * @schema io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList#items + */ + readonly items: KubeStorageVersionV1Alpha1Props[]; + + /** + * @schema io.k8s.api.apiserverinternal.v1alpha1.StorageVersionList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeStorageVersionListV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeStorageVersionListV1Alpha1Props(obj: KubeStorageVersionListV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeStorageVersionV1Alpha1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers. + * + * @schema io.k8s.api.apps.v1.ControllerRevision + */ +export interface KubeControllerRevisionProps { + /** + * Data is the serialized representation of the state. + * + * @schema io.k8s.api.apps.v1.ControllerRevision#data + */ + readonly data?: any; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.apps.v1.ControllerRevision#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Revision indicates the revision of the state represented by Data. + * + * @schema io.k8s.api.apps.v1.ControllerRevision#revision + */ + readonly revision: number; + +} + +/** + * Converts an object of type 'KubeControllerRevisionProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeControllerRevisionProps(obj: KubeControllerRevisionProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'data': obj.data, + 'metadata': toJson_ObjectMeta(obj.metadata), + 'revision': obj.revision, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ControllerRevisionList is a resource containing a list of ControllerRevision objects. + * + * @schema io.k8s.api.apps.v1.ControllerRevisionList + */ +export interface KubeControllerRevisionListProps { + /** + * Items is the list of ControllerRevisions + * + * @schema io.k8s.api.apps.v1.ControllerRevisionList#items + */ + readonly items: KubeControllerRevisionProps[]; + + /** + * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.apps.v1.ControllerRevisionList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeControllerRevisionListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeControllerRevisionListProps(obj: KubeControllerRevisionListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeControllerRevisionProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * DaemonSet represents the configuration of a daemon set. + * + * @schema io.k8s.api.apps.v1.DaemonSet + */ +export interface KubeDaemonSetProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.apps.v1.DaemonSet#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.apps.v1.DaemonSet#spec + */ + readonly spec?: DaemonSetSpec; + +} + +/** + * Converts an object of type 'KubeDaemonSetProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeDaemonSetProps(obj: KubeDaemonSetProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_DaemonSetSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * DaemonSetList is a collection of daemon sets. + * + * @schema io.k8s.api.apps.v1.DaemonSetList + */ +export interface KubeDaemonSetListProps { + /** + * A list of daemon sets. + * + * @schema io.k8s.api.apps.v1.DaemonSetList#items + */ + readonly items: KubeDaemonSetProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.apps.v1.DaemonSetList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeDaemonSetListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeDaemonSetListProps(obj: KubeDaemonSetListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeDaemonSetProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Deployment enables declarative updates for Pods and ReplicaSets. + * + * @schema io.k8s.api.apps.v1.Deployment + */ +export interface KubeDeploymentProps { + /** + * Standard object metadata. + * + * @schema io.k8s.api.apps.v1.Deployment#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of the Deployment. + * + * @schema io.k8s.api.apps.v1.Deployment#spec + */ + readonly spec?: DeploymentSpec; + +} + +/** + * Converts an object of type 'KubeDeploymentProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeDeploymentProps(obj: KubeDeploymentProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_DeploymentSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * DeploymentList is a list of Deployments. + * + * @schema io.k8s.api.apps.v1.DeploymentList + */ +export interface KubeDeploymentListProps { + /** + * Items is the list of Deployments. + * + * @schema io.k8s.api.apps.v1.DeploymentList#items + */ + readonly items: KubeDeploymentProps[]; + + /** + * Standard list metadata. + * + * @schema io.k8s.api.apps.v1.DeploymentList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeDeploymentListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeDeploymentListProps(obj: KubeDeploymentListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeDeploymentProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ReplicaSet ensures that a specified number of pod replicas are running at any given time. + * + * @schema io.k8s.api.apps.v1.ReplicaSet + */ +export interface KubeReplicaSetProps { + /** + * If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.apps.v1.ReplicaSet#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.apps.v1.ReplicaSet#spec + */ + readonly spec?: ReplicaSetSpec; + +} + +/** + * Converts an object of type 'KubeReplicaSetProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeReplicaSetProps(obj: KubeReplicaSetProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_ReplicaSetSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ReplicaSetList is a collection of ReplicaSets. + * + * @schema io.k8s.api.apps.v1.ReplicaSetList + */ +export interface KubeReplicaSetListProps { + /** + * List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller + * + * @schema io.k8s.api.apps.v1.ReplicaSetList#items + */ + readonly items: KubeReplicaSetProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.apps.v1.ReplicaSetList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeReplicaSetListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeReplicaSetListProps(obj: KubeReplicaSetListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeReplicaSetProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * StatefulSet represents a set of pods with consistent identities. Identities are defined as: + * - Network: A single stable DNS and hostname. + * - Storage: As many VolumeClaims as requested. + * The StatefulSet guarantees that a given network identity will always map to the same storage identity. + * + * @schema io.k8s.api.apps.v1.StatefulSet + */ +export interface KubeStatefulSetProps { + /** + * @schema io.k8s.api.apps.v1.StatefulSet#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the desired identities of pods in this set. + * + * @schema io.k8s.api.apps.v1.StatefulSet#spec + */ + readonly spec?: StatefulSetSpec; + +} + +/** + * Converts an object of type 'KubeStatefulSetProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeStatefulSetProps(obj: KubeStatefulSetProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_StatefulSetSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * StatefulSetList is a collection of StatefulSets. + * + * @schema io.k8s.api.apps.v1.StatefulSetList + */ +export interface KubeStatefulSetListProps { + /** + * @schema io.k8s.api.apps.v1.StatefulSetList#items + */ + readonly items: KubeStatefulSetProps[]; + + /** + * @schema io.k8s.api.apps.v1.StatefulSetList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeStatefulSetListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeStatefulSetListProps(obj: KubeStatefulSetListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeStatefulSetProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * TokenRequest requests a token for a given service account. + * + * @schema io.k8s.api.authentication.v1.TokenRequest + */ +export interface KubeTokenRequestProps { + /** + * @schema io.k8s.api.authentication.v1.TokenRequest#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * @schema io.k8s.api.authentication.v1.TokenRequest#spec + */ + readonly spec: TokenRequestSpec; + +} + +/** + * Converts an object of type 'KubeTokenRequestProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeTokenRequestProps(obj: KubeTokenRequestProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_TokenRequestSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver. + * + * @schema io.k8s.api.authentication.v1.TokenReview + */ +export interface KubeTokenReviewProps { + /** + * @schema io.k8s.api.authentication.v1.TokenReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated + * + * @schema io.k8s.api.authentication.v1.TokenReview#spec + */ + readonly spec: TokenReviewSpec; + +} + +/** + * Converts an object of type 'KubeTokenReviewProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeTokenReviewProps(obj: KubeTokenReviewProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_TokenReviewSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver. + * + * @schema io.k8s.api.authentication.v1beta1.TokenReview + */ +export interface KubeTokenReviewV1Beta1Props { + /** + * @schema io.k8s.api.authentication.v1beta1.TokenReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated + * + * @schema io.k8s.api.authentication.v1beta1.TokenReview#spec + */ + readonly spec: TokenReviewSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeTokenReviewV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeTokenReviewV1Beta1Props(obj: KubeTokenReviewV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_TokenReviewSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking. + * + * @schema io.k8s.api.authorization.v1.LocalSubjectAccessReview + */ +export interface KubeLocalSubjectAccessReviewProps { + /** + * @schema io.k8s.api.authorization.v1.LocalSubjectAccessReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted. + * + * @schema io.k8s.api.authorization.v1.LocalSubjectAccessReview#spec + */ + readonly spec: SubjectAccessReviewSpec; + +} + +/** + * Converts an object of type 'KubeLocalSubjectAccessReviewProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeLocalSubjectAccessReviewProps(obj: KubeLocalSubjectAccessReviewProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_SubjectAccessReviewSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action + * + * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReview + */ +export interface KubeSelfSubjectAccessReviewProps { + /** + * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated. user and groups must be empty + * + * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReview#spec + */ + readonly spec: SelfSubjectAccessReviewSpec; + +} + +/** + * Converts an object of type 'KubeSelfSubjectAccessReviewProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeSelfSubjectAccessReviewProps(obj: KubeSelfSubjectAccessReviewProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_SelfSubjectAccessReviewSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server. + * + * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReview + */ +export interface KubeSelfSubjectRulesReviewProps { + /** + * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated. + * + * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReview#spec + */ + readonly spec: SelfSubjectRulesReviewSpec; + +} + +/** + * Converts an object of type 'KubeSelfSubjectRulesReviewProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeSelfSubjectRulesReviewProps(obj: KubeSelfSubjectRulesReviewProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_SelfSubjectRulesReviewSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SubjectAccessReview checks whether or not a user or group can perform an action. + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReview + */ +export interface KubeSubjectAccessReviewProps { + /** + * @schema io.k8s.api.authorization.v1.SubjectAccessReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReview#spec + */ + readonly spec: SubjectAccessReviewSpec; + +} + +/** + * Converts an object of type 'KubeSubjectAccessReviewProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeSubjectAccessReviewProps(obj: KubeSubjectAccessReviewProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_SubjectAccessReviewSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking. + * + * @schema io.k8s.api.authorization.v1beta1.LocalSubjectAccessReview + */ +export interface KubeLocalSubjectAccessReviewV1Beta1Props { + /** + * @schema io.k8s.api.authorization.v1beta1.LocalSubjectAccessReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted. + * + * @schema io.k8s.api.authorization.v1beta1.LocalSubjectAccessReview#spec + */ + readonly spec: SubjectAccessReviewSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeLocalSubjectAccessReviewV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeLocalSubjectAccessReviewV1Beta1Props(obj: KubeLocalSubjectAccessReviewV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_SubjectAccessReviewSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action + * + * @schema io.k8s.api.authorization.v1beta1.SelfSubjectAccessReview + */ +export interface KubeSelfSubjectAccessReviewV1Beta1Props { + /** + * @schema io.k8s.api.authorization.v1beta1.SelfSubjectAccessReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated. user and groups must be empty + * + * @schema io.k8s.api.authorization.v1beta1.SelfSubjectAccessReview#spec + */ + readonly spec: SelfSubjectAccessReviewSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeSelfSubjectAccessReviewV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeSelfSubjectAccessReviewV1Beta1Props(obj: KubeSelfSubjectAccessReviewV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_SelfSubjectAccessReviewSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server. + * + * @schema io.k8s.api.authorization.v1beta1.SelfSubjectRulesReview + */ +export interface KubeSelfSubjectRulesReviewV1Beta1Props { + /** + * @schema io.k8s.api.authorization.v1beta1.SelfSubjectRulesReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated. + * + * @schema io.k8s.api.authorization.v1beta1.SelfSubjectRulesReview#spec + */ + readonly spec: SelfSubjectRulesReviewSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeSelfSubjectRulesReviewV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeSelfSubjectRulesReviewV1Beta1Props(obj: KubeSelfSubjectRulesReviewV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_SelfSubjectRulesReviewSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SubjectAccessReview checks whether or not a user or group can perform an action. + * + * @schema io.k8s.api.authorization.v1beta1.SubjectAccessReview + */ +export interface KubeSubjectAccessReviewV1Beta1Props { + /** + * @schema io.k8s.api.authorization.v1beta1.SubjectAccessReview#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec holds information about the request being evaluated + * + * @schema io.k8s.api.authorization.v1beta1.SubjectAccessReview#spec + */ + readonly spec: SubjectAccessReviewSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeSubjectAccessReviewV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeSubjectAccessReviewV1Beta1Props(obj: KubeSubjectAccessReviewV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_SubjectAccessReviewSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * configuration of a horizontal pod autoscaler. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler + */ +export interface KubeHorizontalPodAutoscalerProps { + /** + * Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler#spec + */ + readonly spec?: HorizontalPodAutoscalerSpec; + +} + +/** + * Converts an object of type 'KubeHorizontalPodAutoscalerProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeHorizontalPodAutoscalerProps(obj: KubeHorizontalPodAutoscalerProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_HorizontalPodAutoscalerSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * list of horizontal pod autoscaler objects. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList + */ +export interface KubeHorizontalPodAutoscalerListProps { + /** + * list of horizontal pod autoscaler objects. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList#items + */ + readonly items: KubeHorizontalPodAutoscalerProps[]; + + /** + * Standard list metadata. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeHorizontalPodAutoscalerListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeHorizontalPodAutoscalerListProps(obj: KubeHorizontalPodAutoscalerListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeHorizontalPodAutoscalerProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Scale represents a scaling request for a resource. + * + * @schema io.k8s.api.autoscaling.v1.Scale + */ +export interface KubeScaleProps { + /** + * Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. + * + * @schema io.k8s.api.autoscaling.v1.Scale#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. + * + * @schema io.k8s.api.autoscaling.v1.Scale#spec + */ + readonly spec?: ScaleSpec; + +} + +/** + * Converts an object of type 'KubeScaleProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeScaleProps(obj: KubeScaleProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_ScaleSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified. + * + * @schema io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscaler + */ +export interface KubeHorizontalPodAutoscalerV2Beta1Props { + /** + * metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscaler#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. + * + * @schema io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscaler#spec + */ + readonly spec?: HorizontalPodAutoscalerSpecV2Beta1; + +} + +/** + * Converts an object of type 'KubeHorizontalPodAutoscalerV2Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeHorizontalPodAutoscalerV2Beta1Props(obj: KubeHorizontalPodAutoscalerV2Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_HorizontalPodAutoscalerSpecV2Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HorizontalPodAutoscaler is a list of horizontal pod autoscaler objects. + * + * @schema io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerList + */ +export interface KubeHorizontalPodAutoscalerListV2Beta1Props { + /** + * items is the list of horizontal pod autoscaler objects. + * + * @schema io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerList#items + */ + readonly items: KubeHorizontalPodAutoscalerV2Beta1Props[]; + + /** + * metadata is the standard list metadata. + * + * @schema io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeHorizontalPodAutoscalerListV2Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeHorizontalPodAutoscalerListV2Beta1Props(obj: KubeHorizontalPodAutoscalerListV2Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeHorizontalPodAutoscalerV2Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified. + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscaler + */ +export interface KubeHorizontalPodAutoscalerV2Beta2Props { + /** + * metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscaler#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscaler#spec + */ + readonly spec?: HorizontalPodAutoscalerSpecV2Beta2; + +} + +/** + * Converts an object of type 'KubeHorizontalPodAutoscalerV2Beta2Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeHorizontalPodAutoscalerV2Beta2Props(obj: KubeHorizontalPodAutoscalerV2Beta2Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_HorizontalPodAutoscalerSpecV2Beta2(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects. + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerList + */ +export interface KubeHorizontalPodAutoscalerListV2Beta2Props { + /** + * items is the list of horizontal pod autoscaler objects. + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerList#items + */ + readonly items: KubeHorizontalPodAutoscalerV2Beta2Props[]; + + /** + * metadata is the standard list metadata. + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeHorizontalPodAutoscalerListV2Beta2Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeHorizontalPodAutoscalerListV2Beta2Props(obj: KubeHorizontalPodAutoscalerListV2Beta2Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeHorizontalPodAutoscalerV2Beta2Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CronJob represents the configuration of a single cron job. + * + * @schema io.k8s.api.batch.v1.CronJob + */ +export interface KubeCronJobProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.batch.v1.CronJob#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.batch.v1.CronJob#spec + */ + readonly spec?: CronJobSpec; + +} + +/** + * Converts an object of type 'KubeCronJobProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCronJobProps(obj: KubeCronJobProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_CronJobSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CronJobList is a collection of cron jobs. + * + * @schema io.k8s.api.batch.v1.CronJobList + */ +export interface KubeCronJobListProps { + /** + * items is the list of CronJobs. + * + * @schema io.k8s.api.batch.v1.CronJobList#items + */ + readonly items: KubeCronJobProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.batch.v1.CronJobList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeCronJobListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCronJobListProps(obj: KubeCronJobListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeCronJobProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Job represents the configuration of a single job. + * + * @schema io.k8s.api.batch.v1.Job + */ +export interface KubeJobProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.batch.v1.Job#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.batch.v1.Job#spec + */ + readonly spec?: JobSpec; + +} + +/** + * Converts an object of type 'KubeJobProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeJobProps(obj: KubeJobProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_JobSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * JobList is a collection of jobs. + * + * @schema io.k8s.api.batch.v1.JobList + */ +export interface KubeJobListProps { + /** + * items is the list of Jobs. + * + * @schema io.k8s.api.batch.v1.JobList#items + */ + readonly items: KubeJobProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.batch.v1.JobList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeJobListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeJobListProps(obj: KubeJobListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeJobProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CronJob represents the configuration of a single cron job. + * + * @schema io.k8s.api.batch.v1beta1.CronJob + */ +export interface KubeCronJobV1Beta1Props { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.batch.v1beta1.CronJob#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.batch.v1beta1.CronJob#spec + */ + readonly spec?: CronJobSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeCronJobV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCronJobV1Beta1Props(obj: KubeCronJobV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_CronJobSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CronJobList is a collection of cron jobs. + * + * @schema io.k8s.api.batch.v1beta1.CronJobList + */ +export interface KubeCronJobListV1Beta1Props { + /** + * items is the list of CronJobs. + * + * @schema io.k8s.api.batch.v1beta1.CronJobList#items + */ + readonly items: KubeCronJobV1Beta1Props[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.batch.v1beta1.CronJobList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeCronJobListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCronJobListV1Beta1Props(obj: KubeCronJobListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeCronJobV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request, and having it asynchronously approved and issued. + * + * Kubelets use this API to obtain: + * 1. client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client-kubelet" signerName). + * 2. serving certificates for TLS endpoints kube-apiserver can connect to securely (with the "kubernetes.io/kubelet-serving" signerName). + * + * This API can be used to request client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client" signerName), or to obtain certificates from custom non-Kubernetes signers. + * + * @schema io.k8s.api.certificates.v1.CertificateSigningRequest + */ +export interface KubeCertificateSigningRequestProps { + /** + * @schema io.k8s.api.certificates.v1.CertificateSigningRequest#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * spec contains the certificate request, and is immutable after creation. Only the request, signerName, and usages fields can be set on creation. Other fields are derived by Kubernetes and cannot be modified by users. + * + * @schema io.k8s.api.certificates.v1.CertificateSigningRequest#spec + */ + readonly spec: CertificateSigningRequestSpec; + +} + +/** + * Converts an object of type 'KubeCertificateSigningRequestProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCertificateSigningRequestProps(obj: KubeCertificateSigningRequestProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_CertificateSigningRequestSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CertificateSigningRequestList is a collection of CertificateSigningRequest objects + * + * @schema io.k8s.api.certificates.v1.CertificateSigningRequestList + */ +export interface KubeCertificateSigningRequestListProps { + /** + * items is a collection of CertificateSigningRequest objects + * + * @schema io.k8s.api.certificates.v1.CertificateSigningRequestList#items + */ + readonly items: KubeCertificateSigningRequestProps[]; + + /** + * @schema io.k8s.api.certificates.v1.CertificateSigningRequestList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeCertificateSigningRequestListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCertificateSigningRequestListProps(obj: KubeCertificateSigningRequestListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeCertificateSigningRequestProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Describes a certificate signing request + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequest + */ +export interface KubeCertificateSigningRequestV1Beta1Props { + /** + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequest#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * The certificate request itself and any additional information. + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequest#spec + */ + readonly spec?: CertificateSigningRequestSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeCertificateSigningRequestV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCertificateSigningRequestV1Beta1Props(obj: KubeCertificateSigningRequestV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_CertificateSigningRequestSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestList + */ +export interface KubeCertificateSigningRequestListV1Beta1Props { + /** + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestList#items + */ + readonly items: KubeCertificateSigningRequestV1Beta1Props[]; + + /** + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeCertificateSigningRequestListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCertificateSigningRequestListV1Beta1Props(obj: KubeCertificateSigningRequestListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeCertificateSigningRequestV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Lease defines a lease concept. + * + * @schema io.k8s.api.coordination.v1.Lease + */ +export interface KubeLeaseProps { + /** + * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.coordination.v1.Lease#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.coordination.v1.Lease#spec + */ + readonly spec?: LeaseSpec; + +} + +/** + * Converts an object of type 'KubeLeaseProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeLeaseProps(obj: KubeLeaseProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_LeaseSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * LeaseList is a list of Lease objects. + * + * @schema io.k8s.api.coordination.v1.LeaseList + */ +export interface KubeLeaseListProps { + /** + * Items is a list of schema objects. + * + * @schema io.k8s.api.coordination.v1.LeaseList#items + */ + readonly items: KubeLeaseProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.coordination.v1.LeaseList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeLeaseListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeLeaseListProps(obj: KubeLeaseListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeLeaseProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Lease defines a lease concept. + * + * @schema io.k8s.api.coordination.v1beta1.Lease + */ +export interface KubeLeaseV1Beta1Props { + /** + * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.coordination.v1beta1.Lease#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.coordination.v1beta1.Lease#spec + */ + readonly spec?: LeaseSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeLeaseV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeLeaseV1Beta1Props(obj: KubeLeaseV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_LeaseSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * LeaseList is a list of Lease objects. + * + * @schema io.k8s.api.coordination.v1beta1.LeaseList + */ +export interface KubeLeaseListV1Beta1Props { + /** + * Items is a list of schema objects. + * + * @schema io.k8s.api.coordination.v1beta1.LeaseList#items + */ + readonly items: KubeLeaseV1Beta1Props[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.coordination.v1beta1.LeaseList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeLeaseListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeLeaseListV1Beta1Props(obj: KubeLeaseListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeLeaseV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead. + * + * @schema io.k8s.api.core.v1.Binding + */ +export interface KubeBindingProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Binding#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * The target object that you want to bind to the standard object. + * + * @schema io.k8s.api.core.v1.Binding#target + */ + readonly target: ObjectReference; + +} + +/** + * Converts an object of type 'KubeBindingProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeBindingProps(obj: KubeBindingProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'target': toJson_ObjectReference(obj.target), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+ + * + * @schema io.k8s.api.core.v1.ComponentStatus + */ +export interface KubeComponentStatusProps { + /** + * List of component conditions observed + * + * @schema io.k8s.api.core.v1.ComponentStatus#conditions + */ + readonly conditions?: ComponentCondition[]; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.ComponentStatus#metadata + */ + readonly metadata?: ObjectMeta; + +} + +/** + * Converts an object of type 'KubeComponentStatusProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeComponentStatusProps(obj: KubeComponentStatusProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'conditions': obj.conditions?.map(y => toJson_ComponentCondition(y)), + 'metadata': toJson_ObjectMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+ + * + * @schema io.k8s.api.core.v1.ComponentStatusList + */ +export interface KubeComponentStatusListProps { + /** + * List of ComponentStatus objects. + * + * @schema io.k8s.api.core.v1.ComponentStatusList#items + */ + readonly items: KubeComponentStatusProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.ComponentStatusList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeComponentStatusListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeComponentStatusListProps(obj: KubeComponentStatusListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeComponentStatusProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ConfigMap holds configuration data for pods to consume. + * + * @schema io.k8s.api.core.v1.ConfigMap + */ +export interface KubeConfigMapProps { + /** + * BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet. + * + * @schema io.k8s.api.core.v1.ConfigMap#binaryData + */ + readonly binaryData?: { [key: string]: string }; + + /** + * Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process. + * + * @schema io.k8s.api.core.v1.ConfigMap#data + */ + readonly data?: { [key: string]: string }; + + /** + * Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. + * + * @schema io.k8s.api.core.v1.ConfigMap#immutable + */ + readonly immutable?: boolean; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.ConfigMap#metadata + */ + readonly metadata?: ObjectMeta; + +} + +/** + * Converts an object of type 'KubeConfigMapProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeConfigMapProps(obj: KubeConfigMapProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'binaryData': ((obj.binaryData) === undefined) ? undefined : (Object.entries(obj.binaryData).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'data': ((obj.data) === undefined) ? undefined : (Object.entries(obj.data).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'immutable': obj.immutable, + 'metadata': toJson_ObjectMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ConfigMapList is a resource containing a list of ConfigMap objects. + * + * @schema io.k8s.api.core.v1.ConfigMapList + */ +export interface KubeConfigMapListProps { + /** + * Items is the list of ConfigMaps. + * + * @schema io.k8s.api.core.v1.ConfigMapList#items + */ + readonly items: KubeConfigMapProps[]; + + /** + * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.ConfigMapList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeConfigMapListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeConfigMapListProps(obj: KubeConfigMapListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeConfigMapProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Endpoints is a collection of endpoints that implement the actual service. Example: + * Name: "mysvc", + * Subsets: [ + * { + * Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + * Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + * }, + * { + * Addresses: [{"ip": "10.10.3.3"}], + * Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] + * }, + * ] + * + * @schema io.k8s.api.core.v1.Endpoints + */ +export interface KubeEndpointsProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Endpoints#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. + * + * @schema io.k8s.api.core.v1.Endpoints#subsets + */ + readonly subsets?: EndpointSubset[]; + +} + +/** + * Converts an object of type 'KubeEndpointsProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeEndpointsProps(obj: KubeEndpointsProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'subsets': obj.subsets?.map(y => toJson_EndpointSubset(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EndpointsList is a list of endpoints. + * + * @schema io.k8s.api.core.v1.EndpointsList + */ +export interface KubeEndpointsListProps { + /** + * List of endpoints. + * + * @schema io.k8s.api.core.v1.EndpointsList#items + */ + readonly items: KubeEndpointsProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.EndpointsList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeEndpointsListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeEndpointsListProps(obj: KubeEndpointsListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeEndpointsProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * A list of ephemeral containers used with the Pod ephemeralcontainers subresource. + * + * @schema io.k8s.api.core.v1.EphemeralContainers + */ +export interface KubeEphemeralContainersProps { + /** + * A list of ephemeral containers associated with this pod. New ephemeral containers may be appended to this list, but existing ephemeral containers may not be removed or modified. + * + * @schema io.k8s.api.core.v1.EphemeralContainers#ephemeralContainers + */ + readonly ephemeralContainers: EphemeralContainer[]; + + /** + * @schema io.k8s.api.core.v1.EphemeralContainers#metadata + */ + readonly metadata?: ObjectMeta; + +} + +/** + * Converts an object of type 'KubeEphemeralContainersProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeEphemeralContainersProps(obj: KubeEphemeralContainersProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'ephemeralContainers': obj.ephemeralContainers?.map(y => toJson_EphemeralContainer(y)), + 'metadata': toJson_ObjectMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data. + * + * @schema io.k8s.api.events.v1.Event + */ +export interface KubeEventProps { + /** + * action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters. + * + * @schema io.k8s.api.events.v1.Event#action + */ + readonly action?: string; + + /** + * deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. + * + * @schema io.k8s.api.events.v1.Event#deprecatedCount + */ + readonly deprecatedCount?: number; + + /** + * deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. + * + * @schema io.k8s.api.events.v1.Event#deprecatedFirstTimestamp + */ + readonly deprecatedFirstTimestamp?: Date; + + /** + * deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. + * + * @schema io.k8s.api.events.v1.Event#deprecatedLastTimestamp + */ + readonly deprecatedLastTimestamp?: Date; + + /** + * deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. + * + * @schema io.k8s.api.events.v1.Event#deprecatedSource + */ + readonly deprecatedSource?: EventSource; + + /** + * eventTime is the time when this Event was first observed. It is required. + * + * @schema io.k8s.api.events.v1.Event#eventTime + */ + readonly eventTime: Date; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.events.v1.Event#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * note is a human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB. + * + * @schema io.k8s.api.events.v1.Event#note + */ + readonly note?: string; + + /** + * reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters. + * + * @schema io.k8s.api.events.v1.Event#reason + */ + readonly reason?: string; + + /** + * regarding contains the object this Event is about. In most cases it's an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object. + * + * @schema io.k8s.api.events.v1.Event#regarding + */ + readonly regarding?: ObjectReference; + + /** + * related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object. + * + * @schema io.k8s.api.events.v1.Event#related + */ + readonly related?: ObjectReference; + + /** + * reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events. + * + * @schema io.k8s.api.events.v1.Event#reportingController + */ + readonly reportingController?: string; + + /** + * reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters. + * + * @schema io.k8s.api.events.v1.Event#reportingInstance + */ + readonly reportingInstance?: string; + + /** + * series is data about the Event series this event represents or nil if it's a singleton Event. + * + * @schema io.k8s.api.events.v1.Event#series + */ + readonly series?: EventSeries; + + /** + * type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. This field cannot be empty for new Events. + * + * @schema io.k8s.api.events.v1.Event#type + */ + readonly type?: string; + +} + +/** + * Converts an object of type 'KubeEventProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeEventProps(obj: KubeEventProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'action': obj.action, + 'deprecatedCount': obj.deprecatedCount, + 'deprecatedFirstTimestamp': obj.deprecatedFirstTimestamp?.toISOString(), + 'deprecatedLastTimestamp': obj.deprecatedLastTimestamp?.toISOString(), + 'deprecatedSource': toJson_EventSource(obj.deprecatedSource), + 'eventTime': obj.eventTime?.toISOString(), + 'metadata': toJson_ObjectMeta(obj.metadata), + 'note': obj.note, + 'reason': obj.reason, + 'regarding': toJson_ObjectReference(obj.regarding), + 'related': toJson_ObjectReference(obj.related), + 'reportingController': obj.reportingController, + 'reportingInstance': obj.reportingInstance, + 'series': toJson_EventSeries(obj.series), + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EventList is a list of Event objects. + * + * @schema io.k8s.api.events.v1.EventList + */ +export interface KubeEventListProps { + /** + * items is a list of schema objects. + * + * @schema io.k8s.api.events.v1.EventList#items + */ + readonly items: KubeEventProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.events.v1.EventList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeEventListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeEventListProps(obj: KubeEventListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeEventProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * LimitRange sets resource usage limits for each kind of resource in a Namespace. + * + * @schema io.k8s.api.core.v1.LimitRange + */ +export interface KubeLimitRangeProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.LimitRange#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.LimitRange#spec + */ + readonly spec?: LimitRangeSpec; + +} + +/** + * Converts an object of type 'KubeLimitRangeProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeLimitRangeProps(obj: KubeLimitRangeProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_LimitRangeSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * LimitRangeList is a list of LimitRange items. + * + * @schema io.k8s.api.core.v1.LimitRangeList + */ +export interface KubeLimitRangeListProps { + /** + * Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + * + * @schema io.k8s.api.core.v1.LimitRangeList#items + */ + readonly items: KubeLimitRangeProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.LimitRangeList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeLimitRangeListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeLimitRangeListProps(obj: KubeLimitRangeListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeLimitRangeProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Namespace provides a scope for Names. Use of multiple namespaces is optional. + * + * @schema io.k8s.api.core.v1.Namespace + */ +export interface KubeNamespaceProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Namespace#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.Namespace#spec + */ + readonly spec?: NamespaceSpec; + +} + +/** + * Converts an object of type 'KubeNamespaceProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeNamespaceProps(obj: KubeNamespaceProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_NamespaceSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NamespaceList is a list of Namespaces. + * + * @schema io.k8s.api.core.v1.NamespaceList + */ +export interface KubeNamespaceListProps { + /** + * Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + * + * @schema io.k8s.api.core.v1.NamespaceList#items + */ + readonly items: KubeNamespaceProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.NamespaceList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeNamespaceListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeNamespaceListProps(obj: KubeNamespaceListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeNamespaceProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd). + * + * @schema io.k8s.api.core.v1.Node + */ +export interface KubeNodeProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Node#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.Node#spec + */ + readonly spec?: NodeSpec; + +} + +/** + * Converts an object of type 'KubeNodeProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeNodeProps(obj: KubeNodeProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_NodeSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NodeList is the whole list of all Nodes which have been registered with master. + * + * @schema io.k8s.api.core.v1.NodeList + */ +export interface KubeNodeListProps { + /** + * List of nodes + * + * @schema io.k8s.api.core.v1.NodeList#items + */ + readonly items: KubeNodeProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.NodeList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeNodeListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeNodeListProps(obj: KubeNodeListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeNodeProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes + * + * @schema io.k8s.api.core.v1.PersistentVolume + */ +export interface KubePersistentVolumeProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.PersistentVolume#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes + * + * @schema io.k8s.api.core.v1.PersistentVolume#spec + */ + readonly spec?: PersistentVolumeSpec; + +} + +/** + * Converts an object of type 'KubePersistentVolumeProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePersistentVolumeProps(obj: KubePersistentVolumeProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_PersistentVolumeSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PersistentVolumeClaim is a user's request for and claim to a persistent volume + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaim + */ +export interface KubePersistentVolumeClaimProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaim#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaim#spec + */ + readonly spec?: PersistentVolumeClaimSpec; + +} + +/** + * Converts an object of type 'KubePersistentVolumeClaimProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePersistentVolumeClaimProps(obj: KubePersistentVolumeClaimProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_PersistentVolumeClaimSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PersistentVolumeClaimList is a list of PersistentVolumeClaim items. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimList + */ +export interface KubePersistentVolumeClaimListProps { + /** + * A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimList#items + */ + readonly items: KubePersistentVolumeClaimProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubePersistentVolumeClaimListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePersistentVolumeClaimListProps(obj: KubePersistentVolumeClaimListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubePersistentVolumeClaimProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PersistentVolumeList is a list of PersistentVolume items. + * + * @schema io.k8s.api.core.v1.PersistentVolumeList + */ +export interface KubePersistentVolumeListProps { + /** + * List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes + * + * @schema io.k8s.api.core.v1.PersistentVolumeList#items + */ + readonly items: KubePersistentVolumeProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.PersistentVolumeList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubePersistentVolumeListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePersistentVolumeListProps(obj: KubePersistentVolumeListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubePersistentVolumeProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts. + * + * @schema io.k8s.api.core.v1.Pod + */ +export interface KubePodProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Pod#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.Pod#spec + */ + readonly spec?: PodSpec; + +} + +/** + * Converts an object of type 'KubePodProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePodProps(obj: KubePodProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_PodSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodList is a list of Pods. + * + * @schema io.k8s.api.core.v1.PodList + */ +export interface KubePodListProps { + /** + * List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md + * + * @schema io.k8s.api.core.v1.PodList#items + */ + readonly items: KubePodProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.PodList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubePodListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePodListProps(obj: KubePodListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubePodProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodTemplate describes a template for creating copies of a predefined pod. + * + * @schema io.k8s.api.core.v1.PodTemplate + */ +export interface KubePodTemplateProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.PodTemplate#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.PodTemplate#template + */ + readonly template?: PodTemplateSpec; + +} + +/** + * Converts an object of type 'KubePodTemplateProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePodTemplateProps(obj: KubePodTemplateProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'template': toJson_PodTemplateSpec(obj.template), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodTemplateList is a list of PodTemplates. + * + * @schema io.k8s.api.core.v1.PodTemplateList + */ +export interface KubePodTemplateListProps { + /** + * List of pod templates + * + * @schema io.k8s.api.core.v1.PodTemplateList#items + */ + readonly items: KubePodTemplateProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.PodTemplateList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubePodTemplateListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePodTemplateListProps(obj: KubePodTemplateListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubePodTemplateProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ReplicationController represents the configuration of a replication controller. + * + * @schema io.k8s.api.core.v1.ReplicationController + */ +export interface KubeReplicationControllerProps { + /** + * If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.ReplicationController#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.ReplicationController#spec + */ + readonly spec?: ReplicationControllerSpec; + +} + +/** + * Converts an object of type 'KubeReplicationControllerProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeReplicationControllerProps(obj: KubeReplicationControllerProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_ReplicationControllerSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ReplicationControllerList is a collection of replication controllers. + * + * @schema io.k8s.api.core.v1.ReplicationControllerList + */ +export interface KubeReplicationControllerListProps { + /** + * List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller + * + * @schema io.k8s.api.core.v1.ReplicationControllerList#items + */ + readonly items: KubeReplicationControllerProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.ReplicationControllerList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeReplicationControllerListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeReplicationControllerListProps(obj: KubeReplicationControllerListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeReplicationControllerProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ResourceQuota sets aggregate quota restrictions enforced per namespace + * + * @schema io.k8s.api.core.v1.ResourceQuota + */ +export interface KubeResourceQuotaProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.ResourceQuota#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.ResourceQuota#spec + */ + readonly spec?: ResourceQuotaSpec; + +} + +/** + * Converts an object of type 'KubeResourceQuotaProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeResourceQuotaProps(obj: KubeResourceQuotaProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_ResourceQuotaSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ResourceQuotaList is a list of ResourceQuota items. + * + * @schema io.k8s.api.core.v1.ResourceQuotaList + */ +export interface KubeResourceQuotaListProps { + /** + * Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ + * + * @schema io.k8s.api.core.v1.ResourceQuotaList#items + */ + readonly items: KubeResourceQuotaProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.ResourceQuotaList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeResourceQuotaListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeResourceQuotaListProps(obj: KubeResourceQuotaListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeResourceQuotaProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes. + * + * @schema io.k8s.api.core.v1.Secret + */ +export interface KubeSecretProps { + /** + * Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 + * + * @schema io.k8s.api.core.v1.Secret#data + */ + readonly data?: { [key: string]: string }; + + /** + * Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. + * + * @schema io.k8s.api.core.v1.Secret#immutable + */ + readonly immutable?: boolean; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Secret#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API. + * + * @schema io.k8s.api.core.v1.Secret#stringData + */ + readonly stringData?: { [key: string]: string }; + + /** + * Used to facilitate programmatic handling of secret data. + * + * @schema io.k8s.api.core.v1.Secret#type + */ + readonly type?: string; + +} + +/** + * Converts an object of type 'KubeSecretProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeSecretProps(obj: KubeSecretProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'data': ((obj.data) === undefined) ? undefined : (Object.entries(obj.data).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'immutable': obj.immutable, + 'metadata': toJson_ObjectMeta(obj.metadata), + 'stringData': ((obj.stringData) === undefined) ? undefined : (Object.entries(obj.stringData).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SecretList is a list of Secret. + * + * @schema io.k8s.api.core.v1.SecretList + */ +export interface KubeSecretListProps { + /** + * Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret + * + * @schema io.k8s.api.core.v1.SecretList#items + */ + readonly items: KubeSecretProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.SecretList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeSecretListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeSecretListProps(obj: KubeSecretListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeSecretProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy. + * + * @schema io.k8s.api.core.v1.Service + */ +export interface KubeServiceProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.Service#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.Service#spec + */ + readonly spec?: ServiceSpec; + +} + +/** + * Converts an object of type 'KubeServiceProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeServiceProps(obj: KubeServiceProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_ServiceSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets + * + * @schema io.k8s.api.core.v1.ServiceAccount + */ +export interface KubeServiceAccountProps { + /** + * AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level. + * + * @schema io.k8s.api.core.v1.ServiceAccount#automountServiceAccountToken + */ + readonly automountServiceAccountToken?: boolean; + + /** + * ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod + * + * @schema io.k8s.api.core.v1.ServiceAccount#imagePullSecrets + */ + readonly imagePullSecrets?: LocalObjectReference[]; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.ServiceAccount#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret + * + * @schema io.k8s.api.core.v1.ServiceAccount#secrets + */ + readonly secrets?: ObjectReference[]; + +} + +/** + * Converts an object of type 'KubeServiceAccountProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeServiceAccountProps(obj: KubeServiceAccountProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'automountServiceAccountToken': obj.automountServiceAccountToken, + 'imagePullSecrets': obj.imagePullSecrets?.map(y => toJson_LocalObjectReference(y)), + 'metadata': toJson_ObjectMeta(obj.metadata), + 'secrets': obj.secrets?.map(y => toJson_ObjectReference(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ServiceAccountList is a list of ServiceAccount objects + * + * @schema io.k8s.api.core.v1.ServiceAccountList + */ +export interface KubeServiceAccountListProps { + /** + * List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ + * + * @schema io.k8s.api.core.v1.ServiceAccountList#items + */ + readonly items: KubeServiceAccountProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.ServiceAccountList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeServiceAccountListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeServiceAccountListProps(obj: KubeServiceAccountListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeServiceAccountProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ServiceList holds a list of services. + * + * @schema io.k8s.api.core.v1.ServiceList + */ +export interface KubeServiceListProps { + /** + * List of services + * + * @schema io.k8s.api.core.v1.ServiceList#items + */ + readonly items: KubeServiceProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.ServiceList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeServiceListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeServiceListProps(obj: KubeServiceListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeServiceProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. + * + * @schema io.k8s.api.discovery.v1.EndpointSlice + */ +export interface KubeEndpointSliceProps { + /** + * addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name. + * + * @schema io.k8s.api.discovery.v1.EndpointSlice#addressType + */ + readonly addressType: string; + + /** + * endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints. + * + * @schema io.k8s.api.discovery.v1.EndpointSlice#endpoints + */ + readonly endpoints: Endpoint[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.discovery.v1.EndpointSlice#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports. + * + * @schema io.k8s.api.discovery.v1.EndpointSlice#ports + */ + readonly ports?: EndpointPort[]; + +} + +/** + * Converts an object of type 'KubeEndpointSliceProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeEndpointSliceProps(obj: KubeEndpointSliceProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'addressType': obj.addressType, + 'endpoints': obj.endpoints?.map(y => toJson_Endpoint(y)), + 'metadata': toJson_ObjectMeta(obj.metadata), + 'ports': obj.ports?.map(y => toJson_EndpointPort(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EndpointSliceList represents a list of endpoint slices + * + * @schema io.k8s.api.discovery.v1.EndpointSliceList + */ +export interface KubeEndpointSliceListProps { + /** + * List of endpoint slices + * + * @schema io.k8s.api.discovery.v1.EndpointSliceList#items + */ + readonly items: KubeEndpointSliceProps[]; + + /** + * Standard list metadata. + * + * @schema io.k8s.api.discovery.v1.EndpointSliceList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeEndpointSliceListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeEndpointSliceListProps(obj: KubeEndpointSliceListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeEndpointSliceProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSlice + */ +export interface KubeEndpointSliceV1Beta1Props { + /** + * addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSlice#addressType + */ + readonly addressType: string; + + /** + * endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSlice#endpoints + */ + readonly endpoints: EndpointV1Beta1[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSlice#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSlice#ports + */ + readonly ports?: EndpointPortV1Beta1[]; + +} + +/** + * Converts an object of type 'KubeEndpointSliceV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeEndpointSliceV1Beta1Props(obj: KubeEndpointSliceV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'addressType': obj.addressType, + 'endpoints': obj.endpoints?.map(y => toJson_EndpointV1Beta1(y)), + 'metadata': toJson_ObjectMeta(obj.metadata), + 'ports': obj.ports?.map(y => toJson_EndpointPortV1Beta1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EndpointSliceList represents a list of endpoint slices + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSliceList + */ +export interface KubeEndpointSliceListV1Beta1Props { + /** + * List of endpoint slices + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSliceList#items + */ + readonly items: KubeEndpointSliceV1Beta1Props[]; + + /** + * Standard list metadata. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointSliceList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeEndpointSliceListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeEndpointSliceListV1Beta1Props(obj: KubeEndpointSliceListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeEndpointSliceV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data. + * + * @schema io.k8s.api.events.v1beta1.Event + */ +export interface KubeEventV1Beta1Props { + /** + * action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field can have at most 128 characters. + * + * @schema io.k8s.api.events.v1beta1.Event#action + */ + readonly action?: string; + + /** + * deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. + * + * @schema io.k8s.api.events.v1beta1.Event#deprecatedCount + */ + readonly deprecatedCount?: number; + + /** + * deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. + * + * @schema io.k8s.api.events.v1beta1.Event#deprecatedFirstTimestamp + */ + readonly deprecatedFirstTimestamp?: Date; + + /** + * deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. + * + * @schema io.k8s.api.events.v1beta1.Event#deprecatedLastTimestamp + */ + readonly deprecatedLastTimestamp?: Date; + + /** + * deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. + * + * @schema io.k8s.api.events.v1beta1.Event#deprecatedSource + */ + readonly deprecatedSource?: EventSource; + + /** + * eventTime is the time when this Event was first observed. It is required. + * + * @schema io.k8s.api.events.v1beta1.Event#eventTime + */ + readonly eventTime: Date; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.events.v1beta1.Event#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * note is a human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB. + * + * @schema io.k8s.api.events.v1beta1.Event#note + */ + readonly note?: string; + + /** + * reason is why the action was taken. It is human-readable. This field can have at most 128 characters. + * + * @schema io.k8s.api.events.v1beta1.Event#reason + */ + readonly reason?: string; + + /** + * regarding contains the object this Event is about. In most cases it's an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object. + * + * @schema io.k8s.api.events.v1beta1.Event#regarding + */ + readonly regarding?: ObjectReference; + + /** + * related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object. + * + * @schema io.k8s.api.events.v1beta1.Event#related + */ + readonly related?: ObjectReference; + + /** + * reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events. + * + * @schema io.k8s.api.events.v1beta1.Event#reportingController + */ + readonly reportingController?: string; + + /** + * reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters. + * + * @schema io.k8s.api.events.v1beta1.Event#reportingInstance + */ + readonly reportingInstance?: string; + + /** + * series is data about the Event series this event represents or nil if it's a singleton Event. + * + * @schema io.k8s.api.events.v1beta1.Event#series + */ + readonly series?: EventSeriesV1Beta1; + + /** + * type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. + * + * @schema io.k8s.api.events.v1beta1.Event#type + */ + readonly type?: string; + +} + +/** + * Converts an object of type 'KubeEventV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeEventV1Beta1Props(obj: KubeEventV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'action': obj.action, + 'deprecatedCount': obj.deprecatedCount, + 'deprecatedFirstTimestamp': obj.deprecatedFirstTimestamp?.toISOString(), + 'deprecatedLastTimestamp': obj.deprecatedLastTimestamp?.toISOString(), + 'deprecatedSource': toJson_EventSource(obj.deprecatedSource), + 'eventTime': obj.eventTime?.toISOString(), + 'metadata': toJson_ObjectMeta(obj.metadata), + 'note': obj.note, + 'reason': obj.reason, + 'regarding': toJson_ObjectReference(obj.regarding), + 'related': toJson_ObjectReference(obj.related), + 'reportingController': obj.reportingController, + 'reportingInstance': obj.reportingInstance, + 'series': toJson_EventSeriesV1Beta1(obj.series), + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EventList is a list of Event objects. + * + * @schema io.k8s.api.events.v1beta1.EventList + */ +export interface KubeEventListV1Beta1Props { + /** + * items is a list of schema objects. + * + * @schema io.k8s.api.events.v1beta1.EventList#items + */ + readonly items: KubeEventV1Beta1Props[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.events.v1beta1.EventList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeEventListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeEventListV1Beta1Props(obj: KubeEventListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeEventV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. + * + * @schema io.k8s.api.networking.v1beta1.Ingress + */ +export interface KubeIngressV1Beta1Props { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.networking.v1beta1.Ingress#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.networking.v1beta1.Ingress#spec + */ + readonly spec?: IngressSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeIngressV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeIngressV1Beta1Props(obj: KubeIngressV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_IngressSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressList is a collection of Ingress. + * + * @schema io.k8s.api.networking.v1beta1.IngressList + */ +export interface KubeIngressListV1Beta1Props { + /** + * Items is the list of Ingress. + * + * @schema io.k8s.api.networking.v1beta1.IngressList#items + */ + readonly items: KubeIngressV1Beta1Props[]; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.networking.v1beta1.IngressList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeIngressListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeIngressListV1Beta1Props(obj: KubeIngressListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeIngressV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher". + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowSchema + */ +export interface KubeFlowSchemaV1Beta1Props { + /** + * `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowSchema#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * `spec` is the specification of the desired behavior of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowSchema#spec + */ + readonly spec?: FlowSchemaSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeFlowSchemaV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeFlowSchemaV1Beta1Props(obj: KubeFlowSchemaV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_FlowSchemaSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * FlowSchemaList is a list of FlowSchema objects. + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowSchemaList + */ +export interface KubeFlowSchemaListV1Beta1Props { + /** + * `items` is a list of FlowSchemas. + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowSchemaList#items + */ + readonly items: KubeFlowSchemaV1Beta1Props[]; + + /** + * `metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowSchemaList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeFlowSchemaListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeFlowSchemaListV1Beta1Props(obj: KubeFlowSchemaListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeFlowSchemaV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PriorityLevelConfiguration represents the configuration of a priority level. + * + * @schema io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfiguration + */ +export interface KubePriorityLevelConfigurationV1Beta1Props { + /** + * `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfiguration#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * `spec` is the specification of the desired behavior of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfiguration#spec + */ + readonly spec?: PriorityLevelConfigurationSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubePriorityLevelConfigurationV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePriorityLevelConfigurationV1Beta1Props(obj: KubePriorityLevelConfigurationV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_PriorityLevelConfigurationSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. + * + * @schema io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationList + */ +export interface KubePriorityLevelConfigurationListV1Beta1Props { + /** + * `items` is a list of request-priorities. + * + * @schema io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationList#items + */ + readonly items: KubePriorityLevelConfigurationV1Beta1Props[]; + + /** + * `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubePriorityLevelConfigurationListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePriorityLevelConfigurationListV1Beta1Props(obj: KubePriorityLevelConfigurationListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubePriorityLevelConfigurationV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. + * + * @schema io.k8s.api.networking.v1.Ingress + */ +export interface KubeIngressProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.networking.v1.Ingress#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.networking.v1.Ingress#spec + */ + readonly spec?: IngressSpec; + +} + +/** + * Converts an object of type 'KubeIngressProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeIngressProps(obj: KubeIngressProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_IngressSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class. + * + * @schema io.k8s.api.networking.v1.IngressClass + */ +export interface KubeIngressClassProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.networking.v1.IngressClass#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.networking.v1.IngressClass#spec + */ + readonly spec?: IngressClassSpec; + +} + +/** + * Converts an object of type 'KubeIngressClassProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeIngressClassProps(obj: KubeIngressClassProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_IngressClassSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressClassList is a collection of IngressClasses. + * + * @schema io.k8s.api.networking.v1.IngressClassList + */ +export interface KubeIngressClassListProps { + /** + * Items is the list of IngressClasses. + * + * @schema io.k8s.api.networking.v1.IngressClassList#items + */ + readonly items: KubeIngressClassProps[]; + + /** + * Standard list metadata. + * + * @schema io.k8s.api.networking.v1.IngressClassList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeIngressClassListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeIngressClassListProps(obj: KubeIngressClassListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeIngressClassProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressList is a collection of Ingress. + * + * @schema io.k8s.api.networking.v1.IngressList + */ +export interface KubeIngressListProps { + /** + * Items is the list of Ingress. + * + * @schema io.k8s.api.networking.v1.IngressList#items + */ + readonly items: KubeIngressProps[]; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.networking.v1.IngressList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeIngressListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeIngressListProps(obj: KubeIngressListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeIngressProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NetworkPolicy describes what network traffic is allowed for a set of Pods + * + * @schema io.k8s.api.networking.v1.NetworkPolicy + */ +export interface KubeNetworkPolicyProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.networking.v1.NetworkPolicy#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior for this NetworkPolicy. + * + * @schema io.k8s.api.networking.v1.NetworkPolicy#spec + */ + readonly spec?: NetworkPolicySpec; + +} + +/** + * Converts an object of type 'KubeNetworkPolicyProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeNetworkPolicyProps(obj: KubeNetworkPolicyProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_NetworkPolicySpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NetworkPolicyList is a list of NetworkPolicy objects. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyList + */ +export interface KubeNetworkPolicyListProps { + /** + * Items is a list of schema objects. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyList#items + */ + readonly items: KubeNetworkPolicyProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.networking.v1.NetworkPolicyList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeNetworkPolicyListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeNetworkPolicyListProps(obj: KubeNetworkPolicyListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeNetworkPolicyProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class. + * + * @schema io.k8s.api.networking.v1beta1.IngressClass + */ +export interface KubeIngressClassV1Beta1Props { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.networking.v1beta1.IngressClass#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.networking.v1beta1.IngressClass#spec + */ + readonly spec?: IngressClassSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeIngressClassV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeIngressClassV1Beta1Props(obj: KubeIngressClassV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_IngressClassSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressClassList is a collection of IngressClasses. + * + * @schema io.k8s.api.networking.v1beta1.IngressClassList + */ +export interface KubeIngressClassListV1Beta1Props { + /** + * Items is the list of IngressClasses. + * + * @schema io.k8s.api.networking.v1beta1.IngressClassList#items + */ + readonly items: KubeIngressClassV1Beta1Props[]; + + /** + * Standard list metadata. + * + * @schema io.k8s.api.networking.v1beta1.IngressClassList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeIngressClassListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeIngressClassListV1Beta1Props(obj: KubeIngressClassListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeIngressClassV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://kubernetes.io/docs/concepts/containers/runtime-class/ + * + * @schema io.k8s.api.node.v1.RuntimeClass + */ +export interface KubeRuntimeClassProps { + /** + * Handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable. + * + * @schema io.k8s.api.node.v1.RuntimeClass#handler + */ + readonly handler: string; + + /** + * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.node.v1.RuntimeClass#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see + * https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/ + * This field is in beta starting v1.18 and is only honored by servers that enable the PodOverhead feature. + * + * @schema io.k8s.api.node.v1.RuntimeClass#overhead + */ + readonly overhead?: Overhead; + + /** + * Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes. + * + * @schema io.k8s.api.node.v1.RuntimeClass#scheduling + */ + readonly scheduling?: Scheduling; + +} + +/** + * Converts an object of type 'KubeRuntimeClassProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRuntimeClassProps(obj: KubeRuntimeClassProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'handler': obj.handler, + 'metadata': toJson_ObjectMeta(obj.metadata), + 'overhead': toJson_Overhead(obj.overhead), + 'scheduling': toJson_Scheduling(obj.scheduling), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RuntimeClassList is a list of RuntimeClass objects. + * + * @schema io.k8s.api.node.v1.RuntimeClassList + */ +export interface KubeRuntimeClassListProps { + /** + * Items is a list of schema objects. + * + * @schema io.k8s.api.node.v1.RuntimeClassList#items + */ + readonly items: KubeRuntimeClassProps[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.node.v1.RuntimeClassList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeRuntimeClassListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRuntimeClassListProps(obj: KubeRuntimeClassListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeRuntimeClassProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are (currently) manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md + * + * @schema io.k8s.api.node.v1alpha1.RuntimeClass + */ +export interface KubeRuntimeClassV1Alpha1Props { + /** + * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.node.v1alpha1.RuntimeClass#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the RuntimeClass More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.node.v1alpha1.RuntimeClass#spec + */ + readonly spec: RuntimeClassSpecV1Alpha1; + +} + +/** + * Converts an object of type 'KubeRuntimeClassV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRuntimeClassV1Alpha1Props(obj: KubeRuntimeClassV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_RuntimeClassSpecV1Alpha1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RuntimeClassList is a list of RuntimeClass objects. + * + * @schema io.k8s.api.node.v1alpha1.RuntimeClassList + */ +export interface KubeRuntimeClassListV1Alpha1Props { + /** + * Items is a list of schema objects. + * + * @schema io.k8s.api.node.v1alpha1.RuntimeClassList#items + */ + readonly items: KubeRuntimeClassV1Alpha1Props[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.node.v1alpha1.RuntimeClassList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeRuntimeClassListV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRuntimeClassListV1Alpha1Props(obj: KubeRuntimeClassListV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeRuntimeClassV1Alpha1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are (currently) manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md + * + * @schema io.k8s.api.node.v1beta1.RuntimeClass + */ +export interface KubeRuntimeClassV1Beta1Props { + /** + * Handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable. + * + * @schema io.k8s.api.node.v1beta1.RuntimeClass#handler + */ + readonly handler: string; + + /** + * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.node.v1beta1.RuntimeClass#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature. + * + * @schema io.k8s.api.node.v1beta1.RuntimeClass#overhead + */ + readonly overhead?: OverheadV1Beta1; + + /** + * Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes. + * + * @schema io.k8s.api.node.v1beta1.RuntimeClass#scheduling + */ + readonly scheduling?: SchedulingV1Beta1; + +} + +/** + * Converts an object of type 'KubeRuntimeClassV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRuntimeClassV1Beta1Props(obj: KubeRuntimeClassV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'handler': obj.handler, + 'metadata': toJson_ObjectMeta(obj.metadata), + 'overhead': toJson_OverheadV1Beta1(obj.overhead), + 'scheduling': toJson_SchedulingV1Beta1(obj.scheduling), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RuntimeClassList is a list of RuntimeClass objects. + * + * @schema io.k8s.api.node.v1beta1.RuntimeClassList + */ +export interface KubeRuntimeClassListV1Beta1Props { + /** + * Items is a list of schema objects. + * + * @schema io.k8s.api.node.v1beta1.RuntimeClassList#items + */ + readonly items: KubeRuntimeClassV1Beta1Props[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.node.v1beta1.RuntimeClassList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeRuntimeClassListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRuntimeClassListV1Beta1Props(obj: KubeRuntimeClassListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeRuntimeClassV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods + * + * @schema io.k8s.api.policy.v1.PodDisruptionBudget + */ +export interface KubePodDisruptionBudgetProps { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.policy.v1.PodDisruptionBudget#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of the PodDisruptionBudget. + * + * @schema io.k8s.api.policy.v1.PodDisruptionBudget#spec + */ + readonly spec?: PodDisruptionBudgetSpec; + +} + +/** + * Converts an object of type 'KubePodDisruptionBudgetProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePodDisruptionBudgetProps(obj: KubePodDisruptionBudgetProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_PodDisruptionBudgetSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodDisruptionBudgetList is a collection of PodDisruptionBudgets. + * + * @schema io.k8s.api.policy.v1.PodDisruptionBudgetList + */ +export interface KubePodDisruptionBudgetListProps { + /** + * Items is a list of PodDisruptionBudgets + * + * @schema io.k8s.api.policy.v1.PodDisruptionBudgetList#items + */ + readonly items: KubePodDisruptionBudgetProps[]; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.policy.v1.PodDisruptionBudgetList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubePodDisruptionBudgetListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePodDisruptionBudgetListProps(obj: KubePodDisruptionBudgetListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubePodDisruptionBudgetProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods//evictions. + * + * @schema io.k8s.api.policy.v1beta1.Eviction + */ +export interface KubeEvictionV1Beta1Props { + /** + * DeleteOptions may be provided + * + * @schema io.k8s.api.policy.v1beta1.Eviction#deleteOptions + */ + readonly deleteOptions?: DeleteOptions; + + /** + * ObjectMeta describes the pod that is being evicted. + * + * @schema io.k8s.api.policy.v1beta1.Eviction#metadata + */ + readonly metadata?: ObjectMeta; + +} + +/** + * Converts an object of type 'KubeEvictionV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeEvictionV1Beta1Props(obj: KubeEvictionV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'deleteOptions': toJson_DeleteOptions(obj.deleteOptions), + 'metadata': toJson_ObjectMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudget + */ +export interface KubePodDisruptionBudgetV1Beta1Props { + /** + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudget#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of the PodDisruptionBudget. + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudget#spec + */ + readonly spec?: PodDisruptionBudgetSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubePodDisruptionBudgetV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePodDisruptionBudgetV1Beta1Props(obj: KubePodDisruptionBudgetV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_PodDisruptionBudgetSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodDisruptionBudgetList is a collection of PodDisruptionBudgets. + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetList + */ +export interface KubePodDisruptionBudgetListV1Beta1Props { + /** + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetList#items + */ + readonly items: KubePodDisruptionBudgetV1Beta1Props[]; + + /** + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubePodDisruptionBudgetListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePodDisruptionBudgetListV1Beta1Props(obj: KubePodDisruptionBudgetListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubePodDisruptionBudgetV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. Deprecated in 1.21. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicy + */ +export interface KubePodSecurityPolicyV1Beta1Props { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicy#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * spec defines the policy enforced. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicy#spec + */ + readonly spec?: PodSecurityPolicySpecV1Beta1; + +} + +/** + * Converts an object of type 'KubePodSecurityPolicyV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePodSecurityPolicyV1Beta1Props(obj: KubePodSecurityPolicyV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_PodSecurityPolicySpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodSecurityPolicyList is a list of PodSecurityPolicy objects. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicyList + */ +export interface KubePodSecurityPolicyListV1Beta1Props { + /** + * items is a list of schema objects. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicyList#items + */ + readonly items: KubePodSecurityPolicyV1Beta1Props[]; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicyList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubePodSecurityPolicyListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePodSecurityPolicyListV1Beta1Props(obj: KubePodSecurityPolicyListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubePodSecurityPolicyV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. + * + * @schema io.k8s.api.rbac.v1.ClusterRole + */ +export interface KubeClusterRoleProps { + /** + * AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller. + * + * @schema io.k8s.api.rbac.v1.ClusterRole#aggregationRule + */ + readonly aggregationRule?: AggregationRule; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.ClusterRole#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Rules holds all the PolicyRules for this ClusterRole + * + * @schema io.k8s.api.rbac.v1.ClusterRole#rules + */ + readonly rules?: PolicyRule[]; + +} + +/** + * Converts an object of type 'KubeClusterRoleProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeClusterRoleProps(obj: KubeClusterRoleProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'aggregationRule': toJson_AggregationRule(obj.aggregationRule), + 'metadata': toJson_ObjectMeta(obj.metadata), + 'rules': obj.rules?.map(y => toJson_PolicyRule(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBinding + */ +export interface KubeClusterRoleBindingProps { + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBinding#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBinding#roleRef + */ + readonly roleRef: RoleRef; + + /** + * Subjects holds references to the objects the role applies to. + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBinding#subjects + */ + readonly subjects?: Subject[]; + +} + +/** + * Converts an object of type 'KubeClusterRoleBindingProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeClusterRoleBindingProps(obj: KubeClusterRoleBindingProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'roleRef': toJson_RoleRef(obj.roleRef), + 'subjects': obj.subjects?.map(y => toJson_Subject(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ClusterRoleBindingList is a collection of ClusterRoleBindings + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBindingList + */ +export interface KubeClusterRoleBindingListProps { + /** + * Items is a list of ClusterRoleBindings + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBindingList#items + */ + readonly items: KubeClusterRoleBindingProps[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.ClusterRoleBindingList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeClusterRoleBindingListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeClusterRoleBindingListProps(obj: KubeClusterRoleBindingListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeClusterRoleBindingProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ClusterRoleList is a collection of ClusterRoles + * + * @schema io.k8s.api.rbac.v1.ClusterRoleList + */ +export interface KubeClusterRoleListProps { + /** + * Items is a list of ClusterRoles + * + * @schema io.k8s.api.rbac.v1.ClusterRoleList#items + */ + readonly items: KubeClusterRoleProps[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.ClusterRoleList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeClusterRoleListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeClusterRoleListProps(obj: KubeClusterRoleListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeClusterRoleProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. + * + * @schema io.k8s.api.rbac.v1.Role + */ +export interface KubeRoleProps { + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.Role#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Rules holds all the PolicyRules for this Role + * + * @schema io.k8s.api.rbac.v1.Role#rules + */ + readonly rules?: PolicyRule[]; + +} + +/** + * Converts an object of type 'KubeRoleProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRoleProps(obj: KubeRoleProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'rules': obj.rules?.map(y => toJson_PolicyRule(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. + * + * @schema io.k8s.api.rbac.v1.RoleBinding + */ +export interface KubeRoleBindingProps { + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.RoleBinding#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. + * + * @schema io.k8s.api.rbac.v1.RoleBinding#roleRef + */ + readonly roleRef: RoleRef; + + /** + * Subjects holds references to the objects the role applies to. + * + * @schema io.k8s.api.rbac.v1.RoleBinding#subjects + */ + readonly subjects?: Subject[]; + +} + +/** + * Converts an object of type 'KubeRoleBindingProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRoleBindingProps(obj: KubeRoleBindingProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'roleRef': toJson_RoleRef(obj.roleRef), + 'subjects': obj.subjects?.map(y => toJson_Subject(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RoleBindingList is a collection of RoleBindings + * + * @schema io.k8s.api.rbac.v1.RoleBindingList + */ +export interface KubeRoleBindingListProps { + /** + * Items is a list of RoleBindings + * + * @schema io.k8s.api.rbac.v1.RoleBindingList#items + */ + readonly items: KubeRoleBindingProps[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.RoleBindingList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeRoleBindingListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRoleBindingListProps(obj: KubeRoleBindingListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeRoleBindingProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RoleList is a collection of Roles + * + * @schema io.k8s.api.rbac.v1.RoleList + */ +export interface KubeRoleListProps { + /** + * Items is a list of Roles + * + * @schema io.k8s.api.rbac.v1.RoleList#items + */ + readonly items: KubeRoleProps[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1.RoleList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeRoleListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRoleListProps(obj: KubeRoleListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeRoleProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRole, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRole + */ +export interface KubeClusterRoleV1Alpha1Props { + /** + * AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRole#aggregationRule + */ + readonly aggregationRule?: AggregationRuleV1Alpha1; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRole#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Rules holds all the PolicyRules for this ClusterRole + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRole#rules + */ + readonly rules?: PolicyRuleV1Alpha1[]; + +} + +/** + * Converts an object of type 'KubeClusterRoleV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeClusterRoleV1Alpha1Props(obj: KubeClusterRoleV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'aggregationRule': toJson_AggregationRuleV1Alpha1(obj.aggregationRule), + 'metadata': toJson_ObjectMeta(obj.metadata), + 'rules': obj.rules?.map(y => toJson_PolicyRuleV1Alpha1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBinding, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRoleBinding + */ +export interface KubeClusterRoleBindingV1Alpha1Props { + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRoleBinding#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRoleBinding#roleRef + */ + readonly roleRef: RoleRefV1Alpha1; + + /** + * Subjects holds references to the objects the role applies to. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRoleBinding#subjects + */ + readonly subjects?: SubjectV1Alpha1[]; + +} + +/** + * Converts an object of type 'KubeClusterRoleBindingV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeClusterRoleBindingV1Alpha1Props(obj: KubeClusterRoleBindingV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'roleRef': toJson_RoleRefV1Alpha1(obj.roleRef), + 'subjects': obj.subjects?.map(y => toJson_SubjectV1Alpha1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ClusterRoleBindingList is a collection of ClusterRoleBindings. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBindings, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRoleBindingList + */ +export interface KubeClusterRoleBindingListV1Alpha1Props { + /** + * Items is a list of ClusterRoleBindings + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRoleBindingList#items + */ + readonly items: KubeClusterRoleBindingV1Alpha1Props[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRoleBindingList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeClusterRoleBindingListV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeClusterRoleBindingListV1Alpha1Props(obj: KubeClusterRoleBindingListV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeClusterRoleBindingV1Alpha1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ClusterRoleList is a collection of ClusterRoles. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoles, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRoleList + */ +export interface KubeClusterRoleListV1Alpha1Props { + /** + * Items is a list of ClusterRoles + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRoleList#items + */ + readonly items: KubeClusterRoleV1Alpha1Props[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1alpha1.ClusterRoleList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeClusterRoleListV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeClusterRoleListV1Alpha1Props(obj: KubeClusterRoleListV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeClusterRoleV1Alpha1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 Role, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.Role + */ +export interface KubeRoleV1Alpha1Props { + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1alpha1.Role#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Rules holds all the PolicyRules for this Role + * + * @schema io.k8s.api.rbac.v1alpha1.Role#rules + */ + readonly rules?: PolicyRuleV1Alpha1[]; + +} + +/** + * Converts an object of type 'KubeRoleV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRoleV1Alpha1Props(obj: KubeRoleV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'rules': obj.rules?.map(y => toJson_PolicyRuleV1Alpha1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBinding, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.RoleBinding + */ +export interface KubeRoleBindingV1Alpha1Props { + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1alpha1.RoleBinding#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. + * + * @schema io.k8s.api.rbac.v1alpha1.RoleBinding#roleRef + */ + readonly roleRef: RoleRefV1Alpha1; + + /** + * Subjects holds references to the objects the role applies to. + * + * @schema io.k8s.api.rbac.v1alpha1.RoleBinding#subjects + */ + readonly subjects?: SubjectV1Alpha1[]; + +} + +/** + * Converts an object of type 'KubeRoleBindingV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRoleBindingV1Alpha1Props(obj: KubeRoleBindingV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'roleRef': toJson_RoleRefV1Alpha1(obj.roleRef), + 'subjects': obj.subjects?.map(y => toJson_SubjectV1Alpha1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RoleBindingList is a collection of RoleBindings Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBindingList, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.RoleBindingList + */ +export interface KubeRoleBindingListV1Alpha1Props { + /** + * Items is a list of RoleBindings + * + * @schema io.k8s.api.rbac.v1alpha1.RoleBindingList#items + */ + readonly items: KubeRoleBindingV1Alpha1Props[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1alpha1.RoleBindingList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeRoleBindingListV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRoleBindingListV1Alpha1Props(obj: KubeRoleBindingListV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeRoleBindingV1Alpha1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RoleList is a collection of Roles. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleList, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1alpha1.RoleList + */ +export interface KubeRoleListV1Alpha1Props { + /** + * Items is a list of Roles + * + * @schema io.k8s.api.rbac.v1alpha1.RoleList#items + */ + readonly items: KubeRoleV1Alpha1Props[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1alpha1.RoleList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeRoleListV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRoleListV1Alpha1Props(obj: KubeRoleListV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeRoleV1Alpha1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRole, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRole + */ +export interface KubeClusterRoleV1Beta1Props { + /** + * AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRole#aggregationRule + */ + readonly aggregationRule?: AggregationRuleV1Beta1; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRole#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Rules holds all the PolicyRules for this ClusterRole + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRole#rules + */ + readonly rules?: PolicyRuleV1Beta1[]; + +} + +/** + * Converts an object of type 'KubeClusterRoleV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeClusterRoleV1Beta1Props(obj: KubeClusterRoleV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'aggregationRule': toJson_AggregationRuleV1Beta1(obj.aggregationRule), + 'metadata': toJson_ObjectMeta(obj.metadata), + 'rules': obj.rules?.map(y => toJson_PolicyRuleV1Beta1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBinding, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRoleBinding + */ +export interface KubeClusterRoleBindingV1Beta1Props { + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRoleBinding#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRoleBinding#roleRef + */ + readonly roleRef: RoleRefV1Beta1; + + /** + * Subjects holds references to the objects the role applies to. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRoleBinding#subjects + */ + readonly subjects?: SubjectV1Beta1[]; + +} + +/** + * Converts an object of type 'KubeClusterRoleBindingV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeClusterRoleBindingV1Beta1Props(obj: KubeClusterRoleBindingV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'roleRef': toJson_RoleRefV1Beta1(obj.roleRef), + 'subjects': obj.subjects?.map(y => toJson_SubjectV1Beta1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ClusterRoleBindingList is a collection of ClusterRoleBindings. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBindingList, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRoleBindingList + */ +export interface KubeClusterRoleBindingListV1Beta1Props { + /** + * Items is a list of ClusterRoleBindings + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRoleBindingList#items + */ + readonly items: KubeClusterRoleBindingV1Beta1Props[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRoleBindingList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeClusterRoleBindingListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeClusterRoleBindingListV1Beta1Props(obj: KubeClusterRoleBindingListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeClusterRoleBindingV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ClusterRoleList is a collection of ClusterRoles. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoles, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRoleList + */ +export interface KubeClusterRoleListV1Beta1Props { + /** + * Items is a list of ClusterRoles + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRoleList#items + */ + readonly items: KubeClusterRoleV1Beta1Props[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1beta1.ClusterRoleList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeClusterRoleListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeClusterRoleListV1Beta1Props(obj: KubeClusterRoleListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeClusterRoleV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 Role, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.Role + */ +export interface KubeRoleV1Beta1Props { + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1beta1.Role#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Rules holds all the PolicyRules for this Role + * + * @schema io.k8s.api.rbac.v1beta1.Role#rules + */ + readonly rules?: PolicyRuleV1Beta1[]; + +} + +/** + * Converts an object of type 'KubeRoleV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRoleV1Beta1Props(obj: KubeRoleV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'rules': obj.rules?.map(y => toJson_PolicyRuleV1Beta1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBinding, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.RoleBinding + */ +export interface KubeRoleBindingV1Beta1Props { + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1beta1.RoleBinding#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. + * + * @schema io.k8s.api.rbac.v1beta1.RoleBinding#roleRef + */ + readonly roleRef: RoleRefV1Beta1; + + /** + * Subjects holds references to the objects the role applies to. + * + * @schema io.k8s.api.rbac.v1beta1.RoleBinding#subjects + */ + readonly subjects?: SubjectV1Beta1[]; + +} + +/** + * Converts an object of type 'KubeRoleBindingV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRoleBindingV1Beta1Props(obj: KubeRoleBindingV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'roleRef': toJson_RoleRefV1Beta1(obj.roleRef), + 'subjects': obj.subjects?.map(y => toJson_SubjectV1Beta1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RoleBindingList is a collection of RoleBindings Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBindingList, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.RoleBindingList + */ +export interface KubeRoleBindingListV1Beta1Props { + /** + * Items is a list of RoleBindings + * + * @schema io.k8s.api.rbac.v1beta1.RoleBindingList#items + */ + readonly items: KubeRoleBindingV1Beta1Props[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1beta1.RoleBindingList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeRoleBindingListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRoleBindingListV1Beta1Props(obj: KubeRoleBindingListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeRoleBindingV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RoleList is a collection of Roles Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleList, and will no longer be served in v1.22. + * + * @schema io.k8s.api.rbac.v1beta1.RoleList + */ +export interface KubeRoleListV1Beta1Props { + /** + * Items is a list of Roles + * + * @schema io.k8s.api.rbac.v1beta1.RoleList#items + */ + readonly items: KubeRoleV1Beta1Props[]; + + /** + * Standard object's metadata. + * + * @schema io.k8s.api.rbac.v1beta1.RoleList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeRoleListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeRoleListV1Beta1Props(obj: KubeRoleListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeRoleV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. + * + * @schema io.k8s.api.scheduling.v1.PriorityClass + */ +export interface KubePriorityClassProps { + /** + * description is an arbitrary string that usually provides guidelines on when this priority class should be used. + * + * @schema io.k8s.api.scheduling.v1.PriorityClass#description + */ + readonly description?: string; + + /** + * globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. + * + * @schema io.k8s.api.scheduling.v1.PriorityClass#globalDefault + */ + readonly globalDefault?: boolean; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.scheduling.v1.PriorityClass#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + * + * @default PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + * @schema io.k8s.api.scheduling.v1.PriorityClass#preemptionPolicy + */ + readonly preemptionPolicy?: string; + + /** + * The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. + * + * @schema io.k8s.api.scheduling.v1.PriorityClass#value + */ + readonly value: number; + +} + +/** + * Converts an object of type 'KubePriorityClassProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePriorityClassProps(obj: KubePriorityClassProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'description': obj.description, + 'globalDefault': obj.globalDefault, + 'metadata': toJson_ObjectMeta(obj.metadata), + 'preemptionPolicy': obj.preemptionPolicy, + 'value': obj.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PriorityClassList is a collection of priority classes. + * + * @schema io.k8s.api.scheduling.v1.PriorityClassList + */ +export interface KubePriorityClassListProps { + /** + * items is the list of PriorityClasses + * + * @schema io.k8s.api.scheduling.v1.PriorityClassList#items + */ + readonly items: KubePriorityClassProps[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.scheduling.v1.PriorityClassList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubePriorityClassListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePriorityClassListProps(obj: KubePriorityClassListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubePriorityClassProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * DEPRECATED - This group version of PriorityClass is deprecated by scheduling.k8s.io/v1/PriorityClass. PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. + * + * @schema io.k8s.api.scheduling.v1alpha1.PriorityClass + */ +export interface KubePriorityClassV1Alpha1Props { + /** + * description is an arbitrary string that usually provides guidelines on when this priority class should be used. + * + * @schema io.k8s.api.scheduling.v1alpha1.PriorityClass#description + */ + readonly description?: string; + + /** + * globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. + * + * @schema io.k8s.api.scheduling.v1alpha1.PriorityClass#globalDefault + */ + readonly globalDefault?: boolean; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.scheduling.v1alpha1.PriorityClass#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + * + * @default PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + * @schema io.k8s.api.scheduling.v1alpha1.PriorityClass#preemptionPolicy + */ + readonly preemptionPolicy?: string; + + /** + * The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. + * + * @schema io.k8s.api.scheduling.v1alpha1.PriorityClass#value + */ + readonly value: number; + +} + +/** + * Converts an object of type 'KubePriorityClassV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePriorityClassV1Alpha1Props(obj: KubePriorityClassV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'description': obj.description, + 'globalDefault': obj.globalDefault, + 'metadata': toJson_ObjectMeta(obj.metadata), + 'preemptionPolicy': obj.preemptionPolicy, + 'value': obj.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PriorityClassList is a collection of priority classes. + * + * @schema io.k8s.api.scheduling.v1alpha1.PriorityClassList + */ +export interface KubePriorityClassListV1Alpha1Props { + /** + * items is the list of PriorityClasses + * + * @schema io.k8s.api.scheduling.v1alpha1.PriorityClassList#items + */ + readonly items: KubePriorityClassV1Alpha1Props[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.scheduling.v1alpha1.PriorityClassList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubePriorityClassListV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePriorityClassListV1Alpha1Props(obj: KubePriorityClassListV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubePriorityClassV1Alpha1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * DEPRECATED - This group version of PriorityClass is deprecated by scheduling.k8s.io/v1/PriorityClass. PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. + * + * @schema io.k8s.api.scheduling.v1beta1.PriorityClass + */ +export interface KubePriorityClassV1Beta1Props { + /** + * description is an arbitrary string that usually provides guidelines on when this priority class should be used. + * + * @schema io.k8s.api.scheduling.v1beta1.PriorityClass#description + */ + readonly description?: string; + + /** + * globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. + * + * @schema io.k8s.api.scheduling.v1beta1.PriorityClass#globalDefault + */ + readonly globalDefault?: boolean; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.scheduling.v1beta1.PriorityClass#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + * + * @default PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + * @schema io.k8s.api.scheduling.v1beta1.PriorityClass#preemptionPolicy + */ + readonly preemptionPolicy?: string; + + /** + * The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. + * + * @schema io.k8s.api.scheduling.v1beta1.PriorityClass#value + */ + readonly value: number; + +} + +/** + * Converts an object of type 'KubePriorityClassV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePriorityClassV1Beta1Props(obj: KubePriorityClassV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'description': obj.description, + 'globalDefault': obj.globalDefault, + 'metadata': toJson_ObjectMeta(obj.metadata), + 'preemptionPolicy': obj.preemptionPolicy, + 'value': obj.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PriorityClassList is a collection of priority classes. + * + * @schema io.k8s.api.scheduling.v1beta1.PriorityClassList + */ +export interface KubePriorityClassListV1Beta1Props { + /** + * items is the list of PriorityClasses + * + * @schema io.k8s.api.scheduling.v1beta1.PriorityClassList#items + */ + readonly items: KubePriorityClassV1Beta1Props[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.scheduling.v1beta1.PriorityClassList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubePriorityClassListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubePriorityClassListV1Beta1Props(obj: KubePriorityClassListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubePriorityClassV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. + * + * @schema io.k8s.api.storage.v1.CSIDriver + */ +export interface KubeCsiDriverProps { + /** + * Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1.CSIDriver#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the CSI Driver. + * + * @schema io.k8s.api.storage.v1.CSIDriver#spec + */ + readonly spec: CsiDriverSpec; + +} + +/** + * Converts an object of type 'KubeCsiDriverProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCsiDriverProps(obj: KubeCsiDriverProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_CsiDriverSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSIDriverList is a collection of CSIDriver objects. + * + * @schema io.k8s.api.storage.v1.CSIDriverList + */ +export interface KubeCsiDriverListProps { + /** + * items is the list of CSIDriver + * + * @schema io.k8s.api.storage.v1.CSIDriverList#items + */ + readonly items: KubeCsiDriverProps[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1.CSIDriverList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeCsiDriverListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCsiDriverListProps(obj: KubeCsiDriverListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeCsiDriverProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. + * + * @schema io.k8s.api.storage.v1.CSINode + */ +export interface KubeCsiNodeProps { + /** + * metadata.name must be the Kubernetes node name. + * + * @schema io.k8s.api.storage.v1.CSINode#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * spec is the specification of CSINode + * + * @schema io.k8s.api.storage.v1.CSINode#spec + */ + readonly spec: CsiNodeSpec; + +} + +/** + * Converts an object of type 'KubeCsiNodeProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCsiNodeProps(obj: KubeCsiNodeProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_CsiNodeSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSINodeList is a collection of CSINode objects. + * + * @schema io.k8s.api.storage.v1.CSINodeList + */ +export interface KubeCsiNodeListProps { + /** + * items is the list of CSINode + * + * @schema io.k8s.api.storage.v1.CSINodeList#items + */ + readonly items: KubeCsiNodeProps[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1.CSINodeList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeCsiNodeListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCsiNodeListProps(obj: KubeCsiNodeListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeCsiNodeProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. + * + * StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name. + * + * @schema io.k8s.api.storage.v1.StorageClass + */ +export interface KubeStorageClassProps { + /** + * AllowVolumeExpansion shows whether the storage class allow volume expand + * + * @schema io.k8s.api.storage.v1.StorageClass#allowVolumeExpansion + */ + readonly allowVolumeExpansion?: boolean; + + /** + * Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature. + * + * @schema io.k8s.api.storage.v1.StorageClass#allowedTopologies + */ + readonly allowedTopologies?: TopologySelectorTerm[]; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1.StorageClass#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. + * + * @schema io.k8s.api.storage.v1.StorageClass#mountOptions + */ + readonly mountOptions?: string[]; + + /** + * Parameters holds the parameters for the provisioner that should create volumes of this storage class. + * + * @schema io.k8s.api.storage.v1.StorageClass#parameters + */ + readonly parameters?: { [key: string]: string }; + + /** + * Provisioner indicates the type of the provisioner. + * + * @schema io.k8s.api.storage.v1.StorageClass#provisioner + */ + readonly provisioner: string; + + /** + * Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete. + * + * @default Delete. + * @schema io.k8s.api.storage.v1.StorageClass#reclaimPolicy + */ + readonly reclaimPolicy?: string; + + /** + * VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature. + * + * @schema io.k8s.api.storage.v1.StorageClass#volumeBindingMode + */ + readonly volumeBindingMode?: string; + +} + +/** + * Converts an object of type 'KubeStorageClassProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeStorageClassProps(obj: KubeStorageClassProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'allowVolumeExpansion': obj.allowVolumeExpansion, + 'allowedTopologies': obj.allowedTopologies?.map(y => toJson_TopologySelectorTerm(y)), + 'metadata': toJson_ObjectMeta(obj.metadata), + 'mountOptions': obj.mountOptions?.map(y => y), + 'parameters': ((obj.parameters) === undefined) ? undefined : (Object.entries(obj.parameters).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'provisioner': obj.provisioner, + 'reclaimPolicy': obj.reclaimPolicy, + 'volumeBindingMode': obj.volumeBindingMode, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * StorageClassList is a collection of storage classes. + * + * @schema io.k8s.api.storage.v1.StorageClassList + */ +export interface KubeStorageClassListProps { + /** + * Items is the list of StorageClasses + * + * @schema io.k8s.api.storage.v1.StorageClassList#items + */ + readonly items: KubeStorageClassProps[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1.StorageClassList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeStorageClassListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeStorageClassListProps(obj: KubeStorageClassListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeStorageClassProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + * + * VolumeAttachment objects are non-namespaced. + * + * @schema io.k8s.api.storage.v1.VolumeAttachment + */ +export interface KubeVolumeAttachmentProps { + /** + * Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1.VolumeAttachment#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. + * + * @schema io.k8s.api.storage.v1.VolumeAttachment#spec + */ + readonly spec: VolumeAttachmentSpec; + +} + +/** + * Converts an object of type 'KubeVolumeAttachmentProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeVolumeAttachmentProps(obj: KubeVolumeAttachmentProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_VolumeAttachmentSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeAttachmentList is a collection of VolumeAttachment objects. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentList + */ +export interface KubeVolumeAttachmentListProps { + /** + * Items is the list of VolumeAttachments + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentList#items + */ + readonly items: KubeVolumeAttachmentProps[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeVolumeAttachmentListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeVolumeAttachmentListProps(obj: KubeVolumeAttachmentListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeVolumeAttachmentProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes. + * + * For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123" + * + * The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero + * + * The producer of these objects can decide which approach is more suitable. + * + * They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity. + * + * @schema io.k8s.api.storage.v1alpha1.CSIStorageCapacity + */ +export interface KubeCsiStorageCapacityV1Alpha1Props { + /** + * Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. + * + * The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity. + * + * @schema io.k8s.api.storage.v1alpha1.CSIStorageCapacity#capacity + */ + readonly capacity?: Quantity; + + /** + * MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. + * + * This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim. + * + * @schema io.k8s.api.storage.v1alpha1.CSIStorageCapacity#maximumVolumeSize + */ + readonly maximumVolumeSize?: Quantity; + + /** + * Standard object's metadata. The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-, a generated name, or a reverse-domain name which ends with the unique CSI driver name. + * + * Objects are namespaced. + * + * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1alpha1.CSIStorageCapacity#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * NodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable. + * + * @schema io.k8s.api.storage.v1alpha1.CSIStorageCapacity#nodeTopology + */ + readonly nodeTopology?: LabelSelector; + + /** + * The name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable. + * + * @schema io.k8s.api.storage.v1alpha1.CSIStorageCapacity#storageClassName + */ + readonly storageClassName: string; + +} + +/** + * Converts an object of type 'KubeCsiStorageCapacityV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCsiStorageCapacityV1Alpha1Props(obj: KubeCsiStorageCapacityV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'capacity': obj.capacity?.value, + 'maximumVolumeSize': obj.maximumVolumeSize?.value, + 'metadata': toJson_ObjectMeta(obj.metadata), + 'nodeTopology': toJson_LabelSelector(obj.nodeTopology), + 'storageClassName': obj.storageClassName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSIStorageCapacityList is a collection of CSIStorageCapacity objects. + * + * @schema io.k8s.api.storage.v1alpha1.CSIStorageCapacityList + */ +export interface KubeCsiStorageCapacityListV1Alpha1Props { + /** + * Items is the list of CSIStorageCapacity objects. + * + * @schema io.k8s.api.storage.v1alpha1.CSIStorageCapacityList#items + */ + readonly items: KubeCsiStorageCapacityV1Alpha1Props[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1alpha1.CSIStorageCapacityList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeCsiStorageCapacityListV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCsiStorageCapacityListV1Alpha1Props(obj: KubeCsiStorageCapacityListV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeCsiStorageCapacityV1Alpha1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + * + * VolumeAttachment objects are non-namespaced. + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachment + */ +export interface KubeVolumeAttachmentV1Alpha1Props { + /** + * Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachment#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachment#spec + */ + readonly spec: VolumeAttachmentSpecV1Alpha1; + +} + +/** + * Converts an object of type 'KubeVolumeAttachmentV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeVolumeAttachmentV1Alpha1Props(obj: KubeVolumeAttachmentV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_VolumeAttachmentSpecV1Alpha1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeAttachmentList is a collection of VolumeAttachment objects. + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachmentList + */ +export interface KubeVolumeAttachmentListV1Alpha1Props { + /** + * Items is the list of VolumeAttachments + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachmentList#items + */ + readonly items: KubeVolumeAttachmentV1Alpha1Props[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachmentList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeVolumeAttachmentListV1Alpha1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeVolumeAttachmentListV1Alpha1Props(obj: KubeVolumeAttachmentListV1Alpha1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeVolumeAttachmentV1Alpha1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. CSI drivers do not need to create the CSIDriver object directly. Instead they may use the cluster-driver-registrar sidecar container. When deployed with a CSI driver it automatically creates a CSIDriver object representing the driver. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriver + */ +export interface KubeCsiDriverV1Beta1Props { + /** + * Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1beta1.CSIDriver#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the CSI Driver. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriver#spec + */ + readonly spec: CsiDriverSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeCsiDriverV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCsiDriverV1Beta1Props(obj: KubeCsiDriverV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_CsiDriverSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSIDriverList is a collection of CSIDriver objects. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverList + */ +export interface KubeCsiDriverListV1Beta1Props { + /** + * items is the list of CSIDriver + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverList#items + */ + readonly items: KubeCsiDriverV1Beta1Props[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeCsiDriverListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCsiDriverListV1Beta1Props(obj: KubeCsiDriverListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeCsiDriverV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * DEPRECATED - This group version of CSINode is deprecated by storage/v1/CSINode. See the release notes for more information. CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. + * + * @schema io.k8s.api.storage.v1beta1.CSINode + */ +export interface KubeCsiNodeV1Beta1Props { + /** + * metadata.name must be the Kubernetes node name. + * + * @schema io.k8s.api.storage.v1beta1.CSINode#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * spec is the specification of CSINode + * + * @schema io.k8s.api.storage.v1beta1.CSINode#spec + */ + readonly spec: CsiNodeSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeCsiNodeV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCsiNodeV1Beta1Props(obj: KubeCsiNodeV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_CsiNodeSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSINodeList is a collection of CSINode objects. + * + * @schema io.k8s.api.storage.v1beta1.CSINodeList + */ +export interface KubeCsiNodeListV1Beta1Props { + /** + * items is the list of CSINode + * + * @schema io.k8s.api.storage.v1beta1.CSINodeList#items + */ + readonly items: KubeCsiNodeV1Beta1Props[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1beta1.CSINodeList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeCsiNodeListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCsiNodeListV1Beta1Props(obj: KubeCsiNodeListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeCsiNodeV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes. + * + * For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123" + * + * The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero + * + * The producer of these objects can decide which approach is more suitable. + * + * They are consumed by the kube-scheduler if the CSIStorageCapacity beta feature gate is enabled there and a CSI driver opts into capacity-aware scheduling with CSIDriver.StorageCapacity. + * + * @schema io.k8s.api.storage.v1beta1.CSIStorageCapacity + */ +export interface KubeCsiStorageCapacityV1Beta1Props { + /** + * Capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. + * + * The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable and treated like zero capacity. + * + * @schema io.k8s.api.storage.v1beta1.CSIStorageCapacity#capacity + */ + readonly capacity?: Quantity; + + /** + * MaximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. + * + * This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim. + * + * @schema io.k8s.api.storage.v1beta1.CSIStorageCapacity#maximumVolumeSize + */ + readonly maximumVolumeSize?: Quantity; + + /** + * Standard object's metadata. The name has no particular meaning. It must be be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-, a generated name, or a reverse-domain name which ends with the unique CSI driver name. + * + * Objects are namespaced. + * + * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1beta1.CSIStorageCapacity#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * NodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable. + * + * @schema io.k8s.api.storage.v1beta1.CSIStorageCapacity#nodeTopology + */ + readonly nodeTopology?: LabelSelector; + + /** + * The name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable. + * + * @schema io.k8s.api.storage.v1beta1.CSIStorageCapacity#storageClassName + */ + readonly storageClassName: string; + +} + +/** + * Converts an object of type 'KubeCsiStorageCapacityV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCsiStorageCapacityV1Beta1Props(obj: KubeCsiStorageCapacityV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'capacity': obj.capacity?.value, + 'maximumVolumeSize': obj.maximumVolumeSize?.value, + 'metadata': toJson_ObjectMeta(obj.metadata), + 'nodeTopology': toJson_LabelSelector(obj.nodeTopology), + 'storageClassName': obj.storageClassName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSIStorageCapacityList is a collection of CSIStorageCapacity objects. + * + * @schema io.k8s.api.storage.v1beta1.CSIStorageCapacityList + */ +export interface KubeCsiStorageCapacityListV1Beta1Props { + /** + * Items is the list of CSIStorageCapacity objects. + * + * @schema io.k8s.api.storage.v1beta1.CSIStorageCapacityList#items + */ + readonly items: KubeCsiStorageCapacityV1Beta1Props[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1beta1.CSIStorageCapacityList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeCsiStorageCapacityListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCsiStorageCapacityListV1Beta1Props(obj: KubeCsiStorageCapacityListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeCsiStorageCapacityV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. + * + * StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name. + * + * @schema io.k8s.api.storage.v1beta1.StorageClass + */ +export interface KubeStorageClassV1Beta1Props { + /** + * AllowVolumeExpansion shows whether the storage class allow volume expand + * + * @schema io.k8s.api.storage.v1beta1.StorageClass#allowVolumeExpansion + */ + readonly allowVolumeExpansion?: boolean; + + /** + * Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature. + * + * @schema io.k8s.api.storage.v1beta1.StorageClass#allowedTopologies + */ + readonly allowedTopologies?: TopologySelectorTerm[]; + + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1beta1.StorageClass#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. + * + * @schema io.k8s.api.storage.v1beta1.StorageClass#mountOptions + */ + readonly mountOptions?: string[]; + + /** + * Parameters holds the parameters for the provisioner that should create volumes of this storage class. + * + * @schema io.k8s.api.storage.v1beta1.StorageClass#parameters + */ + readonly parameters?: { [key: string]: string }; + + /** + * Provisioner indicates the type of the provisioner. + * + * @schema io.k8s.api.storage.v1beta1.StorageClass#provisioner + */ + readonly provisioner: string; + + /** + * Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete. + * + * @default Delete. + * @schema io.k8s.api.storage.v1beta1.StorageClass#reclaimPolicy + */ + readonly reclaimPolicy?: string; + + /** + * VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature. + * + * @schema io.k8s.api.storage.v1beta1.StorageClass#volumeBindingMode + */ + readonly volumeBindingMode?: string; + +} + +/** + * Converts an object of type 'KubeStorageClassV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeStorageClassV1Beta1Props(obj: KubeStorageClassV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'allowVolumeExpansion': obj.allowVolumeExpansion, + 'allowedTopologies': obj.allowedTopologies?.map(y => toJson_TopologySelectorTerm(y)), + 'metadata': toJson_ObjectMeta(obj.metadata), + 'mountOptions': obj.mountOptions?.map(y => y), + 'parameters': ((obj.parameters) === undefined) ? undefined : (Object.entries(obj.parameters).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'provisioner': obj.provisioner, + 'reclaimPolicy': obj.reclaimPolicy, + 'volumeBindingMode': obj.volumeBindingMode, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * StorageClassList is a collection of storage classes. + * + * @schema io.k8s.api.storage.v1beta1.StorageClassList + */ +export interface KubeStorageClassListV1Beta1Props { + /** + * Items is the list of StorageClasses + * + * @schema io.k8s.api.storage.v1beta1.StorageClassList#items + */ + readonly items: KubeStorageClassV1Beta1Props[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1beta1.StorageClassList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeStorageClassListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeStorageClassListV1Beta1Props(obj: KubeStorageClassListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeStorageClassV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. + * + * VolumeAttachment objects are non-namespaced. + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachment + */ +export interface KubeVolumeAttachmentV1Beta1Props { + /** + * Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachment#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachment#spec + */ + readonly spec: VolumeAttachmentSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeVolumeAttachmentV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeVolumeAttachmentV1Beta1Props(obj: KubeVolumeAttachmentV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_VolumeAttachmentSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeAttachmentList is a collection of VolumeAttachment objects. + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachmentList + */ +export interface KubeVolumeAttachmentListV1Beta1Props { + /** + * Items is the list of VolumeAttachments + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachmentList#items + */ + readonly items: KubeVolumeAttachmentV1Beta1Props[]; + + /** + * Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachmentList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeVolumeAttachmentListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeVolumeAttachmentListV1Beta1Props(obj: KubeVolumeAttachmentListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeVolumeAttachmentV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition + */ +export interface KubeCustomResourceDefinitionProps { + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * spec describes how the user wants the resources to appear + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition#spec + */ + readonly spec: CustomResourceDefinitionSpec; + +} + +/** + * Converts an object of type 'KubeCustomResourceDefinitionProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCustomResourceDefinitionProps(obj: KubeCustomResourceDefinitionProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_CustomResourceDefinitionSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceDefinitionList is a list of CustomResourceDefinition objects. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList + */ +export interface KubeCustomResourceDefinitionListProps { + /** + * items list individual CustomResourceDefinition objects + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList#items + */ + readonly items: KubeCustomResourceDefinitionProps[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeCustomResourceDefinitionListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCustomResourceDefinitionListProps(obj: KubeCustomResourceDefinitionListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeCustomResourceDefinitionProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>. Deprecated in v1.16, planned for removal in v1.22. Use apiextensions.k8s.io/v1 CustomResourceDefinition instead. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinition + */ +export interface KubeCustomResourceDefinitionV1Beta1Props { + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinition#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * spec describes how the user wants the resources to appear + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinition#spec + */ + readonly spec: CustomResourceDefinitionSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeCustomResourceDefinitionV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCustomResourceDefinitionV1Beta1Props(obj: KubeCustomResourceDefinitionV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_CustomResourceDefinitionSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceDefinitionList is a list of CustomResourceDefinition objects. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionList + */ +export interface KubeCustomResourceDefinitionListV1Beta1Props { + /** + * items list individual CustomResourceDefinition objects + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionList#items + */ + readonly items: KubeCustomResourceDefinitionV1Beta1Props[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeCustomResourceDefinitionListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeCustomResourceDefinitionListV1Beta1Props(obj: KubeCustomResourceDefinitionListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeCustomResourceDefinitionV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Status is a return value for calls that don't return other objects. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status + */ +export interface KubeStatusProps { + /** + * Suggested HTTP return code for this status, 0 if not set. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#code + */ + readonly code?: number; + + /** + * Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#details + */ + readonly details?: StatusDetails; + + /** + * A human-readable description of the status of this operation. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#message + */ + readonly message?: string; + + /** + * Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#metadata + */ + readonly metadata?: ListMeta; + + /** + * A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Status#reason + */ + readonly reason?: string; + +} + +/** + * Converts an object of type 'KubeStatusProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeStatusProps(obj: KubeStatusProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'code': obj.code, + 'details': toJson_StatusDetails(obj.details), + 'message': obj.message, + 'metadata': toJson_ListMeta(obj.metadata), + 'reason': obj.reason, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * APIService represents a server for a particular GroupVersion. Name must be "version.group". + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService + */ +export interface KubeApiServiceProps { + /** + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec contains information for locating and communicating with a server + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIService#spec + */ + readonly spec?: ApiServiceSpec; + +} + +/** + * Converts an object of type 'KubeApiServiceProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeApiServiceProps(obj: KubeApiServiceProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_ApiServiceSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * APIServiceList is a list of APIService objects. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList + */ +export interface KubeApiServiceListProps { + /** + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList#items + */ + readonly items: KubeApiServiceProps[]; + + /** + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeApiServiceListProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeApiServiceListProps(obj: KubeApiServiceListProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeApiServiceProps(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * APIService represents a server for a particular GroupVersion. Name must be "version.group". + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIService + */ +export interface KubeApiServiceV1Beta1Props { + /** + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIService#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Spec contains information for locating and communicating with a server + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIService#spec + */ + readonly spec?: ApiServiceSpecV1Beta1; + +} + +/** + * Converts an object of type 'KubeApiServiceV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeApiServiceV1Beta1Props(obj: KubeApiServiceV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_ApiServiceSpecV1Beta1(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * APIServiceList is a list of APIService objects. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceList + */ +export interface KubeApiServiceListV1Beta1Props { + /** + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceList#items + */ + readonly items: KubeApiServiceV1Beta1Props[]; + + /** + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceList#metadata + */ + readonly metadata?: ListMeta; + +} + +/** + * Converts an object of type 'KubeApiServiceListV1Beta1Props' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KubeApiServiceListV1Beta1Props(obj: KubeApiServiceListV1Beta1Props | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KubeApiServiceV1Beta1Props(y)), + 'metadata': toJson_ListMeta(obj.metadata), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta + */ +export interface ObjectMeta { + /** + * Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#annotations + */ + readonly annotations?: { [key: string]: string }; + + /** + * The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#clusterName + */ + readonly clusterName?: string; + + /** + * CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. + * + * Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#creationTimestamp + */ + readonly creationTimestamp?: Date; + + /** + * Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#deletionGracePeriodSeconds + */ + readonly deletionGracePeriodSeconds?: number; + + /** + * DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. + * + * Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#deletionTimestamp + */ + readonly deletionTimestamp?: Date; + + /** + * Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#finalizers + */ + readonly finalizers?: string[]; + + /** + * GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. + * + * If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). + * + * Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#generateName + */ + readonly generateName?: string; + + /** + * A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#generation + */ + readonly generation?: number; + + /** + * Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#labels + */ + readonly labels?: { [key: string]: string }; + + /** + * ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#managedFields + */ + readonly managedFields?: ManagedFieldsEntry[]; + + /** + * Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#name + */ + readonly name?: string; + + /** + * Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. + * + * Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#namespace + */ + readonly namespace?: string; + + /** + * List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#ownerReferences + */ + readonly ownerReferences?: OwnerReference[]; + + /** + * An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. + * + * Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#resourceVersion + */ + readonly resourceVersion?: string; + + /** + * SelfLink is a URL representing this object. Populated by the system. Read-only. + * + * DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#selfLink + */ + readonly selfLink?: string; + + /** + * UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. + * + * Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta#uid + */ + readonly uid?: string; + +} + +/** + * Converts an object of type 'ObjectMeta' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ObjectMeta(obj: ObjectMeta | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'annotations': ((obj.annotations) === undefined) ? undefined : (Object.entries(obj.annotations).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'clusterName': obj.clusterName, + 'creationTimestamp': obj.creationTimestamp?.toISOString(), + 'deletionGracePeriodSeconds': obj.deletionGracePeriodSeconds, + 'deletionTimestamp': obj.deletionTimestamp?.toISOString(), + 'finalizers': obj.finalizers?.map(y => y), + 'generateName': obj.generateName, + 'generation': obj.generation, + 'labels': ((obj.labels) === undefined) ? undefined : (Object.entries(obj.labels).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'managedFields': obj.managedFields?.map(y => toJson_ManagedFieldsEntry(y)), + 'name': obj.name, + 'namespace': obj.namespace, + 'ownerReferences': obj.ownerReferences?.map(y => toJson_OwnerReference(y)), + 'resourceVersion': obj.resourceVersion, + 'selfLink': obj.selfLink, + 'uid': obj.uid, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * MutatingWebhook describes an admission webhook and the resources and operations it applies to. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook + */ +export interface MutatingWebhook { + /** + * AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#admissionReviewVersions + */ + readonly admissionReviewVersions: string[]; + + /** + * ClientConfig defines how to communicate with the hook. Required + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#clientConfig + */ + readonly clientConfig: WebhookClientConfig; + + /** + * FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail. + * + * @default Fail. + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#failurePolicy + */ + readonly failurePolicy?: string; + + /** + * matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". + * + * - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. + * + * - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. + * + * Defaults to "Equivalent" + * + * @default Equivalent" + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#matchPolicy + */ + readonly matchPolicy?: string; + + /** + * The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#name + */ + readonly name: string; + + /** + * NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. + * + * For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { + * "matchExpressions": [ + * { + * "key": "runlevel", + * "operator": "NotIn", + * "values": [ + * "0", + * "1" + * ] + * } + * ] + * } + * + * If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { + * "matchExpressions": [ + * { + * "key": "environment", + * "operator": "In", + * "values": [ + * "prod", + * "staging" + * ] + * } + * ] + * } + * + * See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. + * + * Default to the empty LabelSelector, which matches everything. + * + * @default the empty LabelSelector, which matches everything. + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#namespaceSelector + */ + readonly namespaceSelector?: LabelSelector; + + /** + * ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. + * + * @default the empty LabelSelector, which matches everything. + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#objectSelector + */ + readonly objectSelector?: LabelSelector; + + /** + * reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded". + * + * Never: the webhook will not be called more than once in a single admission evaluation. + * + * IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. + * + * Defaults to "Never". + * + * @default Never". + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#reinvocationPolicy + */ + readonly reinvocationPolicy?: string; + + /** + * Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#rules + */ + readonly rules?: RuleWithOperations[]; + + /** + * SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. + * + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#sideEffects + */ + readonly sideEffects: string; + + /** + * TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds. + * + * @default 10 seconds. + * @schema io.k8s.api.admissionregistration.v1.MutatingWebhook#timeoutSeconds + */ + readonly timeoutSeconds?: number; + +} + +/** + * Converts an object of type 'MutatingWebhook' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_MutatingWebhook(obj: MutatingWebhook | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'admissionReviewVersions': obj.admissionReviewVersions?.map(y => y), + 'clientConfig': toJson_WebhookClientConfig(obj.clientConfig), + 'failurePolicy': obj.failurePolicy, + 'matchPolicy': obj.matchPolicy, + 'name': obj.name, + 'namespaceSelector': toJson_LabelSelector(obj.namespaceSelector), + 'objectSelector': toJson_LabelSelector(obj.objectSelector), + 'reinvocationPolicy': obj.reinvocationPolicy, + 'rules': obj.rules?.map(y => toJson_RuleWithOperations(y)), + 'sideEffects': obj.sideEffects, + 'timeoutSeconds': obj.timeoutSeconds, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta + */ +export interface ListMeta { + /** + * continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta#continue + */ + readonly continue?: string; + + /** + * remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta#remainingItemCount + */ + readonly remainingItemCount?: number; + + /** + * String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta#resourceVersion + */ + readonly resourceVersion?: string; + + /** + * selfLink is a URL representing this object. Populated by the system. Read-only. + * + * DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta#selfLink + */ + readonly selfLink?: string; + +} + +/** + * Converts an object of type 'ListMeta' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ListMeta(obj: ListMeta | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'continue': obj.continue, + 'remainingItemCount': obj.remainingItemCount, + 'resourceVersion': obj.resourceVersion, + 'selfLink': obj.selfLink, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ValidatingWebhook describes an admission webhook and the resources and operations it applies to. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook + */ +export interface ValidatingWebhook { + /** + * AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#admissionReviewVersions + */ + readonly admissionReviewVersions: string[]; + + /** + * ClientConfig defines how to communicate with the hook. Required + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#clientConfig + */ + readonly clientConfig: WebhookClientConfig; + + /** + * FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail. + * + * @default Fail. + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#failurePolicy + */ + readonly failurePolicy?: string; + + /** + * matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". + * + * - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. + * + * - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. + * + * Defaults to "Equivalent" + * + * @default Equivalent" + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#matchPolicy + */ + readonly matchPolicy?: string; + + /** + * The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#name + */ + readonly name: string; + + /** + * NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. + * + * For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { + * "matchExpressions": [ + * { + * "key": "runlevel", + * "operator": "NotIn", + * "values": [ + * "0", + * "1" + * ] + * } + * ] + * } + * + * If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { + * "matchExpressions": [ + * { + * "key": "environment", + * "operator": "In", + * "values": [ + * "prod", + * "staging" + * ] + * } + * ] + * } + * + * See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels for more examples of label selectors. + * + * Default to the empty LabelSelector, which matches everything. + * + * @default the empty LabelSelector, which matches everything. + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#namespaceSelector + */ + readonly namespaceSelector?: LabelSelector; + + /** + * ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. + * + * @default the empty LabelSelector, which matches everything. + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#objectSelector + */ + readonly objectSelector?: LabelSelector; + + /** + * Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#rules + */ + readonly rules?: RuleWithOperations[]; + + /** + * SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. + * + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#sideEffects + */ + readonly sideEffects: string; + + /** + * TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds. + * + * @default 10 seconds. + * @schema io.k8s.api.admissionregistration.v1.ValidatingWebhook#timeoutSeconds + */ + readonly timeoutSeconds?: number; + +} + +/** + * Converts an object of type 'ValidatingWebhook' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ValidatingWebhook(obj: ValidatingWebhook | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'admissionReviewVersions': obj.admissionReviewVersions?.map(y => y), + 'clientConfig': toJson_WebhookClientConfig(obj.clientConfig), + 'failurePolicy': obj.failurePolicy, + 'matchPolicy': obj.matchPolicy, + 'name': obj.name, + 'namespaceSelector': toJson_LabelSelector(obj.namespaceSelector), + 'objectSelector': toJson_LabelSelector(obj.objectSelector), + 'rules': obj.rules?.map(y => toJson_RuleWithOperations(y)), + 'sideEffects': obj.sideEffects, + 'timeoutSeconds': obj.timeoutSeconds, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * MutatingWebhook describes an admission webhook and the resources and operations it applies to. + * + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhook + */ +export interface MutatingWebhookV1Beta1 { + /** + * AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. Default to `['v1beta1']`. + * + * @default v1beta1']`. + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhook#admissionReviewVersions + */ + readonly admissionReviewVersions?: string[]; + + /** + * ClientConfig defines how to communicate with the hook. Required + * + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhook#clientConfig + */ + readonly clientConfig: WebhookClientConfigV1Beta1; + + /** + * FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore. + * + * @default Ignore. + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhook#failurePolicy + */ + readonly failurePolicy?: string; + + /** + * matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". + * + * - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. + * + * - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. + * + * Defaults to "Exact" + * + * @default Exact" + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhook#matchPolicy + */ + readonly matchPolicy?: string; + + /** + * The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. + * + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhook#name + */ + readonly name: string; + + /** + * NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. + * + * For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { + * "matchExpressions": [ + * { + * "key": "runlevel", + * "operator": "NotIn", + * "values": [ + * "0", + * "1" + * ] + * } + * ] + * } + * + * If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { + * "matchExpressions": [ + * { + * "key": "environment", + * "operator": "In", + * "values": [ + * "prod", + * "staging" + * ] + * } + * ] + * } + * + * See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. + * + * Default to the empty LabelSelector, which matches everything. + * + * @default the empty LabelSelector, which matches everything. + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhook#namespaceSelector + */ + readonly namespaceSelector?: LabelSelector; + + /** + * ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. + * + * @default the empty LabelSelector, which matches everything. + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhook#objectSelector + */ + readonly objectSelector?: LabelSelector; + + /** + * reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded". + * + * Never: the webhook will not be called more than once in a single admission evaluation. + * + * IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. + * + * Defaults to "Never". + * + * @default Never". + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhook#reinvocationPolicy + */ + readonly reinvocationPolicy?: string; + + /** + * Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + * + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhook#rules + */ + readonly rules?: RuleWithOperationsV1Beta1[]; + + /** + * SideEffects states whether this webhook has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. Defaults to Unknown. + * + * @default Unknown. + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhook#sideEffects + */ + readonly sideEffects?: string; + + /** + * TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 30 seconds. + * + * @default 30 seconds. + * @schema io.k8s.api.admissionregistration.v1beta1.MutatingWebhook#timeoutSeconds + */ + readonly timeoutSeconds?: number; + +} + +/** + * Converts an object of type 'MutatingWebhookV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_MutatingWebhookV1Beta1(obj: MutatingWebhookV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'admissionReviewVersions': obj.admissionReviewVersions?.map(y => y), + 'clientConfig': toJson_WebhookClientConfigV1Beta1(obj.clientConfig), + 'failurePolicy': obj.failurePolicy, + 'matchPolicy': obj.matchPolicy, + 'name': obj.name, + 'namespaceSelector': toJson_LabelSelector(obj.namespaceSelector), + 'objectSelector': toJson_LabelSelector(obj.objectSelector), + 'reinvocationPolicy': obj.reinvocationPolicy, + 'rules': obj.rules?.map(y => toJson_RuleWithOperationsV1Beta1(y)), + 'sideEffects': obj.sideEffects, + 'timeoutSeconds': obj.timeoutSeconds, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ValidatingWebhook describes an admission webhook and the resources and operations it applies to. + * + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhook + */ +export interface ValidatingWebhookV1Beta1 { + /** + * AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. Default to `['v1beta1']`. + * + * @default v1beta1']`. + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhook#admissionReviewVersions + */ + readonly admissionReviewVersions?: string[]; + + /** + * ClientConfig defines how to communicate with the hook. Required + * + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhook#clientConfig + */ + readonly clientConfig: WebhookClientConfigV1Beta1; + + /** + * FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore. + * + * @default Ignore. + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhook#failurePolicy + */ + readonly failurePolicy?: string; + + /** + * matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". + * + * - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. + * + * - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. + * + * Defaults to "Exact" + * + * @default Exact" + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhook#matchPolicy + */ + readonly matchPolicy?: string; + + /** + * The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. + * + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhook#name + */ + readonly name: string; + + /** + * NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. + * + * For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { + * "matchExpressions": [ + * { + * "key": "runlevel", + * "operator": "NotIn", + * "values": [ + * "0", + * "1" + * ] + * } + * ] + * } + * + * If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { + * "matchExpressions": [ + * { + * "key": "environment", + * "operator": "In", + * "values": [ + * "prod", + * "staging" + * ] + * } + * ] + * } + * + * See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels for more examples of label selectors. + * + * Default to the empty LabelSelector, which matches everything. + * + * @default the empty LabelSelector, which matches everything. + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhook#namespaceSelector + */ + readonly namespaceSelector?: LabelSelector; + + /** + * ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. + * + * @default the empty LabelSelector, which matches everything. + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhook#objectSelector + */ + readonly objectSelector?: LabelSelector; + + /** + * Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. + * + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhook#rules + */ + readonly rules?: RuleWithOperationsV1Beta1[]; + + /** + * SideEffects states whether this webhook has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. Defaults to Unknown. + * + * @default Unknown. + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhook#sideEffects + */ + readonly sideEffects?: string; + + /** + * TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 30 seconds. + * + * @default 30 seconds. + * @schema io.k8s.api.admissionregistration.v1beta1.ValidatingWebhook#timeoutSeconds + */ + readonly timeoutSeconds?: number; + +} + +/** + * Converts an object of type 'ValidatingWebhookV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ValidatingWebhookV1Beta1(obj: ValidatingWebhookV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'admissionReviewVersions': obj.admissionReviewVersions?.map(y => y), + 'clientConfig': toJson_WebhookClientConfigV1Beta1(obj.clientConfig), + 'failurePolicy': obj.failurePolicy, + 'matchPolicy': obj.matchPolicy, + 'name': obj.name, + 'namespaceSelector': toJson_LabelSelector(obj.namespaceSelector), + 'objectSelector': toJson_LabelSelector(obj.objectSelector), + 'rules': obj.rules?.map(y => toJson_RuleWithOperationsV1Beta1(y)), + 'sideEffects': obj.sideEffects, + 'timeoutSeconds': obj.timeoutSeconds, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * DaemonSetSpec is the specification of a daemon set. + * + * @schema io.k8s.api.apps.v1.DaemonSetSpec + */ +export interface DaemonSetSpec { + /** + * The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready). + * + * @default 0 (pod will be considered available as soon as it is ready). + * @schema io.k8s.api.apps.v1.DaemonSetSpec#minReadySeconds + */ + readonly minReadySeconds?: number; + + /** + * The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. + * + * @default 10. + * @schema io.k8s.api.apps.v1.DaemonSetSpec#revisionHistoryLimit + */ + readonly revisionHistoryLimit?: number; + + /** + * A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + * + * @schema io.k8s.api.apps.v1.DaemonSetSpec#selector + */ + readonly selector: LabelSelector; + + /** + * An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template + * + * @schema io.k8s.api.apps.v1.DaemonSetSpec#template + */ + readonly template: PodTemplateSpec; + + /** + * An update strategy to replace existing DaemonSet pods with new pods. + * + * @schema io.k8s.api.apps.v1.DaemonSetSpec#updateStrategy + */ + readonly updateStrategy?: DaemonSetUpdateStrategy; + +} + +/** + * Converts an object of type 'DaemonSetSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_DaemonSetSpec(obj: DaemonSetSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'minReadySeconds': obj.minReadySeconds, + 'revisionHistoryLimit': obj.revisionHistoryLimit, + 'selector': toJson_LabelSelector(obj.selector), + 'template': toJson_PodTemplateSpec(obj.template), + 'updateStrategy': toJson_DaemonSetUpdateStrategy(obj.updateStrategy), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * DeploymentSpec is the specification of the desired behavior of the Deployment. + * + * @schema io.k8s.api.apps.v1.DeploymentSpec + */ +export interface DeploymentSpec { + /** + * 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. Defaults to 0 (pod will be considered available as soon as it is ready) + * + * @default 0 (pod will be considered available as soon as it is ready) + * @schema io.k8s.api.apps.v1.DeploymentSpec#minReadySeconds + */ + readonly minReadySeconds?: number; + + /** + * Indicates that the deployment is paused. + * + * @schema io.k8s.api.apps.v1.DeploymentSpec#paused + */ + readonly paused?: boolean; + + /** + * The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s. + * + * @default 600s. + * @schema io.k8s.api.apps.v1.DeploymentSpec#progressDeadlineSeconds + */ + readonly progressDeadlineSeconds?: number; + + /** + * Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. + * + * @default 1. + * @schema io.k8s.api.apps.v1.DeploymentSpec#replicas + */ + readonly replicas?: number; + + /** + * The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. + * + * @default 10. + * @schema io.k8s.api.apps.v1.DeploymentSpec#revisionHistoryLimit + */ + readonly revisionHistoryLimit?: number; + + /** + * Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. + * + * @schema io.k8s.api.apps.v1.DeploymentSpec#selector + */ + readonly selector: LabelSelector; + + /** + * The deployment strategy to use to replace existing pods with new ones. + * + * @schema io.k8s.api.apps.v1.DeploymentSpec#strategy + */ + readonly strategy?: DeploymentStrategy; + + /** + * Template describes the pods that will be created. + * + * @schema io.k8s.api.apps.v1.DeploymentSpec#template + */ + readonly template: PodTemplateSpec; + +} + +/** + * Converts an object of type 'DeploymentSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_DeploymentSpec(obj: DeploymentSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'minReadySeconds': obj.minReadySeconds, + 'paused': obj.paused, + 'progressDeadlineSeconds': obj.progressDeadlineSeconds, + 'replicas': obj.replicas, + 'revisionHistoryLimit': obj.revisionHistoryLimit, + 'selector': toJson_LabelSelector(obj.selector), + 'strategy': toJson_DeploymentStrategy(obj.strategy), + 'template': toJson_PodTemplateSpec(obj.template), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ReplicaSetSpec is the specification of a ReplicaSet. + * + * @schema io.k8s.api.apps.v1.ReplicaSetSpec + */ +export interface ReplicaSetSpec { + /** + * 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. Defaults to 0 (pod will be considered available as soon as it is ready) + * + * @default 0 (pod will be considered available as soon as it is ready) + * @schema io.k8s.api.apps.v1.ReplicaSetSpec#minReadySeconds + */ + readonly minReadySeconds?: number; + + /** + * Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller + * + * @default 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller + * @schema io.k8s.api.apps.v1.ReplicaSetSpec#replicas + */ + readonly replicas?: number; + + /** + * Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + * + * @schema io.k8s.api.apps.v1.ReplicaSetSpec#selector + */ + readonly selector: LabelSelector; + + /** + * Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template + * + * @schema io.k8s.api.apps.v1.ReplicaSetSpec#template + */ + readonly template?: PodTemplateSpec; + +} + +/** + * Converts an object of type 'ReplicaSetSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ReplicaSetSpec(obj: ReplicaSetSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'minReadySeconds': obj.minReadySeconds, + 'replicas': obj.replicas, + 'selector': toJson_LabelSelector(obj.selector), + 'template': toJson_PodTemplateSpec(obj.template), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * A StatefulSetSpec is the specification of a StatefulSet. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec + */ +export interface StatefulSetSpec { + /** + * podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#podManagementPolicy + */ + readonly podManagementPolicy?: string; + + /** + * replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#replicas + */ + readonly replicas?: number; + + /** + * revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#revisionHistoryLimit + */ + readonly revisionHistoryLimit?: number; + + /** + * selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#selector + */ + readonly selector: LabelSelector; + + /** + * serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#serviceName + */ + readonly serviceName: string; + + /** + * template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#template + */ + readonly template: PodTemplateSpec; + + /** + * updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#updateStrategy + */ + readonly updateStrategy?: StatefulSetUpdateStrategy; + + /** + * volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name. + * + * @schema io.k8s.api.apps.v1.StatefulSetSpec#volumeClaimTemplates + */ + readonly volumeClaimTemplates?: KubePersistentVolumeClaimProps[]; + +} + +/** + * Converts an object of type 'StatefulSetSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_StatefulSetSpec(obj: StatefulSetSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'podManagementPolicy': obj.podManagementPolicy, + 'replicas': obj.replicas, + 'revisionHistoryLimit': obj.revisionHistoryLimit, + 'selector': toJson_LabelSelector(obj.selector), + 'serviceName': obj.serviceName, + 'template': toJson_PodTemplateSpec(obj.template), + 'updateStrategy': toJson_StatefulSetUpdateStrategy(obj.updateStrategy), + 'volumeClaimTemplates': obj.volumeClaimTemplates?.map(y => toJson_KubePersistentVolumeClaimProps(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * TokenRequestSpec contains client provided parameters of a token request. + * + * @schema io.k8s.api.authentication.v1.TokenRequestSpec + */ +export interface TokenRequestSpec { + /** + * Audiences are the intendend audiences of the token. A recipient of a token must identitfy themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences. + * + * @schema io.k8s.api.authentication.v1.TokenRequestSpec#audiences + */ + readonly audiences: string[]; + + /** + * BoundObjectRef is a reference to an object that the token will be bound to. The token will only be valid for as long as the bound object exists. NOTE: The API server's TokenReview endpoint will validate the BoundObjectRef, but other audiences may not. Keep ExpirationSeconds small if you want prompt revocation. + * + * @schema io.k8s.api.authentication.v1.TokenRequestSpec#boundObjectRef + */ + readonly boundObjectRef?: BoundObjectReference; + + /** + * ExpirationSeconds is the requested duration of validity of the request. The token issuer may return a token with a different validity duration so a client needs to check the 'expiration' field in a response. + * + * @schema io.k8s.api.authentication.v1.TokenRequestSpec#expirationSeconds + */ + readonly expirationSeconds?: number; + +} + +/** + * Converts an object of type 'TokenRequestSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_TokenRequestSpec(obj: TokenRequestSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'audiences': obj.audiences?.map(y => y), + 'boundObjectRef': toJson_BoundObjectReference(obj.boundObjectRef), + 'expirationSeconds': obj.expirationSeconds, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * TokenReviewSpec is a description of the token authentication request. + * + * @schema io.k8s.api.authentication.v1.TokenReviewSpec + */ +export interface TokenReviewSpec { + /** + * Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver. + * + * @schema io.k8s.api.authentication.v1.TokenReviewSpec#audiences + */ + readonly audiences?: string[]; + + /** + * Token is the opaque bearer token. + * + * @schema io.k8s.api.authentication.v1.TokenReviewSpec#token + */ + readonly token?: string; + +} + +/** + * Converts an object of type 'TokenReviewSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_TokenReviewSpec(obj: TokenReviewSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'audiences': obj.audiences?.map(y => y), + 'token': obj.token, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * TokenReviewSpec is a description of the token authentication request. + * + * @schema io.k8s.api.authentication.v1beta1.TokenReviewSpec + */ +export interface TokenReviewSpecV1Beta1 { + /** + * Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver. + * + * @schema io.k8s.api.authentication.v1beta1.TokenReviewSpec#audiences + */ + readonly audiences?: string[]; + + /** + * Token is the opaque bearer token. + * + * @schema io.k8s.api.authentication.v1beta1.TokenReviewSpec#token + */ + readonly token?: string; + +} + +/** + * Converts an object of type 'TokenReviewSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_TokenReviewSpecV1Beta1(obj: TokenReviewSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'audiences': obj.audiences?.map(y => y), + 'token': obj.token, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec + */ +export interface SubjectAccessReviewSpec { + /** + * Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#extra + */ + readonly extra?: { [key: string]: string[] }; + + /** + * Groups is the groups you're testing for. + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#groups + */ + readonly groups?: string[]; + + /** + * NonResourceAttributes describes information for a non-resource access request + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#nonResourceAttributes + */ + readonly nonResourceAttributes?: NonResourceAttributes; + + /** + * ResourceAuthorizationAttributes describes information for a resource access request + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#resourceAttributes + */ + readonly resourceAttributes?: ResourceAttributes; + + /** + * UID information about the requesting user. + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#uid + */ + readonly uid?: string; + + /** + * User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups + * + * @schema io.k8s.api.authorization.v1.SubjectAccessReviewSpec#user + */ + readonly user?: string; + +} + +/** + * Converts an object of type 'SubjectAccessReviewSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SubjectAccessReviewSpec(obj: SubjectAccessReviewSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'extra': ((obj.extra) === undefined) ? undefined : (Object.entries(obj.extra).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.map(y => y) }), {})), + 'groups': obj.groups?.map(y => y), + 'nonResourceAttributes': toJson_NonResourceAttributes(obj.nonResourceAttributes), + 'resourceAttributes': toJson_ResourceAttributes(obj.resourceAttributes), + 'uid': obj.uid, + 'user': obj.user, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SelfSubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set + * + * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReviewSpec + */ +export interface SelfSubjectAccessReviewSpec { + /** + * NonResourceAttributes describes information for a non-resource access request + * + * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReviewSpec#nonResourceAttributes + */ + readonly nonResourceAttributes?: NonResourceAttributes; + + /** + * ResourceAuthorizationAttributes describes information for a resource access request + * + * @schema io.k8s.api.authorization.v1.SelfSubjectAccessReviewSpec#resourceAttributes + */ + readonly resourceAttributes?: ResourceAttributes; + +} + +/** + * Converts an object of type 'SelfSubjectAccessReviewSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SelfSubjectAccessReviewSpec(obj: SelfSubjectAccessReviewSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'nonResourceAttributes': toJson_NonResourceAttributes(obj.nonResourceAttributes), + 'resourceAttributes': toJson_ResourceAttributes(obj.resourceAttributes), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReviewSpec + */ +export interface SelfSubjectRulesReviewSpec { + /** + * Namespace to evaluate rules for. Required. + * + * @schema io.k8s.api.authorization.v1.SelfSubjectRulesReviewSpec#namespace + */ + readonly namespace?: string; + +} + +/** + * Converts an object of type 'SelfSubjectRulesReviewSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SelfSubjectRulesReviewSpec(obj: SelfSubjectRulesReviewSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'namespace': obj.namespace, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set + * + * @schema io.k8s.api.authorization.v1beta1.SubjectAccessReviewSpec + */ +export interface SubjectAccessReviewSpecV1Beta1 { + /** + * Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. + * + * @schema io.k8s.api.authorization.v1beta1.SubjectAccessReviewSpec#extra + */ + readonly extra?: { [key: string]: string[] }; + + /** + * Groups is the groups you're testing for. + * + * @schema io.k8s.api.authorization.v1beta1.SubjectAccessReviewSpec#group + */ + readonly group?: string[]; + + /** + * NonResourceAttributes describes information for a non-resource access request + * + * @schema io.k8s.api.authorization.v1beta1.SubjectAccessReviewSpec#nonResourceAttributes + */ + readonly nonResourceAttributes?: NonResourceAttributesV1Beta1; + + /** + * ResourceAuthorizationAttributes describes information for a resource access request + * + * @schema io.k8s.api.authorization.v1beta1.SubjectAccessReviewSpec#resourceAttributes + */ + readonly resourceAttributes?: ResourceAttributesV1Beta1; + + /** + * UID information about the requesting user. + * + * @schema io.k8s.api.authorization.v1beta1.SubjectAccessReviewSpec#uid + */ + readonly uid?: string; + + /** + * User is the user you're testing for. If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups + * + * @schema io.k8s.api.authorization.v1beta1.SubjectAccessReviewSpec#user + */ + readonly user?: string; + +} + +/** + * Converts an object of type 'SubjectAccessReviewSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SubjectAccessReviewSpecV1Beta1(obj: SubjectAccessReviewSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'extra': ((obj.extra) === undefined) ? undefined : (Object.entries(obj.extra).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.map(y => y) }), {})), + 'group': obj.group?.map(y => y), + 'nonResourceAttributes': toJson_NonResourceAttributesV1Beta1(obj.nonResourceAttributes), + 'resourceAttributes': toJson_ResourceAttributesV1Beta1(obj.resourceAttributes), + 'uid': obj.uid, + 'user': obj.user, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SelfSubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set + * + * @schema io.k8s.api.authorization.v1beta1.SelfSubjectAccessReviewSpec + */ +export interface SelfSubjectAccessReviewSpecV1Beta1 { + /** + * NonResourceAttributes describes information for a non-resource access request + * + * @schema io.k8s.api.authorization.v1beta1.SelfSubjectAccessReviewSpec#nonResourceAttributes + */ + readonly nonResourceAttributes?: NonResourceAttributesV1Beta1; + + /** + * ResourceAuthorizationAttributes describes information for a resource access request + * + * @schema io.k8s.api.authorization.v1beta1.SelfSubjectAccessReviewSpec#resourceAttributes + */ + readonly resourceAttributes?: ResourceAttributesV1Beta1; + +} + +/** + * Converts an object of type 'SelfSubjectAccessReviewSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SelfSubjectAccessReviewSpecV1Beta1(obj: SelfSubjectAccessReviewSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'nonResourceAttributes': toJson_NonResourceAttributesV1Beta1(obj.nonResourceAttributes), + 'resourceAttributes': toJson_ResourceAttributesV1Beta1(obj.resourceAttributes), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * @schema io.k8s.api.authorization.v1beta1.SelfSubjectRulesReviewSpec + */ +export interface SelfSubjectRulesReviewSpecV1Beta1 { + /** + * Namespace to evaluate rules for. Required. + * + * @schema io.k8s.api.authorization.v1beta1.SelfSubjectRulesReviewSpec#namespace + */ + readonly namespace?: string; + +} + +/** + * Converts an object of type 'SelfSubjectRulesReviewSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SelfSubjectRulesReviewSpecV1Beta1(obj: SelfSubjectRulesReviewSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'namespace': obj.namespace, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * specification of a horizontal pod autoscaler. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec + */ +export interface HorizontalPodAutoscalerSpec { + /** + * upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec#maxReplicas + */ + readonly maxReplicas: number; + + /** + * minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec#minReplicas + */ + readonly minReplicas?: number; + + /** + * reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec#scaleTargetRef + */ + readonly scaleTargetRef: CrossVersionObjectReference; + + /** + * target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used. + * + * @schema io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec#targetCPUUtilizationPercentage + */ + readonly targetCpuUtilizationPercentage?: number; + +} + +/** + * Converts an object of type 'HorizontalPodAutoscalerSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HorizontalPodAutoscalerSpec(obj: HorizontalPodAutoscalerSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'maxReplicas': obj.maxReplicas, + 'minReplicas': obj.minReplicas, + 'scaleTargetRef': toJson_CrossVersionObjectReference(obj.scaleTargetRef), + 'targetCPUUtilizationPercentage': obj.targetCpuUtilizationPercentage, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ScaleSpec describes the attributes of a scale subresource. + * + * @schema io.k8s.api.autoscaling.v1.ScaleSpec + */ +export interface ScaleSpec { + /** + * desired number of instances for the scaled object. + * + * @schema io.k8s.api.autoscaling.v1.ScaleSpec#replicas + */ + readonly replicas?: number; + +} + +/** + * Converts an object of type 'ScaleSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ScaleSpec(obj: ScaleSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'replicas': obj.replicas, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler. + * + * @schema io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerSpec + */ +export interface HorizontalPodAutoscalerSpecV2Beta1 { + /** + * maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. + * + * @schema io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerSpec#maxReplicas + */ + readonly maxReplicas: number; + + /** + * metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. + * + * @schema io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerSpec#metrics + */ + readonly metrics?: MetricSpecV2Beta1[]; + + /** + * minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. + * + * @schema io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerSpec#minReplicas + */ + readonly minReplicas?: number; + + /** + * scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count. + * + * @schema io.k8s.api.autoscaling.v2beta1.HorizontalPodAutoscalerSpec#scaleTargetRef + */ + readonly scaleTargetRef: CrossVersionObjectReferenceV2Beta1; + +} + +/** + * Converts an object of type 'HorizontalPodAutoscalerSpecV2Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HorizontalPodAutoscalerSpecV2Beta1(obj: HorizontalPodAutoscalerSpecV2Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'maxReplicas': obj.maxReplicas, + 'metrics': obj.metrics?.map(y => toJson_MetricSpecV2Beta1(y)), + 'minReplicas': obj.minReplicas, + 'scaleTargetRef': toJson_CrossVersionObjectReferenceV2Beta1(obj.scaleTargetRef), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler. + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerSpec + */ +export interface HorizontalPodAutoscalerSpecV2Beta2 { + /** + * behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used. + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerSpec#behavior + */ + readonly behavior?: HorizontalPodAutoscalerBehaviorV2Beta2; + + /** + * maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerSpec#maxReplicas + */ + readonly maxReplicas: number; + + /** + * metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization. + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerSpec#metrics + */ + readonly metrics?: MetricSpecV2Beta2[]; + + /** + * minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerSpec#minReplicas + */ + readonly minReplicas?: number; + + /** + * scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count. + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerSpec#scaleTargetRef + */ + readonly scaleTargetRef: CrossVersionObjectReferenceV2Beta2; + +} + +/** + * Converts an object of type 'HorizontalPodAutoscalerSpecV2Beta2' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HorizontalPodAutoscalerSpecV2Beta2(obj: HorizontalPodAutoscalerSpecV2Beta2 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'behavior': toJson_HorizontalPodAutoscalerBehaviorV2Beta2(obj.behavior), + 'maxReplicas': obj.maxReplicas, + 'metrics': obj.metrics?.map(y => toJson_MetricSpecV2Beta2(y)), + 'minReplicas': obj.minReplicas, + 'scaleTargetRef': toJson_CrossVersionObjectReferenceV2Beta2(obj.scaleTargetRef), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CronJobSpec describes how the job execution will look like and when it will actually run. + * + * @schema io.k8s.api.batch.v1.CronJobSpec + */ +export interface CronJobSpec { + /** + * Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one + * + * @schema io.k8s.api.batch.v1.CronJobSpec#concurrencyPolicy + */ + readonly concurrencyPolicy?: string; + + /** + * The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1. + * + * @default 1. + * @schema io.k8s.api.batch.v1.CronJobSpec#failedJobsHistoryLimit + */ + readonly failedJobsHistoryLimit?: number; + + /** + * Specifies the job that will be created when executing a CronJob. + * + * @schema io.k8s.api.batch.v1.CronJobSpec#jobTemplate + */ + readonly jobTemplate: JobTemplateSpec; + + /** + * The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. + * + * @schema io.k8s.api.batch.v1.CronJobSpec#schedule + */ + readonly schedule: string; + + /** + * Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. + * + * @schema io.k8s.api.batch.v1.CronJobSpec#startingDeadlineSeconds + */ + readonly startingDeadlineSeconds?: number; + + /** + * The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3. + * + * @default 3. + * @schema io.k8s.api.batch.v1.CronJobSpec#successfulJobsHistoryLimit + */ + readonly successfulJobsHistoryLimit?: number; + + /** + * This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. + * + * @default false. + * @schema io.k8s.api.batch.v1.CronJobSpec#suspend + */ + readonly suspend?: boolean; + +} + +/** + * Converts an object of type 'CronJobSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CronJobSpec(obj: CronJobSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'concurrencyPolicy': obj.concurrencyPolicy, + 'failedJobsHistoryLimit': obj.failedJobsHistoryLimit, + 'jobTemplate': toJson_JobTemplateSpec(obj.jobTemplate), + 'schedule': obj.schedule, + 'startingDeadlineSeconds': obj.startingDeadlineSeconds, + 'successfulJobsHistoryLimit': obj.successfulJobsHistoryLimit, + 'suspend': obj.suspend, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * JobSpec describes how the job execution will look like. + * + * @schema io.k8s.api.batch.v1.JobSpec + */ +export interface JobSpec { + /** + * Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again. + * + * @schema io.k8s.api.batch.v1.JobSpec#activeDeadlineSeconds + */ + readonly activeDeadlineSeconds?: number; + + /** + * Specifies the number of retries before marking this job failed. Defaults to 6 + * + * @default 6 + * @schema io.k8s.api.batch.v1.JobSpec#backoffLimit + */ + readonly backoffLimit?: number; + + /** + * CompletionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`. + * + * `NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other. + * + * `Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. + * + * This field is alpha-level and is only honored by servers that enable the IndexedJob feature gate. More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, the controller skips updates for the Job. + * + * @schema io.k8s.api.batch.v1.JobSpec#completionMode + */ + readonly completionMode?: string; + + /** + * Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ + * + * @schema io.k8s.api.batch.v1.JobSpec#completions + */ + readonly completions?: number; + + /** + * manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector + * + * @schema io.k8s.api.batch.v1.JobSpec#manualSelector + */ + readonly manualSelector?: boolean; + + /** + * Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ + * + * @schema io.k8s.api.batch.v1.JobSpec#parallelism + */ + readonly parallelism?: number; + + /** + * A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + * + * @schema io.k8s.api.batch.v1.JobSpec#selector + */ + readonly selector?: LabelSelector; + + /** + * Suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. This is an alpha field and requires the SuspendJob feature gate to be enabled; otherwise this field may not be set to true. Defaults to false. + * + * @default false. + * @schema io.k8s.api.batch.v1.JobSpec#suspend + */ + readonly suspend?: boolean; + + /** + * Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ + * + * @schema io.k8s.api.batch.v1.JobSpec#template + */ + readonly template: PodTemplateSpec; + + /** + * ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature. + * + * @schema io.k8s.api.batch.v1.JobSpec#ttlSecondsAfterFinished + */ + readonly ttlSecondsAfterFinished?: number; + +} + +/** + * Converts an object of type 'JobSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_JobSpec(obj: JobSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'activeDeadlineSeconds': obj.activeDeadlineSeconds, + 'backoffLimit': obj.backoffLimit, + 'completionMode': obj.completionMode, + 'completions': obj.completions, + 'manualSelector': obj.manualSelector, + 'parallelism': obj.parallelism, + 'selector': toJson_LabelSelector(obj.selector), + 'suspend': obj.suspend, + 'template': toJson_PodTemplateSpec(obj.template), + 'ttlSecondsAfterFinished': obj.ttlSecondsAfterFinished, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CronJobSpec describes how the job execution will look like and when it will actually run. + * + * @schema io.k8s.api.batch.v1beta1.CronJobSpec + */ +export interface CronJobSpecV1Beta1 { + /** + * Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one + * + * @schema io.k8s.api.batch.v1beta1.CronJobSpec#concurrencyPolicy + */ + readonly concurrencyPolicy?: string; + + /** + * The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. + * + * @default 1. + * @schema io.k8s.api.batch.v1beta1.CronJobSpec#failedJobsHistoryLimit + */ + readonly failedJobsHistoryLimit?: number; + + /** + * Specifies the job that will be created when executing a CronJob. + * + * @schema io.k8s.api.batch.v1beta1.CronJobSpec#jobTemplate + */ + readonly jobTemplate: JobTemplateSpecV1Beta1; + + /** + * The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. + * + * @schema io.k8s.api.batch.v1beta1.CronJobSpec#schedule + */ + readonly schedule: string; + + /** + * Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. + * + * @schema io.k8s.api.batch.v1beta1.CronJobSpec#startingDeadlineSeconds + */ + readonly startingDeadlineSeconds?: number; + + /** + * The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3. + * + * @default 3. + * @schema io.k8s.api.batch.v1beta1.CronJobSpec#successfulJobsHistoryLimit + */ + readonly successfulJobsHistoryLimit?: number; + + /** + * This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. + * + * @default false. + * @schema io.k8s.api.batch.v1beta1.CronJobSpec#suspend + */ + readonly suspend?: boolean; + +} + +/** + * Converts an object of type 'CronJobSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CronJobSpecV1Beta1(obj: CronJobSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'concurrencyPolicy': obj.concurrencyPolicy, + 'failedJobsHistoryLimit': obj.failedJobsHistoryLimit, + 'jobTemplate': toJson_JobTemplateSpecV1Beta1(obj.jobTemplate), + 'schedule': obj.schedule, + 'startingDeadlineSeconds': obj.startingDeadlineSeconds, + 'successfulJobsHistoryLimit': obj.successfulJobsHistoryLimit, + 'suspend': obj.suspend, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CertificateSigningRequestSpec contains the certificate request. + * + * @schema io.k8s.api.certificates.v1.CertificateSigningRequestSpec + */ +export interface CertificateSigningRequestSpec { + /** + * extra contains extra attributes of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. + * + * @schema io.k8s.api.certificates.v1.CertificateSigningRequestSpec#extra + */ + readonly extra?: { [key: string]: string[] }; + + /** + * groups contains group membership of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. + * + * @schema io.k8s.api.certificates.v1.CertificateSigningRequestSpec#groups + */ + readonly groups?: string[]; + + /** + * request contains an x509 certificate signing request encoded in a "CERTIFICATE REQUEST" PEM block. When serialized as JSON or YAML, the data is additionally base64-encoded. + * + * @schema io.k8s.api.certificates.v1.CertificateSigningRequestSpec#request + */ + readonly request: string; + + /** + * signerName indicates the requested signer, and is a qualified name. + * + * List/watch requests for CertificateSigningRequests can filter on this field using a "spec.signerName=NAME" fieldSelector. + * + * Well-known Kubernetes signers are: + * 1. "kubernetes.io/kube-apiserver-client": issues client certificates that can be used to authenticate to kube-apiserver. + * Requests for this signer are never auto-approved by kube-controller-manager, can be issued by the "csrsigning" controller in kube-controller-manager. + * 2. "kubernetes.io/kube-apiserver-client-kubelet": issues client certificates that kubelets use to authenticate to kube-apiserver. + * Requests for this signer can be auto-approved by the "csrapproving" controller in kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. + * 3. "kubernetes.io/kubelet-serving" issues serving certificates that kubelets use to serve TLS endpoints, which kube-apiserver can connect to securely. + * Requests for this signer are never auto-approved by kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. + * + * More details are available at https://k8s.io/docs/reference/access-authn-authz/certificate-signing-requests/#kubernetes-signers + * + * Custom signerNames can also be specified. The signer defines: + * 1. Trust distribution: how trust (CA bundles) are distributed. + * 2. Permitted subjects: and behavior when a disallowed subject is requested. + * 3. Required, permitted, or forbidden x509 extensions in the request (including whether subjectAltNames are allowed, which types, restrictions on allowed values) and behavior when a disallowed extension is requested. + * 4. Required, permitted, or forbidden key usages / extended key usages. + * 5. Expiration/certificate lifetime: whether it is fixed by the signer, configurable by the admin. + * 6. Whether or not requests for CA certificates are allowed. + * + * @schema io.k8s.api.certificates.v1.CertificateSigningRequestSpec#signerName + */ + readonly signerName: string; + + /** + * uid contains the uid of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. + * + * @schema io.k8s.api.certificates.v1.CertificateSigningRequestSpec#uid + */ + readonly uid?: string; + + /** + * usages specifies a set of key usages requested in the issued certificate. + * + * Requests for TLS client certificates typically request: "digital signature", "key encipherment", "client auth". + * + * Requests for TLS serving certificates typically request: "key encipherment", "digital signature", "server auth". + * + * Valid values are: + * "signing", "digital signature", "content commitment", + * "key encipherment", "key agreement", "data encipherment", + * "cert sign", "crl sign", "encipher only", "decipher only", "any", + * "server auth", "client auth", + * "code signing", "email protection", "s/mime", + * "ipsec end system", "ipsec tunnel", "ipsec user", + * "timestamping", "ocsp signing", "microsoft sgc", "netscape sgc" + * + * @schema io.k8s.api.certificates.v1.CertificateSigningRequestSpec#usages + */ + readonly usages?: string[]; + + /** + * username contains the name of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. + * + * @schema io.k8s.api.certificates.v1.CertificateSigningRequestSpec#username + */ + readonly username?: string; + +} + +/** + * Converts an object of type 'CertificateSigningRequestSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CertificateSigningRequestSpec(obj: CertificateSigningRequestSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'extra': ((obj.extra) === undefined) ? undefined : (Object.entries(obj.extra).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.map(y => y) }), {})), + 'groups': obj.groups?.map(y => y), + 'request': obj.request, + 'signerName': obj.signerName, + 'uid': obj.uid, + 'usages': obj.usages?.map(y => y), + 'username': obj.username, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * This information is immutable after the request is created. Only the Request and Usages fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users. + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec + */ +export interface CertificateSigningRequestSpecV1Beta1 { + /** + * Extra information about the requesting user. See user.Info interface for details. + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#extra + */ + readonly extra?: { [key: string]: string[] }; + + /** + * Group information about the requesting user. See user.Info interface for details. + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#groups + */ + readonly groups?: string[]; + + /** + * Base64-encoded PKCS#10 CSR data + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#request + */ + readonly request: string; + + /** + * Requested signer for the request. It is a qualified name in the form: `scope-hostname.io/name`. If empty, it will be defaulted: + * 1. If it's a kubelet client certificate, it is assigned + * "kubernetes.io/kube-apiserver-client-kubelet". + * 2. If it's a kubelet serving certificate, it is assigned + * "kubernetes.io/kubelet-serving". + * 3. Otherwise, it is assigned "kubernetes.io/legacy-unknown". + * Distribution of trust for signers happens out of band. You can select on this field using `spec.signerName`. + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#signerName + */ + readonly signerName?: string; + + /** + * UID information about the requesting user. See user.Info interface for details. + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#uid + */ + readonly uid?: string; + + /** + * allowedUsages specifies a set of usage contexts the key will be valid for. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 + * https://tools.ietf.org/html/rfc5280#section-4.2.1.12 + * Valid values are: + * "signing", + * "digital signature", + * "content commitment", + * "key encipherment", + * "key agreement", + * "data encipherment", + * "cert sign", + * "crl sign", + * "encipher only", + * "decipher only", + * "any", + * "server auth", + * "client auth", + * "code signing", + * "email protection", + * "s/mime", + * "ipsec end system", + * "ipsec tunnel", + * "ipsec user", + * "timestamping", + * "ocsp signing", + * "microsoft sgc", + * "netscape sgc" + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#usages + */ + readonly usages?: string[]; + + /** + * Information about the requesting user. See user.Info interface for details. + * + * @schema io.k8s.api.certificates.v1beta1.CertificateSigningRequestSpec#username + */ + readonly username?: string; + +} + +/** + * Converts an object of type 'CertificateSigningRequestSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CertificateSigningRequestSpecV1Beta1(obj: CertificateSigningRequestSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'extra': ((obj.extra) === undefined) ? undefined : (Object.entries(obj.extra).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.map(y => y) }), {})), + 'groups': obj.groups?.map(y => y), + 'request': obj.request, + 'signerName': obj.signerName, + 'uid': obj.uid, + 'usages': obj.usages?.map(y => y), + 'username': obj.username, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * LeaseSpec is a specification of a Lease. + * + * @schema io.k8s.api.coordination.v1.LeaseSpec + */ +export interface LeaseSpec { + /** + * acquireTime is a time when the current lease was acquired. + * + * @schema io.k8s.api.coordination.v1.LeaseSpec#acquireTime + */ + readonly acquireTime?: Date; + + /** + * holderIdentity contains the identity of the holder of a current lease. + * + * @schema io.k8s.api.coordination.v1.LeaseSpec#holderIdentity + */ + readonly holderIdentity?: string; + + /** + * leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime. + * + * @schema io.k8s.api.coordination.v1.LeaseSpec#leaseDurationSeconds + */ + readonly leaseDurationSeconds?: number; + + /** + * leaseTransitions is the number of transitions of a lease between holders. + * + * @schema io.k8s.api.coordination.v1.LeaseSpec#leaseTransitions + */ + readonly leaseTransitions?: number; + + /** + * renewTime is a time when the current holder of a lease has last updated the lease. + * + * @schema io.k8s.api.coordination.v1.LeaseSpec#renewTime + */ + readonly renewTime?: Date; + +} + +/** + * Converts an object of type 'LeaseSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_LeaseSpec(obj: LeaseSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'acquireTime': obj.acquireTime?.toISOString(), + 'holderIdentity': obj.holderIdentity, + 'leaseDurationSeconds': obj.leaseDurationSeconds, + 'leaseTransitions': obj.leaseTransitions, + 'renewTime': obj.renewTime?.toISOString(), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * LeaseSpec is a specification of a Lease. + * + * @schema io.k8s.api.coordination.v1beta1.LeaseSpec + */ +export interface LeaseSpecV1Beta1 { + /** + * acquireTime is a time when the current lease was acquired. + * + * @schema io.k8s.api.coordination.v1beta1.LeaseSpec#acquireTime + */ + readonly acquireTime?: Date; + + /** + * holderIdentity contains the identity of the holder of a current lease. + * + * @schema io.k8s.api.coordination.v1beta1.LeaseSpec#holderIdentity + */ + readonly holderIdentity?: string; + + /** + * leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime. + * + * @schema io.k8s.api.coordination.v1beta1.LeaseSpec#leaseDurationSeconds + */ + readonly leaseDurationSeconds?: number; + + /** + * leaseTransitions is the number of transitions of a lease between holders. + * + * @schema io.k8s.api.coordination.v1beta1.LeaseSpec#leaseTransitions + */ + readonly leaseTransitions?: number; + + /** + * renewTime is a time when the current holder of a lease has last updated the lease. + * + * @schema io.k8s.api.coordination.v1beta1.LeaseSpec#renewTime + */ + readonly renewTime?: Date; + +} + +/** + * Converts an object of type 'LeaseSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_LeaseSpecV1Beta1(obj: LeaseSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'acquireTime': obj.acquireTime?.toISOString(), + 'holderIdentity': obj.holderIdentity, + 'leaseDurationSeconds': obj.leaseDurationSeconds, + 'leaseTransitions': obj.leaseTransitions, + 'renewTime': obj.renewTime?.toISOString(), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ObjectReference contains enough information to let you inspect or modify the referred object. + * + * @schema io.k8s.api.core.v1.ObjectReference + */ +export interface ObjectReference { + /** + * API version of the referent. + * + * @schema io.k8s.api.core.v1.ObjectReference#apiVersion + */ + readonly apiVersion?: string; + + /** + * If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. + * + * @schema io.k8s.api.core.v1.ObjectReference#fieldPath + */ + readonly fieldPath?: string; + + /** + * Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.api.core.v1.ObjectReference#kind + */ + readonly kind?: string; + + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.ObjectReference#name + */ + readonly name?: string; + + /** + * Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + * + * @schema io.k8s.api.core.v1.ObjectReference#namespace + */ + readonly namespace?: string; + + /** + * Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency + * + * @schema io.k8s.api.core.v1.ObjectReference#resourceVersion + */ + readonly resourceVersion?: string; + + /** + * UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids + * + * @schema io.k8s.api.core.v1.ObjectReference#uid + */ + readonly uid?: string; + +} + +/** + * Converts an object of type 'ObjectReference' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ObjectReference(obj: ObjectReference | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiVersion': obj.apiVersion, + 'fieldPath': obj.fieldPath, + 'kind': obj.kind, + 'name': obj.name, + 'namespace': obj.namespace, + 'resourceVersion': obj.resourceVersion, + 'uid': obj.uid, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Information about the condition of a component. + * + * @schema io.k8s.api.core.v1.ComponentCondition + */ +export interface ComponentCondition { + /** + * Condition error code for a component. For example, a health check error code. + * + * @schema io.k8s.api.core.v1.ComponentCondition#error + */ + readonly error?: string; + + /** + * Message about the condition for a component. For example, information about a health check. + * + * @schema io.k8s.api.core.v1.ComponentCondition#message + */ + readonly message?: string; + + /** + * Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". + * + * @schema io.k8s.api.core.v1.ComponentCondition#status + */ + readonly status: string; + + /** + * Type of condition for a component. Valid value: "Healthy" + * + * @schema io.k8s.api.core.v1.ComponentCondition#type + */ + readonly type: string; + +} + +/** + * Converts an object of type 'ComponentCondition' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ComponentCondition(obj: ComponentCondition | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'error': obj.error, + 'message': obj.message, + 'status': obj.status, + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: + * { + * Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], + * Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] + * } + * The resulting set of endpoints can be viewed as: + * a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], + * b: [ 10.10.1.1:309, 10.10.2.2:309 ] + * + * @schema io.k8s.api.core.v1.EndpointSubset + */ +export interface EndpointSubset { + /** + * IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize. + * + * @schema io.k8s.api.core.v1.EndpointSubset#addresses + */ + readonly addresses?: EndpointAddress[]; + + /** + * IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. + * + * @schema io.k8s.api.core.v1.EndpointSubset#notReadyAddresses + */ + readonly notReadyAddresses?: EndpointAddress[]; + + /** + * Port numbers available on the related IP addresses. + * + * @schema io.k8s.api.core.v1.EndpointSubset#ports + */ + readonly ports?: EndpointPort[]; + +} + +/** + * Converts an object of type 'EndpointSubset' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EndpointSubset(obj: EndpointSubset | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'addresses': obj.addresses?.map(y => toJson_EndpointAddress(y)), + 'notReadyAddresses': obj.notReadyAddresses?.map(y => toJson_EndpointAddress(y)), + 'ports': obj.ports?.map(y => toJson_EndpointPort(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * An EphemeralContainer is a container that may be added temporarily to an existing pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a pod is removed or restarted. If an ephemeral container causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral containers may not be added by directly updating the pod spec. They must be added via the pod's ephemeralcontainers subresource, and they will appear in the pod spec once added. This is an alpha feature enabled by the EphemeralContainers feature flag. + * + * @schema io.k8s.api.core.v1.EphemeralContainer + */ +export interface EphemeralContainer { + /** + * Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If 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). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + * + * @schema io.k8s.api.core.v1.EphemeralContainer#args + */ + readonly args?: string[]; + + /** + * Entrypoint array. 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. If 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). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + * + * @schema io.k8s.api.core.v1.EphemeralContainer#command + */ + readonly command?: string[]; + + /** + * List of environment variables to set in the container. Cannot be updated. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#env + */ + readonly env?: EnvVar[]; + + /** + * List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#envFrom + */ + readonly envFrom?: EnvFromSource[]; + + /** + * Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images + * + * @schema io.k8s.api.core.v1.EphemeralContainer#image + */ + readonly image?: string; + + /** + * Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + * + * @default Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + * @schema io.k8s.api.core.v1.EphemeralContainer#imagePullPolicy + */ + readonly imagePullPolicy?: string; + + /** + * Lifecycle is not allowed for ephemeral containers. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#lifecycle + */ + readonly lifecycle?: Lifecycle; + + /** + * Probes are not allowed for ephemeral containers. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#livenessProbe + */ + readonly livenessProbe?: Probe; + + /** + * Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#name + */ + readonly name: string; + + /** + * Ports are not allowed for ephemeral containers. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#ports + */ + readonly ports?: ContainerPort[]; + + /** + * Probes are not allowed for ephemeral containers. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#readinessProbe + */ + readonly readinessProbe?: Probe; + + /** + * Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#resources + */ + readonly resources?: ResourceRequirements; + + /** + * SecurityContext is not allowed for ephemeral containers. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#securityContext + */ + readonly securityContext?: SecurityContext; + + /** + * Probes are not allowed for ephemeral containers. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#startupProbe + */ + readonly startupProbe?: Probe; + + /** + * Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. + * + * @default false. + * @schema io.k8s.api.core.v1.EphemeralContainer#stdin + */ + readonly stdin?: boolean; + + /** + * Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + * + * @default false + * @schema io.k8s.api.core.v1.EphemeralContainer#stdinOnce + */ + readonly stdinOnce?: boolean; + + /** + * If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container is run in whatever namespaces are shared for the pod. Note that the container runtime must support this feature. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#targetContainerName + */ + readonly targetContainerName?: string; + + /** + * Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + * + * @default dev/termination-log. Cannot be updated. + * @schema io.k8s.api.core.v1.EphemeralContainer#terminationMessagePath + */ + readonly terminationMessagePath?: string; + + /** + * Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + * + * @default File. Cannot be updated. + * @schema io.k8s.api.core.v1.EphemeralContainer#terminationMessagePolicy + */ + readonly terminationMessagePolicy?: string; + + /** + * Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. + * + * @default false. + * @schema io.k8s.api.core.v1.EphemeralContainer#tty + */ + readonly tty?: boolean; + + /** + * volumeDevices is the list of block devices to be used by the container. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#volumeDevices + */ + readonly volumeDevices?: VolumeDevice[]; + + /** + * Pod volumes to mount into the container's filesystem. Cannot be updated. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#volumeMounts + */ + readonly volumeMounts?: VolumeMount[]; + + /** + * Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + * + * @schema io.k8s.api.core.v1.EphemeralContainer#workingDir + */ + readonly workingDir?: string; + +} + +/** + * Converts an object of type 'EphemeralContainer' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EphemeralContainer(obj: EphemeralContainer | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'args': obj.args?.map(y => y), + 'command': obj.command?.map(y => y), + 'env': obj.env?.map(y => toJson_EnvVar(y)), + 'envFrom': obj.envFrom?.map(y => toJson_EnvFromSource(y)), + 'image': obj.image, + 'imagePullPolicy': obj.imagePullPolicy, + 'lifecycle': toJson_Lifecycle(obj.lifecycle), + 'livenessProbe': toJson_Probe(obj.livenessProbe), + 'name': obj.name, + 'ports': obj.ports?.map(y => toJson_ContainerPort(y)), + 'readinessProbe': toJson_Probe(obj.readinessProbe), + 'resources': toJson_ResourceRequirements(obj.resources), + 'securityContext': toJson_SecurityContext(obj.securityContext), + 'startupProbe': toJson_Probe(obj.startupProbe), + 'stdin': obj.stdin, + 'stdinOnce': obj.stdinOnce, + 'targetContainerName': obj.targetContainerName, + 'terminationMessagePath': obj.terminationMessagePath, + 'terminationMessagePolicy': obj.terminationMessagePolicy, + 'tty': obj.tty, + 'volumeDevices': obj.volumeDevices?.map(y => toJson_VolumeDevice(y)), + 'volumeMounts': obj.volumeMounts?.map(y => toJson_VolumeMount(y)), + 'workingDir': obj.workingDir, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EventSource contains information for an event. + * + * @schema io.k8s.api.core.v1.EventSource + */ +export interface EventSource { + /** + * Component from which the event is generated. + * + * @schema io.k8s.api.core.v1.EventSource#component + */ + readonly component?: string; + + /** + * Node name on which the event is generated. + * + * @schema io.k8s.api.core.v1.EventSource#host + */ + readonly host?: string; + +} + +/** + * Converts an object of type 'EventSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EventSource(obj: EventSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'component': obj.component, + 'host': obj.host, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. How often to update the EventSeries is up to the event reporters. The default event reporter in "k8s.io/client-go/tools/events/event_broadcaster.go" shows how this struct is updated on heartbeats and can guide customized reporter implementations. + * + * @schema io.k8s.api.events.v1.EventSeries + */ +export interface EventSeries { + /** + * count is the number of occurrences in this series up to the last heartbeat time. + * + * @schema io.k8s.api.events.v1.EventSeries#count + */ + readonly count: number; + + /** + * lastObservedTime is the time when last Event from the series was seen before last heartbeat. + * + * @schema io.k8s.api.events.v1.EventSeries#lastObservedTime + */ + readonly lastObservedTime: Date; + +} + +/** + * Converts an object of type 'EventSeries' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EventSeries(obj: EventSeries | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'count': obj.count, + 'lastObservedTime': obj.lastObservedTime?.toISOString(), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * LimitRangeSpec defines a min/max usage limit for resources that match on kind. + * + * @schema io.k8s.api.core.v1.LimitRangeSpec + */ +export interface LimitRangeSpec { + /** + * Limits is the list of LimitRangeItem objects that are enforced. + * + * @schema io.k8s.api.core.v1.LimitRangeSpec#limits + */ + readonly limits: LimitRangeItem[]; + +} + +/** + * Converts an object of type 'LimitRangeSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_LimitRangeSpec(obj: LimitRangeSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'limits': obj.limits?.map(y => toJson_LimitRangeItem(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NamespaceSpec describes the attributes on a Namespace. + * + * @schema io.k8s.api.core.v1.NamespaceSpec + */ +export interface NamespaceSpec { + /** + * Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ + * + * @schema io.k8s.api.core.v1.NamespaceSpec#finalizers + */ + readonly finalizers?: string[]; + +} + +/** + * Converts an object of type 'NamespaceSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NamespaceSpec(obj: NamespaceSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'finalizers': obj.finalizers?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NodeSpec describes the attributes that a node is created with. + * + * @schema io.k8s.api.core.v1.NodeSpec + */ +export interface NodeSpec { + /** + * If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field + * + * @schema io.k8s.api.core.v1.NodeSpec#configSource + */ + readonly configSource?: NodeConfigSource; + + /** + * Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966 + * + * @schema io.k8s.api.core.v1.NodeSpec#externalID + */ + readonly externalId?: string; + + /** + * PodCIDR represents the pod IP range assigned to the node. + * + * @schema io.k8s.api.core.v1.NodeSpec#podCIDR + */ + readonly podCidr?: string; + + /** + * podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6. + * + * @schema io.k8s.api.core.v1.NodeSpec#podCIDRs + */ + readonly podCidRs?: string[]; + + /** + * ID of the node assigned by the cloud provider in the format: :// + * + * @schema io.k8s.api.core.v1.NodeSpec#providerID + */ + readonly providerId?: string; + + /** + * If specified, the node's taints. + * + * @schema io.k8s.api.core.v1.NodeSpec#taints + */ + readonly taints?: Taint[]; + + /** + * Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration + * + * @schema io.k8s.api.core.v1.NodeSpec#unschedulable + */ + readonly unschedulable?: boolean; + +} + +/** + * Converts an object of type 'NodeSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NodeSpec(obj: NodeSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'configSource': toJson_NodeConfigSource(obj.configSource), + 'externalID': obj.externalId, + 'podCIDR': obj.podCidr, + 'podCIDRs': obj.podCidRs?.map(y => y), + 'providerID': obj.providerId, + 'taints': obj.taints?.map(y => toJson_Taint(y)), + 'unschedulable': obj.unschedulable, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PersistentVolumeSpec is the specification of a persistent volume. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec + */ +export interface PersistentVolumeSpec { + /** + * AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#accessModes + */ + readonly accessModes?: string[]; + + /** + * AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#awsElasticBlockStore + */ + readonly awsElasticBlockStore?: AwsElasticBlockStoreVolumeSource; + + /** + * AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#azureDisk + */ + readonly azureDisk?: AzureDiskVolumeSource; + + /** + * AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#azureFile + */ + readonly azureFile?: AzureFilePersistentVolumeSource; + + /** + * A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#capacity + */ + readonly capacity?: { [key: string]: Quantity }; + + /** + * CephFS represents a Ceph FS mount on the host that shares a pod's lifetime + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#cephfs + */ + readonly cephfs?: CephFsPersistentVolumeSource; + + /** + * Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#cinder + */ + readonly cinder?: CinderPersistentVolumeSource; + + /** + * ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#claimRef + */ + readonly claimRef?: ObjectReference; + + /** + * CSI represents storage that is handled by an external CSI driver (Beta feature). + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#csi + */ + readonly csi?: CsiPersistentVolumeSource; + + /** + * FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#fc + */ + readonly fc?: FcVolumeSource; + + /** + * FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#flexVolume + */ + readonly flexVolume?: FlexPersistentVolumeSource; + + /** + * Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#flocker + */ + readonly flocker?: FlockerVolumeSource; + + /** + * GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#gcePersistentDisk + */ + readonly gcePersistentDisk?: GcePersistentDiskVolumeSource; + + /** + * Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#glusterfs + */ + readonly glusterfs?: GlusterfsPersistentVolumeSource; + + /** + * HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#hostPath + */ + readonly hostPath?: HostPathVolumeSource; + + /** + * ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#iscsi + */ + readonly iscsi?: IscsiPersistentVolumeSource; + + /** + * Local represents directly-attached storage with node affinity + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#local + */ + readonly local?: LocalVolumeSource; + + /** + * A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#mountOptions + */ + readonly mountOptions?: string[]; + + /** + * NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#nfs + */ + readonly nfs?: NfsVolumeSource; + + /** + * NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#nodeAffinity + */ + readonly nodeAffinity?: VolumeNodeAffinity; + + /** + * What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#persistentVolumeReclaimPolicy + */ + readonly persistentVolumeReclaimPolicy?: string; + + /** + * PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#photonPersistentDisk + */ + readonly photonPersistentDisk?: PhotonPersistentDiskVolumeSource; + + /** + * PortworxVolume represents a portworx volume attached and mounted on kubelets host machine + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#portworxVolume + */ + readonly portworxVolume?: PortworxVolumeSource; + + /** + * Quobyte represents a Quobyte mount on the host that shares a pod's lifetime + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#quobyte + */ + readonly quobyte?: QuobyteVolumeSource; + + /** + * RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#rbd + */ + readonly rbd?: RbdPersistentVolumeSource; + + /** + * ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#scaleIO + */ + readonly scaleIo?: ScaleIoPersistentVolumeSource; + + /** + * Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#storageClassName + */ + readonly storageClassName?: string; + + /** + * StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#storageos + */ + readonly storageos?: StorageOsPersistentVolumeSource; + + /** + * volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#volumeMode + */ + readonly volumeMode?: string; + + /** + * VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine + * + * @schema io.k8s.api.core.v1.PersistentVolumeSpec#vsphereVolume + */ + readonly vsphereVolume?: VsphereVirtualDiskVolumeSource; + +} + +/** + * Converts an object of type 'PersistentVolumeSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PersistentVolumeSpec(obj: PersistentVolumeSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'accessModes': obj.accessModes?.map(y => y), + 'awsElasticBlockStore': toJson_AwsElasticBlockStoreVolumeSource(obj.awsElasticBlockStore), + 'azureDisk': toJson_AzureDiskVolumeSource(obj.azureDisk), + 'azureFile': toJson_AzureFilePersistentVolumeSource(obj.azureFile), + 'capacity': ((obj.capacity) === undefined) ? undefined : (Object.entries(obj.capacity).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.value }), {})), + 'cephfs': toJson_CephFsPersistentVolumeSource(obj.cephfs), + 'cinder': toJson_CinderPersistentVolumeSource(obj.cinder), + 'claimRef': toJson_ObjectReference(obj.claimRef), + 'csi': toJson_CsiPersistentVolumeSource(obj.csi), + 'fc': toJson_FcVolumeSource(obj.fc), + 'flexVolume': toJson_FlexPersistentVolumeSource(obj.flexVolume), + 'flocker': toJson_FlockerVolumeSource(obj.flocker), + 'gcePersistentDisk': toJson_GcePersistentDiskVolumeSource(obj.gcePersistentDisk), + 'glusterfs': toJson_GlusterfsPersistentVolumeSource(obj.glusterfs), + 'hostPath': toJson_HostPathVolumeSource(obj.hostPath), + 'iscsi': toJson_IscsiPersistentVolumeSource(obj.iscsi), + 'local': toJson_LocalVolumeSource(obj.local), + 'mountOptions': obj.mountOptions?.map(y => y), + 'nfs': toJson_NfsVolumeSource(obj.nfs), + 'nodeAffinity': toJson_VolumeNodeAffinity(obj.nodeAffinity), + 'persistentVolumeReclaimPolicy': obj.persistentVolumeReclaimPolicy, + 'photonPersistentDisk': toJson_PhotonPersistentDiskVolumeSource(obj.photonPersistentDisk), + 'portworxVolume': toJson_PortworxVolumeSource(obj.portworxVolume), + 'quobyte': toJson_QuobyteVolumeSource(obj.quobyte), + 'rbd': toJson_RbdPersistentVolumeSource(obj.rbd), + 'scaleIO': toJson_ScaleIoPersistentVolumeSource(obj.scaleIo), + 'storageClassName': obj.storageClassName, + 'storageos': toJson_StorageOsPersistentVolumeSource(obj.storageos), + 'volumeMode': obj.volumeMode, + 'vsphereVolume': toJson_VsphereVirtualDiskVolumeSource(obj.vsphereVolume), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec + */ +export interface PersistentVolumeClaimSpec { + /** + * AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#accessModes + */ + readonly accessModes?: string[]; + + /** + * This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#dataSource + */ + readonly dataSource?: TypedLocalObjectReference; + + /** + * Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#resources + */ + readonly resources?: ResourceRequirements; + + /** + * A label query over volumes to consider for binding. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#selector + */ + readonly selector?: LabelSelector; + + /** + * Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#storageClassName + */ + readonly storageClassName?: string; + + /** + * volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#volumeMode + */ + readonly volumeMode?: string; + + /** + * VolumeName is the binding reference to the PersistentVolume backing this claim. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimSpec#volumeName + */ + readonly volumeName?: string; + +} + +/** + * Converts an object of type 'PersistentVolumeClaimSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PersistentVolumeClaimSpec(obj: PersistentVolumeClaimSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'accessModes': obj.accessModes?.map(y => y), + 'dataSource': toJson_TypedLocalObjectReference(obj.dataSource), + 'resources': toJson_ResourceRequirements(obj.resources), + 'selector': toJson_LabelSelector(obj.selector), + 'storageClassName': obj.storageClassName, + 'volumeMode': obj.volumeMode, + 'volumeName': obj.volumeName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodSpec is a description of a pod. + * + * @schema io.k8s.api.core.v1.PodSpec + */ +export interface PodSpec { + /** + * Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. + * + * @schema io.k8s.api.core.v1.PodSpec#activeDeadlineSeconds + */ + readonly activeDeadlineSeconds?: number; + + /** + * If specified, the pod's scheduling constraints + * + * @schema io.k8s.api.core.v1.PodSpec#affinity + */ + readonly affinity?: Affinity; + + /** + * AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. + * + * @schema io.k8s.api.core.v1.PodSpec#automountServiceAccountToken + */ + readonly automountServiceAccountToken?: boolean; + + /** + * List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. + * + * @schema io.k8s.api.core.v1.PodSpec#containers + */ + readonly containers: Container[]; + + /** + * Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. + * + * @schema io.k8s.api.core.v1.PodSpec#dnsConfig + */ + readonly dnsConfig?: PodDnsConfig; + + /** + * Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. + * + * @default ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. + * @schema io.k8s.api.core.v1.PodSpec#dnsPolicy + */ + readonly dnsPolicy?: string; + + /** + * EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true. + * + * @default true. + * @schema io.k8s.api.core.v1.PodSpec#enableServiceLinks + */ + readonly enableServiceLinks?: boolean; + + /** + * List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. + * + * @schema io.k8s.api.core.v1.PodSpec#ephemeralContainers + */ + readonly ephemeralContainers?: EphemeralContainer[]; + + /** + * HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. + * + * @schema io.k8s.api.core.v1.PodSpec#hostAliases + */ + readonly hostAliases?: HostAlias[]; + + /** + * Use the host's ipc namespace. Optional: Default to false. + * + * @default false. + * @schema io.k8s.api.core.v1.PodSpec#hostIPC + */ + readonly hostIpc?: boolean; + + /** + * Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. + * + * @default false. + * @schema io.k8s.api.core.v1.PodSpec#hostNetwork + */ + readonly hostNetwork?: boolean; + + /** + * Use the host's pid namespace. Optional: Default to false. + * + * @default false. + * @schema io.k8s.api.core.v1.PodSpec#hostPID + */ + readonly hostPid?: boolean; + + /** + * Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. + * + * @schema io.k8s.api.core.v1.PodSpec#hostname + */ + readonly hostname?: string; + + /** + * ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod + * + * @schema io.k8s.api.core.v1.PodSpec#imagePullSecrets + */ + readonly imagePullSecrets?: LocalObjectReference[]; + + /** + * List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ + * + * @schema io.k8s.api.core.v1.PodSpec#initContainers + */ + readonly initContainers?: Container[]; + + /** + * NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. + * + * @schema io.k8s.api.core.v1.PodSpec#nodeName + */ + readonly nodeName?: string; + + /** + * NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + * + * @schema io.k8s.api.core.v1.PodSpec#nodeSelector + */ + readonly nodeSelector?: { [key: string]: string }; + + /** + * Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature. + * + * @schema io.k8s.api.core.v1.PodSpec#overhead + */ + readonly overhead?: { [key: string]: Quantity }; + + /** + * PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + * + * @default PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. + * @schema io.k8s.api.core.v1.PodSpec#preemptionPolicy + */ + readonly preemptionPolicy?: string; + + /** + * The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. + * + * @schema io.k8s.api.core.v1.PodSpec#priority + */ + readonly priority?: number; + + /** + * If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. + * + * @schema io.k8s.api.core.v1.PodSpec#priorityClassName + */ + readonly priorityClassName?: string; + + /** + * If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md + * + * @schema io.k8s.api.core.v1.PodSpec#readinessGates + */ + readonly readinessGates?: PodReadinessGate[]; + + /** + * Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy + * + * @default Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy + * @schema io.k8s.api.core.v1.PodSpec#restartPolicy + */ + readonly restartPolicy?: string; + + /** + * RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14. + * + * @schema io.k8s.api.core.v1.PodSpec#runtimeClassName + */ + readonly runtimeClassName?: string; + + /** + * If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. + * + * @schema io.k8s.api.core.v1.PodSpec#schedulerName + */ + readonly schedulerName?: string; + + /** + * SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. + * + * @default empty. See type description for default values of each field. + * @schema io.k8s.api.core.v1.PodSpec#securityContext + */ + readonly securityContext?: PodSecurityContext; + + /** + * DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. + * + * @schema io.k8s.api.core.v1.PodSpec#serviceAccount + */ + readonly serviceAccount?: string; + + /** + * ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ + * + * @schema io.k8s.api.core.v1.PodSpec#serviceAccountName + */ + readonly serviceAccountName?: string; + + /** + * If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false. + * + * @default false. + * @schema io.k8s.api.core.v1.PodSpec#setHostnameAsFQDN + */ + readonly setHostnameAsFqdn?: boolean; + + /** + * Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. + * + * @default false. + * @schema io.k8s.api.core.v1.PodSpec#shareProcessNamespace + */ + readonly shareProcessNamespace?: boolean; + + /** + * If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. + * + * @schema io.k8s.api.core.v1.PodSpec#subdomain + */ + readonly subdomain?: string; + + /** + * Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. + * + * @default 30 seconds. + * @schema io.k8s.api.core.v1.PodSpec#terminationGracePeriodSeconds + */ + readonly terminationGracePeriodSeconds?: number; + + /** + * If specified, the pod's tolerations. + * + * @schema io.k8s.api.core.v1.PodSpec#tolerations + */ + readonly tolerations?: Toleration[]; + + /** + * TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. + * + * @schema io.k8s.api.core.v1.PodSpec#topologySpreadConstraints + */ + readonly topologySpreadConstraints?: TopologySpreadConstraint[]; + + /** + * List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes + * + * @schema io.k8s.api.core.v1.PodSpec#volumes + */ + readonly volumes?: Volume[]; + +} + +/** + * Converts an object of type 'PodSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PodSpec(obj: PodSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'activeDeadlineSeconds': obj.activeDeadlineSeconds, + 'affinity': toJson_Affinity(obj.affinity), + 'automountServiceAccountToken': obj.automountServiceAccountToken, + 'containers': obj.containers?.map(y => toJson_Container(y)), + 'dnsConfig': toJson_PodDnsConfig(obj.dnsConfig), + 'dnsPolicy': obj.dnsPolicy, + 'enableServiceLinks': obj.enableServiceLinks, + 'ephemeralContainers': obj.ephemeralContainers?.map(y => toJson_EphemeralContainer(y)), + 'hostAliases': obj.hostAliases?.map(y => toJson_HostAlias(y)), + 'hostIPC': obj.hostIpc, + 'hostNetwork': obj.hostNetwork, + 'hostPID': obj.hostPid, + 'hostname': obj.hostname, + 'imagePullSecrets': obj.imagePullSecrets?.map(y => toJson_LocalObjectReference(y)), + 'initContainers': obj.initContainers?.map(y => toJson_Container(y)), + 'nodeName': obj.nodeName, + 'nodeSelector': ((obj.nodeSelector) === undefined) ? undefined : (Object.entries(obj.nodeSelector).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'overhead': ((obj.overhead) === undefined) ? undefined : (Object.entries(obj.overhead).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.value }), {})), + 'preemptionPolicy': obj.preemptionPolicy, + 'priority': obj.priority, + 'priorityClassName': obj.priorityClassName, + 'readinessGates': obj.readinessGates?.map(y => toJson_PodReadinessGate(y)), + 'restartPolicy': obj.restartPolicy, + 'runtimeClassName': obj.runtimeClassName, + 'schedulerName': obj.schedulerName, + 'securityContext': toJson_PodSecurityContext(obj.securityContext), + 'serviceAccount': obj.serviceAccount, + 'serviceAccountName': obj.serviceAccountName, + 'setHostnameAsFQDN': obj.setHostnameAsFqdn, + 'shareProcessNamespace': obj.shareProcessNamespace, + 'subdomain': obj.subdomain, + 'terminationGracePeriodSeconds': obj.terminationGracePeriodSeconds, + 'tolerations': obj.tolerations?.map(y => toJson_Toleration(y)), + 'topologySpreadConstraints': obj.topologySpreadConstraints?.map(y => toJson_TopologySpreadConstraint(y)), + 'volumes': obj.volumes?.map(y => toJson_Volume(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodTemplateSpec describes the data a pod should have when created from a template + * + * @schema io.k8s.api.core.v1.PodTemplateSpec + */ +export interface PodTemplateSpec { + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.core.v1.PodTemplateSpec#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.core.v1.PodTemplateSpec#spec + */ + readonly spec?: PodSpec; + +} + +/** + * Converts an object of type 'PodTemplateSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PodTemplateSpec(obj: PodTemplateSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_PodSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ReplicationControllerSpec is the specification of a replication controller. + * + * @schema io.k8s.api.core.v1.ReplicationControllerSpec + */ +export interface ReplicationControllerSpec { + /** + * 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. Defaults to 0 (pod will be considered available as soon as it is ready) + * + * @default 0 (pod will be considered available as soon as it is ready) + * @schema io.k8s.api.core.v1.ReplicationControllerSpec#minReadySeconds + */ + readonly minReadySeconds?: number; + + /** + * Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller + * + * @default 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller + * @schema io.k8s.api.core.v1.ReplicationControllerSpec#replicas + */ + readonly replicas?: number; + + /** + * Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors + * + * @schema io.k8s.api.core.v1.ReplicationControllerSpec#selector + */ + readonly selector?: { [key: string]: string }; + + /** + * Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template + * + * @schema io.k8s.api.core.v1.ReplicationControllerSpec#template + */ + readonly template?: PodTemplateSpec; + +} + +/** + * Converts an object of type 'ReplicationControllerSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ReplicationControllerSpec(obj: ReplicationControllerSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'minReadySeconds': obj.minReadySeconds, + 'replicas': obj.replicas, + 'selector': ((obj.selector) === undefined) ? undefined : (Object.entries(obj.selector).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'template': toJson_PodTemplateSpec(obj.template), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ResourceQuotaSpec defines the desired hard limits to enforce for Quota. + * + * @schema io.k8s.api.core.v1.ResourceQuotaSpec + */ +export interface ResourceQuotaSpec { + /** + * hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ + * + * @schema io.k8s.api.core.v1.ResourceQuotaSpec#hard + */ + readonly hard?: { [key: string]: Quantity }; + + /** + * scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. + * + * @schema io.k8s.api.core.v1.ResourceQuotaSpec#scopeSelector + */ + readonly scopeSelector?: ScopeSelector; + + /** + * A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. + * + * @schema io.k8s.api.core.v1.ResourceQuotaSpec#scopes + */ + readonly scopes?: string[]; + +} + +/** + * Converts an object of type 'ResourceQuotaSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ResourceQuotaSpec(obj: ResourceQuotaSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'hard': ((obj.hard) === undefined) ? undefined : (Object.entries(obj.hard).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.value }), {})), + 'scopeSelector': toJson_ScopeSelector(obj.scopeSelector), + 'scopes': obj.scopes?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ServiceSpec describes the attributes that a user creates on a service. + * + * @schema io.k8s.api.core.v1.ServiceSpec + */ +export interface ServiceSpec { + /** + * allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. allocateLoadBalancerNodePorts may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. This field is alpha-level and is only honored by servers that enable the ServiceLBNodePortControl feature. + * + * @default true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. allocateLoadBalancerNodePorts may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. This field is alpha-level and is only honored by servers that enable the ServiceLBNodePortControl feature. + * @schema io.k8s.api.core.v1.ServiceSpec#allocateLoadBalancerNodePorts + */ + readonly allocateLoadBalancerNodePorts?: boolean; + + /** + * clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + * + * @schema io.k8s.api.core.v1.ServiceSpec#clusterIP + */ + readonly clusterIp?: string; + + /** + * ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. If this field is not specified, it will be initialized from the clusterIP field. If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value. + * + * Unless the "IPv6DualStack" feature gate is enabled, this field is limited to one value, which must be the same as the clusterIP field. If the feature gate is enabled, this field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + * + * @schema io.k8s.api.core.v1.ServiceSpec#clusterIPs + */ + readonly clusterIPs?: string[]; + + /** + * externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. + * + * @schema io.k8s.api.core.v1.ServiceSpec#externalIPs + */ + readonly externalIPs?: string[]; + + /** + * externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName". + * + * @schema io.k8s.api.core.v1.ServiceSpec#externalName + */ + readonly externalName?: string; + + /** + * externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading. + * + * @schema io.k8s.api.core.v1.ServiceSpec#externalTrafficPolicy + */ + readonly externalTrafficPolicy?: string; + + /** + * healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). + * + * @schema io.k8s.api.core.v1.ServiceSpec#healthCheckNodePort + */ + readonly healthCheckNodePort?: number; + + /** + * InternalTrafficPolicy specifies if the cluster internal traffic should be routed to all endpoints or node-local endpoints only. "Cluster" routes internal traffic to a Service to all endpoints. "Local" routes traffic to node-local endpoints only, traffic is dropped if no node-local endpoints are ready. The default value is "Cluster". + * + * @schema io.k8s.api.core.v1.ServiceSpec#internalTrafficPolicy + */ + readonly internalTrafficPolicy?: string; + + /** + * IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service, and is gated by the "IPv6DualStack" feature gate. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. + * + * This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. + * + * @schema io.k8s.api.core.v1.ServiceSpec#ipFamilies + */ + readonly ipFamilies?: string[]; + + /** + * IPFamilyPolicy represents the dual-stack-ness requested or required by this Service, and is gated by the "IPv6DualStack" feature gate. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName. + * + * @schema io.k8s.api.core.v1.ServiceSpec#ipFamilyPolicy + */ + readonly ipFamilyPolicy?: string; + + /** + * loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type. + * + * @schema io.k8s.api.core.v1.ServiceSpec#loadBalancerClass + */ + readonly loadBalancerClass?: string; + + /** + * Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. + * + * @schema io.k8s.api.core.v1.ServiceSpec#loadBalancerIP + */ + readonly loadBalancerIp?: string; + + /** + * If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/ + * + * @schema io.k8s.api.core.v1.ServiceSpec#loadBalancerSourceRanges + */ + readonly loadBalancerSourceRanges?: string[]; + + /** + * The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + * + * @schema io.k8s.api.core.v1.ServiceSpec#ports + */ + readonly ports?: ServicePort[]; + + /** + * publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a StatefulSet's Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered "ready" even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior. + * + * @schema io.k8s.api.core.v1.ServiceSpec#publishNotReadyAddresses + */ + readonly publishNotReadyAddresses?: boolean; + + /** + * Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/ + * + * @schema io.k8s.api.core.v1.ServiceSpec#selector + */ + readonly selector?: { [key: string]: string }; + + /** + * Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + * + * @default None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies + * @schema io.k8s.api.core.v1.ServiceSpec#sessionAffinity + */ + readonly sessionAffinity?: string; + + /** + * sessionAffinityConfig contains the configurations of session affinity. + * + * @schema io.k8s.api.core.v1.ServiceSpec#sessionAffinityConfig + */ + readonly sessionAffinityConfig?: SessionAffinityConfig; + + /** + * topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. Topology keys must be valid label keys and at most 16 keys may be specified. Endpoints are chosen based on the first topology key with available backends. If this field is specified and all entries have no backends that match the topology of the client, the service has no backends for that client and connections should fail. The special value "*" may be used to mean "any topology". This catch-all value, if used, only makes sense as the last value in the list. If this is not specified or empty, no topology constraints will be applied. This field is alpha-level and is only honored by servers that enable the ServiceTopology feature. This field is deprecated and will be removed in a future version. + * + * @schema io.k8s.api.core.v1.ServiceSpec#topologyKeys + */ + readonly topologyKeys?: string[]; + + /** + * type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + * + * @default ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types + * @schema io.k8s.api.core.v1.ServiceSpec#type + */ + readonly type?: string; + +} + +/** + * Converts an object of type 'ServiceSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ServiceSpec(obj: ServiceSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'allocateLoadBalancerNodePorts': obj.allocateLoadBalancerNodePorts, + 'clusterIP': obj.clusterIp, + 'clusterIPs': obj.clusterIPs?.map(y => y), + 'externalIPs': obj.externalIPs?.map(y => y), + 'externalName': obj.externalName, + 'externalTrafficPolicy': obj.externalTrafficPolicy, + 'healthCheckNodePort': obj.healthCheckNodePort, + 'internalTrafficPolicy': obj.internalTrafficPolicy, + 'ipFamilies': obj.ipFamilies?.map(y => y), + 'ipFamilyPolicy': obj.ipFamilyPolicy, + 'loadBalancerClass': obj.loadBalancerClass, + 'loadBalancerIP': obj.loadBalancerIp, + 'loadBalancerSourceRanges': obj.loadBalancerSourceRanges?.map(y => y), + 'ports': obj.ports?.map(y => toJson_ServicePort(y)), + 'publishNotReadyAddresses': obj.publishNotReadyAddresses, + 'selector': ((obj.selector) === undefined) ? undefined : (Object.entries(obj.selector).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'sessionAffinity': obj.sessionAffinity, + 'sessionAffinityConfig': toJson_SessionAffinityConfig(obj.sessionAffinityConfig), + 'topologyKeys': obj.topologyKeys?.map(y => y), + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. + * + * @schema io.k8s.api.core.v1.LocalObjectReference + */ +export interface LocalObjectReference { + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.LocalObjectReference#name + */ + readonly name?: string; + +} + +/** + * Converts an object of type 'LocalObjectReference' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_LocalObjectReference(obj: LocalObjectReference | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Endpoint represents a single logical "backend" implementing a service. + * + * @schema io.k8s.api.discovery.v1.Endpoint + */ +export interface Endpoint { + /** + * addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100. + * + * @schema io.k8s.api.discovery.v1.Endpoint#addresses + */ + readonly addresses: string[]; + + /** + * conditions contains information about the current status of the endpoint. + * + * @schema io.k8s.api.discovery.v1.Endpoint#conditions + */ + readonly conditions?: EndpointConditions; + + /** + * deprecatedTopology contains topology information part of the v1beta1 API. This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24). While this field can hold values, it is not writable through the v1 API, and any attempts to write to it will be silently ignored. Topology information can be found in the zone and nodeName fields instead. + * + * @schema io.k8s.api.discovery.v1.Endpoint#deprecatedTopology + */ + readonly deprecatedTopology?: { [key: string]: string }; + + /** + * hints contains information associated with how an endpoint should be consumed. + * + * @schema io.k8s.api.discovery.v1.Endpoint#hints + */ + readonly hints?: EndpointHints; + + /** + * hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation. + * + * @schema io.k8s.api.discovery.v1.Endpoint#hostname + */ + readonly hostname?: string; + + /** + * nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node. This field can be enabled with the EndpointSliceNodeName feature gate. + * + * @schema io.k8s.api.discovery.v1.Endpoint#nodeName + */ + readonly nodeName?: string; + + /** + * targetRef is a reference to a Kubernetes object that represents this endpoint. + * + * @schema io.k8s.api.discovery.v1.Endpoint#targetRef + */ + readonly targetRef?: ObjectReference; + + /** + * zone is the name of the Zone this endpoint exists in. + * + * @schema io.k8s.api.discovery.v1.Endpoint#zone + */ + readonly zone?: string; + +} + +/** + * Converts an object of type 'Endpoint' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Endpoint(obj: Endpoint | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'addresses': obj.addresses?.map(y => y), + 'conditions': toJson_EndpointConditions(obj.conditions), + 'deprecatedTopology': ((obj.deprecatedTopology) === undefined) ? undefined : (Object.entries(obj.deprecatedTopology).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'hints': toJson_EndpointHints(obj.hints), + 'hostname': obj.hostname, + 'nodeName': obj.nodeName, + 'targetRef': toJson_ObjectReference(obj.targetRef), + 'zone': obj.zone, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EndpointPort is a tuple that describes a single port. + * + * @schema io.k8s.api.core.v1.EndpointPort + */ +export interface EndpointPort { + /** + * The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default. + * + * @schema io.k8s.api.core.v1.EndpointPort#appProtocol + */ + readonly appProtocol?: string; + + /** + * The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined. + * + * @schema io.k8s.api.core.v1.EndpointPort#name + */ + readonly name?: string; + + /** + * The port number of the endpoint. + * + * @schema io.k8s.api.core.v1.EndpointPort#port + */ + readonly port: number; + + /** + * The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. + * + * @default TCP. + * @schema io.k8s.api.core.v1.EndpointPort#protocol + */ + readonly protocol?: string; + +} + +/** + * Converts an object of type 'EndpointPort' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EndpointPort(obj: EndpointPort | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'appProtocol': obj.appProtocol, + 'name': obj.name, + 'port': obj.port, + 'protocol': obj.protocol, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Endpoint represents a single logical "backend" implementing a service. + * + * @schema io.k8s.api.discovery.v1beta1.Endpoint + */ +export interface EndpointV1Beta1 { + /** + * addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100. + * + * @schema io.k8s.api.discovery.v1beta1.Endpoint#addresses + */ + readonly addresses: string[]; + + /** + * conditions contains information about the current status of the endpoint. + * + * @schema io.k8s.api.discovery.v1beta1.Endpoint#conditions + */ + readonly conditions?: EndpointConditionsV1Beta1; + + /** + * hints contains information associated with how an endpoint should be consumed. + * + * @schema io.k8s.api.discovery.v1beta1.Endpoint#hints + */ + readonly hints?: EndpointHintsV1Beta1; + + /** + * hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation. + * + * @schema io.k8s.api.discovery.v1beta1.Endpoint#hostname + */ + readonly hostname?: string; + + /** + * nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node. This field can be enabled with the EndpointSliceNodeName feature gate. + * + * @schema io.k8s.api.discovery.v1beta1.Endpoint#nodeName + */ + readonly nodeName?: string; + + /** + * targetRef is a reference to a Kubernetes object that represents this endpoint. + * + * @schema io.k8s.api.discovery.v1beta1.Endpoint#targetRef + */ + readonly targetRef?: ObjectReference; + + /** + * topology contains arbitrary topology information associated with the endpoint. These key/value pairs must conform with the label format. https://kubernetes.io/docs/concepts/overview/working-with-objects/labels Topology may include a maximum of 16 key/value pairs. This includes, but is not limited to the following well known keys: * kubernetes.io/hostname: the value indicates the hostname of the node + * where the endpoint is located. This should match the corresponding + * node label. + * * topology.kubernetes.io/zone: the value indicates the zone where the + * endpoint is located. This should match the corresponding node label. + * * topology.kubernetes.io/region: the value indicates the region where the + * endpoint is located. This should match the corresponding node label. + * This field is deprecated and will be removed in future api versions. + * + * @schema io.k8s.api.discovery.v1beta1.Endpoint#topology + */ + readonly topology?: { [key: string]: string }; + +} + +/** + * Converts an object of type 'EndpointV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EndpointV1Beta1(obj: EndpointV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'addresses': obj.addresses?.map(y => y), + 'conditions': toJson_EndpointConditionsV1Beta1(obj.conditions), + 'hints': toJson_EndpointHintsV1Beta1(obj.hints), + 'hostname': obj.hostname, + 'nodeName': obj.nodeName, + 'targetRef': toJson_ObjectReference(obj.targetRef), + 'topology': ((obj.topology) === undefined) ? undefined : (Object.entries(obj.topology).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EndpointPort represents a Port used by an EndpointSlice + * + * @schema io.k8s.api.discovery.v1beta1.EndpointPort + */ +export interface EndpointPortV1Beta1 { + /** + * The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointPort#appProtocol + */ + readonly appProtocol?: string; + + /** + * The name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is dervied from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string. + * + * @default empty string. + * @schema io.k8s.api.discovery.v1beta1.EndpointPort#name + */ + readonly name?: string; + + /** + * The port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointPort#port + */ + readonly port?: number; + + /** + * The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. + * + * @default TCP. + * @schema io.k8s.api.discovery.v1beta1.EndpointPort#protocol + */ + readonly protocol?: string; + +} + +/** + * Converts an object of type 'EndpointPortV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EndpointPortV1Beta1(obj: EndpointPortV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'appProtocol': obj.appProtocol, + 'name': obj.name, + 'port': obj.port, + 'protocol': obj.protocol, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. + * + * @schema io.k8s.api.events.v1beta1.EventSeries + */ +export interface EventSeriesV1Beta1 { + /** + * count is the number of occurrences in this series up to the last heartbeat time. + * + * @schema io.k8s.api.events.v1beta1.EventSeries#count + */ + readonly count: number; + + /** + * lastObservedTime is the time when last Event from the series was seen before last heartbeat. + * + * @schema io.k8s.api.events.v1beta1.EventSeries#lastObservedTime + */ + readonly lastObservedTime: Date; + +} + +/** + * Converts an object of type 'EventSeriesV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EventSeriesV1Beta1(obj: EventSeriesV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'count': obj.count, + 'lastObservedTime': obj.lastObservedTime?.toISOString(), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressSpec describes the Ingress the user wishes to exist. + * + * @schema io.k8s.api.networking.v1beta1.IngressSpec + */ +export interface IngressSpecV1Beta1 { + /** + * A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default. + * + * @schema io.k8s.api.networking.v1beta1.IngressSpec#backend + */ + readonly backend?: IngressBackendV1Beta1; + + /** + * IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation. + * + * @schema io.k8s.api.networking.v1beta1.IngressSpec#ingressClassName + */ + readonly ingressClassName?: string; + + /** + * A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. + * + * @schema io.k8s.api.networking.v1beta1.IngressSpec#rules + */ + readonly rules?: IngressRuleV1Beta1[]; + + /** + * TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. + * + * @schema io.k8s.api.networking.v1beta1.IngressSpec#tls + */ + readonly tls?: IngressTlsv1Beta1[]; + +} + +/** + * Converts an object of type 'IngressSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IngressSpecV1Beta1(obj: IngressSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'backend': toJson_IngressBackendV1Beta1(obj.backend), + 'ingressClassName': obj.ingressClassName, + 'rules': obj.rules?.map(y => toJson_IngressRuleV1Beta1(y)), + 'tls': obj.tls?.map(y => toJson_IngressTlsv1Beta1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * FlowSchemaSpec describes how the FlowSchema's specification looks like. + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowSchemaSpec + */ +export interface FlowSchemaSpecV1Beta1 { + /** + * `distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. `nil` specifies that the distinguisher is disabled and thus will always be the empty string. + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowSchemaSpec#distinguisherMethod + */ + readonly distinguisherMethod?: FlowDistinguisherMethodV1Beta1; + + /** + * `matchingPrecedence` is used to choose among the FlowSchemas that match a given request. The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be ranged in [1,10000]. Note that if the precedence is not specified, it will be set to 1000 as default. + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowSchemaSpec#matchingPrecedence + */ + readonly matchingPrecedence?: number; + + /** + * `priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. If the reference cannot be resolved, the FlowSchema will be ignored and marked as invalid in its status. Required. + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowSchemaSpec#priorityLevelConfiguration + */ + readonly priorityLevelConfiguration: PriorityLevelConfigurationReferenceV1Beta1; + + /** + * `rules` describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema. + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowSchemaSpec#rules + */ + readonly rules?: PolicyRulesWithSubjectsV1Beta1[]; + +} + +/** + * Converts an object of type 'FlowSchemaSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_FlowSchemaSpecV1Beta1(obj: FlowSchemaSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'distinguisherMethod': toJson_FlowDistinguisherMethodV1Beta1(obj.distinguisherMethod), + 'matchingPrecedence': obj.matchingPrecedence, + 'priorityLevelConfiguration': toJson_PriorityLevelConfigurationReferenceV1Beta1(obj.priorityLevelConfiguration), + 'rules': obj.rules?.map(y => toJson_PolicyRulesWithSubjectsV1Beta1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PriorityLevelConfigurationSpec specifies the configuration of a priority level. + * + * @schema io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationSpec + */ +export interface PriorityLevelConfigurationSpecV1Beta1 { + /** + * `limited` specifies how requests are handled for a Limited priority level. This field must be non-empty if and only if `type` is `"Limited"`. + * + * @schema io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationSpec#limited + */ + readonly limited?: LimitedPriorityLevelConfigurationV1Beta1; + + /** + * `type` indicates whether this priority level is subject to limitation on request execution. A value of `"Exempt"` means that requests of this priority level are not subject to a limit (and thus are never queued) and do not detract from the capacity made available to other priority levels. A value of `"Limited"` means that (a) requests of this priority level _are_ subject to limits and (b) some of the server's limited capacity is made available exclusively to this priority level. Required. + * + * @schema io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationSpec#type + */ + readonly type: string; + +} + +/** + * Converts an object of type 'PriorityLevelConfigurationSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PriorityLevelConfigurationSpecV1Beta1(obj: PriorityLevelConfigurationSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'limited': toJson_LimitedPriorityLevelConfigurationV1Beta1(obj.limited), + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressSpec describes the Ingress the user wishes to exist. + * + * @schema io.k8s.api.networking.v1.IngressSpec + */ +export interface IngressSpec { + /** + * DefaultBackend is the backend that should handle requests that don't match any rule. If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller. + * + * @schema io.k8s.api.networking.v1.IngressSpec#defaultBackend + */ + readonly defaultBackend?: IngressBackend; + + /** + * IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation. + * + * @schema io.k8s.api.networking.v1.IngressSpec#ingressClassName + */ + readonly ingressClassName?: string; + + /** + * A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. + * + * @schema io.k8s.api.networking.v1.IngressSpec#rules + */ + readonly rules?: IngressRule[]; + + /** + * TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. + * + * @schema io.k8s.api.networking.v1.IngressSpec#tls + */ + readonly tls?: IngressTls[]; + +} + +/** + * Converts an object of type 'IngressSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IngressSpec(obj: IngressSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'defaultBackend': toJson_IngressBackend(obj.defaultBackend), + 'ingressClassName': obj.ingressClassName, + 'rules': obj.rules?.map(y => toJson_IngressRule(y)), + 'tls': obj.tls?.map(y => toJson_IngressTls(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressClassSpec provides information about the class of an Ingress. + * + * @schema io.k8s.api.networking.v1.IngressClassSpec + */ +export interface IngressClassSpec { + /** + * Controller refers to the name of the controller that should handle this class. This allows for different "flavors" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable. + * + * @schema io.k8s.api.networking.v1.IngressClassSpec#controller + */ + readonly controller?: string; + + /** + * Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters. + * + * @schema io.k8s.api.networking.v1.IngressClassSpec#parameters + */ + readonly parameters?: IngressClassParametersReference; + +} + +/** + * Converts an object of type 'IngressClassSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IngressClassSpec(obj: IngressClassSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'controller': obj.controller, + 'parameters': toJson_IngressClassParametersReference(obj.parameters), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NetworkPolicySpec provides the specification of a NetworkPolicy + * + * @schema io.k8s.api.networking.v1.NetworkPolicySpec + */ +export interface NetworkPolicySpec { + /** + * List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8 + * + * @schema io.k8s.api.networking.v1.NetworkPolicySpec#egress + */ + readonly egress?: NetworkPolicyEgressRule[]; + + /** + * List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default) + * + * @schema io.k8s.api.networking.v1.NetworkPolicySpec#ingress + */ + readonly ingress?: NetworkPolicyIngressRule[]; + + /** + * Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace. + * + * @schema io.k8s.api.networking.v1.NetworkPolicySpec#podSelector + */ + readonly podSelector: LabelSelector; + + /** + * List of rule types that the NetworkPolicy relates to. Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"]. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8 + * + * @schema io.k8s.api.networking.v1.NetworkPolicySpec#policyTypes + */ + readonly policyTypes?: string[]; + +} + +/** + * Converts an object of type 'NetworkPolicySpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NetworkPolicySpec(obj: NetworkPolicySpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'egress': obj.egress?.map(y => toJson_NetworkPolicyEgressRule(y)), + 'ingress': obj.ingress?.map(y => toJson_NetworkPolicyIngressRule(y)), + 'podSelector': toJson_LabelSelector(obj.podSelector), + 'policyTypes': obj.policyTypes?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressClassSpec provides information about the class of an Ingress. + * + * @schema io.k8s.api.networking.v1beta1.IngressClassSpec + */ +export interface IngressClassSpecV1Beta1 { + /** + * Controller refers to the name of the controller that should handle this class. This allows for different "flavors" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable. + * + * @schema io.k8s.api.networking.v1beta1.IngressClassSpec#controller + */ + readonly controller?: string; + + /** + * Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters. + * + * @schema io.k8s.api.networking.v1beta1.IngressClassSpec#parameters + */ + readonly parameters?: IngressClassParametersReferenceV1Beta1; + +} + +/** + * Converts an object of type 'IngressClassSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IngressClassSpecV1Beta1(obj: IngressClassSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'controller': obj.controller, + 'parameters': toJson_IngressClassParametersReferenceV1Beta1(obj.parameters), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Overhead structure represents the resource overhead associated with running a pod. + * + * @schema io.k8s.api.node.v1.Overhead + */ +export interface Overhead { + /** + * PodFixed represents the fixed resource overhead associated with running a pod. + * + * @schema io.k8s.api.node.v1.Overhead#podFixed + */ + readonly podFixed?: { [key: string]: Quantity }; + +} + +/** + * Converts an object of type 'Overhead' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Overhead(obj: Overhead | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'podFixed': ((obj.podFixed) === undefined) ? undefined : (Object.entries(obj.podFixed).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.value }), {})), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass. + * + * @schema io.k8s.api.node.v1.Scheduling + */ +export interface Scheduling { + /** + * nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission. + * + * @schema io.k8s.api.node.v1.Scheduling#nodeSelector + */ + readonly nodeSelector?: { [key: string]: string }; + + /** + * tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. + * + * @schema io.k8s.api.node.v1.Scheduling#tolerations + */ + readonly tolerations?: Toleration[]; + +} + +/** + * Converts an object of type 'Scheduling' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Scheduling(obj: Scheduling | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'nodeSelector': ((obj.nodeSelector) === undefined) ? undefined : (Object.entries(obj.nodeSelector).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'tolerations': obj.tolerations?.map(y => toJson_Toleration(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RuntimeClassSpec is a specification of a RuntimeClass. It contains parameters that are required to describe the RuntimeClass to the Container Runtime Interface (CRI) implementation, as well as any other components that need to understand how the pod will be run. The RuntimeClassSpec is immutable. + * + * @schema io.k8s.api.node.v1alpha1.RuntimeClassSpec + */ +export interface RuntimeClassSpecV1Alpha1 { + /** + * Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature. + * + * @schema io.k8s.api.node.v1alpha1.RuntimeClassSpec#overhead + */ + readonly overhead?: OverheadV1Alpha1; + + /** + * RuntimeHandler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The RuntimeHandler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable. + * + * @schema io.k8s.api.node.v1alpha1.RuntimeClassSpec#runtimeHandler + */ + readonly runtimeHandler: string; + + /** + * Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes. + * + * @schema io.k8s.api.node.v1alpha1.RuntimeClassSpec#scheduling + */ + readonly scheduling?: SchedulingV1Alpha1; + +} + +/** + * Converts an object of type 'RuntimeClassSpecV1Alpha1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_RuntimeClassSpecV1Alpha1(obj: RuntimeClassSpecV1Alpha1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'overhead': toJson_OverheadV1Alpha1(obj.overhead), + 'runtimeHandler': obj.runtimeHandler, + 'scheduling': toJson_SchedulingV1Alpha1(obj.scheduling), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Overhead structure represents the resource overhead associated with running a pod. + * + * @schema io.k8s.api.node.v1beta1.Overhead + */ +export interface OverheadV1Beta1 { + /** + * PodFixed represents the fixed resource overhead associated with running a pod. + * + * @schema io.k8s.api.node.v1beta1.Overhead#podFixed + */ + readonly podFixed?: { [key: string]: Quantity }; + +} + +/** + * Converts an object of type 'OverheadV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_OverheadV1Beta1(obj: OverheadV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'podFixed': ((obj.podFixed) === undefined) ? undefined : (Object.entries(obj.podFixed).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.value }), {})), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass. + * + * @schema io.k8s.api.node.v1beta1.Scheduling + */ +export interface SchedulingV1Beta1 { + /** + * nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission. + * + * @schema io.k8s.api.node.v1beta1.Scheduling#nodeSelector + */ + readonly nodeSelector?: { [key: string]: string }; + + /** + * tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. + * + * @schema io.k8s.api.node.v1beta1.Scheduling#tolerations + */ + readonly tolerations?: Toleration[]; + +} + +/** + * Converts an object of type 'SchedulingV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SchedulingV1Beta1(obj: SchedulingV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'nodeSelector': ((obj.nodeSelector) === undefined) ? undefined : (Object.entries(obj.nodeSelector).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'tolerations': obj.tolerations?.map(y => toJson_Toleration(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodDisruptionBudgetSpec is a description of a PodDisruptionBudget. + * + * @schema io.k8s.api.policy.v1.PodDisruptionBudgetSpec + */ +export interface PodDisruptionBudgetSpec { + /** + * An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". + * + * @schema io.k8s.api.policy.v1.PodDisruptionBudgetSpec#maxUnavailable + */ + readonly maxUnavailable?: IntOrString; + + /** + * An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". + * + * @schema io.k8s.api.policy.v1.PodDisruptionBudgetSpec#minAvailable + */ + readonly minAvailable?: IntOrString; + + /** + * Label query over pods whose evictions are managed by the disruption budget. A null selector will match no pods, while an empty ({}) selector will select all pods within the namespace. + * + * @schema io.k8s.api.policy.v1.PodDisruptionBudgetSpec#selector + */ + readonly selector?: LabelSelector; + +} + +/** + * Converts an object of type 'PodDisruptionBudgetSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PodDisruptionBudgetSpec(obj: PodDisruptionBudgetSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'maxUnavailable': obj.maxUnavailable?.value, + 'minAvailable': obj.minAvailable?.value, + 'selector': toJson_LabelSelector(obj.selector), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * DeleteOptions may be provided when deleting an API object. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions + */ +export interface DeleteOptions { + /** + * APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#apiVersion + */ + readonly apiVersion?: string; + + /** + * When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#dryRun + */ + readonly dryRun?: string[]; + + /** + * The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. + * + * @default a per object value if not specified. zero means delete immediately. + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#gracePeriodSeconds + */ + readonly gracePeriodSeconds?: number; + + /** + * Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#kind + */ + readonly kind?: IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind; + + /** + * Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#orphanDependents + */ + readonly orphanDependents?: boolean; + + /** + * Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#preconditions + */ + readonly preconditions?: Preconditions; + + /** + * Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions#propagationPolicy + */ + readonly propagationPolicy?: string; + +} + +/** + * Converts an object of type 'DeleteOptions' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_DeleteOptions(obj: DeleteOptions | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiVersion': obj.apiVersion, + 'dryRun': obj.dryRun?.map(y => y), + 'gracePeriodSeconds': obj.gracePeriodSeconds, + 'kind': obj.kind, + 'orphanDependents': obj.orphanDependents, + 'preconditions': toJson_Preconditions(obj.preconditions), + 'propagationPolicy': obj.propagationPolicy, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodDisruptionBudgetSpec is a description of a PodDisruptionBudget. + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetSpec + */ +export interface PodDisruptionBudgetSpecV1Beta1 { + /** + * An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetSpec#maxUnavailable + */ + readonly maxUnavailable?: IntOrString; + + /** + * An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetSpec#minAvailable + */ + readonly minAvailable?: IntOrString; + + /** + * Label query over pods whose evictions are managed by the disruption budget. A null selector selects no pods. An empty selector ({}) also selects no pods, which differs from standard behavior of selecting all pods. In policy/v1, an empty selector will select all pods in the namespace. + * + * @schema io.k8s.api.policy.v1beta1.PodDisruptionBudgetSpec#selector + */ + readonly selector?: LabelSelector; + +} + +/** + * Converts an object of type 'PodDisruptionBudgetSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PodDisruptionBudgetSpecV1Beta1(obj: PodDisruptionBudgetSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'maxUnavailable': obj.maxUnavailable?.value, + 'minAvailable': obj.minAvailable?.value, + 'selector': toJson_LabelSelector(obj.selector), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodSecurityPolicySpec defines the policy enforced. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec + */ +export interface PodSecurityPolicySpecV1Beta1 { + /** + * allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowPrivilegeEscalation + */ + readonly allowPrivilegeEscalation?: boolean; + + /** + * AllowedCSIDrivers is an allowlist of inline CSI drivers that must be explicitly set to be embedded within a pod spec. An empty value indicates that any CSI driver can be used for inline ephemeral volumes. This is a beta field, and is only honored if the API server enables the CSIInlineVolume feature gate. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedCSIDrivers + */ + readonly allowedCsiDrivers?: AllowedCsiDriverV1Beta1[]; + + /** + * allowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both allowedCapabilities and requiredDropCapabilities. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedCapabilities + */ + readonly allowedCapabilities?: string[]; + + /** + * allowedFlexVolumes is an allowlist of Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "volumes" field. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedFlexVolumes + */ + readonly allowedFlexVolumes?: AllowedFlexVolumeV1Beta1[]; + + /** + * allowedHostPaths is an allowlist of host paths. Empty indicates that all host paths may be used. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedHostPaths + */ + readonly allowedHostPaths?: AllowedHostPathV1Beta1[]; + + /** + * AllowedProcMountTypes is an allowlist of allowed ProcMountTypes. Empty or nil indicates that only the DefaultProcMountType may be used. This requires the ProcMountType feature flag to be enabled. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedProcMountTypes + */ + readonly allowedProcMountTypes?: string[]; + + /** + * allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to allowlist all allowed unsafe sysctls explicitly to avoid rejection. + * + * Examples: e.g. "foo/*" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#allowedUnsafeSysctls + */ + readonly allowedUnsafeSysctls?: string[]; + + /** + * defaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both defaultAddCapabilities and requiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the allowedCapabilities list. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#defaultAddCapabilities + */ + readonly defaultAddCapabilities?: string[]; + + /** + * defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#defaultAllowPrivilegeEscalation + */ + readonly defaultAllowPrivilegeEscalation?: boolean; + + /** + * forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden. + * + * Examples: e.g. "foo/*" forbids "foo/bar", "foo/baz", etc. e.g. "foo.*" forbids "foo.bar", "foo.baz", etc. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#forbiddenSysctls + */ + readonly forbiddenSysctls?: string[]; + + /** + * fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#fsGroup + */ + readonly fsGroup: FsGroupStrategyOptionsV1Beta1; + + /** + * hostIPC determines if the policy allows the use of HostIPC in the pod spec. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#hostIPC + */ + readonly hostIpc?: boolean; + + /** + * hostNetwork determines if the policy allows the use of HostNetwork in the pod spec. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#hostNetwork + */ + readonly hostNetwork?: boolean; + + /** + * hostPID determines if the policy allows the use of HostPID in the pod spec. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#hostPID + */ + readonly hostPid?: boolean; + + /** + * hostPorts determines which host port ranges are allowed to be exposed. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#hostPorts + */ + readonly hostPorts?: HostPortRangeV1Beta1[]; + + /** + * privileged determines if a pod can request to be run as privileged. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#privileged + */ + readonly privileged?: boolean; + + /** + * readOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#readOnlyRootFilesystem + */ + readonly readOnlyRootFilesystem?: boolean; + + /** + * requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#requiredDropCapabilities + */ + readonly requiredDropCapabilities?: string[]; + + /** + * RunAsGroup is the strategy that will dictate the allowable RunAsGroup values that may be set. If this field is omitted, the pod's RunAsGroup can take any value. This field requires the RunAsGroup feature gate to be enabled. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#runAsGroup + */ + readonly runAsGroup?: RunAsGroupStrategyOptionsV1Beta1; + + /** + * runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#runAsUser + */ + readonly runAsUser: RunAsUserStrategyOptionsV1Beta1; + + /** + * runtimeClass is the strategy that will dictate the allowable RuntimeClasses for a pod. If this field is omitted, the pod's runtimeClassName field is unrestricted. Enforcement of this field depends on the RuntimeClass feature gate being enabled. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#runtimeClass + */ + readonly runtimeClass?: RuntimeClassStrategyOptionsV1Beta1; + + /** + * seLinux is the strategy that will dictate the allowable labels that may be set. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#seLinux + */ + readonly seLinux: SeLinuxStrategyOptionsV1Beta1; + + /** + * supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#supplementalGroups + */ + readonly supplementalGroups: SupplementalGroupsStrategyOptionsV1Beta1; + + /** + * volumes is an allowlist of volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use '*'. + * + * @schema io.k8s.api.policy.v1beta1.PodSecurityPolicySpec#volumes + */ + readonly volumes?: string[]; + +} + +/** + * Converts an object of type 'PodSecurityPolicySpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PodSecurityPolicySpecV1Beta1(obj: PodSecurityPolicySpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'allowPrivilegeEscalation': obj.allowPrivilegeEscalation, + 'allowedCSIDrivers': obj.allowedCsiDrivers?.map(y => toJson_AllowedCsiDriverV1Beta1(y)), + 'allowedCapabilities': obj.allowedCapabilities?.map(y => y), + 'allowedFlexVolumes': obj.allowedFlexVolumes?.map(y => toJson_AllowedFlexVolumeV1Beta1(y)), + 'allowedHostPaths': obj.allowedHostPaths?.map(y => toJson_AllowedHostPathV1Beta1(y)), + 'allowedProcMountTypes': obj.allowedProcMountTypes?.map(y => y), + 'allowedUnsafeSysctls': obj.allowedUnsafeSysctls?.map(y => y), + 'defaultAddCapabilities': obj.defaultAddCapabilities?.map(y => y), + 'defaultAllowPrivilegeEscalation': obj.defaultAllowPrivilegeEscalation, + 'forbiddenSysctls': obj.forbiddenSysctls?.map(y => y), + 'fsGroup': toJson_FsGroupStrategyOptionsV1Beta1(obj.fsGroup), + 'hostIPC': obj.hostIpc, + 'hostNetwork': obj.hostNetwork, + 'hostPID': obj.hostPid, + 'hostPorts': obj.hostPorts?.map(y => toJson_HostPortRangeV1Beta1(y)), + 'privileged': obj.privileged, + 'readOnlyRootFilesystem': obj.readOnlyRootFilesystem, + 'requiredDropCapabilities': obj.requiredDropCapabilities?.map(y => y), + 'runAsGroup': toJson_RunAsGroupStrategyOptionsV1Beta1(obj.runAsGroup), + 'runAsUser': toJson_RunAsUserStrategyOptionsV1Beta1(obj.runAsUser), + 'runtimeClass': toJson_RuntimeClassStrategyOptionsV1Beta1(obj.runtimeClass), + 'seLinux': toJson_SeLinuxStrategyOptionsV1Beta1(obj.seLinux), + 'supplementalGroups': toJson_SupplementalGroupsStrategyOptionsV1Beta1(obj.supplementalGroups), + 'volumes': obj.volumes?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole + * + * @schema io.k8s.api.rbac.v1.AggregationRule + */ +export interface AggregationRule { + /** + * ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added + * + * @schema io.k8s.api.rbac.v1.AggregationRule#clusterRoleSelectors + */ + readonly clusterRoleSelectors?: LabelSelector[]; + +} + +/** + * Converts an object of type 'AggregationRule' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_AggregationRule(obj: AggregationRule | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'clusterRoleSelectors': obj.clusterRoleSelectors?.map(y => toJson_LabelSelector(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. + * + * @schema io.k8s.api.rbac.v1.PolicyRule + */ +export interface PolicyRule { + /** + * APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. + * + * @schema io.k8s.api.rbac.v1.PolicyRule#apiGroups + */ + readonly apiGroups?: string[]; + + /** + * NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. + * + * @schema io.k8s.api.rbac.v1.PolicyRule#nonResourceURLs + */ + readonly nonResourceUrLs?: string[]; + + /** + * ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. + * + * @schema io.k8s.api.rbac.v1.PolicyRule#resourceNames + */ + readonly resourceNames?: string[]; + + /** + * Resources is a list of resources this rule applies to. ResourceAll represents all resources. + * + * @schema io.k8s.api.rbac.v1.PolicyRule#resources + */ + readonly resources?: string[]; + + /** + * Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. + * + * @schema io.k8s.api.rbac.v1.PolicyRule#verbs + */ + readonly verbs: string[]; + +} + +/** + * Converts an object of type 'PolicyRule' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PolicyRule(obj: PolicyRule | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiGroups': obj.apiGroups?.map(y => y), + 'nonResourceURLs': obj.nonResourceUrLs?.map(y => y), + 'resourceNames': obj.resourceNames?.map(y => y), + 'resources': obj.resources?.map(y => y), + 'verbs': obj.verbs?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RoleRef contains information that points to the role being used + * + * @schema io.k8s.api.rbac.v1.RoleRef + */ +export interface RoleRef { + /** + * APIGroup is the group for the resource being referenced + * + * @schema io.k8s.api.rbac.v1.RoleRef#apiGroup + */ + readonly apiGroup: string; + + /** + * Kind is the type of resource being referenced + * + * @schema io.k8s.api.rbac.v1.RoleRef#kind + */ + readonly kind: string; + + /** + * Name is the name of resource being referenced + * + * @schema io.k8s.api.rbac.v1.RoleRef#name + */ + readonly name: string; + +} + +/** + * Converts an object of type 'RoleRef' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_RoleRef(obj: RoleRef | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiGroup': obj.apiGroup, + 'kind': obj.kind, + 'name': obj.name, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names. + * + * @schema io.k8s.api.rbac.v1.Subject + */ +export interface Subject { + /** + * APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. + * + * @default for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. + * @schema io.k8s.api.rbac.v1.Subject#apiGroup + */ + readonly apiGroup?: string; + + /** + * Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. + * + * @schema io.k8s.api.rbac.v1.Subject#kind + */ + readonly kind: string; + + /** + * Name of the object being referenced. + * + * @schema io.k8s.api.rbac.v1.Subject#name + */ + readonly name: string; + + /** + * Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. + * + * @schema io.k8s.api.rbac.v1.Subject#namespace + */ + readonly namespace?: string; + +} + +/** + * Converts an object of type 'Subject' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Subject(obj: Subject | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiGroup': obj.apiGroup, + 'kind': obj.kind, + 'name': obj.name, + 'namespace': obj.namespace, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole + * + * @schema io.k8s.api.rbac.v1alpha1.AggregationRule + */ +export interface AggregationRuleV1Alpha1 { + /** + * ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added + * + * @schema io.k8s.api.rbac.v1alpha1.AggregationRule#clusterRoleSelectors + */ + readonly clusterRoleSelectors?: LabelSelector[]; + +} + +/** + * Converts an object of type 'AggregationRuleV1Alpha1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_AggregationRuleV1Alpha1(obj: AggregationRuleV1Alpha1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'clusterRoleSelectors': obj.clusterRoleSelectors?.map(y => toJson_LabelSelector(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. + * + * @schema io.k8s.api.rbac.v1alpha1.PolicyRule + */ +export interface PolicyRuleV1Alpha1 { + /** + * APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. + * + * @schema io.k8s.api.rbac.v1alpha1.PolicyRule#apiGroups + */ + readonly apiGroups?: string[]; + + /** + * NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. + * + * @schema io.k8s.api.rbac.v1alpha1.PolicyRule#nonResourceURLs + */ + readonly nonResourceUrLs?: string[]; + + /** + * ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. + * + * @schema io.k8s.api.rbac.v1alpha1.PolicyRule#resourceNames + */ + readonly resourceNames?: string[]; + + /** + * Resources is a list of resources this rule applies to. ResourceAll represents all resources. + * + * @schema io.k8s.api.rbac.v1alpha1.PolicyRule#resources + */ + readonly resources?: string[]; + + /** + * Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. + * + * @schema io.k8s.api.rbac.v1alpha1.PolicyRule#verbs + */ + readonly verbs: string[]; + +} + +/** + * Converts an object of type 'PolicyRuleV1Alpha1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PolicyRuleV1Alpha1(obj: PolicyRuleV1Alpha1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiGroups': obj.apiGroups?.map(y => y), + 'nonResourceURLs': obj.nonResourceUrLs?.map(y => y), + 'resourceNames': obj.resourceNames?.map(y => y), + 'resources': obj.resources?.map(y => y), + 'verbs': obj.verbs?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RoleRef contains information that points to the role being used + * + * @schema io.k8s.api.rbac.v1alpha1.RoleRef + */ +export interface RoleRefV1Alpha1 { + /** + * APIGroup is the group for the resource being referenced + * + * @schema io.k8s.api.rbac.v1alpha1.RoleRef#apiGroup + */ + readonly apiGroup: string; + + /** + * Kind is the type of resource being referenced + * + * @schema io.k8s.api.rbac.v1alpha1.RoleRef#kind + */ + readonly kind: string; + + /** + * Name is the name of resource being referenced + * + * @schema io.k8s.api.rbac.v1alpha1.RoleRef#name + */ + readonly name: string; + +} + +/** + * Converts an object of type 'RoleRefV1Alpha1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_RoleRefV1Alpha1(obj: RoleRefV1Alpha1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiGroup': obj.apiGroup, + 'kind': obj.kind, + 'name': obj.name, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names. + * + * @schema io.k8s.api.rbac.v1alpha1.Subject + */ +export interface SubjectV1Alpha1 { + /** + * APIVersion holds the API group and version of the referenced subject. Defaults to "v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects. + * + * @default v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects. + * @schema io.k8s.api.rbac.v1alpha1.Subject#apiVersion + */ + readonly apiVersion?: string; + + /** + * Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. + * + * @schema io.k8s.api.rbac.v1alpha1.Subject#kind + */ + readonly kind: string; + + /** + * Name of the object being referenced. + * + * @schema io.k8s.api.rbac.v1alpha1.Subject#name + */ + readonly name: string; + + /** + * Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. + * + * @schema io.k8s.api.rbac.v1alpha1.Subject#namespace + */ + readonly namespace?: string; + +} + +/** + * Converts an object of type 'SubjectV1Alpha1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SubjectV1Alpha1(obj: SubjectV1Alpha1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiVersion': obj.apiVersion, + 'kind': obj.kind, + 'name': obj.name, + 'namespace': obj.namespace, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole + * + * @schema io.k8s.api.rbac.v1beta1.AggregationRule + */ +export interface AggregationRuleV1Beta1 { + /** + * ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added + * + * @schema io.k8s.api.rbac.v1beta1.AggregationRule#clusterRoleSelectors + */ + readonly clusterRoleSelectors?: LabelSelector[]; + +} + +/** + * Converts an object of type 'AggregationRuleV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_AggregationRuleV1Beta1(obj: AggregationRuleV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'clusterRoleSelectors': obj.clusterRoleSelectors?.map(y => toJson_LabelSelector(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. + * + * @schema io.k8s.api.rbac.v1beta1.PolicyRule + */ +export interface PolicyRuleV1Beta1 { + /** + * APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. + * + * @schema io.k8s.api.rbac.v1beta1.PolicyRule#apiGroups + */ + readonly apiGroups?: string[]; + + /** + * NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. + * + * @schema io.k8s.api.rbac.v1beta1.PolicyRule#nonResourceURLs + */ + readonly nonResourceUrLs?: string[]; + + /** + * ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. + * + * @schema io.k8s.api.rbac.v1beta1.PolicyRule#resourceNames + */ + readonly resourceNames?: string[]; + + /** + * Resources is a list of resources this rule applies to. '*' represents all resources in the specified apiGroups. '_/foo' represents the subresource 'foo' for all resources in the specified apiGroups. + * + * @schema io.k8s.api.rbac.v1beta1.PolicyRule#resources + */ + readonly resources?: string[]; + + /** + * Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. + * + * @schema io.k8s.api.rbac.v1beta1.PolicyRule#verbs + */ + readonly verbs: string[]; + +} + +/** + * Converts an object of type 'PolicyRuleV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PolicyRuleV1Beta1(obj: PolicyRuleV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiGroups': obj.apiGroups?.map(y => y), + 'nonResourceURLs': obj.nonResourceUrLs?.map(y => y), + 'resourceNames': obj.resourceNames?.map(y => y), + 'resources': obj.resources?.map(y => y), + 'verbs': obj.verbs?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RoleRef contains information that points to the role being used + * + * @schema io.k8s.api.rbac.v1beta1.RoleRef + */ +export interface RoleRefV1Beta1 { + /** + * APIGroup is the group for the resource being referenced + * + * @schema io.k8s.api.rbac.v1beta1.RoleRef#apiGroup + */ + readonly apiGroup: string; + + /** + * Kind is the type of resource being referenced + * + * @schema io.k8s.api.rbac.v1beta1.RoleRef#kind + */ + readonly kind: string; + + /** + * Name is the name of resource being referenced + * + * @schema io.k8s.api.rbac.v1beta1.RoleRef#name + */ + readonly name: string; + +} + +/** + * Converts an object of type 'RoleRefV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_RoleRefV1Beta1(obj: RoleRefV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiGroup': obj.apiGroup, + 'kind': obj.kind, + 'name': obj.name, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names. + * + * @schema io.k8s.api.rbac.v1beta1.Subject + */ +export interface SubjectV1Beta1 { + /** + * APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. + * + * @default for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. + * @schema io.k8s.api.rbac.v1beta1.Subject#apiGroup + */ + readonly apiGroup?: string; + + /** + * Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. + * + * @schema io.k8s.api.rbac.v1beta1.Subject#kind + */ + readonly kind: string; + + /** + * Name of the object being referenced. + * + * @schema io.k8s.api.rbac.v1beta1.Subject#name + */ + readonly name: string; + + /** + * Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. + * + * @schema io.k8s.api.rbac.v1beta1.Subject#namespace + */ + readonly namespace?: string; + +} + +/** + * Converts an object of type 'SubjectV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SubjectV1Beta1(obj: SubjectV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiGroup': obj.apiGroup, + 'kind': obj.kind, + 'name': obj.name, + 'namespace': obj.namespace, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSIDriverSpec is the specification of a CSIDriver. + * + * @schema io.k8s.api.storage.v1.CSIDriverSpec + */ +export interface CsiDriverSpec { + /** + * attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. + * + * This field is immutable. + * + * @schema io.k8s.api.storage.v1.CSIDriverSpec#attachRequired + */ + readonly attachRequired?: boolean; + + /** + * Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. This field is alpha-level, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate. + * + * This field is immutable. + * + * @schema io.k8s.api.storage.v1.CSIDriverSpec#fsGroupPolicy + */ + readonly fsGroupPolicy?: string; + + /** + * If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume + * defined by a CSIVolumeSource, otherwise "false" + * + * "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. + * + * This field is immutable. + * + * @default false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume + * @schema io.k8s.api.storage.v1.CSIDriverSpec#podInfoOnMount + */ + readonly podInfoOnMount?: boolean; + + /** + * RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false. + * + * Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container. + * + * This is a beta feature and only available when the CSIServiceAccountToken feature is enabled. + * + * @schema io.k8s.api.storage.v1.CSIDriverSpec#requiresRepublish + */ + readonly requiresRepublish?: boolean; + + /** + * If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information. + * + * The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object. + * + * Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published. + * + * This field is immutable. + * + * This is a beta field and only available when the CSIStorageCapacity feature is enabled. The default is false. + * + * @schema io.k8s.api.storage.v1.CSIDriverSpec#storageCapacity + */ + readonly storageCapacity?: boolean; + + /** + * TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": { + * "": { + * "token": , + * "expirationTimestamp": , + * }, + * ... + * } + * + * Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically. + * + * This is a beta feature and only available when the CSIServiceAccountToken feature is enabled. + * + * @schema io.k8s.api.storage.v1.CSIDriverSpec#tokenRequests + */ + readonly tokenRequests?: TokenRequest[]; + + /** + * volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. This field is beta. + * + * This field is immutable. + * + * @schema io.k8s.api.storage.v1.CSIDriverSpec#volumeLifecycleModes + */ + readonly volumeLifecycleModes?: string[]; + +} + +/** + * Converts an object of type 'CsiDriverSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CsiDriverSpec(obj: CsiDriverSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'attachRequired': obj.attachRequired, + 'fsGroupPolicy': obj.fsGroupPolicy, + 'podInfoOnMount': obj.podInfoOnMount, + 'requiresRepublish': obj.requiresRepublish, + 'storageCapacity': obj.storageCapacity, + 'tokenRequests': obj.tokenRequests?.map(y => toJson_TokenRequest(y)), + 'volumeLifecycleModes': obj.volumeLifecycleModes?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSINodeSpec holds information about the specification of all CSI drivers installed on a node + * + * @schema io.k8s.api.storage.v1.CSINodeSpec + */ +export interface CsiNodeSpec { + /** + * drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty. + * + * @schema io.k8s.api.storage.v1.CSINodeSpec#drivers + */ + readonly drivers: CsiNodeDriver[]; + +} + +/** + * Converts an object of type 'CsiNodeSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CsiNodeSpec(obj: CsiNodeSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'drivers': obj.drivers?.map(y => toJson_CsiNodeDriver(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future. + * + * @schema io.k8s.api.core.v1.TopologySelectorTerm + */ +export interface TopologySelectorTerm { + /** + * A list of topology selector requirements by labels. + * + * @schema io.k8s.api.core.v1.TopologySelectorTerm#matchLabelExpressions + */ + readonly matchLabelExpressions?: TopologySelectorLabelRequirement[]; + +} + +/** + * Converts an object of type 'TopologySelectorTerm' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_TopologySelectorTerm(obj: TopologySelectorTerm | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'matchLabelExpressions': obj.matchLabelExpressions?.map(y => toJson_TopologySelectorLabelRequirement(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeAttachmentSpec is the specification of a VolumeAttachment request. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentSpec + */ +export interface VolumeAttachmentSpec { + /** + * Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentSpec#attacher + */ + readonly attacher: string; + + /** + * The node that the volume should be attached to. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentSpec#nodeName + */ + readonly nodeName: string; + + /** + * Source represents the volume that should be attached. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentSpec#source + */ + readonly source: VolumeAttachmentSource; + +} + +/** + * Converts an object of type 'VolumeAttachmentSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_VolumeAttachmentSpec(obj: VolumeAttachmentSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'attacher': obj.attacher, + 'nodeName': obj.nodeName, + 'source': toJson_VolumeAttachmentSource(obj.source), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * @schema io.k8s.apimachinery.pkg.api.resource.Quantity + */ +export class Quantity { + public static fromString(value: string): Quantity { + return new Quantity(value); + } + public static fromNumber(value: number): Quantity { + return new Quantity(value); + } + private constructor(public readonly value: any) { + } +} + +/** + * A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector + */ +export interface LabelSelector { + /** + * matchExpressions is a list of label selector requirements. The requirements are ANDed. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector#matchExpressions + */ + readonly matchExpressions?: LabelSelectorRequirement[]; + + /** + * matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector#matchLabels + */ + readonly matchLabels?: { [key: string]: string }; + +} + +/** + * Converts an object of type 'LabelSelector' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_LabelSelector(obj: LabelSelector | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'matchExpressions': obj.matchExpressions?.map(y => toJson_LabelSelectorRequirement(y)), + 'matchLabels': ((obj.matchLabels) === undefined) ? undefined : (Object.entries(obj.matchLabels).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeAttachmentSpec is the specification of a VolumeAttachment request. + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachmentSpec + */ +export interface VolumeAttachmentSpecV1Alpha1 { + /** + * Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachmentSpec#attacher + */ + readonly attacher: string; + + /** + * The node that the volume should be attached to. + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachmentSpec#nodeName + */ + readonly nodeName: string; + + /** + * Source represents the volume that should be attached. + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachmentSpec#source + */ + readonly source: VolumeAttachmentSourceV1Alpha1; + +} + +/** + * Converts an object of type 'VolumeAttachmentSpecV1Alpha1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_VolumeAttachmentSpecV1Alpha1(obj: VolumeAttachmentSpecV1Alpha1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'attacher': obj.attacher, + 'nodeName': obj.nodeName, + 'source': toJson_VolumeAttachmentSourceV1Alpha1(obj.source), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSIDriverSpec is the specification of a CSIDriver. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec + */ +export interface CsiDriverSpecV1Beta1 { + /** + * attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. + * + * This field is immutable. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec#attachRequired + */ + readonly attachRequired?: boolean; + + /** + * Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. This field is alpha-level, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate. + * + * This field is immutable. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec#fsGroupPolicy + */ + readonly fsGroupPolicy?: string; + + /** + * If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume + * defined by a CSIVolumeSource, otherwise "false" + * + * "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. + * + * This field is immutable. + * + * @default false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume + * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec#podInfoOnMount + */ + readonly podInfoOnMount?: boolean; + + /** + * RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false. + * + * Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container. + * + * This is a beta feature and only available when the CSIServiceAccountToken feature is enabled. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec#requiresRepublish + */ + readonly requiresRepublish?: boolean; + + /** + * If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information. + * + * The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object. + * + * Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published. + * + * This field is immutable. + * + * This is a beta field and only available when the CSIStorageCapacity feature is enabled. The default is false. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec#storageCapacity + */ + readonly storageCapacity?: boolean; + + /** + * TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": { + * "": { + * "token": , + * "expirationTimestamp": , + * }, + * ... + * } + * + * Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically. + * + * This is a beta feature and only available when the CSIServiceAccountToken feature is enabled. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec#tokenRequests + */ + readonly tokenRequests?: TokenRequestV1Beta1[]; + + /** + * VolumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. + * + * This field is immutable. + * + * @schema io.k8s.api.storage.v1beta1.CSIDriverSpec#volumeLifecycleModes + */ + readonly volumeLifecycleModes?: string[]; + +} + +/** + * Converts an object of type 'CsiDriverSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CsiDriverSpecV1Beta1(obj: CsiDriverSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'attachRequired': obj.attachRequired, + 'fsGroupPolicy': obj.fsGroupPolicy, + 'podInfoOnMount': obj.podInfoOnMount, + 'requiresRepublish': obj.requiresRepublish, + 'storageCapacity': obj.storageCapacity, + 'tokenRequests': obj.tokenRequests?.map(y => toJson_TokenRequestV1Beta1(y)), + 'volumeLifecycleModes': obj.volumeLifecycleModes?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSINodeSpec holds information about the specification of all CSI drivers installed on a node + * + * @schema io.k8s.api.storage.v1beta1.CSINodeSpec + */ +export interface CsiNodeSpecV1Beta1 { + /** + * drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty. + * + * @schema io.k8s.api.storage.v1beta1.CSINodeSpec#drivers + */ + readonly drivers: CsiNodeDriverV1Beta1[]; + +} + +/** + * Converts an object of type 'CsiNodeSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CsiNodeSpecV1Beta1(obj: CsiNodeSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'drivers': obj.drivers?.map(y => toJson_CsiNodeDriverV1Beta1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeAttachmentSpec is the specification of a VolumeAttachment request. + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachmentSpec + */ +export interface VolumeAttachmentSpecV1Beta1 { + /** + * Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachmentSpec#attacher + */ + readonly attacher: string; + + /** + * The node that the volume should be attached to. + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachmentSpec#nodeName + */ + readonly nodeName: string; + + /** + * Source represents the volume that should be attached. + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachmentSpec#source + */ + readonly source: VolumeAttachmentSourceV1Beta1; + +} + +/** + * Converts an object of type 'VolumeAttachmentSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_VolumeAttachmentSpecV1Beta1(obj: VolumeAttachmentSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'attacher': obj.attacher, + 'nodeName': obj.nodeName, + 'source': toJson_VolumeAttachmentSourceV1Beta1(obj.source), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceDefinitionSpec describes how a user wants their resource to appear + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec + */ +export interface CustomResourceDefinitionSpec { + /** + * conversion defines conversion settings for the CRD. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#conversion + */ + readonly conversion?: CustomResourceConversion; + + /** + * group is the API group of the defined custom resource. The custom resources are served under `/apis//...`. Must match the name of the CustomResourceDefinition (in the form `.`). + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#group + */ + readonly group: string; + + /** + * names specify the resource and kind names for the custom resource. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#names + */ + readonly names: CustomResourceDefinitionNames; + + /** + * preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting `x-preserve-unknown-fields` to true in `spec.versions[*].schema.openAPIV3Schema`. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#preserveUnknownFields + */ + readonly preserveUnknownFields?: boolean; + + /** + * scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#scope + */ + readonly scope: string; + + /** + * versions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec#versions + */ + readonly versions: CustomResourceDefinitionVersion[]; + +} + +/** + * Converts an object of type 'CustomResourceDefinitionSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceDefinitionSpec(obj: CustomResourceDefinitionSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'conversion': toJson_CustomResourceConversion(obj.conversion), + 'group': obj.group, + 'names': toJson_CustomResourceDefinitionNames(obj.names), + 'preserveUnknownFields': obj.preserveUnknownFields, + 'scope': obj.scope, + 'versions': obj.versions?.map(y => toJson_CustomResourceDefinitionVersion(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceDefinitionSpec describes how a user wants their resource to appear + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionSpec + */ +export interface CustomResourceDefinitionSpecV1Beta1 { + /** + * additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If present, this field configures columns for all versions. Top-level and per-version columns are mutually exclusive. If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionSpec#additionalPrinterColumns + */ + readonly additionalPrinterColumns?: CustomResourceColumnDefinitionV1Beta1[]; + + /** + * conversion defines conversion settings for the CRD. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionSpec#conversion + */ + readonly conversion?: CustomResourceConversionV1Beta1; + + /** + * group is the API group of the defined custom resource. The custom resources are served under `/apis//...`. Must match the name of the CustomResourceDefinition (in the form `.`). + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionSpec#group + */ + readonly group: string; + + /** + * names specify the resource and kind names for the custom resource. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionSpec#names + */ + readonly names: CustomResourceDefinitionNamesV1Beta1; + + /** + * preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. If false, schemas must be defined for all versions. Defaults to true in v1beta for backwards compatibility. Deprecated: will be required to be false in v1. Preservation of unknown fields can be specified in the validation schema using the `x-kubernetes-preserve-unknown-fields: true` extension. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details. + * + * @default true in v1beta for backwards compatibility. Deprecated: will be required to be false in v1. Preservation of unknown fields can be specified in the validation schema using the `x-kubernetes-preserve-unknown-fields: true` extension. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details. + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionSpec#preserveUnknownFields + */ + readonly preserveUnknownFields?: boolean; + + /** + * scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`. Default is `Namespaced`. + * + * @default Namespaced`. + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionSpec#scope + */ + readonly scope: string; + + /** + * subresources specify what subresources the defined custom resource has. If present, this field configures subresources for all versions. Top-level and per-version subresources are mutually exclusive. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionSpec#subresources + */ + readonly subresources?: CustomResourceSubresourcesV1Beta1; + + /** + * validation describes the schema used for validation and pruning of the custom resource. If present, this validation schema is used to validate all versions. Top-level and per-version schemas are mutually exclusive. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionSpec#validation + */ + readonly validation?: CustomResourceValidationV1Beta1; + + /** + * version is the API version of the defined custom resource. The custom resources are served under `/apis///...`. Must match the name of the first item in the `versions` list if `version` and `versions` are both specified. Optional if `versions` is specified. Deprecated: use `versions` instead. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionSpec#version + */ + readonly version?: string; + + /** + * versions is the list of all API versions of the defined custom resource. Optional if `version` is specified. The name of the first item in the `versions` list must match the `version` field if `version` and `versions` are both specified. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionSpec#versions + */ + readonly versions?: CustomResourceDefinitionVersionV1Beta1[]; + +} + +/** + * Converts an object of type 'CustomResourceDefinitionSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceDefinitionSpecV1Beta1(obj: CustomResourceDefinitionSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'additionalPrinterColumns': obj.additionalPrinterColumns?.map(y => toJson_CustomResourceColumnDefinitionV1Beta1(y)), + 'conversion': toJson_CustomResourceConversionV1Beta1(obj.conversion), + 'group': obj.group, + 'names': toJson_CustomResourceDefinitionNamesV1Beta1(obj.names), + 'preserveUnknownFields': obj.preserveUnknownFields, + 'scope': obj.scope, + 'subresources': toJson_CustomResourceSubresourcesV1Beta1(obj.subresources), + 'validation': toJson_CustomResourceValidationV1Beta1(obj.validation), + 'version': obj.version, + 'versions': obj.versions?.map(y => toJson_CustomResourceDefinitionVersionV1Beta1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails + */ +export interface StatusDetails { + /** + * The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#causes + */ + readonly causes?: StatusCause[]; + + /** + * The group attribute of the resource associated with the status StatusReason. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#group + */ + readonly group?: string; + + /** + * The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#kind + */ + readonly kind?: string; + + /** + * The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#name + */ + readonly name?: string; + + /** + * If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#retryAfterSeconds + */ + readonly retryAfterSeconds?: number; + + /** + * UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails#uid + */ + readonly uid?: string; + +} + +/** + * Converts an object of type 'StatusDetails' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_StatusDetails(obj: StatusDetails | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'causes': obj.causes?.map(y => toJson_StatusCause(y)), + 'group': obj.group, + 'kind': obj.kind, + 'name': obj.name, + 'retryAfterSeconds': obj.retryAfterSeconds, + 'uid': obj.uid, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec + */ +export interface ApiServiceSpec { + /** + * CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#caBundle + */ + readonly caBundle?: string; + + /** + * Group is the API group name this server hosts + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#group + */ + readonly group?: string; + + /** + * GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#groupPriorityMinimum + */ + readonly groupPriorityMinimum: number; + + /** + * InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#insecureSkipTLSVerify + */ + readonly insecureSkipTlsVerify?: boolean; + + /** + * Service is a reference to the service for this API server. It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#service + */ + readonly service?: ServiceReference; + + /** + * Version is the API version this server hosts. For example, "v1" + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#version + */ + readonly version?: string; + + /** + * VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceSpec#versionPriority + */ + readonly versionPriority: number; + +} + +/** + * Converts an object of type 'ApiServiceSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ApiServiceSpec(obj: ApiServiceSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'caBundle': obj.caBundle, + 'group': obj.group, + 'groupPriorityMinimum': obj.groupPriorityMinimum, + 'insecureSkipTLSVerify': obj.insecureSkipTlsVerify, + 'service': toJson_ServiceReference(obj.service), + 'version': obj.version, + 'versionPriority': obj.versionPriority, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceSpec + */ +export interface ApiServiceSpecV1Beta1 { + /** + * CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceSpec#caBundle + */ + readonly caBundle?: string; + + /** + * Group is the API group name this server hosts + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceSpec#group + */ + readonly group?: string; + + /** + * GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceSpec#groupPriorityMinimum + */ + readonly groupPriorityMinimum: number; + + /** + * InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceSpec#insecureSkipTLSVerify + */ + readonly insecureSkipTlsVerify?: boolean; + + /** + * Service is a reference to the service for this API server. It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceSpec#service + */ + readonly service?: ServiceReferenceV1Beta1; + + /** + * Version is the API version this server hosts. For example, "v1" + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceSpec#version + */ + readonly version?: string; + + /** + * VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. + * + * @schema io.k8s.kube-aggregator.pkg.apis.apiregistration.v1beta1.APIServiceSpec#versionPriority + */ + readonly versionPriority: number; + +} + +/** + * Converts an object of type 'ApiServiceSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ApiServiceSpecV1Beta1(obj: ApiServiceSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'caBundle': obj.caBundle, + 'group': obj.group, + 'groupPriorityMinimum': obj.groupPriorityMinimum, + 'insecureSkipTLSVerify': obj.insecureSkipTlsVerify, + 'service': toJson_ServiceReferenceV1Beta1(obj.service), + 'version': obj.version, + 'versionPriority': obj.versionPriority, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry + */ +export interface ManagedFieldsEntry { + /** + * APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#apiVersion + */ + readonly apiVersion?: string; + + /** + * FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#fieldsType + */ + readonly fieldsType?: string; + + /** + * FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#fieldsV1 + */ + readonly fieldsV1?: any; + + /** + * Manager is an identifier of the workflow managing these fields. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#manager + */ + readonly manager?: string; + + /** + * Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#operation + */ + readonly operation?: string; + + /** + * Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply' + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry#time + */ + readonly time?: Date; + +} + +/** + * Converts an object of type 'ManagedFieldsEntry' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ManagedFieldsEntry(obj: ManagedFieldsEntry | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiVersion': obj.apiVersion, + 'fieldsType': obj.fieldsType, + 'fieldsV1': obj.fieldsV1, + 'manager': obj.manager, + 'operation': obj.operation, + 'time': obj.time?.toISOString(), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference + */ +export interface OwnerReference { + /** + * API version of the referent. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#apiVersion + */ + readonly apiVersion: string; + + /** + * If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. + * + * @default false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#blockOwnerDeletion + */ + readonly blockOwnerDeletion?: boolean; + + /** + * If true, this reference points to the managing controller. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#controller + */ + readonly controller?: boolean; + + /** + * Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#kind + */ + readonly kind: string; + + /** + * Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#name + */ + readonly name: string; + + /** + * UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference#uid + */ + readonly uid: string; + +} + +/** + * Converts an object of type 'OwnerReference' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_OwnerReference(obj: OwnerReference | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiVersion': obj.apiVersion, + 'blockOwnerDeletion': obj.blockOwnerDeletion, + 'controller': obj.controller, + 'kind': obj.kind, + 'name': obj.name, + 'uid': obj.uid, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * WebhookClientConfig contains the information to make a TLS connection with the webhook + * + * @schema io.k8s.api.admissionregistration.v1.WebhookClientConfig + */ +export interface WebhookClientConfig { + /** + * `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. + * + * @schema io.k8s.api.admissionregistration.v1.WebhookClientConfig#caBundle + */ + readonly caBundle?: string; + + /** + * `service` is a reference to the service for this webhook. Either `service` or `url` must be specified. + * + * If the webhook is running within the cluster, then you should use `service`. + * + * @schema io.k8s.api.admissionregistration.v1.WebhookClientConfig#service + */ + readonly service?: ServiceReference; + + /** + * `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. + * + * The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. + * + * Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. + * + * The scheme must be "https"; the URL must begin with "https://". + * + * A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. + * + * Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. + * + * @schema io.k8s.api.admissionregistration.v1.WebhookClientConfig#url + */ + readonly url?: string; + +} + +/** + * Converts an object of type 'WebhookClientConfig' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_WebhookClientConfig(obj: WebhookClientConfig | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'caBundle': obj.caBundle, + 'service': toJson_ServiceReference(obj.service), + 'url': obj.url, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid. + * + * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations + */ +export interface RuleWithOperations { + /** + * APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required. + * + * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#apiGroups + */ + readonly apiGroups?: string[]; + + /** + * APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required. + * + * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#apiVersions + */ + readonly apiVersions?: string[]; + + /** + * Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required. + * + * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#operations + */ + readonly operations?: string[]; + + /** + * Resources is a list of resources this rule applies to. + * + * For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '_/scale' means all scale subresources. '_/*' means all resources and their subresources. + * + * If wildcard is present, the validation rule will ensure resources do not overlap with each other. + * + * Depending on the enclosing object, subresources might not be allowed. Required. + * + * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#resources + */ + readonly resources?: string[]; + + /** + * scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". + * + * @default . + * @schema io.k8s.api.admissionregistration.v1.RuleWithOperations#scope + */ + readonly scope?: string; + +} + +/** + * Converts an object of type 'RuleWithOperations' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_RuleWithOperations(obj: RuleWithOperations | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiGroups': obj.apiGroups?.map(y => y), + 'apiVersions': obj.apiVersions?.map(y => y), + 'operations': obj.operations?.map(y => y), + 'resources': obj.resources?.map(y => y), + 'scope': obj.scope, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * WebhookClientConfig contains the information to make a TLS connection with the webhook + * + * @schema io.k8s.api.admissionregistration.v1beta1.WebhookClientConfig + */ +export interface WebhookClientConfigV1Beta1 { + /** + * `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. + * + * @schema io.k8s.api.admissionregistration.v1beta1.WebhookClientConfig#caBundle + */ + readonly caBundle?: string; + + /** + * `service` is a reference to the service for this webhook. Either `service` or `url` must be specified. + * + * If the webhook is running within the cluster, then you should use `service`. + * + * @schema io.k8s.api.admissionregistration.v1beta1.WebhookClientConfig#service + */ + readonly service?: ServiceReferenceV1Beta1; + + /** + * `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. + * + * The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. + * + * Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. + * + * The scheme must be "https"; the URL must begin with "https://". + * + * A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. + * + * Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. + * + * @schema io.k8s.api.admissionregistration.v1beta1.WebhookClientConfig#url + */ + readonly url?: string; + +} + +/** + * Converts an object of type 'WebhookClientConfigV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_WebhookClientConfigV1Beta1(obj: WebhookClientConfigV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'caBundle': obj.caBundle, + 'service': toJson_ServiceReferenceV1Beta1(obj.service), + 'url': obj.url, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid. + * + * @schema io.k8s.api.admissionregistration.v1beta1.RuleWithOperations + */ +export interface RuleWithOperationsV1Beta1 { + /** + * APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required. + * + * @schema io.k8s.api.admissionregistration.v1beta1.RuleWithOperations#apiGroups + */ + readonly apiGroups?: string[]; + + /** + * APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required. + * + * @schema io.k8s.api.admissionregistration.v1beta1.RuleWithOperations#apiVersions + */ + readonly apiVersions?: string[]; + + /** + * Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required. + * + * @schema io.k8s.api.admissionregistration.v1beta1.RuleWithOperations#operations + */ + readonly operations?: string[]; + + /** + * Resources is a list of resources this rule applies to. + * + * For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '_/scale' means all scale subresources. '_/*' means all resources and their subresources. + * + * If wildcard is present, the validation rule will ensure resources do not overlap with each other. + * + * Depending on the enclosing object, subresources might not be allowed. Required. + * + * @schema io.k8s.api.admissionregistration.v1beta1.RuleWithOperations#resources + */ + readonly resources?: string[]; + + /** + * scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". + * + * @default . + * @schema io.k8s.api.admissionregistration.v1beta1.RuleWithOperations#scope + */ + readonly scope?: string; + +} + +/** + * Converts an object of type 'RuleWithOperationsV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_RuleWithOperationsV1Beta1(obj: RuleWithOperationsV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiGroups': obj.apiGroups?.map(y => y), + 'apiVersions': obj.apiVersions?.map(y => y), + 'operations': obj.operations?.map(y => y), + 'resources': obj.resources?.map(y => y), + 'scope': obj.scope, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet. + * + * @schema io.k8s.api.apps.v1.DaemonSetUpdateStrategy + */ +export interface DaemonSetUpdateStrategy { + /** + * Rolling update config params. Present only if type = "RollingUpdate". + * + * @schema io.k8s.api.apps.v1.DaemonSetUpdateStrategy#rollingUpdate + */ + readonly rollingUpdate?: RollingUpdateDaemonSet; + + /** + * Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate. + * + * @default RollingUpdate. + * @schema io.k8s.api.apps.v1.DaemonSetUpdateStrategy#type + */ + readonly type?: string; + +} + +/** + * Converts an object of type 'DaemonSetUpdateStrategy' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_DaemonSetUpdateStrategy(obj: DaemonSetUpdateStrategy | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'rollingUpdate': toJson_RollingUpdateDaemonSet(obj.rollingUpdate), + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * DeploymentStrategy describes how to replace existing pods with new ones. + * + * @schema io.k8s.api.apps.v1.DeploymentStrategy + */ +export interface DeploymentStrategy { + /** + * Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. + * + * @schema io.k8s.api.apps.v1.DeploymentStrategy#rollingUpdate + */ + readonly rollingUpdate?: RollingUpdateDeployment; + + /** + * Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. + * + * @default RollingUpdate. + * @schema io.k8s.api.apps.v1.DeploymentStrategy#type + */ + readonly type?: string; + +} + +/** + * Converts an object of type 'DeploymentStrategy' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_DeploymentStrategy(obj: DeploymentStrategy | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'rollingUpdate': toJson_RollingUpdateDeployment(obj.rollingUpdate), + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy. + * + * @schema io.k8s.api.apps.v1.StatefulSetUpdateStrategy + */ +export interface StatefulSetUpdateStrategy { + /** + * RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. + * + * @schema io.k8s.api.apps.v1.StatefulSetUpdateStrategy#rollingUpdate + */ + readonly rollingUpdate?: RollingUpdateStatefulSetStrategy; + + /** + * Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate. + * + * @default RollingUpdate. + * @schema io.k8s.api.apps.v1.StatefulSetUpdateStrategy#type + */ + readonly type?: string; + +} + +/** + * Converts an object of type 'StatefulSetUpdateStrategy' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_StatefulSetUpdateStrategy(obj: StatefulSetUpdateStrategy | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'rollingUpdate': toJson_RollingUpdateStatefulSetStrategy(obj.rollingUpdate), + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * BoundObjectReference is a reference to an object that a token is bound to. + * + * @schema io.k8s.api.authentication.v1.BoundObjectReference + */ +export interface BoundObjectReference { + /** + * API version of the referent. + * + * @schema io.k8s.api.authentication.v1.BoundObjectReference#apiVersion + */ + readonly apiVersion?: string; + + /** + * Kind of the referent. Valid kinds are 'Pod' and 'Secret'. + * + * @schema io.k8s.api.authentication.v1.BoundObjectReference#kind + */ + readonly kind?: string; + + /** + * Name of the referent. + * + * @schema io.k8s.api.authentication.v1.BoundObjectReference#name + */ + readonly name?: string; + + /** + * UID of the referent. + * + * @schema io.k8s.api.authentication.v1.BoundObjectReference#uid + */ + readonly uid?: string; + +} + +/** + * Converts an object of type 'BoundObjectReference' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_BoundObjectReference(obj: BoundObjectReference | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiVersion': obj.apiVersion, + 'kind': obj.kind, + 'name': obj.name, + 'uid': obj.uid, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface + * + * @schema io.k8s.api.authorization.v1.NonResourceAttributes + */ +export interface NonResourceAttributes { + /** + * Path is the URL path of the request + * + * @schema io.k8s.api.authorization.v1.NonResourceAttributes#path + */ + readonly path?: string; + + /** + * Verb is the standard HTTP verb + * + * @schema io.k8s.api.authorization.v1.NonResourceAttributes#verb + */ + readonly verb?: string; + +} + +/** + * Converts an object of type 'NonResourceAttributes' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NonResourceAttributes(obj: NonResourceAttributes | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'path': obj.path, + 'verb': obj.verb, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes + */ +export interface ResourceAttributes { + /** + * Group is the API Group of the Resource. "*" means all. + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes#group + */ + readonly group?: string; + + /** + * Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all. + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes#name + */ + readonly name?: string; + + /** + * Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes#namespace + */ + readonly namespace?: string; + + /** + * Resource is one of the existing resource types. "*" means all. + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes#resource + */ + readonly resource?: string; + + /** + * Subresource is one of the existing resource types. "" means none. + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes#subresource + */ + readonly subresource?: string; + + /** + * Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes#verb + */ + readonly verb?: string; + + /** + * Version is the API Version of the Resource. "*" means all. + * + * @schema io.k8s.api.authorization.v1.ResourceAttributes#version + */ + readonly version?: string; + +} + +/** + * Converts an object of type 'ResourceAttributes' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ResourceAttributes(obj: ResourceAttributes | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'group': obj.group, + 'name': obj.name, + 'namespace': obj.namespace, + 'resource': obj.resource, + 'subresource': obj.subresource, + 'verb': obj.verb, + 'version': obj.version, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface + * + * @schema io.k8s.api.authorization.v1beta1.NonResourceAttributes + */ +export interface NonResourceAttributesV1Beta1 { + /** + * Path is the URL path of the request + * + * @schema io.k8s.api.authorization.v1beta1.NonResourceAttributes#path + */ + readonly path?: string; + + /** + * Verb is the standard HTTP verb + * + * @schema io.k8s.api.authorization.v1beta1.NonResourceAttributes#verb + */ + readonly verb?: string; + +} + +/** + * Converts an object of type 'NonResourceAttributesV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NonResourceAttributesV1Beta1(obj: NonResourceAttributesV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'path': obj.path, + 'verb': obj.verb, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface + * + * @schema io.k8s.api.authorization.v1beta1.ResourceAttributes + */ +export interface ResourceAttributesV1Beta1 { + /** + * Group is the API Group of the Resource. "*" means all. + * + * @schema io.k8s.api.authorization.v1beta1.ResourceAttributes#group + */ + readonly group?: string; + + /** + * Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all. + * + * @schema io.k8s.api.authorization.v1beta1.ResourceAttributes#name + */ + readonly name?: string; + + /** + * Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview + * + * @schema io.k8s.api.authorization.v1beta1.ResourceAttributes#namespace + */ + readonly namespace?: string; + + /** + * Resource is one of the existing resource types. "*" means all. + * + * @schema io.k8s.api.authorization.v1beta1.ResourceAttributes#resource + */ + readonly resource?: string; + + /** + * Subresource is one of the existing resource types. "" means none. + * + * @schema io.k8s.api.authorization.v1beta1.ResourceAttributes#subresource + */ + readonly subresource?: string; + + /** + * Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. + * + * @schema io.k8s.api.authorization.v1beta1.ResourceAttributes#verb + */ + readonly verb?: string; + + /** + * Version is the API Version of the Resource. "*" means all. + * + * @schema io.k8s.api.authorization.v1beta1.ResourceAttributes#version + */ + readonly version?: string; + +} + +/** + * Converts an object of type 'ResourceAttributesV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ResourceAttributesV1Beta1(obj: ResourceAttributesV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'group': obj.group, + 'name': obj.name, + 'namespace': obj.namespace, + 'resource': obj.resource, + 'subresource': obj.subresource, + 'verb': obj.verb, + 'version': obj.version, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CrossVersionObjectReference contains enough information to let you identify the referred resource. + * + * @schema io.k8s.api.autoscaling.v1.CrossVersionObjectReference + */ +export interface CrossVersionObjectReference { + /** + * API version of the referent + * + * @schema io.k8s.api.autoscaling.v1.CrossVersionObjectReference#apiVersion + */ + readonly apiVersion?: string; + + /** + * Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + * + * @schema io.k8s.api.autoscaling.v1.CrossVersionObjectReference#kind + */ + readonly kind: string; + + /** + * Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names + * + * @schema io.k8s.api.autoscaling.v1.CrossVersionObjectReference#name + */ + readonly name: string; + +} + +/** + * Converts an object of type 'CrossVersionObjectReference' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CrossVersionObjectReference(obj: CrossVersionObjectReference | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiVersion': obj.apiVersion, + 'kind': obj.kind, + 'name': obj.name, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once). + * + * @schema io.k8s.api.autoscaling.v2beta1.MetricSpec + */ +export interface MetricSpecV2Beta1 { + /** + * container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag. + * + * @schema io.k8s.api.autoscaling.v2beta1.MetricSpec#containerResource + */ + readonly containerResource?: ContainerResourceMetricSourceV2Beta1; + + /** + * external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). + * + * @schema io.k8s.api.autoscaling.v2beta1.MetricSpec#external + */ + readonly external?: ExternalMetricSourceV2Beta1; + + /** + * object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). + * + * @schema io.k8s.api.autoscaling.v2beta1.MetricSpec#object + */ + readonly object?: ObjectMetricSourceV2Beta1; + + /** + * pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. + * + * @schema io.k8s.api.autoscaling.v2beta1.MetricSpec#pods + */ + readonly pods?: PodsMetricSourceV2Beta1; + + /** + * resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. + * + * @schema io.k8s.api.autoscaling.v2beta1.MetricSpec#resource + */ + readonly resource?: ResourceMetricSourceV2Beta1; + + /** + * type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled + * + * @schema io.k8s.api.autoscaling.v2beta1.MetricSpec#type + */ + readonly type: string; + +} + +/** + * Converts an object of type 'MetricSpecV2Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_MetricSpecV2Beta1(obj: MetricSpecV2Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'containerResource': toJson_ContainerResourceMetricSourceV2Beta1(obj.containerResource), + 'external': toJson_ExternalMetricSourceV2Beta1(obj.external), + 'object': toJson_ObjectMetricSourceV2Beta1(obj.object), + 'pods': toJson_PodsMetricSourceV2Beta1(obj.pods), + 'resource': toJson_ResourceMetricSourceV2Beta1(obj.resource), + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CrossVersionObjectReference contains enough information to let you identify the referred resource. + * + * @schema io.k8s.api.autoscaling.v2beta1.CrossVersionObjectReference + */ +export interface CrossVersionObjectReferenceV2Beta1 { + /** + * API version of the referent + * + * @schema io.k8s.api.autoscaling.v2beta1.CrossVersionObjectReference#apiVersion + */ + readonly apiVersion?: string; + + /** + * Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + * + * @schema io.k8s.api.autoscaling.v2beta1.CrossVersionObjectReference#kind + */ + readonly kind: string; + + /** + * Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names + * + * @schema io.k8s.api.autoscaling.v2beta1.CrossVersionObjectReference#name + */ + readonly name: string; + +} + +/** + * Converts an object of type 'CrossVersionObjectReferenceV2Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CrossVersionObjectReferenceV2Beta1(obj: CrossVersionObjectReferenceV2Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiVersion': obj.apiVersion, + 'kind': obj.kind, + 'name': obj.name, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerBehavior + */ +export interface HorizontalPodAutoscalerBehaviorV2Beta2 { + /** + * scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used). + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerBehavior#scaleDown + */ + readonly scaleDown?: HpaScalingRulesV2Beta2; + + /** + * scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of: + * * increase no more than 4 pods per 60 seconds + * * double the number of pods per 60 seconds + * No stabilization is used. + * + * @schema io.k8s.api.autoscaling.v2beta2.HorizontalPodAutoscalerBehavior#scaleUp + */ + readonly scaleUp?: HpaScalingRulesV2Beta2; + +} + +/** + * Converts an object of type 'HorizontalPodAutoscalerBehaviorV2Beta2' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HorizontalPodAutoscalerBehaviorV2Beta2(obj: HorizontalPodAutoscalerBehaviorV2Beta2 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'scaleDown': toJson_HpaScalingRulesV2Beta2(obj.scaleDown), + 'scaleUp': toJson_HpaScalingRulesV2Beta2(obj.scaleUp), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once). + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricSpec + */ +export interface MetricSpecV2Beta2 { + /** + * container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag. + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricSpec#containerResource + */ + readonly containerResource?: ContainerResourceMetricSourceV2Beta2; + + /** + * external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricSpec#external + */ + readonly external?: ExternalMetricSourceV2Beta2; + + /** + * object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricSpec#object + */ + readonly object?: ObjectMetricSourceV2Beta2; + + /** + * pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricSpec#pods + */ + readonly pods?: PodsMetricSourceV2Beta2; + + /** + * resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricSpec#resource + */ + readonly resource?: ResourceMetricSourceV2Beta2; + + /** + * type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricSpec#type + */ + readonly type: string; + +} + +/** + * Converts an object of type 'MetricSpecV2Beta2' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_MetricSpecV2Beta2(obj: MetricSpecV2Beta2 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'containerResource': toJson_ContainerResourceMetricSourceV2Beta2(obj.containerResource), + 'external': toJson_ExternalMetricSourceV2Beta2(obj.external), + 'object': toJson_ObjectMetricSourceV2Beta2(obj.object), + 'pods': toJson_PodsMetricSourceV2Beta2(obj.pods), + 'resource': toJson_ResourceMetricSourceV2Beta2(obj.resource), + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CrossVersionObjectReference contains enough information to let you identify the referred resource. + * + * @schema io.k8s.api.autoscaling.v2beta2.CrossVersionObjectReference + */ +export interface CrossVersionObjectReferenceV2Beta2 { + /** + * API version of the referent + * + * @schema io.k8s.api.autoscaling.v2beta2.CrossVersionObjectReference#apiVersion + */ + readonly apiVersion?: string; + + /** + * Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + * + * @schema io.k8s.api.autoscaling.v2beta2.CrossVersionObjectReference#kind + */ + readonly kind: string; + + /** + * Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names + * + * @schema io.k8s.api.autoscaling.v2beta2.CrossVersionObjectReference#name + */ + readonly name: string; + +} + +/** + * Converts an object of type 'CrossVersionObjectReferenceV2Beta2' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CrossVersionObjectReferenceV2Beta2(obj: CrossVersionObjectReferenceV2Beta2 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiVersion': obj.apiVersion, + 'kind': obj.kind, + 'name': obj.name, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * JobTemplateSpec describes the data a Job should have when created from a template + * + * @schema io.k8s.api.batch.v1.JobTemplateSpec + */ +export interface JobTemplateSpec { + /** + * Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.batch.v1.JobTemplateSpec#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.batch.v1.JobTemplateSpec#spec + */ + readonly spec?: JobSpec; + +} + +/** + * Converts an object of type 'JobTemplateSpec' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_JobTemplateSpec(obj: JobTemplateSpec | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_JobSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * JobTemplateSpec describes the data a Job should have when created from a template + * + * @schema io.k8s.api.batch.v1beta1.JobTemplateSpec + */ +export interface JobTemplateSpecV1Beta1 { + /** + * Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + * + * @schema io.k8s.api.batch.v1beta1.JobTemplateSpec#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + * + * @schema io.k8s.api.batch.v1beta1.JobTemplateSpec#spec + */ + readonly spec?: JobSpec; + +} + +/** + * Converts an object of type 'JobTemplateSpecV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_JobTemplateSpecV1Beta1(obj: JobTemplateSpecV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_JobSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EndpointAddress is a tuple that describes single IP address. + * + * @schema io.k8s.api.core.v1.EndpointAddress + */ +export interface EndpointAddress { + /** + * The Hostname of this endpoint + * + * @schema io.k8s.api.core.v1.EndpointAddress#hostname + */ + readonly hostname?: string; + + /** + * The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready. + * + * @schema io.k8s.api.core.v1.EndpointAddress#ip + */ + readonly ip: string; + + /** + * Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. + * + * @schema io.k8s.api.core.v1.EndpointAddress#nodeName + */ + readonly nodeName?: string; + + /** + * Reference to object providing the endpoint. + * + * @schema io.k8s.api.core.v1.EndpointAddress#targetRef + */ + readonly targetRef?: ObjectReference; + +} + +/** + * Converts an object of type 'EndpointAddress' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EndpointAddress(obj: EndpointAddress | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'hostname': obj.hostname, + 'ip': obj.ip, + 'nodeName': obj.nodeName, + 'targetRef': toJson_ObjectReference(obj.targetRef), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EnvVar represents an environment variable present in a Container. + * + * @schema io.k8s.api.core.v1.EnvVar + */ +export interface EnvVar { + /** + * Name of the environment variable. Must be a C_IDENTIFIER. + * + * @schema io.k8s.api.core.v1.EnvVar#name + */ + readonly name: string; + + /** + * Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If 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). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". + * + * @default . + * @schema io.k8s.api.core.v1.EnvVar#value + */ + readonly value?: string; + + /** + * Source for the environment variable's value. Cannot be used if value is not empty. + * + * @schema io.k8s.api.core.v1.EnvVar#valueFrom + */ + readonly valueFrom?: EnvVarSource; + +} + +/** + * Converts an object of type 'EnvVar' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EnvVar(obj: EnvVar | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + 'value': obj.value, + 'valueFrom': toJson_EnvVarSource(obj.valueFrom), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EnvFromSource represents the source of a set of ConfigMaps + * + * @schema io.k8s.api.core.v1.EnvFromSource + */ +export interface EnvFromSource { + /** + * The ConfigMap to select from + * + * @schema io.k8s.api.core.v1.EnvFromSource#configMapRef + */ + readonly configMapRef?: ConfigMapEnvSource; + + /** + * An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + * + * @schema io.k8s.api.core.v1.EnvFromSource#prefix + */ + readonly prefix?: string; + + /** + * The Secret to select from + * + * @schema io.k8s.api.core.v1.EnvFromSource#secretRef + */ + readonly secretRef?: SecretEnvSource; + +} + +/** + * Converts an object of type 'EnvFromSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EnvFromSource(obj: EnvFromSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'configMapRef': toJson_ConfigMapEnvSource(obj.configMapRef), + 'prefix': obj.prefix, + 'secretRef': toJson_SecretEnvSource(obj.secretRef), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. + * + * @schema io.k8s.api.core.v1.Lifecycle + */ +export interface Lifecycle { + /** + * PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks + * + * @schema io.k8s.api.core.v1.Lifecycle#postStart + */ + readonly postStart?: Handler; + + /** + * PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks + * + * @schema io.k8s.api.core.v1.Lifecycle#preStop + */ + readonly preStop?: Handler; + +} + +/** + * Converts an object of type 'Lifecycle' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Lifecycle(obj: Lifecycle | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'postStart': toJson_Handler(obj.postStart), + 'preStop': toJson_Handler(obj.preStop), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. + * + * @schema io.k8s.api.core.v1.Probe + */ +export interface Probe { + /** + * One and only one of the following should be specified. Exec specifies the action to take. + * + * @schema io.k8s.api.core.v1.Probe#exec + */ + readonly exec?: ExecAction; + + /** + * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. + * + * @default 3. Minimum value is 1. + * @schema io.k8s.api.core.v1.Probe#failureThreshold + */ + readonly failureThreshold?: number; + + /** + * HTTPGet specifies the http request to perform. + * + * @schema io.k8s.api.core.v1.Probe#httpGet + */ + readonly httpGet?: HttpGetAction; + + /** + * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + * + * @schema io.k8s.api.core.v1.Probe#initialDelaySeconds + */ + readonly initialDelaySeconds?: number; + + /** + * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. + * + * @default 10 seconds. Minimum value is 1. + * @schema io.k8s.api.core.v1.Probe#periodSeconds + */ + readonly periodSeconds?: number; + + /** + * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. + * + * @default 1. Must be 1 for liveness and startup. Minimum value is 1. + * @schema io.k8s.api.core.v1.Probe#successThreshold + */ + readonly successThreshold?: number; + + /** + * TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported + * + * @schema io.k8s.api.core.v1.Probe#tcpSocket + */ + readonly tcpSocket?: TcpSocketAction; + + /** + * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. + * + * @schema io.k8s.api.core.v1.Probe#terminationGracePeriodSeconds + */ + readonly terminationGracePeriodSeconds?: number; + + /** + * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + * + * @default 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + * @schema io.k8s.api.core.v1.Probe#timeoutSeconds + */ + readonly timeoutSeconds?: number; + +} + +/** + * Converts an object of type 'Probe' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Probe(obj: Probe | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'exec': toJson_ExecAction(obj.exec), + 'failureThreshold': obj.failureThreshold, + 'httpGet': toJson_HttpGetAction(obj.httpGet), + 'initialDelaySeconds': obj.initialDelaySeconds, + 'periodSeconds': obj.periodSeconds, + 'successThreshold': obj.successThreshold, + 'tcpSocket': toJson_TcpSocketAction(obj.tcpSocket), + 'terminationGracePeriodSeconds': obj.terminationGracePeriodSeconds, + 'timeoutSeconds': obj.timeoutSeconds, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ContainerPort represents a network port in a single container. + * + * @schema io.k8s.api.core.v1.ContainerPort + */ +export interface ContainerPort { + /** + * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. + * + * @schema io.k8s.api.core.v1.ContainerPort#containerPort + */ + readonly containerPort: number; + + /** + * What host IP to bind the external port to. + * + * @schema io.k8s.api.core.v1.ContainerPort#hostIP + */ + readonly hostIp?: string; + + /** + * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. + * + * @schema io.k8s.api.core.v1.ContainerPort#hostPort + */ + readonly hostPort?: number; + + /** + * If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. + * + * @schema io.k8s.api.core.v1.ContainerPort#name + */ + readonly name?: string; + + /** + * Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". + * + * @default TCP". + * @schema io.k8s.api.core.v1.ContainerPort#protocol + */ + readonly protocol?: string; + +} + +/** + * Converts an object of type 'ContainerPort' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ContainerPort(obj: ContainerPort | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'containerPort': obj.containerPort, + 'hostIP': obj.hostIp, + 'hostPort': obj.hostPort, + 'name': obj.name, + 'protocol': obj.protocol, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ResourceRequirements describes the compute resource requirements. + * + * @schema io.k8s.api.core.v1.ResourceRequirements + */ +export interface ResourceRequirements { + /** + * Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + * + * @schema io.k8s.api.core.v1.ResourceRequirements#limits + */ + readonly limits?: { [key: string]: Quantity }; + + /** + * Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + * + * @schema io.k8s.api.core.v1.ResourceRequirements#requests + */ + readonly requests?: { [key: string]: Quantity }; + +} + +/** + * Converts an object of type 'ResourceRequirements' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ResourceRequirements(obj: ResourceRequirements | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'limits': ((obj.limits) === undefined) ? undefined : (Object.entries(obj.limits).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.value }), {})), + 'requests': ((obj.requests) === undefined) ? undefined : (Object.entries(obj.requests).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.value }), {})), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. + * + * @schema io.k8s.api.core.v1.SecurityContext + */ +export interface SecurityContext { + /** + * AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN + * + * @schema io.k8s.api.core.v1.SecurityContext#allowPrivilegeEscalation + */ + readonly allowPrivilegeEscalation?: boolean; + + /** + * The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. + * + * @default the default set of capabilities granted by the container runtime. + * @schema io.k8s.api.core.v1.SecurityContext#capabilities + */ + readonly capabilities?: Capabilities; + + /** + * Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. + * + * @default false. + * @schema io.k8s.api.core.v1.SecurityContext#privileged + */ + readonly privileged?: boolean; + + /** + * procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. + * + * @schema io.k8s.api.core.v1.SecurityContext#procMount + */ + readonly procMount?: string; + + /** + * Whether this container has a read-only root filesystem. Default is false. + * + * @default false. + * @schema io.k8s.api.core.v1.SecurityContext#readOnlyRootFilesystem + */ + readonly readOnlyRootFilesystem?: boolean; + + /** + * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @schema io.k8s.api.core.v1.SecurityContext#runAsGroup + */ + readonly runAsGroup?: number; + + /** + * Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @schema io.k8s.api.core.v1.SecurityContext#runAsNonRoot + */ + readonly runAsNonRoot?: boolean; + + /** + * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @default user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * @schema io.k8s.api.core.v1.SecurityContext#runAsUser + */ + readonly runAsUser?: number; + + /** + * The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @schema io.k8s.api.core.v1.SecurityContext#seLinuxOptions + */ + readonly seLinuxOptions?: SeLinuxOptions; + + /** + * The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. + * + * @schema io.k8s.api.core.v1.SecurityContext#seccompProfile + */ + readonly seccompProfile?: SeccompProfile; + + /** + * The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @schema io.k8s.api.core.v1.SecurityContext#windowsOptions + */ + readonly windowsOptions?: WindowsSecurityContextOptions; + +} + +/** + * Converts an object of type 'SecurityContext' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SecurityContext(obj: SecurityContext | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'allowPrivilegeEscalation': obj.allowPrivilegeEscalation, + 'capabilities': toJson_Capabilities(obj.capabilities), + 'privileged': obj.privileged, + 'procMount': obj.procMount, + 'readOnlyRootFilesystem': obj.readOnlyRootFilesystem, + 'runAsGroup': obj.runAsGroup, + 'runAsNonRoot': obj.runAsNonRoot, + 'runAsUser': obj.runAsUser, + 'seLinuxOptions': toJson_SeLinuxOptions(obj.seLinuxOptions), + 'seccompProfile': toJson_SeccompProfile(obj.seccompProfile), + 'windowsOptions': toJson_WindowsSecurityContextOptions(obj.windowsOptions), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * volumeDevice describes a mapping of a raw block device within a container. + * + * @schema io.k8s.api.core.v1.VolumeDevice + */ +export interface VolumeDevice { + /** + * devicePath is the path inside of the container that the device will be mapped to. + * + * @schema io.k8s.api.core.v1.VolumeDevice#devicePath + */ + readonly devicePath: string; + + /** + * name must match the name of a persistentVolumeClaim in the pod + * + * @schema io.k8s.api.core.v1.VolumeDevice#name + */ + readonly name: string; + +} + +/** + * Converts an object of type 'VolumeDevice' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_VolumeDevice(obj: VolumeDevice | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'devicePath': obj.devicePath, + 'name': obj.name, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeMount describes a mounting of a Volume within a container. + * + * @schema io.k8s.api.core.v1.VolumeMount + */ +export interface VolumeMount { + /** + * Path within the container at which the volume should be mounted. Must not contain ':'. + * + * @schema io.k8s.api.core.v1.VolumeMount#mountPath + */ + readonly mountPath: string; + + /** + * mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. + * + * @schema io.k8s.api.core.v1.VolumeMount#mountPropagation + */ + readonly mountPropagation?: string; + + /** + * This must match the Name of a Volume. + * + * @schema io.k8s.api.core.v1.VolumeMount#name + */ + readonly name: string; + + /** + * Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. + * + * @default false. + * @schema io.k8s.api.core.v1.VolumeMount#readOnly + */ + readonly readOnly?: boolean; + + /** + * Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). + * + * @default volume's root). + * @schema io.k8s.api.core.v1.VolumeMount#subPath + */ + readonly subPath?: string; + + /** + * Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. + * + * @default volume's root). SubPathExpr and SubPath are mutually exclusive. + * @schema io.k8s.api.core.v1.VolumeMount#subPathExpr + */ + readonly subPathExpr?: string; + +} + +/** + * Converts an object of type 'VolumeMount' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_VolumeMount(obj: VolumeMount | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'mountPath': obj.mountPath, + 'mountPropagation': obj.mountPropagation, + 'name': obj.name, + 'readOnly': obj.readOnly, + 'subPath': obj.subPath, + 'subPathExpr': obj.subPathExpr, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * LimitRangeItem defines a min/max usage limit for any resource that matches on kind. + * + * @schema io.k8s.api.core.v1.LimitRangeItem + */ +export interface LimitRangeItem { + /** + * Default resource requirement limit value by resource name if resource limit is omitted. + * + * @schema io.k8s.api.core.v1.LimitRangeItem#default + */ + readonly default?: { [key: string]: Quantity }; + + /** + * DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. + * + * @schema io.k8s.api.core.v1.LimitRangeItem#defaultRequest + */ + readonly defaultRequest?: { [key: string]: Quantity }; + + /** + * Max usage constraints on this kind by resource name. + * + * @schema io.k8s.api.core.v1.LimitRangeItem#max + */ + readonly max?: { [key: string]: Quantity }; + + /** + * MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource. + * + * @schema io.k8s.api.core.v1.LimitRangeItem#maxLimitRequestRatio + */ + readonly maxLimitRequestRatio?: { [key: string]: Quantity }; + + /** + * Min usage constraints on this kind by resource name. + * + * @schema io.k8s.api.core.v1.LimitRangeItem#min + */ + readonly min?: { [key: string]: Quantity }; + + /** + * Type of resource that this limit applies to. + * + * @schema io.k8s.api.core.v1.LimitRangeItem#type + */ + readonly type: string; + +} + +/** + * Converts an object of type 'LimitRangeItem' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_LimitRangeItem(obj: LimitRangeItem | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'default': ((obj.default) === undefined) ? undefined : (Object.entries(obj.default).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.value }), {})), + 'defaultRequest': ((obj.defaultRequest) === undefined) ? undefined : (Object.entries(obj.defaultRequest).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.value }), {})), + 'max': ((obj.max) === undefined) ? undefined : (Object.entries(obj.max).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.value }), {})), + 'maxLimitRequestRatio': ((obj.maxLimitRequestRatio) === undefined) ? undefined : (Object.entries(obj.maxLimitRequestRatio).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.value }), {})), + 'min': ((obj.min) === undefined) ? undefined : (Object.entries(obj.min).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.value }), {})), + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. + * + * @schema io.k8s.api.core.v1.NodeConfigSource + */ +export interface NodeConfigSource { + /** + * ConfigMap is a reference to a Node's ConfigMap + * + * @schema io.k8s.api.core.v1.NodeConfigSource#configMap + */ + readonly configMap?: ConfigMapNodeConfigSource; + +} + +/** + * Converts an object of type 'NodeConfigSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NodeConfigSource(obj: NodeConfigSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'configMap': toJson_ConfigMapNodeConfigSource(obj.configMap), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint. + * + * @schema io.k8s.api.core.v1.Taint + */ +export interface Taint { + /** + * Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. + * + * @schema io.k8s.api.core.v1.Taint#effect + */ + readonly effect: string; + + /** + * Required. The taint key to be applied to a node. + * + * @schema io.k8s.api.core.v1.Taint#key + */ + readonly key: string; + + /** + * TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. + * + * @schema io.k8s.api.core.v1.Taint#timeAdded + */ + readonly timeAdded?: Date; + + /** + * The taint value corresponding to the taint key. + * + * @schema io.k8s.api.core.v1.Taint#value + */ + readonly value?: string; + +} + +/** + * Converts an object of type 'Taint' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Taint(obj: Taint | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'effect': obj.effect, + 'key': obj.key, + 'timeAdded': obj.timeAdded?.toISOString(), + 'value': obj.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a Persistent Disk resource in AWS. + * + * An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource + */ +export interface AwsElasticBlockStoreVolumeSource { + /** + * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + * + * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). + * + * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource#partition + */ + readonly partition?: number; + + /** + * Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + * + * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + * + * @schema io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource#volumeID + */ + readonly volumeId: string; + +} + +/** + * Converts an object of type 'AwsElasticBlockStoreVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_AwsElasticBlockStoreVolumeSource(obj: AwsElasticBlockStoreVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'partition': obj.partition, + 'readOnly': obj.readOnly, + 'volumeID': obj.volumeId, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + * + * @schema io.k8s.api.core.v1.AzureDiskVolumeSource + */ +export interface AzureDiskVolumeSource { + /** + * Host Caching mode: None, Read Only, Read Write. + * + * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#cachingMode + */ + readonly cachingMode?: string; + + /** + * The Name of the data disk in the blob storage + * + * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#diskName + */ + readonly diskName: string; + + /** + * The URI the data disk in the blob storage + * + * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#diskURI + */ + readonly diskUri: string; + + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + * + * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared + * + * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#kind + */ + readonly kind?: string; + + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.AzureDiskVolumeSource#readOnly + */ + readonly readOnly?: boolean; + +} + +/** + * Converts an object of type 'AzureDiskVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_AzureDiskVolumeSource(obj: AzureDiskVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'cachingMode': obj.cachingMode, + 'diskName': obj.diskName, + 'diskURI': obj.diskUri, + 'fsType': obj.fsType, + 'kind': obj.kind, + 'readOnly': obj.readOnly, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + * + * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource + */ +export interface AzureFilePersistentVolumeSource { + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * the name of secret that contains Azure Storage Account Name and Key + * + * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource#secretName + */ + readonly secretName: string; + + /** + * the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod + * + * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource#secretNamespace + */ + readonly secretNamespace?: string; + + /** + * Share Name + * + * @schema io.k8s.api.core.v1.AzureFilePersistentVolumeSource#shareName + */ + readonly shareName: string; + +} + +/** + * Converts an object of type 'AzureFilePersistentVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_AzureFilePersistentVolumeSource(obj: AzureFilePersistentVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'readOnly': obj.readOnly, + 'secretName': obj.secretName, + 'secretNamespace': obj.secretNamespace, + 'shareName': obj.shareName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource + */ +export interface CephFsPersistentVolumeSource { + /** + * Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#monitors + */ + readonly monitors: string[]; + + /** + * Optional: Used as the mounted root, rather than the full Ceph tree, default is / + * + * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#path + */ + readonly path?: string; + + /** + * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#secretFile + */ + readonly secretFile?: string; + + /** + * Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#secretRef + */ + readonly secretRef?: SecretReference; + + /** + * Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSPersistentVolumeSource#user + */ + readonly user?: string; + +} + +/** + * Converts an object of type 'CephFsPersistentVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CephFsPersistentVolumeSource(obj: CephFsPersistentVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'monitors': obj.monitors?.map(y => y), + 'path': obj.path, + 'readOnly': obj.readOnly, + 'secretFile': obj.secretFile, + 'secretRef': toJson_SecretReference(obj.secretRef), + 'user': obj.user, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource + */ +export interface CinderPersistentVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Optional: points to a secret object containing parameters used to connect to OpenStack. + * + * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource#secretRef + */ + readonly secretRef?: SecretReference; + + /** + * volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @schema io.k8s.api.core.v1.CinderPersistentVolumeSource#volumeID + */ + readonly volumeId: string; + +} + +/** + * Converts an object of type 'CinderPersistentVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CinderPersistentVolumeSource(obj: CinderPersistentVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'readOnly': obj.readOnly, + 'secretRef': toJson_SecretReference(obj.secretRef), + 'volumeID': obj.volumeId, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents storage that is managed by an external CSI volume driver (Beta feature) + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource + */ +export interface CsiPersistentVolumeSource { + /** + * ControllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This is an alpha field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#controllerExpandSecretRef + */ + readonly controllerExpandSecretRef?: SecretReference; + + /** + * ControllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#controllerPublishSecretRef + */ + readonly controllerPublishSecretRef?: SecretReference; + + /** + * Driver is the name of the driver to use for this volume. Required. + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#driver + */ + readonly driver: string; + + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#nodePublishSecretRef + */ + readonly nodePublishSecretRef?: SecretReference; + + /** + * NodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#nodeStageSecretRef + */ + readonly nodeStageSecretRef?: SecretReference; + + /** + * Optional: The value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). + * + * @default false (read/write). + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Attributes of the volume to publish. + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#volumeAttributes + */ + readonly volumeAttributes?: { [key: string]: string }; + + /** + * VolumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required. + * + * @schema io.k8s.api.core.v1.CSIPersistentVolumeSource#volumeHandle + */ + readonly volumeHandle: string; + +} + +/** + * Converts an object of type 'CsiPersistentVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CsiPersistentVolumeSource(obj: CsiPersistentVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'controllerExpandSecretRef': toJson_SecretReference(obj.controllerExpandSecretRef), + 'controllerPublishSecretRef': toJson_SecretReference(obj.controllerPublishSecretRef), + 'driver': obj.driver, + 'fsType': obj.fsType, + 'nodePublishSecretRef': toJson_SecretReference(obj.nodePublishSecretRef), + 'nodeStageSecretRef': toJson_SecretReference(obj.nodeStageSecretRef), + 'readOnly': obj.readOnly, + 'volumeAttributes': ((obj.volumeAttributes) === undefined) ? undefined : (Object.entries(obj.volumeAttributes).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'volumeHandle': obj.volumeHandle, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.FCVolumeSource + */ +export interface FcVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + * + * @schema io.k8s.api.core.v1.FCVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Optional: FC target lun number + * + * @schema io.k8s.api.core.v1.FCVolumeSource#lun + */ + readonly lun?: number; + + /** + * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.FCVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Optional: FC target worldwide names (WWNs) + * + * @schema io.k8s.api.core.v1.FCVolumeSource#targetWWNs + */ + readonly targetWwNs?: string[]; + + /** + * Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. + * + * @schema io.k8s.api.core.v1.FCVolumeSource#wwids + */ + readonly wwids?: string[]; + +} + +/** + * Converts an object of type 'FcVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_FcVolumeSource(obj: FcVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'lun': obj.lun, + 'readOnly': obj.readOnly, + 'targetWWNs': obj.targetWwNs?.map(y => y), + 'wwids': obj.wwids?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin. + * + * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource + */ +export interface FlexPersistentVolumeSource { + /** + * Driver is the name of the driver to use for this volume. + * + * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#driver + */ + readonly driver: string; + + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. + * + * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Optional: Extra command options if any. + * + * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#options + */ + readonly options?: { [key: string]: string }; + + /** + * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. + * + * @schema io.k8s.api.core.v1.FlexPersistentVolumeSource#secretRef + */ + readonly secretRef?: SecretReference; + +} + +/** + * Converts an object of type 'FlexPersistentVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_FlexPersistentVolumeSource(obj: FlexPersistentVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'driver': obj.driver, + 'fsType': obj.fsType, + 'options': ((obj.options) === undefined) ? undefined : (Object.entries(obj.options).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'readOnly': obj.readOnly, + 'secretRef': toJson_SecretReference(obj.secretRef), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.FlockerVolumeSource + */ +export interface FlockerVolumeSource { + /** + * Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated + * + * @schema io.k8s.api.core.v1.FlockerVolumeSource#datasetName + */ + readonly datasetName?: string; + + /** + * UUID of the dataset. This is unique identifier of a Flocker dataset + * + * @schema io.k8s.api.core.v1.FlockerVolumeSource#datasetUUID + */ + readonly datasetUuid?: string; + +} + +/** + * Converts an object of type 'FlockerVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_FlockerVolumeSource(obj: FlockerVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'datasetName': obj.datasetName, + 'datasetUUID': obj.datasetUuid, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a Persistent Disk resource in Google Compute Engine. + * + * A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource + */ +export interface GcePersistentDiskVolumeSource { + /** + * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + * + * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + * + * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource#partition + */ + readonly partition?: number; + + /** + * Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + * + * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource#pdName + */ + readonly pdName: string; + + /** + * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + * + * @default false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + * @schema io.k8s.api.core.v1.GCEPersistentDiskVolumeSource#readOnly + */ + readonly readOnly?: boolean; + +} + +/** + * Converts an object of type 'GcePersistentDiskVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_GcePersistentDiskVolumeSource(obj: GcePersistentDiskVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'partition': obj.partition, + 'pdName': obj.pdName, + 'readOnly': obj.readOnly, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource + */ +export interface GlusterfsPersistentVolumeSource { + /** + * EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * + * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource#endpoints + */ + readonly endpoints: string; + + /** + * EndpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * + * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource#endpointsNamespace + */ + readonly endpointsNamespace?: string; + + /** + * Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * + * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource#path + */ + readonly path: string; + + /** + * ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * + * @default false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * @schema io.k8s.api.core.v1.GlusterfsPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + +} + +/** + * Converts an object of type 'GlusterfsPersistentVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_GlusterfsPersistentVolumeSource(obj: GlusterfsPersistentVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'endpoints': obj.endpoints, + 'endpointsNamespace': obj.endpointsNamespace, + 'path': obj.path, + 'readOnly': obj.readOnly, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.HostPathVolumeSource + */ +export interface HostPathVolumeSource { + /** + * Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + * + * @schema io.k8s.api.core.v1.HostPathVolumeSource#path + */ + readonly path: string; + + /** + * Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + * + * @default More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + * @schema io.k8s.api.core.v1.HostPathVolumeSource#type + */ + readonly type?: string; + +} + +/** + * Converts an object of type 'HostPathVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HostPathVolumeSource(obj: HostPathVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'path': obj.path, + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource + */ +export interface IscsiPersistentVolumeSource { + /** + * whether support iSCSI Discovery CHAP authentication + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#chapAuthDiscovery + */ + readonly chapAuthDiscovery?: boolean; + + /** + * whether support iSCSI Session CHAP authentication + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#chapAuthSession + */ + readonly chapAuthSession?: boolean; + + /** + * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#initiatorName + */ + readonly initiatorName?: string; + + /** + * Target iSCSI Qualified Name. + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#iqn + */ + readonly iqn: string; + + /** + * iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). + * + * @default default' (tcp). + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#iscsiInterface + */ + readonly iscsiInterface?: string; + + /** + * iSCSI Target Lun number. + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#lun + */ + readonly lun: number; + + /** + * iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#portals + */ + readonly portals?: string[]; + + /** + * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. + * + * @default false. + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * CHAP Secret for iSCSI target and initiator authentication + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#secretRef + */ + readonly secretRef?: SecretReference; + + /** + * iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + * + * @schema io.k8s.api.core.v1.ISCSIPersistentVolumeSource#targetPortal + */ + readonly targetPortal: string; + +} + +/** + * Converts an object of type 'IscsiPersistentVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IscsiPersistentVolumeSource(obj: IscsiPersistentVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'chapAuthDiscovery': obj.chapAuthDiscovery, + 'chapAuthSession': obj.chapAuthSession, + 'fsType': obj.fsType, + 'initiatorName': obj.initiatorName, + 'iqn': obj.iqn, + 'iscsiInterface': obj.iscsiInterface, + 'lun': obj.lun, + 'portals': obj.portals?.map(y => y), + 'readOnly': obj.readOnly, + 'secretRef': toJson_SecretReference(obj.secretRef), + 'targetPortal': obj.targetPortal, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Local represents directly-attached storage with node affinity (Beta feature) + * + * @schema io.k8s.api.core.v1.LocalVolumeSource + */ +export interface LocalVolumeSource { + /** + * Filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified. + * + * @schema io.k8s.api.core.v1.LocalVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * The full path to the volume on the node. It can be either a directory or block device (disk, partition, ...). + * + * @schema io.k8s.api.core.v1.LocalVolumeSource#path + */ + readonly path: string; + +} + +/** + * Converts an object of type 'LocalVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_LocalVolumeSource(obj: LocalVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'path': obj.path, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.NFSVolumeSource + */ +export interface NfsVolumeSource { + /** + * Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + * + * @schema io.k8s.api.core.v1.NFSVolumeSource#path + */ + readonly path: string; + + /** + * ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + * + * @default false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + * @schema io.k8s.api.core.v1.NFSVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + * + * @schema io.k8s.api.core.v1.NFSVolumeSource#server + */ + readonly server: string; + +} + +/** + * Converts an object of type 'NfsVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NfsVolumeSource(obj: NfsVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'path': obj.path, + 'readOnly': obj.readOnly, + 'server': obj.server, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from. + * + * @schema io.k8s.api.core.v1.VolumeNodeAffinity + */ +export interface VolumeNodeAffinity { + /** + * Required specifies hard node constraints that must be met. + * + * @schema io.k8s.api.core.v1.VolumeNodeAffinity#required + */ + readonly required?: NodeSelector; + +} + +/** + * Converts an object of type 'VolumeNodeAffinity' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_VolumeNodeAffinity(obj: VolumeNodeAffinity | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'required': toJson_NodeSelector(obj.required), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a Photon Controller persistent disk resource. + * + * @schema io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource + */ +export interface PhotonPersistentDiskVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + * + * @schema io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * ID that identifies Photon Controller persistent disk + * + * @schema io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource#pdID + */ + readonly pdId: string; + +} + +/** + * Converts an object of type 'PhotonPersistentDiskVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PhotonPersistentDiskVolumeSource(obj: PhotonPersistentDiskVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'pdID': obj.pdId, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PortworxVolumeSource represents a Portworx volume resource. + * + * @schema io.k8s.api.core.v1.PortworxVolumeSource + */ +export interface PortworxVolumeSource { + /** + * FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. + * + * @schema io.k8s.api.core.v1.PortworxVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.PortworxVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * VolumeID uniquely identifies a Portworx volume + * + * @schema io.k8s.api.core.v1.PortworxVolumeSource#volumeID + */ + readonly volumeId: string; + +} + +/** + * Converts an object of type 'PortworxVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PortworxVolumeSource(obj: PortworxVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'readOnly': obj.readOnly, + 'volumeID': obj.volumeId, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.QuobyteVolumeSource + */ +export interface QuobyteVolumeSource { + /** + * Group to map volume access to Default is no group + * + * @default no group + * @schema io.k8s.api.core.v1.QuobyteVolumeSource#group + */ + readonly group?: string; + + /** + * ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. + * + * @default false. + * @schema io.k8s.api.core.v1.QuobyteVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes + * + * @schema io.k8s.api.core.v1.QuobyteVolumeSource#registry + */ + readonly registry: string; + + /** + * Tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin + * + * @schema io.k8s.api.core.v1.QuobyteVolumeSource#tenant + */ + readonly tenant?: string; + + /** + * User to map volume access to Defaults to serivceaccount user + * + * @default serivceaccount user + * @schema io.k8s.api.core.v1.QuobyteVolumeSource#user + */ + readonly user?: string; + + /** + * Volume is a string that references an already created Quobyte volume by name. + * + * @schema io.k8s.api.core.v1.QuobyteVolumeSource#volume + */ + readonly volume: string; + +} + +/** + * Converts an object of type 'QuobyteVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_QuobyteVolumeSource(obj: QuobyteVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'group': obj.group, + 'readOnly': obj.readOnly, + 'registry': obj.registry, + 'tenant': obj.tenant, + 'user': obj.user, + 'volume': obj.volume, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource + */ +export interface RbdPersistentVolumeSource { + /** + * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd + * + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#image + */ + readonly image: string; + + /** + * Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#keyring + */ + readonly keyring?: string; + + /** + * A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#monitors + */ + readonly monitors: string[]; + + /** + * The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#pool + */ + readonly pool?: string; + + /** + * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#secretRef + */ + readonly secretRef?: SecretReference; + + /** + * The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDPersistentVolumeSource#user + */ + readonly user?: string; + +} + +/** + * Converts an object of type 'RbdPersistentVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_RbdPersistentVolumeSource(obj: RbdPersistentVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'image': obj.image, + 'keyring': obj.keyring, + 'monitors': obj.monitors?.map(y => y), + 'pool': obj.pool, + 'readOnly': obj.readOnly, + 'secretRef': toJson_SecretReference(obj.secretRef), + 'user': obj.user, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource + */ +export interface ScaleIoPersistentVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs" + * + * @default xfs" + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * The host address of the ScaleIO API Gateway. + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#gateway + */ + readonly gateway: string; + + /** + * The name of the ScaleIO Protection Domain for the configured storage. + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#protectionDomain + */ + readonly protectionDomain?: string; + + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#secretRef + */ + readonly secretRef: SecretReference; + + /** + * Flag to enable/disable SSL communication with Gateway, default false + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#sslEnabled + */ + readonly sslEnabled?: boolean; + + /** + * Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. + * + * @default ThinProvisioned. + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#storageMode + */ + readonly storageMode?: string; + + /** + * The ScaleIO Storage Pool associated with the protection domain. + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#storagePool + */ + readonly storagePool?: string; + + /** + * The name of the storage system as configured in ScaleIO. + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#system + */ + readonly system: string; + + /** + * The name of a volume already created in the ScaleIO system that is associated with this volume source. + * + * @schema io.k8s.api.core.v1.ScaleIOPersistentVolumeSource#volumeName + */ + readonly volumeName?: string; + +} + +/** + * Converts an object of type 'ScaleIoPersistentVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ScaleIoPersistentVolumeSource(obj: ScaleIoPersistentVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'gateway': obj.gateway, + 'protectionDomain': obj.protectionDomain, + 'readOnly': obj.readOnly, + 'secretRef': toJson_SecretReference(obj.secretRef), + 'sslEnabled': obj.sslEnabled, + 'storageMode': obj.storageMode, + 'storagePool': obj.storagePool, + 'system': obj.system, + 'volumeName': obj.volumeName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a StorageOS persistent volume resource. + * + * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource + */ +export interface StorageOsPersistentVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + * + * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. + * + * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#secretRef + */ + readonly secretRef?: ObjectReference; + + /** + * VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. + * + * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#volumeName + */ + readonly volumeName?: string; + + /** + * VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. + * + * @schema io.k8s.api.core.v1.StorageOSPersistentVolumeSource#volumeNamespace + */ + readonly volumeNamespace?: string; + +} + +/** + * Converts an object of type 'StorageOsPersistentVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_StorageOsPersistentVolumeSource(obj: StorageOsPersistentVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'readOnly': obj.readOnly, + 'secretRef': toJson_ObjectReference(obj.secretRef), + 'volumeName': obj.volumeName, + 'volumeNamespace': obj.volumeNamespace, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a vSphere volume resource. + * + * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource + */ +export interface VsphereVirtualDiskVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + * + * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. + * + * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource#storagePolicyID + */ + readonly storagePolicyId?: string; + + /** + * Storage Policy Based Management (SPBM) profile name. + * + * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource#storagePolicyName + */ + readonly storagePolicyName?: string; + + /** + * Path that identifies vSphere volume vmdk + * + * @schema io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource#volumePath + */ + readonly volumePath: string; + +} + +/** + * Converts an object of type 'VsphereVirtualDiskVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_VsphereVirtualDiskVolumeSource(obj: VsphereVirtualDiskVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'storagePolicyID': obj.storagePolicyId, + 'storagePolicyName': obj.storagePolicyName, + 'volumePath': obj.volumePath, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. + * + * @schema io.k8s.api.core.v1.TypedLocalObjectReference + */ +export interface TypedLocalObjectReference { + /** + * APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + * + * @schema io.k8s.api.core.v1.TypedLocalObjectReference#apiGroup + */ + readonly apiGroup?: string; + + /** + * Kind is the type of resource being referenced + * + * @schema io.k8s.api.core.v1.TypedLocalObjectReference#kind + */ + readonly kind: string; + + /** + * Name is the name of resource being referenced + * + * @schema io.k8s.api.core.v1.TypedLocalObjectReference#name + */ + readonly name: string; + +} + +/** + * Converts an object of type 'TypedLocalObjectReference' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_TypedLocalObjectReference(obj: TypedLocalObjectReference | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiGroup': obj.apiGroup, + 'kind': obj.kind, + 'name': obj.name, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Affinity is a group of affinity scheduling rules. + * + * @schema io.k8s.api.core.v1.Affinity + */ +export interface Affinity { + /** + * Describes node affinity scheduling rules for the pod. + * + * @schema io.k8s.api.core.v1.Affinity#nodeAffinity + */ + readonly nodeAffinity?: NodeAffinity; + + /** + * Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). + * + * @schema io.k8s.api.core.v1.Affinity#podAffinity + */ + readonly podAffinity?: PodAffinity; + + /** + * Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). + * + * @schema io.k8s.api.core.v1.Affinity#podAntiAffinity + */ + readonly podAntiAffinity?: PodAntiAffinity; + +} + +/** + * Converts an object of type 'Affinity' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Affinity(obj: Affinity | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'nodeAffinity': toJson_NodeAffinity(obj.nodeAffinity), + 'podAffinity': toJson_PodAffinity(obj.podAffinity), + 'podAntiAffinity': toJson_PodAntiAffinity(obj.podAntiAffinity), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * A single application container that you want to run within a pod. + * + * @schema io.k8s.api.core.v1.Container + */ +export interface Container { + /** + * Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If 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). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + * + * @schema io.k8s.api.core.v1.Container#args + */ + readonly args?: string[]; + + /** + * Entrypoint array. 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. If 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). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell + * + * @schema io.k8s.api.core.v1.Container#command + */ + readonly command?: string[]; + + /** + * List of environment variables to set in the container. Cannot be updated. + * + * @schema io.k8s.api.core.v1.Container#env + */ + readonly env?: EnvVar[]; + + /** + * List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. + * + * @schema io.k8s.api.core.v1.Container#envFrom + */ + readonly envFrom?: EnvFromSource[]; + + /** + * Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. + * + * @schema io.k8s.api.core.v1.Container#image + */ + readonly image?: string; + + /** + * Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + * + * @default Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images + * @schema io.k8s.api.core.v1.Container#imagePullPolicy + */ + readonly imagePullPolicy?: string; + + /** + * Actions that the management system should take in response to container lifecycle events. Cannot be updated. + * + * @schema io.k8s.api.core.v1.Container#lifecycle + */ + readonly lifecycle?: Lifecycle; + + /** + * Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + * + * @schema io.k8s.api.core.v1.Container#livenessProbe + */ + readonly livenessProbe?: Probe; + + /** + * Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. + * + * @schema io.k8s.api.core.v1.Container#name + */ + readonly name: string; + + /** + * List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. + * + * @schema io.k8s.api.core.v1.Container#ports + */ + readonly ports?: ContainerPort[]; + + /** + * Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + * + * @schema io.k8s.api.core.v1.Container#readinessProbe + */ + readonly readinessProbe?: Probe; + + /** + * Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + * + * @schema io.k8s.api.core.v1.Container#resources + */ + readonly resources?: ResourceRequirements; + + /** + * Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ + * + * @schema io.k8s.api.core.v1.Container#securityContext + */ + readonly securityContext?: SecurityContext; + + /** + * StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes + * + * @schema io.k8s.api.core.v1.Container#startupProbe + */ + readonly startupProbe?: Probe; + + /** + * Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. + * + * @default false. + * @schema io.k8s.api.core.v1.Container#stdin + */ + readonly stdin?: boolean; + + /** + * Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false + * + * @default false + * @schema io.k8s.api.core.v1.Container#stdinOnce + */ + readonly stdinOnce?: boolean; + + /** + * Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. + * + * @default dev/termination-log. Cannot be updated. + * @schema io.k8s.api.core.v1.Container#terminationMessagePath + */ + readonly terminationMessagePath?: string; + + /** + * Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. + * + * @default File. Cannot be updated. + * @schema io.k8s.api.core.v1.Container#terminationMessagePolicy + */ + readonly terminationMessagePolicy?: string; + + /** + * Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. + * + * @default false. + * @schema io.k8s.api.core.v1.Container#tty + */ + readonly tty?: boolean; + + /** + * volumeDevices is the list of block devices to be used by the container. + * + * @schema io.k8s.api.core.v1.Container#volumeDevices + */ + readonly volumeDevices?: VolumeDevice[]; + + /** + * Pod volumes to mount into the container's filesystem. Cannot be updated. + * + * @schema io.k8s.api.core.v1.Container#volumeMounts + */ + readonly volumeMounts?: VolumeMount[]; + + /** + * Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. + * + * @schema io.k8s.api.core.v1.Container#workingDir + */ + readonly workingDir?: string; + +} + +/** + * Converts an object of type 'Container' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Container(obj: Container | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'args': obj.args?.map(y => y), + 'command': obj.command?.map(y => y), + 'env': obj.env?.map(y => toJson_EnvVar(y)), + 'envFrom': obj.envFrom?.map(y => toJson_EnvFromSource(y)), + 'image': obj.image, + 'imagePullPolicy': obj.imagePullPolicy, + 'lifecycle': toJson_Lifecycle(obj.lifecycle), + 'livenessProbe': toJson_Probe(obj.livenessProbe), + 'name': obj.name, + 'ports': obj.ports?.map(y => toJson_ContainerPort(y)), + 'readinessProbe': toJson_Probe(obj.readinessProbe), + 'resources': toJson_ResourceRequirements(obj.resources), + 'securityContext': toJson_SecurityContext(obj.securityContext), + 'startupProbe': toJson_Probe(obj.startupProbe), + 'stdin': obj.stdin, + 'stdinOnce': obj.stdinOnce, + 'terminationMessagePath': obj.terminationMessagePath, + 'terminationMessagePolicy': obj.terminationMessagePolicy, + 'tty': obj.tty, + 'volumeDevices': obj.volumeDevices?.map(y => toJson_VolumeDevice(y)), + 'volumeMounts': obj.volumeMounts?.map(y => toJson_VolumeMount(y)), + 'workingDir': obj.workingDir, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. + * + * @schema io.k8s.api.core.v1.PodDNSConfig + */ +export interface PodDnsConfig { + /** + * A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. + * + * @schema io.k8s.api.core.v1.PodDNSConfig#nameservers + */ + readonly nameservers?: string[]; + + /** + * A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. + * + * @schema io.k8s.api.core.v1.PodDNSConfig#options + */ + readonly options?: PodDnsConfigOption[]; + + /** + * A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. + * + * @schema io.k8s.api.core.v1.PodDNSConfig#searches + */ + readonly searches?: string[]; + +} + +/** + * Converts an object of type 'PodDnsConfig' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PodDnsConfig(obj: PodDnsConfig | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'nameservers': obj.nameservers?.map(y => y), + 'options': obj.options?.map(y => toJson_PodDnsConfigOption(y)), + 'searches': obj.searches?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. + * + * @schema io.k8s.api.core.v1.HostAlias + */ +export interface HostAlias { + /** + * Hostnames for the above IP address. + * + * @schema io.k8s.api.core.v1.HostAlias#hostnames + */ + readonly hostnames?: string[]; + + /** + * IP address of the host file entry. + * + * @schema io.k8s.api.core.v1.HostAlias#ip + */ + readonly ip?: string; + +} + +/** + * Converts an object of type 'HostAlias' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HostAlias(obj: HostAlias | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'hostnames': obj.hostnames?.map(y => y), + 'ip': obj.ip, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodReadinessGate contains the reference to a pod condition + * + * @schema io.k8s.api.core.v1.PodReadinessGate + */ +export interface PodReadinessGate { + /** + * ConditionType refers to a condition in the pod's condition list with matching type. + * + * @schema io.k8s.api.core.v1.PodReadinessGate#conditionType + */ + readonly conditionType: string; + +} + +/** + * Converts an object of type 'PodReadinessGate' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PodReadinessGate(obj: PodReadinessGate | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'conditionType': obj.conditionType, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. + * + * @schema io.k8s.api.core.v1.PodSecurityContext + */ +export interface PodSecurityContext { + /** + * A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: + * + * 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- + * + * If unset, the Kubelet will not modify the ownership and permissions of any volume. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#fsGroup + */ + readonly fsGroup?: number; + + /** + * fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#fsGroupChangePolicy + */ + readonly fsGroupChangePolicy?: string; + + /** + * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#runAsGroup + */ + readonly runAsGroup?: number; + + /** + * Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#runAsNonRoot + */ + readonly runAsNonRoot?: boolean; + + /** + * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + * + * @default user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + * @schema io.k8s.api.core.v1.PodSecurityContext#runAsUser + */ + readonly runAsUser?: number; + + /** + * The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#seLinuxOptions + */ + readonly seLinuxOptions?: SeLinuxOptions; + + /** + * The seccomp options to use by the containers in this pod. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#seccompProfile + */ + readonly seccompProfile?: SeccompProfile; + + /** + * A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#supplementalGroups + */ + readonly supplementalGroups?: number[]; + + /** + * Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#sysctls + */ + readonly sysctls?: Sysctl[]; + + /** + * The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @schema io.k8s.api.core.v1.PodSecurityContext#windowsOptions + */ + readonly windowsOptions?: WindowsSecurityContextOptions; + +} + +/** + * Converts an object of type 'PodSecurityContext' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PodSecurityContext(obj: PodSecurityContext | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsGroup': obj.fsGroup, + 'fsGroupChangePolicy': obj.fsGroupChangePolicy, + 'runAsGroup': obj.runAsGroup, + 'runAsNonRoot': obj.runAsNonRoot, + 'runAsUser': obj.runAsUser, + 'seLinuxOptions': toJson_SeLinuxOptions(obj.seLinuxOptions), + 'seccompProfile': toJson_SeccompProfile(obj.seccompProfile), + 'supplementalGroups': obj.supplementalGroups?.map(y => y), + 'sysctls': obj.sysctls?.map(y => toJson_Sysctl(y)), + 'windowsOptions': toJson_WindowsSecurityContextOptions(obj.windowsOptions), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . + * + * @schema io.k8s.api.core.v1.Toleration + */ +export interface Toleration { + /** + * Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. + * + * @schema io.k8s.api.core.v1.Toleration#effect + */ + readonly effect?: string; + + /** + * Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. + * + * @schema io.k8s.api.core.v1.Toleration#key + */ + readonly key?: string; + + /** + * Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. + * + * @default Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. + * @schema io.k8s.api.core.v1.Toleration#operator + */ + readonly operator?: string; + + /** + * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. + * + * @schema io.k8s.api.core.v1.Toleration#tolerationSeconds + */ + readonly tolerationSeconds?: number; + + /** + * Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. + * + * @schema io.k8s.api.core.v1.Toleration#value + */ + readonly value?: string; + +} + +/** + * Converts an object of type 'Toleration' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Toleration(obj: Toleration | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'effect': obj.effect, + 'key': obj.key, + 'operator': obj.operator, + 'tolerationSeconds': obj.tolerationSeconds, + 'value': obj.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * TopologySpreadConstraint specifies how to spread matching pods among the given topology. + * + * @schema io.k8s.api.core.v1.TopologySpreadConstraint + */ +export interface TopologySpreadConstraint { + /** + * LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. + * + * @schema io.k8s.api.core.v1.TopologySpreadConstraint#labelSelector + */ + readonly labelSelector?: LabelSelector; + + /** + * MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. + * + * @schema io.k8s.api.core.v1.TopologySpreadConstraint#maxSkew + */ + readonly maxSkew: number; + + /** + * TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. It's a required field. + * + * @schema io.k8s.api.core.v1.TopologySpreadConstraint#topologyKey + */ + readonly topologyKey: string; + + /** + * WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, + * but giving higher precedence to topologies that would help reduce the + * skew. + * A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assigment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. + * + * @schema io.k8s.api.core.v1.TopologySpreadConstraint#whenUnsatisfiable + */ + readonly whenUnsatisfiable: string; + +} + +/** + * Converts an object of type 'TopologySpreadConstraint' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_TopologySpreadConstraint(obj: TopologySpreadConstraint | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'labelSelector': toJson_LabelSelector(obj.labelSelector), + 'maxSkew': obj.maxSkew, + 'topologyKey': obj.topologyKey, + 'whenUnsatisfiable': obj.whenUnsatisfiable, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Volume represents a named volume in a pod that may be accessed by any container in the pod. + * + * @schema io.k8s.api.core.v1.Volume + */ +export interface Volume { + /** + * AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + * + * @schema io.k8s.api.core.v1.Volume#awsElasticBlockStore + */ + readonly awsElasticBlockStore?: AwsElasticBlockStoreVolumeSource; + + /** + * AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + * + * @schema io.k8s.api.core.v1.Volume#azureDisk + */ + readonly azureDisk?: AzureDiskVolumeSource; + + /** + * AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + * + * @schema io.k8s.api.core.v1.Volume#azureFile + */ + readonly azureFile?: AzureFileVolumeSource; + + /** + * CephFS represents a Ceph FS mount on the host that shares a pod's lifetime + * + * @schema io.k8s.api.core.v1.Volume#cephfs + */ + readonly cephfs?: CephFsVolumeSource; + + /** + * Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @schema io.k8s.api.core.v1.Volume#cinder + */ + readonly cinder?: CinderVolumeSource; + + /** + * ConfigMap represents a configMap that should populate this volume + * + * @schema io.k8s.api.core.v1.Volume#configMap + */ + readonly configMap?: ConfigMapVolumeSource; + + /** + * CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). + * + * @schema io.k8s.api.core.v1.Volume#csi + */ + readonly csi?: CsiVolumeSource; + + /** + * DownwardAPI represents downward API about the pod that should populate this volume + * + * @schema io.k8s.api.core.v1.Volume#downwardAPI + */ + readonly downwardApi?: DownwardApiVolumeSource; + + /** + * EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + * + * @schema io.k8s.api.core.v1.Volume#emptyDir + */ + readonly emptyDir?: EmptyDirVolumeSource; + + /** + * Ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. + * + * Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity + * tracking are needed, + * c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through + * a PersistentVolumeClaim (see EphemeralVolumeSource for more + * information on the connection between this volume type + * and PersistentVolumeClaim). + * + * Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. + * + * Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. + * + * A pod can use both types of ephemeral volumes and persistent volumes at the same time. + * + * This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled. + * + * @schema io.k8s.api.core.v1.Volume#ephemeral + */ + readonly ephemeral?: EphemeralVolumeSource; + + /** + * FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + * + * @schema io.k8s.api.core.v1.Volume#fc + */ + readonly fc?: FcVolumeSource; + + /** + * FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. + * + * @schema io.k8s.api.core.v1.Volume#flexVolume + */ + readonly flexVolume?: FlexVolumeSource; + + /** + * Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running + * + * @schema io.k8s.api.core.v1.Volume#flocker + */ + readonly flocker?: FlockerVolumeSource; + + /** + * GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + * + * @schema io.k8s.api.core.v1.Volume#gcePersistentDisk + */ + readonly gcePersistentDisk?: GcePersistentDiskVolumeSource; + + /** + * GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. + * + * @schema io.k8s.api.core.v1.Volume#gitRepo + */ + readonly gitRepo?: GitRepoVolumeSource; + + /** + * Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md + * + * @schema io.k8s.api.core.v1.Volume#glusterfs + */ + readonly glusterfs?: GlusterfsVolumeSource; + + /** + * HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath + * + * @schema io.k8s.api.core.v1.Volume#hostPath + */ + readonly hostPath?: HostPathVolumeSource; + + /** + * ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md + * + * @schema io.k8s.api.core.v1.Volume#iscsi + */ + readonly iscsi?: IscsiVolumeSource; + + /** + * Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.Volume#name + */ + readonly name: string; + + /** + * NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + * + * @schema io.k8s.api.core.v1.Volume#nfs + */ + readonly nfs?: NfsVolumeSource; + + /** + * PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + * + * @schema io.k8s.api.core.v1.Volume#persistentVolumeClaim + */ + readonly persistentVolumeClaim?: PersistentVolumeClaimVolumeSource; + + /** + * PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine + * + * @schema io.k8s.api.core.v1.Volume#photonPersistentDisk + */ + readonly photonPersistentDisk?: PhotonPersistentDiskVolumeSource; + + /** + * PortworxVolume represents a portworx volume attached and mounted on kubelets host machine + * + * @schema io.k8s.api.core.v1.Volume#portworxVolume + */ + readonly portworxVolume?: PortworxVolumeSource; + + /** + * Items for all in one resources secrets, configmaps, and downward API + * + * @schema io.k8s.api.core.v1.Volume#projected + */ + readonly projected?: ProjectedVolumeSource; + + /** + * Quobyte represents a Quobyte mount on the host that shares a pod's lifetime + * + * @schema io.k8s.api.core.v1.Volume#quobyte + */ + readonly quobyte?: QuobyteVolumeSource; + + /** + * RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md + * + * @schema io.k8s.api.core.v1.Volume#rbd + */ + readonly rbd?: RbdVolumeSource; + + /** + * ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + * + * @schema io.k8s.api.core.v1.Volume#scaleIO + */ + readonly scaleIo?: ScaleIoVolumeSource; + + /** + * Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + * + * @schema io.k8s.api.core.v1.Volume#secret + */ + readonly secret?: SecretVolumeSource; + + /** + * StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. + * + * @schema io.k8s.api.core.v1.Volume#storageos + */ + readonly storageos?: StorageOsVolumeSource; + + /** + * VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine + * + * @schema io.k8s.api.core.v1.Volume#vsphereVolume + */ + readonly vsphereVolume?: VsphereVirtualDiskVolumeSource; + +} + +/** + * Converts an object of type 'Volume' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Volume(obj: Volume | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'awsElasticBlockStore': toJson_AwsElasticBlockStoreVolumeSource(obj.awsElasticBlockStore), + 'azureDisk': toJson_AzureDiskVolumeSource(obj.azureDisk), + 'azureFile': toJson_AzureFileVolumeSource(obj.azureFile), + 'cephfs': toJson_CephFsVolumeSource(obj.cephfs), + 'cinder': toJson_CinderVolumeSource(obj.cinder), + 'configMap': toJson_ConfigMapVolumeSource(obj.configMap), + 'csi': toJson_CsiVolumeSource(obj.csi), + 'downwardAPI': toJson_DownwardApiVolumeSource(obj.downwardApi), + 'emptyDir': toJson_EmptyDirVolumeSource(obj.emptyDir), + 'ephemeral': toJson_EphemeralVolumeSource(obj.ephemeral), + 'fc': toJson_FcVolumeSource(obj.fc), + 'flexVolume': toJson_FlexVolumeSource(obj.flexVolume), + 'flocker': toJson_FlockerVolumeSource(obj.flocker), + 'gcePersistentDisk': toJson_GcePersistentDiskVolumeSource(obj.gcePersistentDisk), + 'gitRepo': toJson_GitRepoVolumeSource(obj.gitRepo), + 'glusterfs': toJson_GlusterfsVolumeSource(obj.glusterfs), + 'hostPath': toJson_HostPathVolumeSource(obj.hostPath), + 'iscsi': toJson_IscsiVolumeSource(obj.iscsi), + 'name': obj.name, + 'nfs': toJson_NfsVolumeSource(obj.nfs), + 'persistentVolumeClaim': toJson_PersistentVolumeClaimVolumeSource(obj.persistentVolumeClaim), + 'photonPersistentDisk': toJson_PhotonPersistentDiskVolumeSource(obj.photonPersistentDisk), + 'portworxVolume': toJson_PortworxVolumeSource(obj.portworxVolume), + 'projected': toJson_ProjectedVolumeSource(obj.projected), + 'quobyte': toJson_QuobyteVolumeSource(obj.quobyte), + 'rbd': toJson_RbdVolumeSource(obj.rbd), + 'scaleIO': toJson_ScaleIoVolumeSource(obj.scaleIo), + 'secret': toJson_SecretVolumeSource(obj.secret), + 'storageos': toJson_StorageOsVolumeSource(obj.storageos), + 'vsphereVolume': toJson_VsphereVirtualDiskVolumeSource(obj.vsphereVolume), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements. + * + * @schema io.k8s.api.core.v1.ScopeSelector + */ +export interface ScopeSelector { + /** + * A list of scope selector requirements by scope of the resources. + * + * @schema io.k8s.api.core.v1.ScopeSelector#matchExpressions + */ + readonly matchExpressions?: ScopedResourceSelectorRequirement[]; + +} + +/** + * Converts an object of type 'ScopeSelector' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ScopeSelector(obj: ScopeSelector | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'matchExpressions': obj.matchExpressions?.map(y => toJson_ScopedResourceSelectorRequirement(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ServicePort contains information on service's port. + * + * @schema io.k8s.api.core.v1.ServicePort + */ +export interface ServicePort { + /** + * The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. This is a beta field that is guarded by the ServiceAppProtocol feature gate and enabled by default. + * + * @schema io.k8s.api.core.v1.ServicePort#appProtocol + */ + readonly appProtocol?: string; + + /** + * The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. + * + * @schema io.k8s.api.core.v1.ServicePort#name + */ + readonly name?: string; + + /** + * The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport + * + * @schema io.k8s.api.core.v1.ServicePort#nodePort + */ + readonly nodePort?: number; + + /** + * The port that will be exposed by this service. + * + * @schema io.k8s.api.core.v1.ServicePort#port + */ + readonly port: number; + + /** + * The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. + * + * @default TCP. + * @schema io.k8s.api.core.v1.ServicePort#protocol + */ + readonly protocol?: string; + + /** + * Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service + * + * @schema io.k8s.api.core.v1.ServicePort#targetPort + */ + readonly targetPort?: IntOrString; + +} + +/** + * Converts an object of type 'ServicePort' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ServicePort(obj: ServicePort | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'appProtocol': obj.appProtocol, + 'name': obj.name, + 'nodePort': obj.nodePort, + 'port': obj.port, + 'protocol': obj.protocol, + 'targetPort': obj.targetPort?.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SessionAffinityConfig represents the configurations of session affinity. + * + * @schema io.k8s.api.core.v1.SessionAffinityConfig + */ +export interface SessionAffinityConfig { + /** + * clientIP contains the configurations of Client IP based session affinity. + * + * @schema io.k8s.api.core.v1.SessionAffinityConfig#clientIP + */ + readonly clientIp?: ClientIpConfig; + +} + +/** + * Converts an object of type 'SessionAffinityConfig' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SessionAffinityConfig(obj: SessionAffinityConfig | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'clientIP': toJson_ClientIpConfig(obj.clientIp), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EndpointConditions represents the current condition of an endpoint. + * + * @schema io.k8s.api.discovery.v1.EndpointConditions + */ +export interface EndpointConditions { + /** + * ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be "true" for terminating endpoints. + * + * @schema io.k8s.api.discovery.v1.EndpointConditions#ready + */ + readonly ready?: boolean; + + /** + * serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition. This field can be enabled with the EndpointSliceTerminatingCondition feature gate. + * + * @schema io.k8s.api.discovery.v1.EndpointConditions#serving + */ + readonly serving?: boolean; + + /** + * terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating. This field can be enabled with the EndpointSliceTerminatingCondition feature gate. + * + * @schema io.k8s.api.discovery.v1.EndpointConditions#terminating + */ + readonly terminating?: boolean; + +} + +/** + * Converts an object of type 'EndpointConditions' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EndpointConditions(obj: EndpointConditions | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'ready': obj.ready, + 'serving': obj.serving, + 'terminating': obj.terminating, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EndpointHints provides hints describing how an endpoint should be consumed. + * + * @schema io.k8s.api.discovery.v1.EndpointHints + */ +export interface EndpointHints { + /** + * forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing. + * + * @schema io.k8s.api.discovery.v1.EndpointHints#forZones + */ + readonly forZones?: ForZone[]; + +} + +/** + * Converts an object of type 'EndpointHints' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EndpointHints(obj: EndpointHints | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'forZones': obj.forZones?.map(y => toJson_ForZone(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EndpointConditions represents the current condition of an endpoint. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointConditions + */ +export interface EndpointConditionsV1Beta1 { + /** + * ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be "true" for terminating endpoints. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointConditions#ready + */ + readonly ready?: boolean; + + /** + * serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition. This field can be enabled with the EndpointSliceTerminatingCondition feature gate. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointConditions#serving + */ + readonly serving?: boolean; + + /** + * terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating. This field can be enabled with the EndpointSliceTerminatingCondition feature gate. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointConditions#terminating + */ + readonly terminating?: boolean; + +} + +/** + * Converts an object of type 'EndpointConditionsV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EndpointConditionsV1Beta1(obj: EndpointConditionsV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'ready': obj.ready, + 'serving': obj.serving, + 'terminating': obj.terminating, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EndpointHints provides hints describing how an endpoint should be consumed. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointHints + */ +export interface EndpointHintsV1Beta1 { + /** + * forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing. May contain a maximum of 8 entries. + * + * @schema io.k8s.api.discovery.v1beta1.EndpointHints#forZones + */ + readonly forZones?: ForZoneV1Beta1[]; + +} + +/** + * Converts an object of type 'EndpointHintsV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EndpointHintsV1Beta1(obj: EndpointHintsV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'forZones': obj.forZones?.map(y => toJson_ForZoneV1Beta1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressBackend describes all endpoints for a given service and port. + * + * @schema io.k8s.api.networking.v1beta1.IngressBackend + */ +export interface IngressBackendV1Beta1 { + /** + * Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified. + * + * @schema io.k8s.api.networking.v1beta1.IngressBackend#resource + */ + readonly resource?: TypedLocalObjectReference; + + /** + * Specifies the name of the referenced service. + * + * @schema io.k8s.api.networking.v1beta1.IngressBackend#serviceName + */ + readonly serviceName?: string; + + /** + * Specifies the port of the referenced service. + * + * @schema io.k8s.api.networking.v1beta1.IngressBackend#servicePort + */ + readonly servicePort?: IntOrString; + +} + +/** + * Converts an object of type 'IngressBackendV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IngressBackendV1Beta1(obj: IngressBackendV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'resource': toJson_TypedLocalObjectReference(obj.resource), + 'serviceName': obj.serviceName, + 'servicePort': obj.servicePort?.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue. + * + * @schema io.k8s.api.networking.v1beta1.IngressRule + */ +export interface IngressRuleV1Beta1 { + /** + * Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to + * the IP in the Spec of the parent Ingress. + * 2. The `:` delimiter is not respected because ports are not allowed. + * Currently the port of an Ingress is implicitly :80 for http and + * :443 for https. + * Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. + * + * Host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If Host is precise, the request matches this rule if the http host header is equal to Host. 2. If Host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule. + * + * @schema io.k8s.api.networking.v1beta1.IngressRule#host + */ + readonly host?: string; + + /** + * @schema io.k8s.api.networking.v1beta1.IngressRule#http + */ + readonly http?: HttpIngressRuleValueV1Beta1; + +} + +/** + * Converts an object of type 'IngressRuleV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IngressRuleV1Beta1(obj: IngressRuleV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'host': obj.host, + 'http': toJson_HttpIngressRuleValueV1Beta1(obj.http), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressTLS describes the transport layer security associated with an Ingress. + * + * @schema io.k8s.api.networking.v1beta1.IngressTLS + */ +export interface IngressTlsv1Beta1 { + /** + * Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. + * + * @default the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. + * @schema io.k8s.api.networking.v1beta1.IngressTLS#hosts + */ + readonly hosts?: string[]; + + /** + * SecretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. + * + * @schema io.k8s.api.networking.v1beta1.IngressTLS#secretName + */ + readonly secretName?: string; + +} + +/** + * Converts an object of type 'IngressTlsv1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IngressTlsv1Beta1(obj: IngressTlsv1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'hosts': obj.hosts?.map(y => y), + 'secretName': obj.secretName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * FlowDistinguisherMethod specifies the method of a flow distinguisher. + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowDistinguisherMethod + */ +export interface FlowDistinguisherMethodV1Beta1 { + /** + * `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required. + * + * @schema io.k8s.api.flowcontrol.v1beta1.FlowDistinguisherMethod#type + */ + readonly type: string; + +} + +/** + * Converts an object of type 'FlowDistinguisherMethodV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_FlowDistinguisherMethodV1Beta1(obj: FlowDistinguisherMethodV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PriorityLevelConfigurationReference contains information that points to the "request-priority" being used. + * + * @schema io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationReference + */ +export interface PriorityLevelConfigurationReferenceV1Beta1 { + /** + * `name` is the name of the priority level configuration being referenced Required. + * + * @schema io.k8s.api.flowcontrol.v1beta1.PriorityLevelConfigurationReference#name + */ + readonly name: string; + +} + +/** + * Converts an object of type 'PriorityLevelConfigurationReferenceV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PriorityLevelConfigurationReferenceV1Beta1(obj: PriorityLevelConfigurationReferenceV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request. + * + * @schema io.k8s.api.flowcontrol.v1beta1.PolicyRulesWithSubjects + */ +export interface PolicyRulesWithSubjectsV1Beta1 { + /** + * `nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL. + * + * @schema io.k8s.api.flowcontrol.v1beta1.PolicyRulesWithSubjects#nonResourceRules + */ + readonly nonResourceRules?: NonResourcePolicyRuleV1Beta1[]; + + /** + * `resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one of `resourceRules` and `nonResourceRules` has to be non-empty. + * + * @schema io.k8s.api.flowcontrol.v1beta1.PolicyRulesWithSubjects#resourceRules + */ + readonly resourceRules?: ResourcePolicyRuleV1Beta1[]; + + /** + * subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required. + * + * @schema io.k8s.api.flowcontrol.v1beta1.PolicyRulesWithSubjects#subjects + */ + readonly subjects: SubjectV1Beta1[]; + +} + +/** + * Converts an object of type 'PolicyRulesWithSubjectsV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PolicyRulesWithSubjectsV1Beta1(obj: PolicyRulesWithSubjectsV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'nonResourceRules': obj.nonResourceRules?.map(y => toJson_NonResourcePolicyRuleV1Beta1(y)), + 'resourceRules': obj.resourceRules?.map(y => toJson_ResourcePolicyRuleV1Beta1(y)), + 'subjects': obj.subjects?.map(y => toJson_SubjectV1Beta1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. It addresses two issues: + * * How are requests for this priority level limited? + * * What should be done with requests that exceed the limit? + * + * @schema io.k8s.api.flowcontrol.v1beta1.LimitedPriorityLevelConfiguration + */ +export interface LimitedPriorityLevelConfigurationV1Beta1 { + /** + * `assuredConcurrencyShares` (ACS) configures the execution limit, which is a limit on the number of requests of this priority level that may be exeucting at a given time. ACS must be a positive number. The server's concurrency limit (SCL) is divided among the concurrency-controlled priority levels in proportion to their assured concurrency shares. This produces the assured concurrency value (ACV) --- the number of requests that may be executing at a time --- for each such priority level: + * + * ACV(l) = ceil( SCL * ACS(l) / ( sum[priority levels k] ACS(k) ) ) + * + * bigger numbers of ACS mean more reserved concurrent requests (at the expense of every other PL). This field has a default value of 30. + * + * @schema io.k8s.api.flowcontrol.v1beta1.LimitedPriorityLevelConfiguration#assuredConcurrencyShares + */ + readonly assuredConcurrencyShares?: number; + + /** + * `limitResponse` indicates what to do with requests that can not be executed right now + * + * @schema io.k8s.api.flowcontrol.v1beta1.LimitedPriorityLevelConfiguration#limitResponse + */ + readonly limitResponse?: LimitResponseV1Beta1; + +} + +/** + * Converts an object of type 'LimitedPriorityLevelConfigurationV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_LimitedPriorityLevelConfigurationV1Beta1(obj: LimitedPriorityLevelConfigurationV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'assuredConcurrencyShares': obj.assuredConcurrencyShares, + 'limitResponse': toJson_LimitResponseV1Beta1(obj.limitResponse), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressBackend describes all endpoints for a given service and port. + * + * @schema io.k8s.api.networking.v1.IngressBackend + */ +export interface IngressBackend { + /** + * Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with "Service". + * + * @schema io.k8s.api.networking.v1.IngressBackend#resource + */ + readonly resource?: TypedLocalObjectReference; + + /** + * Service references a Service as a Backend. This is a mutually exclusive setting with "Resource". + * + * @schema io.k8s.api.networking.v1.IngressBackend#service + */ + readonly service?: IngressServiceBackend; + +} + +/** + * Converts an object of type 'IngressBackend' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IngressBackend(obj: IngressBackend | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'resource': toJson_TypedLocalObjectReference(obj.resource), + 'service': toJson_IngressServiceBackend(obj.service), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue. + * + * @schema io.k8s.api.networking.v1.IngressRule + */ +export interface IngressRule { + /** + * Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to + * the IP in the Spec of the parent Ingress. + * 2. The `:` delimiter is not respected because ports are not allowed. + * Currently the port of an Ingress is implicitly :80 for http and + * :443 for https. + * Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. + * + * Host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If Host is precise, the request matches this rule if the http host header is equal to Host. 2. If Host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule. + * + * @schema io.k8s.api.networking.v1.IngressRule#host + */ + readonly host?: string; + + /** + * @schema io.k8s.api.networking.v1.IngressRule#http + */ + readonly http?: HttpIngressRuleValue; + +} + +/** + * Converts an object of type 'IngressRule' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IngressRule(obj: IngressRule | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'host': obj.host, + 'http': toJson_HttpIngressRuleValue(obj.http), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressTLS describes the transport layer security associated with an Ingress. + * + * @schema io.k8s.api.networking.v1.IngressTLS + */ +export interface IngressTls { + /** + * Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. + * + * @default the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. + * @schema io.k8s.api.networking.v1.IngressTLS#hosts + */ + readonly hosts?: string[]; + + /** + * SecretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. + * + * @schema io.k8s.api.networking.v1.IngressTLS#secretName + */ + readonly secretName?: string; + +} + +/** + * Converts an object of type 'IngressTls' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IngressTls(obj: IngressTls | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'hosts': obj.hosts?.map(y => y), + 'secretName': obj.secretName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource. + * + * @schema io.k8s.api.networking.v1.IngressClassParametersReference + */ +export interface IngressClassParametersReference { + /** + * APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + * + * @schema io.k8s.api.networking.v1.IngressClassParametersReference#apiGroup + */ + readonly apiGroup?: string; + + /** + * Kind is the type of resource being referenced. + * + * @schema io.k8s.api.networking.v1.IngressClassParametersReference#kind + */ + readonly kind: string; + + /** + * Name is the name of resource being referenced. + * + * @schema io.k8s.api.networking.v1.IngressClassParametersReference#name + */ + readonly name: string; + + /** + * Namespace is the namespace of the resource being referenced. This field is required when scope is set to "Namespace" and must be unset when scope is set to "Cluster". + * + * @schema io.k8s.api.networking.v1.IngressClassParametersReference#namespace + */ + readonly namespace?: string; + + /** + * Scope represents if this refers to a cluster or namespace scoped resource. This may be set to "Cluster" (default) or "Namespace". Field can be enabled with IngressClassNamespacedParams feature gate. + * + * @schema io.k8s.api.networking.v1.IngressClassParametersReference#scope + */ + readonly scope?: string; + +} + +/** + * Converts an object of type 'IngressClassParametersReference' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IngressClassParametersReference(obj: IngressClassParametersReference | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiGroup': obj.apiGroup, + 'kind': obj.kind, + 'name': obj.name, + 'namespace': obj.namespace, + 'scope': obj.scope, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8 + * + * @schema io.k8s.api.networking.v1.NetworkPolicyEgressRule + */ +export interface NetworkPolicyEgressRule { + /** + * List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyEgressRule#ports + */ + readonly ports?: NetworkPolicyPort[]; + + /** + * List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyEgressRule#to + */ + readonly to?: NetworkPolicyPeer[]; + +} + +/** + * Converts an object of type 'NetworkPolicyEgressRule' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NetworkPolicyEgressRule(obj: NetworkPolicyEgressRule | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'ports': obj.ports?.map(y => toJson_NetworkPolicyPort(y)), + 'to': obj.to?.map(y => toJson_NetworkPolicyPeer(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyIngressRule + */ +export interface NetworkPolicyIngressRule { + /** + * List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyIngressRule#from + */ + readonly from?: NetworkPolicyPeer[]; + + /** + * List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyIngressRule#ports + */ + readonly ports?: NetworkPolicyPort[]; + +} + +/** + * Converts an object of type 'NetworkPolicyIngressRule' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NetworkPolicyIngressRule(obj: NetworkPolicyIngressRule | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'from': obj.from?.map(y => toJson_NetworkPolicyPeer(y)), + 'ports': obj.ports?.map(y => toJson_NetworkPolicyPort(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource. + * + * @schema io.k8s.api.networking.v1beta1.IngressClassParametersReference + */ +export interface IngressClassParametersReferenceV1Beta1 { + /** + * APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. + * + * @schema io.k8s.api.networking.v1beta1.IngressClassParametersReference#apiGroup + */ + readonly apiGroup?: string; + + /** + * Kind is the type of resource being referenced. + * + * @schema io.k8s.api.networking.v1beta1.IngressClassParametersReference#kind + */ + readonly kind: string; + + /** + * Name is the name of resource being referenced. + * + * @schema io.k8s.api.networking.v1beta1.IngressClassParametersReference#name + */ + readonly name: string; + + /** + * Namespace is the namespace of the resource being referenced. This field is required when scope is set to "Namespace" and must be unset when scope is set to "Cluster". + * + * @schema io.k8s.api.networking.v1beta1.IngressClassParametersReference#namespace + */ + readonly namespace?: string; + + /** + * Scope represents if this refers to a cluster or namespace scoped resource. This may be set to "Cluster" (default) or "Namespace". Field can be enabled with IngressClassNamespacedParams feature gate. + * + * @schema io.k8s.api.networking.v1beta1.IngressClassParametersReference#scope + */ + readonly scope?: string; + +} + +/** + * Converts an object of type 'IngressClassParametersReferenceV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IngressClassParametersReferenceV1Beta1(obj: IngressClassParametersReferenceV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiGroup': obj.apiGroup, + 'kind': obj.kind, + 'name': obj.name, + 'namespace': obj.namespace, + 'scope': obj.scope, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Overhead structure represents the resource overhead associated with running a pod. + * + * @schema io.k8s.api.node.v1alpha1.Overhead + */ +export interface OverheadV1Alpha1 { + /** + * PodFixed represents the fixed resource overhead associated with running a pod. + * + * @schema io.k8s.api.node.v1alpha1.Overhead#podFixed + */ + readonly podFixed?: { [key: string]: Quantity }; + +} + +/** + * Converts an object of type 'OverheadV1Alpha1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_OverheadV1Alpha1(obj: OverheadV1Alpha1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'podFixed': ((obj.podFixed) === undefined) ? undefined : (Object.entries(obj.podFixed).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1]?.value }), {})), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass. + * + * @schema io.k8s.api.node.v1alpha1.Scheduling + */ +export interface SchedulingV1Alpha1 { + /** + * nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission. + * + * @schema io.k8s.api.node.v1alpha1.Scheduling#nodeSelector + */ + readonly nodeSelector?: { [key: string]: string }; + + /** + * tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. + * + * @schema io.k8s.api.node.v1alpha1.Scheduling#tolerations + */ + readonly tolerations?: Toleration[]; + +} + +/** + * Converts an object of type 'SchedulingV1Alpha1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SchedulingV1Alpha1(obj: SchedulingV1Alpha1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'nodeSelector': ((obj.nodeSelector) === undefined) ? undefined : (Object.entries(obj.nodeSelector).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'tolerations': obj.tolerations?.map(y => toJson_Toleration(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * @schema io.k8s.apimachinery.pkg.util.intstr.IntOrString + */ +export class IntOrString { + public static fromString(value: string): IntOrString { + return new IntOrString(value); + } + public static fromNumber(value: number): IntOrString { + return new IntOrString(value); + } + private constructor(public readonly value: any) { + } +} + +/** + * Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + * + * @schema IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind + */ +export enum IoK8SApimachineryPkgApisMetaV1DeleteOptionsKind { + /** DeleteOptions */ + DELETE_OPTIONS = 'DeleteOptions', +} + +/** + * Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions + */ +export interface Preconditions { + /** + * Specifies the target ResourceVersion + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions#resourceVersion + */ + readonly resourceVersion?: string; + + /** + * Specifies the target UID. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions#uid + */ + readonly uid?: string; + +} + +/** + * Converts an object of type 'Preconditions' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Preconditions(obj: Preconditions | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'resourceVersion': obj.resourceVersion, + 'uid': obj.uid, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * AllowedCSIDriver represents a single inline CSI Driver that is allowed to be used. + * + * @schema io.k8s.api.policy.v1beta1.AllowedCSIDriver + */ +export interface AllowedCsiDriverV1Beta1 { + /** + * Name is the registered name of the CSI driver + * + * @schema io.k8s.api.policy.v1beta1.AllowedCSIDriver#name + */ + readonly name: string; + +} + +/** + * Converts an object of type 'AllowedCsiDriverV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_AllowedCsiDriverV1Beta1(obj: AllowedCsiDriverV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * AllowedFlexVolume represents a single Flexvolume that is allowed to be used. + * + * @schema io.k8s.api.policy.v1beta1.AllowedFlexVolume + */ +export interface AllowedFlexVolumeV1Beta1 { + /** + * driver is the name of the Flexvolume driver. + * + * @schema io.k8s.api.policy.v1beta1.AllowedFlexVolume#driver + */ + readonly driver: string; + +} + +/** + * Converts an object of type 'AllowedFlexVolumeV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_AllowedFlexVolumeV1Beta1(obj: AllowedFlexVolumeV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'driver': obj.driver, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * AllowedHostPath defines the host volume conditions that will be enabled by a policy for pods to use. It requires the path prefix to be defined. + * + * @schema io.k8s.api.policy.v1beta1.AllowedHostPath + */ +export interface AllowedHostPathV1Beta1 { + /** + * pathPrefix is the path prefix that the host volume must match. It does not support `*`. Trailing slashes are trimmed when validating the path prefix with a host path. + * + * Examples: `/foo` would allow `/foo`, `/foo/` and `/foo/bar` `/foo` would not allow `/food` or `/etc/foo` + * + * @schema io.k8s.api.policy.v1beta1.AllowedHostPath#pathPrefix + */ + readonly pathPrefix?: string; + + /** + * when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly. + * + * @schema io.k8s.api.policy.v1beta1.AllowedHostPath#readOnly + */ + readonly readOnly?: boolean; + +} + +/** + * Converts an object of type 'AllowedHostPathV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_AllowedHostPathV1Beta1(obj: AllowedHostPathV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'pathPrefix': obj.pathPrefix, + 'readOnly': obj.readOnly, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * FSGroupStrategyOptions defines the strategy type and options used to create the strategy. + * + * @schema io.k8s.api.policy.v1beta1.FSGroupStrategyOptions + */ +export interface FsGroupStrategyOptionsV1Beta1 { + /** + * ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end. Required for MustRunAs. + * + * @schema io.k8s.api.policy.v1beta1.FSGroupStrategyOptions#ranges + */ + readonly ranges?: IdRangeV1Beta1[]; + + /** + * rule is the strategy that will dictate what FSGroup is used in the SecurityContext. + * + * @schema io.k8s.api.policy.v1beta1.FSGroupStrategyOptions#rule + */ + readonly rule?: string; + +} + +/** + * Converts an object of type 'FsGroupStrategyOptionsV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_FsGroupStrategyOptionsV1Beta1(obj: FsGroupStrategyOptionsV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'ranges': obj.ranges?.map(y => toJson_IdRangeV1Beta1(y)), + 'rule': obj.rule, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HostPortRange defines a range of host ports that will be enabled by a policy for pods to use. It requires both the start and end to be defined. + * + * @schema io.k8s.api.policy.v1beta1.HostPortRange + */ +export interface HostPortRangeV1Beta1 { + /** + * max is the end of the range, inclusive. + * + * @schema io.k8s.api.policy.v1beta1.HostPortRange#max + */ + readonly max: number; + + /** + * min is the start of the range, inclusive. + * + * @schema io.k8s.api.policy.v1beta1.HostPortRange#min + */ + readonly min: number; + +} + +/** + * Converts an object of type 'HostPortRangeV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HostPortRangeV1Beta1(obj: HostPortRangeV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'max': obj.max, + 'min': obj.min, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RunAsGroupStrategyOptions defines the strategy type and any options used to create the strategy. + * + * @schema io.k8s.api.policy.v1beta1.RunAsGroupStrategyOptions + */ +export interface RunAsGroupStrategyOptionsV1Beta1 { + /** + * ranges are the allowed ranges of gids that may be used. If you would like to force a single gid then supply a single range with the same start and end. Required for MustRunAs. + * + * @schema io.k8s.api.policy.v1beta1.RunAsGroupStrategyOptions#ranges + */ + readonly ranges?: IdRangeV1Beta1[]; + + /** + * rule is the strategy that will dictate the allowable RunAsGroup values that may be set. + * + * @schema io.k8s.api.policy.v1beta1.RunAsGroupStrategyOptions#rule + */ + readonly rule: string; + +} + +/** + * Converts an object of type 'RunAsGroupStrategyOptionsV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_RunAsGroupStrategyOptionsV1Beta1(obj: RunAsGroupStrategyOptionsV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'ranges': obj.ranges?.map(y => toJson_IdRangeV1Beta1(y)), + 'rule': obj.rule, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy. + * + * @schema io.k8s.api.policy.v1beta1.RunAsUserStrategyOptions + */ +export interface RunAsUserStrategyOptionsV1Beta1 { + /** + * ranges are the allowed ranges of uids that may be used. If you would like to force a single uid then supply a single range with the same start and end. Required for MustRunAs. + * + * @schema io.k8s.api.policy.v1beta1.RunAsUserStrategyOptions#ranges + */ + readonly ranges?: IdRangeV1Beta1[]; + + /** + * rule is the strategy that will dictate the allowable RunAsUser values that may be set. + * + * @schema io.k8s.api.policy.v1beta1.RunAsUserStrategyOptions#rule + */ + readonly rule: string; + +} + +/** + * Converts an object of type 'RunAsUserStrategyOptionsV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_RunAsUserStrategyOptionsV1Beta1(obj: RunAsUserStrategyOptionsV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'ranges': obj.ranges?.map(y => toJson_IdRangeV1Beta1(y)), + 'rule': obj.rule, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RuntimeClassStrategyOptions define the strategy that will dictate the allowable RuntimeClasses for a pod. + * + * @schema io.k8s.api.policy.v1beta1.RuntimeClassStrategyOptions + */ +export interface RuntimeClassStrategyOptionsV1Beta1 { + /** + * allowedRuntimeClassNames is an allowlist of RuntimeClass names that may be specified on a pod. A value of "*" means that any RuntimeClass name is allowed, and must be the only item in the list. An empty list requires the RuntimeClassName field to be unset. + * + * @schema io.k8s.api.policy.v1beta1.RuntimeClassStrategyOptions#allowedRuntimeClassNames + */ + readonly allowedRuntimeClassNames: string[]; + + /** + * defaultRuntimeClassName is the default RuntimeClassName to set on the pod. The default MUST be allowed by the allowedRuntimeClassNames list. A value of nil does not mutate the Pod. + * + * @schema io.k8s.api.policy.v1beta1.RuntimeClassStrategyOptions#defaultRuntimeClassName + */ + readonly defaultRuntimeClassName?: string; + +} + +/** + * Converts an object of type 'RuntimeClassStrategyOptionsV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_RuntimeClassStrategyOptionsV1Beta1(obj: RuntimeClassStrategyOptionsV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'allowedRuntimeClassNames': obj.allowedRuntimeClassNames?.map(y => y), + 'defaultRuntimeClassName': obj.defaultRuntimeClassName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SELinuxStrategyOptions defines the strategy type and any options used to create the strategy. + * + * @schema io.k8s.api.policy.v1beta1.SELinuxStrategyOptions + */ +export interface SeLinuxStrategyOptionsV1Beta1 { + /** + * rule is the strategy that will dictate the allowable labels that may be set. + * + * @schema io.k8s.api.policy.v1beta1.SELinuxStrategyOptions#rule + */ + readonly rule: string; + + /** + * seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ + * + * @schema io.k8s.api.policy.v1beta1.SELinuxStrategyOptions#seLinuxOptions + */ + readonly seLinuxOptions?: SeLinuxOptions; + +} + +/** + * Converts an object of type 'SeLinuxStrategyOptionsV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SeLinuxStrategyOptionsV1Beta1(obj: SeLinuxStrategyOptionsV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'rule': obj.rule, + 'seLinuxOptions': toJson_SeLinuxOptions(obj.seLinuxOptions), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy. + * + * @schema io.k8s.api.policy.v1beta1.SupplementalGroupsStrategyOptions + */ +export interface SupplementalGroupsStrategyOptionsV1Beta1 { + /** + * ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end. Required for MustRunAs. + * + * @schema io.k8s.api.policy.v1beta1.SupplementalGroupsStrategyOptions#ranges + */ + readonly ranges?: IdRangeV1Beta1[]; + + /** + * rule is the strategy that will dictate what supplemental groups is used in the SecurityContext. + * + * @schema io.k8s.api.policy.v1beta1.SupplementalGroupsStrategyOptions#rule + */ + readonly rule?: string; + +} + +/** + * Converts an object of type 'SupplementalGroupsStrategyOptionsV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SupplementalGroupsStrategyOptionsV1Beta1(obj: SupplementalGroupsStrategyOptionsV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'ranges': obj.ranges?.map(y => toJson_IdRangeV1Beta1(y)), + 'rule': obj.rule, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * TokenRequest contains parameters of a service account token. + * + * @schema io.k8s.api.storage.v1.TokenRequest + */ +export interface TokenRequest { + /** + * Audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver. + * + * @schema io.k8s.api.storage.v1.TokenRequest#audience + */ + readonly audience: string; + + /** + * ExpirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec". + * + * @schema io.k8s.api.storage.v1.TokenRequest#expirationSeconds + */ + readonly expirationSeconds?: number; + +} + +/** + * Converts an object of type 'TokenRequest' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_TokenRequest(obj: TokenRequest | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'audience': obj.audience, + 'expirationSeconds': obj.expirationSeconds, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSINodeDriver holds information about the specification of one CSI driver installed on a node + * + * @schema io.k8s.api.storage.v1.CSINodeDriver + */ +export interface CsiNodeDriver { + /** + * allocatable represents the volume resources of a node that are available for scheduling. This field is beta. + * + * @schema io.k8s.api.storage.v1.CSINodeDriver#allocatable + */ + readonly allocatable?: VolumeNodeResources; + + /** + * This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver. + * + * @schema io.k8s.api.storage.v1.CSINodeDriver#name + */ + readonly name: string; + + /** + * nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required. + * + * @schema io.k8s.api.storage.v1.CSINodeDriver#nodeID + */ + readonly nodeId: string; + + /** + * topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology. + * + * @schema io.k8s.api.storage.v1.CSINodeDriver#topologyKeys + */ + readonly topologyKeys?: string[]; + +} + +/** + * Converts an object of type 'CsiNodeDriver' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CsiNodeDriver(obj: CsiNodeDriver | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'allocatable': toJson_VolumeNodeResources(obj.allocatable), + 'name': obj.name, + 'nodeID': obj.nodeId, + 'topologyKeys': obj.topologyKeys?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future. + * + * @schema io.k8s.api.core.v1.TopologySelectorLabelRequirement + */ +export interface TopologySelectorLabelRequirement { + /** + * The label key that the selector applies to. + * + * @schema io.k8s.api.core.v1.TopologySelectorLabelRequirement#key + */ + readonly key: string; + + /** + * An array of string values. One value must match the label to be selected. Each entry in Values is ORed. + * + * @schema io.k8s.api.core.v1.TopologySelectorLabelRequirement#values + */ + readonly values: string[]; + +} + +/** + * Converts an object of type 'TopologySelectorLabelRequirement' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_TopologySelectorLabelRequirement(obj: TopologySelectorLabelRequirement | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'key': obj.key, + 'values': obj.values?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentSource + */ +export interface VolumeAttachmentSource { + /** + * inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentSource#inlineVolumeSpec + */ + readonly inlineVolumeSpec?: PersistentVolumeSpec; + + /** + * Name of the persistent volume to attach. + * + * @schema io.k8s.api.storage.v1.VolumeAttachmentSource#persistentVolumeName + */ + readonly persistentVolumeName?: string; + +} + +/** + * Converts an object of type 'VolumeAttachmentSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_VolumeAttachmentSource(obj: VolumeAttachmentSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'inlineVolumeSpec': toJson_PersistentVolumeSpec(obj.inlineVolumeSpec), + 'persistentVolumeName': obj.persistentVolumeName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement + */ +export interface LabelSelectorRequirement { + /** + * key is the label key that the selector applies to. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement#key + */ + readonly key: string; + + /** + * operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement#operator + */ + readonly operator: string; + + /** + * values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement#values + */ + readonly values?: string[]; + +} + +/** + * Converts an object of type 'LabelSelectorRequirement' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_LabelSelectorRequirement(obj: LabelSelectorRequirement | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'key': obj.key, + 'operator': obj.operator, + 'values': obj.values?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set. + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachmentSource + */ +export interface VolumeAttachmentSourceV1Alpha1 { + /** + * inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is alpha-level and is only honored by servers that enabled the CSIMigration feature. + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachmentSource#inlineVolumeSpec + */ + readonly inlineVolumeSpec?: PersistentVolumeSpec; + + /** + * Name of the persistent volume to attach. + * + * @schema io.k8s.api.storage.v1alpha1.VolumeAttachmentSource#persistentVolumeName + */ + readonly persistentVolumeName?: string; + +} + +/** + * Converts an object of type 'VolumeAttachmentSourceV1Alpha1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_VolumeAttachmentSourceV1Alpha1(obj: VolumeAttachmentSourceV1Alpha1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'inlineVolumeSpec': toJson_PersistentVolumeSpec(obj.inlineVolumeSpec), + 'persistentVolumeName': obj.persistentVolumeName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * TokenRequest contains parameters of a service account token. + * + * @schema io.k8s.api.storage.v1beta1.TokenRequest + */ +export interface TokenRequestV1Beta1 { + /** + * Audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver. + * + * @schema io.k8s.api.storage.v1beta1.TokenRequest#audience + */ + readonly audience: string; + + /** + * ExpirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec" + * + * @schema io.k8s.api.storage.v1beta1.TokenRequest#expirationSeconds + */ + readonly expirationSeconds?: number; + +} + +/** + * Converts an object of type 'TokenRequestV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_TokenRequestV1Beta1(obj: TokenRequestV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'audience': obj.audience, + 'expirationSeconds': obj.expirationSeconds, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CSINodeDriver holds information about the specification of one CSI driver installed on a node + * + * @schema io.k8s.api.storage.v1beta1.CSINodeDriver + */ +export interface CsiNodeDriverV1Beta1 { + /** + * allocatable represents the volume resources of a node that are available for scheduling. + * + * @schema io.k8s.api.storage.v1beta1.CSINodeDriver#allocatable + */ + readonly allocatable?: VolumeNodeResourcesV1Beta1; + + /** + * This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver. + * + * @schema io.k8s.api.storage.v1beta1.CSINodeDriver#name + */ + readonly name: string; + + /** + * nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required. + * + * @schema io.k8s.api.storage.v1beta1.CSINodeDriver#nodeID + */ + readonly nodeId: string; + + /** + * topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology. + * + * @schema io.k8s.api.storage.v1beta1.CSINodeDriver#topologyKeys + */ + readonly topologyKeys?: string[]; + +} + +/** + * Converts an object of type 'CsiNodeDriverV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CsiNodeDriverV1Beta1(obj: CsiNodeDriverV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'allocatable': toJson_VolumeNodeResourcesV1Beta1(obj.allocatable), + 'name': obj.name, + 'nodeID': obj.nodeId, + 'topologyKeys': obj.topologyKeys?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set. + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachmentSource + */ +export interface VolumeAttachmentSourceV1Beta1 { + /** + * inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature. + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachmentSource#inlineVolumeSpec + */ + readonly inlineVolumeSpec?: PersistentVolumeSpec; + + /** + * Name of the persistent volume to attach. + * + * @schema io.k8s.api.storage.v1beta1.VolumeAttachmentSource#persistentVolumeName + */ + readonly persistentVolumeName?: string; + +} + +/** + * Converts an object of type 'VolumeAttachmentSourceV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_VolumeAttachmentSourceV1Beta1(obj: VolumeAttachmentSourceV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'inlineVolumeSpec': toJson_PersistentVolumeSpec(obj.inlineVolumeSpec), + 'persistentVolumeName': obj.persistentVolumeName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceConversion describes how to convert different versions of a CR. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceConversion + */ +export interface CustomResourceConversion { + /** + * strategy specifies how custom resources are converted between versions. Allowed values are: - `None`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `Webhook`: API Server will call to an external webhook to do the conversion. Additional information + * is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceConversion#strategy + */ + readonly strategy: string; + + /** + * webhook describes how to call the conversion webhook. Required when `strategy` is set to `Webhook`. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceConversion#webhook + */ + readonly webhook?: WebhookConversion; + +} + +/** + * Converts an object of type 'CustomResourceConversion' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceConversion(obj: CustomResourceConversion | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'strategy': obj.strategy, + 'webhook': toJson_WebhookConversion(obj.webhook), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames + */ +export interface CustomResourceDefinitionNames { + /** + * categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#categories + */ + readonly categories?: string[]; + + /** + * kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#kind + */ + readonly kind: string; + + /** + * listKind is the serialized kind of the list for this resource. Defaults to "`kind`List". + * + * @default kind`List". + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#listKind + */ + readonly listKind?: string; + + /** + * plural is the plural name of the resource to serve. The custom resources are served under `/apis///.../`. Must match the name of the CustomResourceDefinition (in the form `.`). Must be all lowercase. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#plural + */ + readonly plural: string; + + /** + * shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get `. It must be all lowercase. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#shortNames + */ + readonly shortNames?: string[]; + + /** + * singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`. + * + * @default lowercased `kind`. + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames#singular + */ + readonly singular?: string; + +} + +/** + * Converts an object of type 'CustomResourceDefinitionNames' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceDefinitionNames(obj: CustomResourceDefinitionNames | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'categories': obj.categories?.map(y => y), + 'kind': obj.kind, + 'listKind': obj.listKind, + 'plural': obj.plural, + 'shortNames': obj.shortNames?.map(y => y), + 'singular': obj.singular, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceDefinitionVersion describes a version for CRD. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion + */ +export interface CustomResourceDefinitionVersion { + /** + * additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If no columns are specified, a single column displaying the age of the custom resource is used. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#additionalPrinterColumns + */ + readonly additionalPrinterColumns?: CustomResourceColumnDefinition[]; + + /** + * deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false. + * + * @default false. + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#deprecated + */ + readonly deprecated?: boolean; + + /** + * deprecationWarning overrides the default warning returned to API clients. May only be set when `deprecated` is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#deprecationWarning + */ + readonly deprecationWarning?: string; + + /** + * name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis///...` if `served` is true. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#name + */ + readonly name: string; + + /** + * schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#schema + */ + readonly schema?: CustomResourceValidation; + + /** + * served is a flag enabling/disabling this version from being served via REST APIs + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#served + */ + readonly served: boolean; + + /** + * storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#storage + */ + readonly storage: boolean; + + /** + * subresources specify what subresources this version of the defined custom resource have. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion#subresources + */ + readonly subresources?: CustomResourceSubresources; + +} + +/** + * Converts an object of type 'CustomResourceDefinitionVersion' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceDefinitionVersion(obj: CustomResourceDefinitionVersion | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'additionalPrinterColumns': obj.additionalPrinterColumns?.map(y => toJson_CustomResourceColumnDefinition(y)), + 'deprecated': obj.deprecated, + 'deprecationWarning': obj.deprecationWarning, + 'name': obj.name, + 'schema': toJson_CustomResourceValidation(obj.schema), + 'served': obj.served, + 'storage': obj.storage, + 'subresources': toJson_CustomResourceSubresources(obj.subresources), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceColumnDefinition specifies a column for server side printing. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceColumnDefinition + */ +export interface CustomResourceColumnDefinitionV1Beta1 { + /** + * JSONPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceColumnDefinition#JSONPath + */ + readonly jsonPath: string; + + /** + * description is a human readable description of this column. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceColumnDefinition#description + */ + readonly description?: string; + + /** + * format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceColumnDefinition#format + */ + readonly format?: string; + + /** + * name is a human readable name for the column. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceColumnDefinition#name + */ + readonly name: string; + + /** + * priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceColumnDefinition#priority + */ + readonly priority?: number; + + /** + * type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceColumnDefinition#type + */ + readonly type: string; + +} + +/** + * Converts an object of type 'CustomResourceColumnDefinitionV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceColumnDefinitionV1Beta1(obj: CustomResourceColumnDefinitionV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'JSONPath': obj.jsonPath, + 'description': obj.description, + 'format': obj.format, + 'name': obj.name, + 'priority': obj.priority, + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceConversion describes how to convert different versions of a CR. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceConversion + */ +export interface CustomResourceConversionV1Beta1 { + /** + * conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. Defaults to `["v1beta1"]`. + * + * @default v1beta1"]`. + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceConversion#conversionReviewVersions + */ + readonly conversionReviewVersions?: string[]; + + /** + * strategy specifies how custom resources are converted between versions. Allowed values are: - `None`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `Webhook`: API Server will call to an external webhook to do the conversion. Additional information + * is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhookClientConfig to be set. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceConversion#strategy + */ + readonly strategy: string; + + /** + * webhookClientConfig is the instructions for how to call the webhook if strategy is `Webhook`. Required when `strategy` is set to `Webhook`. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceConversion#webhookClientConfig + */ + readonly webhookClientConfig?: WebhookClientConfigV1Beta1; + +} + +/** + * Converts an object of type 'CustomResourceConversionV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceConversionV1Beta1(obj: CustomResourceConversionV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'conversionReviewVersions': obj.conversionReviewVersions?.map(y => y), + 'strategy': obj.strategy, + 'webhookClientConfig': toJson_WebhookClientConfigV1Beta1(obj.webhookClientConfig), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionNames + */ +export interface CustomResourceDefinitionNamesV1Beta1 { + /** + * categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionNames#categories + */ + readonly categories?: string[]; + + /** + * kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionNames#kind + */ + readonly kind: string; + + /** + * listKind is the serialized kind of the list for this resource. Defaults to "`kind`List". + * + * @default kind`List". + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionNames#listKind + */ + readonly listKind?: string; + + /** + * plural is the plural name of the resource to serve. The custom resources are served under `/apis///.../`. Must match the name of the CustomResourceDefinition (in the form `.`). Must be all lowercase. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionNames#plural + */ + readonly plural: string; + + /** + * shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get `. It must be all lowercase. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionNames#shortNames + */ + readonly shortNames?: string[]; + + /** + * singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`. + * + * @default lowercased `kind`. + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionNames#singular + */ + readonly singular?: string; + +} + +/** + * Converts an object of type 'CustomResourceDefinitionNamesV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceDefinitionNamesV1Beta1(obj: CustomResourceDefinitionNamesV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'categories': obj.categories?.map(y => y), + 'kind': obj.kind, + 'listKind': obj.listKind, + 'plural': obj.plural, + 'shortNames': obj.shortNames?.map(y => y), + 'singular': obj.singular, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceSubresources defines the status and scale subresources for CustomResources. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceSubresources + */ +export interface CustomResourceSubresourcesV1Beta1 { + /** + * scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceSubresources#scale + */ + readonly scale?: CustomResourceSubresourceScaleV1Beta1; + + /** + * status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceSubresources#status + */ + readonly status?: any; + +} + +/** + * Converts an object of type 'CustomResourceSubresourcesV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceSubresourcesV1Beta1(obj: CustomResourceSubresourcesV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'scale': toJson_CustomResourceSubresourceScaleV1Beta1(obj.scale), + 'status': obj.status, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceValidation is a list of validation methods for CustomResources. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceValidation + */ +export interface CustomResourceValidationV1Beta1 { + /** + * openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceValidation#openAPIV3Schema + */ + readonly openApiv3Schema?: JsonSchemaPropsV1Beta1; + +} + +/** + * Converts an object of type 'CustomResourceValidationV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceValidationV1Beta1(obj: CustomResourceValidationV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'openAPIV3Schema': toJson_JsonSchemaPropsV1Beta1(obj.openApiv3Schema), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceDefinitionVersion describes a version for CRD. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionVersion + */ +export interface CustomResourceDefinitionVersionV1Beta1 { + /** + * additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. Top-level and per-version columns are mutually exclusive. Per-version columns must not all be set to identical values (top-level columns should be used instead). If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionVersion#additionalPrinterColumns + */ + readonly additionalPrinterColumns?: CustomResourceColumnDefinitionV1Beta1[]; + + /** + * deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false. + * + * @default false. + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionVersion#deprecated + */ + readonly deprecated?: boolean; + + /** + * deprecationWarning overrides the default warning returned to API clients. May only be set when `deprecated` is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionVersion#deprecationWarning + */ + readonly deprecationWarning?: string; + + /** + * name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis///...` if `served` is true. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionVersion#name + */ + readonly name: string; + + /** + * schema describes the schema used for validation and pruning of this version of the custom resource. Top-level and per-version schemas are mutually exclusive. Per-version schemas must not all be set to identical values (top-level validation schema should be used instead). + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionVersion#schema + */ + readonly schema?: CustomResourceValidationV1Beta1; + + /** + * served is a flag enabling/disabling this version from being served via REST APIs + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionVersion#served + */ + readonly served: boolean; + + /** + * storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionVersion#storage + */ + readonly storage: boolean; + + /** + * subresources specify what subresources this version of the defined custom resource have. Top-level and per-version subresources are mutually exclusive. Per-version subresources must not all be set to identical values (top-level subresources should be used instead). + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceDefinitionVersion#subresources + */ + readonly subresources?: CustomResourceSubresourcesV1Beta1; + +} + +/** + * Converts an object of type 'CustomResourceDefinitionVersionV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceDefinitionVersionV1Beta1(obj: CustomResourceDefinitionVersionV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'additionalPrinterColumns': obj.additionalPrinterColumns?.map(y => toJson_CustomResourceColumnDefinitionV1Beta1(y)), + 'deprecated': obj.deprecated, + 'deprecationWarning': obj.deprecationWarning, + 'name': obj.name, + 'schema': toJson_CustomResourceValidationV1Beta1(obj.schema), + 'served': obj.served, + 'storage': obj.storage, + 'subresources': toJson_CustomResourceSubresourcesV1Beta1(obj.subresources), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause + */ +export interface StatusCause { + /** + * The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. + * + * Examples: + * "name" - the field "name" on the current resource + * "items[0].name" - the field "name" on the first array entry in "items" + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause#field + */ + readonly field?: string; + + /** + * A human-readable description of the cause of the error. This field may be presented as-is to a reader. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause#message + */ + readonly message?: string; + + /** + * A machine-readable description of the cause of the error. If this value is empty there is no information available. + * + * @schema io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause#reason + */ + readonly reason?: string; + +} + +/** + * Converts an object of type 'StatusCause' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_StatusCause(obj: StatusCause | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'field': obj.field, + 'message': obj.message, + 'reason': obj.reason, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ServiceReference holds a reference to Service.legacy.k8s.io + * + * @schema io.k8s.api.admissionregistration.v1.ServiceReference + */ +export interface ServiceReference { + /** + * `name` is the name of the service. Required + * + * @schema io.k8s.api.admissionregistration.v1.ServiceReference#name + */ + readonly name: string; + + /** + * `namespace` is the namespace of the service. Required + * + * @schema io.k8s.api.admissionregistration.v1.ServiceReference#namespace + */ + readonly namespace: string; + + /** + * `path` is an optional URL path which will be sent in any request to this service. + * + * @schema io.k8s.api.admissionregistration.v1.ServiceReference#path + */ + readonly path?: string; + + /** + * If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). + * + * @default 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). + * @schema io.k8s.api.admissionregistration.v1.ServiceReference#port + */ + readonly port?: number; + +} + +/** + * Converts an object of type 'ServiceReference' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ServiceReference(obj: ServiceReference | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + 'namespace': obj.namespace, + 'path': obj.path, + 'port': obj.port, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ServiceReference holds a reference to Service.legacy.k8s.io + * + * @schema io.k8s.api.admissionregistration.v1beta1.ServiceReference + */ +export interface ServiceReferenceV1Beta1 { + /** + * `name` is the name of the service. Required + * + * @schema io.k8s.api.admissionregistration.v1beta1.ServiceReference#name + */ + readonly name: string; + + /** + * `namespace` is the namespace of the service. Required + * + * @schema io.k8s.api.admissionregistration.v1beta1.ServiceReference#namespace + */ + readonly namespace: string; + + /** + * `path` is an optional URL path which will be sent in any request to this service. + * + * @schema io.k8s.api.admissionregistration.v1beta1.ServiceReference#path + */ + readonly path?: string; + + /** + * If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). + * + * @default 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). + * @schema io.k8s.api.admissionregistration.v1beta1.ServiceReference#port + */ + readonly port?: number; + +} + +/** + * Converts an object of type 'ServiceReferenceV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ServiceReferenceV1Beta1(obj: ServiceReferenceV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + 'namespace': obj.namespace, + 'path': obj.path, + 'port': obj.port, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Spec to control the desired behavior of daemon set rolling update. + * + * @schema io.k8s.api.apps.v1.RollingUpdateDaemonSet + */ +export interface RollingUpdateDaemonSet { + /** + * The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediatedly created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption. This is an alpha field and requires enabling DaemonSetUpdateSurge feature gate. + * + * @schema io.k8s.api.apps.v1.RollingUpdateDaemonSet#maxSurge + */ + readonly maxSurge?: IntOrString; + + /** + * The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding down to a minimum of one. This cannot be 0 if MaxSurge is 0 Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. + * + * @schema io.k8s.api.apps.v1.RollingUpdateDaemonSet#maxUnavailable + */ + readonly maxUnavailable?: IntOrString; + +} + +/** + * Converts an object of type 'RollingUpdateDaemonSet' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_RollingUpdateDaemonSet(obj: RollingUpdateDaemonSet | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'maxSurge': obj.maxSurge?.value, + 'maxUnavailable': obj.maxUnavailable?.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Spec to control the desired behavior of rolling update. + * + * @schema io.k8s.api.apps.v1.RollingUpdateDeployment + */ +export interface RollingUpdateDeployment { + /** + * The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. + * + * @default 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. + * @schema io.k8s.api.apps.v1.RollingUpdateDeployment#maxSurge + */ + readonly maxSurge?: IntOrString; + + /** + * The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. + * + * @default 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. + * @schema io.k8s.api.apps.v1.RollingUpdateDeployment#maxUnavailable + */ + readonly maxUnavailable?: IntOrString; + +} + +/** + * Converts an object of type 'RollingUpdateDeployment' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_RollingUpdateDeployment(obj: RollingUpdateDeployment | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'maxSurge': obj.maxSurge?.value, + 'maxUnavailable': obj.maxUnavailable?.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType. + * + * @schema io.k8s.api.apps.v1.RollingUpdateStatefulSetStrategy + */ +export interface RollingUpdateStatefulSetStrategy { + /** + * Partition indicates the ordinal at which the StatefulSet should be partitioned. Default value is 0. + * + * @schema io.k8s.api.apps.v1.RollingUpdateStatefulSetStrategy#partition + */ + readonly partition?: number; + +} + +/** + * Converts an object of type 'RollingUpdateStatefulSetStrategy' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_RollingUpdateStatefulSetStrategy(obj: RollingUpdateStatefulSetStrategy | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'partition': obj.partition, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set. + * + * @schema io.k8s.api.autoscaling.v2beta1.ContainerResourceMetricSource + */ +export interface ContainerResourceMetricSourceV2Beta1 { + /** + * container is the name of the container in the pods of the scaling target + * + * @schema io.k8s.api.autoscaling.v2beta1.ContainerResourceMetricSource#container + */ + readonly container: string; + + /** + * name is the name of the resource in question. + * + * @schema io.k8s.api.autoscaling.v2beta1.ContainerResourceMetricSource#name + */ + readonly name: string; + + /** + * targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. + * + * @schema io.k8s.api.autoscaling.v2beta1.ContainerResourceMetricSource#targetAverageUtilization + */ + readonly targetAverageUtilization?: number; + + /** + * targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. + * + * @schema io.k8s.api.autoscaling.v2beta1.ContainerResourceMetricSource#targetAverageValue + */ + readonly targetAverageValue?: Quantity; + +} + +/** + * Converts an object of type 'ContainerResourceMetricSourceV2Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ContainerResourceMetricSourceV2Beta1(obj: ContainerResourceMetricSourceV2Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'container': obj.container, + 'name': obj.name, + 'targetAverageUtilization': obj.targetAverageUtilization, + 'targetAverageValue': obj.targetAverageValue?.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). Exactly one "target" type should be set. + * + * @schema io.k8s.api.autoscaling.v2beta1.ExternalMetricSource + */ +export interface ExternalMetricSourceV2Beta1 { + /** + * metricName is the name of the metric in question. + * + * @schema io.k8s.api.autoscaling.v2beta1.ExternalMetricSource#metricName + */ + readonly metricName: string; + + /** + * metricSelector is used to identify a specific time series within a given metric. + * + * @schema io.k8s.api.autoscaling.v2beta1.ExternalMetricSource#metricSelector + */ + readonly metricSelector?: LabelSelector; + + /** + * targetAverageValue is the target per-pod value of global metric (as a quantity). Mutually exclusive with TargetValue. + * + * @schema io.k8s.api.autoscaling.v2beta1.ExternalMetricSource#targetAverageValue + */ + readonly targetAverageValue?: Quantity; + + /** + * targetValue is the target value of the metric (as a quantity). Mutually exclusive with TargetAverageValue. + * + * @schema io.k8s.api.autoscaling.v2beta1.ExternalMetricSource#targetValue + */ + readonly targetValue?: Quantity; + +} + +/** + * Converts an object of type 'ExternalMetricSourceV2Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ExternalMetricSourceV2Beta1(obj: ExternalMetricSourceV2Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metricName': obj.metricName, + 'metricSelector': toJson_LabelSelector(obj.metricSelector), + 'targetAverageValue': obj.targetAverageValue?.value, + 'targetValue': obj.targetValue?.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object). + * + * @schema io.k8s.api.autoscaling.v2beta1.ObjectMetricSource + */ +export interface ObjectMetricSourceV2Beta1 { + /** + * averageValue is the target value of the average of the metric across all relevant pods (as a quantity) + * + * @schema io.k8s.api.autoscaling.v2beta1.ObjectMetricSource#averageValue + */ + readonly averageValue?: Quantity; + + /** + * metricName is the name of the metric in question. + * + * @schema io.k8s.api.autoscaling.v2beta1.ObjectMetricSource#metricName + */ + readonly metricName: string; + + /** + * selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics. + * + * @schema io.k8s.api.autoscaling.v2beta1.ObjectMetricSource#selector + */ + readonly selector?: LabelSelector; + + /** + * target is the described Kubernetes object. + * + * @schema io.k8s.api.autoscaling.v2beta1.ObjectMetricSource#target + */ + readonly target: CrossVersionObjectReferenceV2Beta1; + + /** + * targetValue is the target value of the metric (as a quantity). + * + * @schema io.k8s.api.autoscaling.v2beta1.ObjectMetricSource#targetValue + */ + readonly targetValue: Quantity; + +} + +/** + * Converts an object of type 'ObjectMetricSourceV2Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ObjectMetricSourceV2Beta1(obj: ObjectMetricSourceV2Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'averageValue': obj.averageValue?.value, + 'metricName': obj.metricName, + 'selector': toJson_LabelSelector(obj.selector), + 'target': toJson_CrossVersionObjectReferenceV2Beta1(obj.target), + 'targetValue': obj.targetValue?.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. + * + * @schema io.k8s.api.autoscaling.v2beta1.PodsMetricSource + */ +export interface PodsMetricSourceV2Beta1 { + /** + * metricName is the name of the metric in question + * + * @schema io.k8s.api.autoscaling.v2beta1.PodsMetricSource#metricName + */ + readonly metricName: string; + + /** + * selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics. + * + * @schema io.k8s.api.autoscaling.v2beta1.PodsMetricSource#selector + */ + readonly selector?: LabelSelector; + + /** + * targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity) + * + * @schema io.k8s.api.autoscaling.v2beta1.PodsMetricSource#targetAverageValue + */ + readonly targetAverageValue: Quantity; + +} + +/** + * Converts an object of type 'PodsMetricSourceV2Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PodsMetricSourceV2Beta1(obj: PodsMetricSourceV2Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metricName': obj.metricName, + 'selector': toJson_LabelSelector(obj.selector), + 'targetAverageValue': obj.targetAverageValue?.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set. + * + * @schema io.k8s.api.autoscaling.v2beta1.ResourceMetricSource + */ +export interface ResourceMetricSourceV2Beta1 { + /** + * name is the name of the resource in question. + * + * @schema io.k8s.api.autoscaling.v2beta1.ResourceMetricSource#name + */ + readonly name: string; + + /** + * targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. + * + * @schema io.k8s.api.autoscaling.v2beta1.ResourceMetricSource#targetAverageUtilization + */ + readonly targetAverageUtilization?: number; + + /** + * targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. + * + * @schema io.k8s.api.autoscaling.v2beta1.ResourceMetricSource#targetAverageValue + */ + readonly targetAverageValue?: Quantity; + +} + +/** + * Converts an object of type 'ResourceMetricSourceV2Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ResourceMetricSourceV2Beta1(obj: ResourceMetricSourceV2Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + 'targetAverageUtilization': obj.targetAverageUtilization, + 'targetAverageValue': obj.targetAverageValue?.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen. + * + * @schema io.k8s.api.autoscaling.v2beta2.HPAScalingRules + */ +export interface HpaScalingRulesV2Beta2 { + /** + * policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid + * + * @schema io.k8s.api.autoscaling.v2beta2.HPAScalingRules#policies + */ + readonly policies?: HpaScalingPolicyV2Beta2[]; + + /** + * selectPolicy is used to specify which policy should be used. If not set, the default value MaxPolicySelect is used. + * + * @schema io.k8s.api.autoscaling.v2beta2.HPAScalingRules#selectPolicy + */ + readonly selectPolicy?: string; + + /** + * StabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long). + * + * @schema io.k8s.api.autoscaling.v2beta2.HPAScalingRules#stabilizationWindowSeconds + */ + readonly stabilizationWindowSeconds?: number; + +} + +/** + * Converts an object of type 'HpaScalingRulesV2Beta2' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HpaScalingRulesV2Beta2(obj: HpaScalingRulesV2Beta2 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'policies': obj.policies?.map(y => toJson_HpaScalingPolicyV2Beta2(y)), + 'selectPolicy': obj.selectPolicy, + 'stabilizationWindowSeconds': obj.stabilizationWindowSeconds, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set. + * + * @schema io.k8s.api.autoscaling.v2beta2.ContainerResourceMetricSource + */ +export interface ContainerResourceMetricSourceV2Beta2 { + /** + * container is the name of the container in the pods of the scaling target + * + * @schema io.k8s.api.autoscaling.v2beta2.ContainerResourceMetricSource#container + */ + readonly container: string; + + /** + * name is the name of the resource in question. + * + * @schema io.k8s.api.autoscaling.v2beta2.ContainerResourceMetricSource#name + */ + readonly name: string; + + /** + * target specifies the target value for the given metric + * + * @schema io.k8s.api.autoscaling.v2beta2.ContainerResourceMetricSource#target + */ + readonly target: MetricTargetV2Beta2; + +} + +/** + * Converts an object of type 'ContainerResourceMetricSourceV2Beta2' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ContainerResourceMetricSourceV2Beta2(obj: ContainerResourceMetricSourceV2Beta2 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'container': obj.container, + 'name': obj.name, + 'target': toJson_MetricTargetV2Beta2(obj.target), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). + * + * @schema io.k8s.api.autoscaling.v2beta2.ExternalMetricSource + */ +export interface ExternalMetricSourceV2Beta2 { + /** + * metric identifies the target metric by name and selector + * + * @schema io.k8s.api.autoscaling.v2beta2.ExternalMetricSource#metric + */ + readonly metric: MetricIdentifierV2Beta2; + + /** + * target specifies the target value for the given metric + * + * @schema io.k8s.api.autoscaling.v2beta2.ExternalMetricSource#target + */ + readonly target: MetricTargetV2Beta2; + +} + +/** + * Converts an object of type 'ExternalMetricSourceV2Beta2' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ExternalMetricSourceV2Beta2(obj: ExternalMetricSourceV2Beta2 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metric': toJson_MetricIdentifierV2Beta2(obj.metric), + 'target': toJson_MetricTargetV2Beta2(obj.target), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object). + * + * @schema io.k8s.api.autoscaling.v2beta2.ObjectMetricSource + */ +export interface ObjectMetricSourceV2Beta2 { + /** + * @schema io.k8s.api.autoscaling.v2beta2.ObjectMetricSource#describedObject + */ + readonly describedObject: CrossVersionObjectReferenceV2Beta2; + + /** + * metric identifies the target metric by name and selector + * + * @schema io.k8s.api.autoscaling.v2beta2.ObjectMetricSource#metric + */ + readonly metric: MetricIdentifierV2Beta2; + + /** + * target specifies the target value for the given metric + * + * @schema io.k8s.api.autoscaling.v2beta2.ObjectMetricSource#target + */ + readonly target: MetricTargetV2Beta2; + +} + +/** + * Converts an object of type 'ObjectMetricSourceV2Beta2' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ObjectMetricSourceV2Beta2(obj: ObjectMetricSourceV2Beta2 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'describedObject': toJson_CrossVersionObjectReferenceV2Beta2(obj.describedObject), + 'metric': toJson_MetricIdentifierV2Beta2(obj.metric), + 'target': toJson_MetricTargetV2Beta2(obj.target), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. + * + * @schema io.k8s.api.autoscaling.v2beta2.PodsMetricSource + */ +export interface PodsMetricSourceV2Beta2 { + /** + * metric identifies the target metric by name and selector + * + * @schema io.k8s.api.autoscaling.v2beta2.PodsMetricSource#metric + */ + readonly metric: MetricIdentifierV2Beta2; + + /** + * target specifies the target value for the given metric + * + * @schema io.k8s.api.autoscaling.v2beta2.PodsMetricSource#target + */ + readonly target: MetricTargetV2Beta2; + +} + +/** + * Converts an object of type 'PodsMetricSourceV2Beta2' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PodsMetricSourceV2Beta2(obj: PodsMetricSourceV2Beta2 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metric': toJson_MetricIdentifierV2Beta2(obj.metric), + 'target': toJson_MetricTargetV2Beta2(obj.target), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set. + * + * @schema io.k8s.api.autoscaling.v2beta2.ResourceMetricSource + */ +export interface ResourceMetricSourceV2Beta2 { + /** + * name is the name of the resource in question. + * + * @schema io.k8s.api.autoscaling.v2beta2.ResourceMetricSource#name + */ + readonly name: string; + + /** + * target specifies the target value for the given metric + * + * @schema io.k8s.api.autoscaling.v2beta2.ResourceMetricSource#target + */ + readonly target: MetricTargetV2Beta2; + +} + +/** + * Converts an object of type 'ResourceMetricSourceV2Beta2' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ResourceMetricSourceV2Beta2(obj: ResourceMetricSourceV2Beta2 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + 'target': toJson_MetricTargetV2Beta2(obj.target), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * EnvVarSource represents a source for the value of an EnvVar. + * + * @schema io.k8s.api.core.v1.EnvVarSource + */ +export interface EnvVarSource { + /** + * Selects a key of a ConfigMap. + * + * @schema io.k8s.api.core.v1.EnvVarSource#configMapKeyRef + */ + readonly configMapKeyRef?: ConfigMapKeySelector; + + /** + * Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + * + * @schema io.k8s.api.core.v1.EnvVarSource#fieldRef + */ + readonly fieldRef?: ObjectFieldSelector; + + /** + * Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. + * + * @schema io.k8s.api.core.v1.EnvVarSource#resourceFieldRef + */ + readonly resourceFieldRef?: ResourceFieldSelector; + + /** + * Selects a key of a secret in the pod's namespace + * + * @schema io.k8s.api.core.v1.EnvVarSource#secretKeyRef + */ + readonly secretKeyRef?: SecretKeySelector; + +} + +/** + * Converts an object of type 'EnvVarSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EnvVarSource(obj: EnvVarSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'configMapKeyRef': toJson_ConfigMapKeySelector(obj.configMapKeyRef), + 'fieldRef': toJson_ObjectFieldSelector(obj.fieldRef), + 'resourceFieldRef': toJson_ResourceFieldSelector(obj.resourceFieldRef), + 'secretKeyRef': toJson_SecretKeySelector(obj.secretKeyRef), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. + * + * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. + * + * @schema io.k8s.api.core.v1.ConfigMapEnvSource + */ +export interface ConfigMapEnvSource { + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.ConfigMapEnvSource#name + */ + readonly name?: string; + + /** + * Specify whether the ConfigMap must be defined + * + * @schema io.k8s.api.core.v1.ConfigMapEnvSource#optional + */ + readonly optional?: boolean; + +} + +/** + * Converts an object of type 'ConfigMapEnvSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ConfigMapEnvSource(obj: ConfigMapEnvSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + 'optional': obj.optional, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SecretEnvSource selects a Secret to populate the environment variables with. + * + * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. + * + * @schema io.k8s.api.core.v1.SecretEnvSource + */ +export interface SecretEnvSource { + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.SecretEnvSource#name + */ + readonly name?: string; + + /** + * Specify whether the Secret must be defined + * + * @schema io.k8s.api.core.v1.SecretEnvSource#optional + */ + readonly optional?: boolean; + +} + +/** + * Converts an object of type 'SecretEnvSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SecretEnvSource(obj: SecretEnvSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + 'optional': obj.optional, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Handler defines a specific action that should be taken + * + * @schema io.k8s.api.core.v1.Handler + */ +export interface Handler { + /** + * One and only one of the following should be specified. Exec specifies the action to take. + * + * @schema io.k8s.api.core.v1.Handler#exec + */ + readonly exec?: ExecAction; + + /** + * HTTPGet specifies the http request to perform. + * + * @schema io.k8s.api.core.v1.Handler#httpGet + */ + readonly httpGet?: HttpGetAction; + + /** + * TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported + * + * @schema io.k8s.api.core.v1.Handler#tcpSocket + */ + readonly tcpSocket?: TcpSocketAction; + +} + +/** + * Converts an object of type 'Handler' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Handler(obj: Handler | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'exec': toJson_ExecAction(obj.exec), + 'httpGet': toJson_HttpGetAction(obj.httpGet), + 'tcpSocket': toJson_TcpSocketAction(obj.tcpSocket), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ExecAction describes a "run in container" action. + * + * @schema io.k8s.api.core.v1.ExecAction + */ +export interface ExecAction { + /** + * Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. + * + * @schema io.k8s.api.core.v1.ExecAction#command + */ + readonly command?: string[]; + +} + +/** + * Converts an object of type 'ExecAction' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ExecAction(obj: ExecAction | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'command': obj.command?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HTTPGetAction describes an action based on HTTP Get requests. + * + * @schema io.k8s.api.core.v1.HTTPGetAction + */ +export interface HttpGetAction { + /** + * Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. + * + * @schema io.k8s.api.core.v1.HTTPGetAction#host + */ + readonly host?: string; + + /** + * Custom headers to set in the request. HTTP allows repeated headers. + * + * @schema io.k8s.api.core.v1.HTTPGetAction#httpHeaders + */ + readonly httpHeaders?: HttpHeader[]; + + /** + * Path to access on the HTTP server. + * + * @schema io.k8s.api.core.v1.HTTPGetAction#path + */ + readonly path?: string; + + /** + * Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + * + * @schema io.k8s.api.core.v1.HTTPGetAction#port + */ + readonly port: IntOrString; + + /** + * Scheme to use for connecting to the host. Defaults to HTTP. + * + * @default HTTP. + * @schema io.k8s.api.core.v1.HTTPGetAction#scheme + */ + readonly scheme?: string; + +} + +/** + * Converts an object of type 'HttpGetAction' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HttpGetAction(obj: HttpGetAction | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'host': obj.host, + 'httpHeaders': obj.httpHeaders?.map(y => toJson_HttpHeader(y)), + 'path': obj.path, + 'port': obj.port?.value, + 'scheme': obj.scheme, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * TCPSocketAction describes an action based on opening a socket + * + * @schema io.k8s.api.core.v1.TCPSocketAction + */ +export interface TcpSocketAction { + /** + * Optional: Host name to connect to, defaults to the pod IP. + * + * @schema io.k8s.api.core.v1.TCPSocketAction#host + */ + readonly host?: string; + + /** + * Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. + * + * @schema io.k8s.api.core.v1.TCPSocketAction#port + */ + readonly port: IntOrString; + +} + +/** + * Converts an object of type 'TcpSocketAction' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_TcpSocketAction(obj: TcpSocketAction | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'host': obj.host, + 'port': obj.port?.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Adds and removes POSIX capabilities from running containers. + * + * @schema io.k8s.api.core.v1.Capabilities + */ +export interface Capabilities { + /** + * Added capabilities + * + * @schema io.k8s.api.core.v1.Capabilities#add + */ + readonly add?: string[]; + + /** + * Removed capabilities + * + * @schema io.k8s.api.core.v1.Capabilities#drop + */ + readonly drop?: string[]; + +} + +/** + * Converts an object of type 'Capabilities' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Capabilities(obj: Capabilities | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'add': obj.add?.map(y => y), + 'drop': obj.drop?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SELinuxOptions are the labels to be applied to the container + * + * @schema io.k8s.api.core.v1.SELinuxOptions + */ +export interface SeLinuxOptions { + /** + * Level is SELinux level label that applies to the container. + * + * @schema io.k8s.api.core.v1.SELinuxOptions#level + */ + readonly level?: string; + + /** + * Role is a SELinux role label that applies to the container. + * + * @schema io.k8s.api.core.v1.SELinuxOptions#role + */ + readonly role?: string; + + /** + * Type is a SELinux type label that applies to the container. + * + * @schema io.k8s.api.core.v1.SELinuxOptions#type + */ + readonly type?: string; + + /** + * User is a SELinux user label that applies to the container. + * + * @schema io.k8s.api.core.v1.SELinuxOptions#user + */ + readonly user?: string; + +} + +/** + * Converts an object of type 'SeLinuxOptions' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SeLinuxOptions(obj: SeLinuxOptions | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'level': obj.level, + 'role': obj.role, + 'type': obj.type, + 'user': obj.user, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. + * + * @schema io.k8s.api.core.v1.SeccompProfile + */ +export interface SeccompProfile { + /** + * localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". + * + * @schema io.k8s.api.core.v1.SeccompProfile#localhostProfile + */ + readonly localhostProfile?: string; + + /** + * type indicates which kind of seccomp profile will be applied. Valid options are: + * + * Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. + * + * @schema io.k8s.api.core.v1.SeccompProfile#type + */ + readonly type: string; + +} + +/** + * Converts an object of type 'SeccompProfile' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SeccompProfile(obj: SeccompProfile | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'localhostProfile': obj.localhostProfile, + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * WindowsSecurityContextOptions contain Windows-specific options and credentials. + * + * @schema io.k8s.api.core.v1.WindowsSecurityContextOptions + */ +export interface WindowsSecurityContextOptions { + /** + * GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. + * + * @schema io.k8s.api.core.v1.WindowsSecurityContextOptions#gmsaCredentialSpec + */ + readonly gmsaCredentialSpec?: string; + + /** + * GMSACredentialSpecName is the name of the GMSA credential spec to use. + * + * @schema io.k8s.api.core.v1.WindowsSecurityContextOptions#gmsaCredentialSpecName + */ + readonly gmsaCredentialSpecName?: string; + + /** + * The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * + * @default the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. + * @schema io.k8s.api.core.v1.WindowsSecurityContextOptions#runAsUserName + */ + readonly runAsUserName?: string; + +} + +/** + * Converts an object of type 'WindowsSecurityContextOptions' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_WindowsSecurityContextOptions(obj: WindowsSecurityContextOptions | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'gmsaCredentialSpec': obj.gmsaCredentialSpec, + 'gmsaCredentialSpecName': obj.gmsaCredentialSpecName, + 'runAsUserName': obj.runAsUserName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. + * + * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource + */ +export interface ConfigMapNodeConfigSource { + /** + * KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. + * + * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#kubeletConfigKey + */ + readonly kubeletConfigKey: string; + + /** + * Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. + * + * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#name + */ + readonly name: string; + + /** + * Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. + * + * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#namespace + */ + readonly namespace: string; + + /** + * ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. + * + * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#resourceVersion + */ + readonly resourceVersion?: string; + + /** + * UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. + * + * @schema io.k8s.api.core.v1.ConfigMapNodeConfigSource#uid + */ + readonly uid?: string; + +} + +/** + * Converts an object of type 'ConfigMapNodeConfigSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ConfigMapNodeConfigSource(obj: ConfigMapNodeConfigSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'kubeletConfigKey': obj.kubeletConfigKey, + 'name': obj.name, + 'namespace': obj.namespace, + 'resourceVersion': obj.resourceVersion, + 'uid': obj.uid, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace + * + * @schema io.k8s.api.core.v1.SecretReference + */ +export interface SecretReference { + /** + * Name is unique within a namespace to reference a secret resource. + * + * @schema io.k8s.api.core.v1.SecretReference#name + */ + readonly name?: string; + + /** + * Namespace defines the space within which the secret name must be unique. + * + * @schema io.k8s.api.core.v1.SecretReference#namespace + */ + readonly namespace?: string; + +} + +/** + * Converts an object of type 'SecretReference' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SecretReference(obj: SecretReference | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + 'namespace': obj.namespace, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. + * + * @schema io.k8s.api.core.v1.NodeSelector + */ +export interface NodeSelector { + /** + * Required. A list of node selector terms. The terms are ORed. + * + * @schema io.k8s.api.core.v1.NodeSelector#nodeSelectorTerms + */ + readonly nodeSelectorTerms: NodeSelectorTerm[]; + +} + +/** + * Converts an object of type 'NodeSelector' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NodeSelector(obj: NodeSelector | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'nodeSelectorTerms': obj.nodeSelectorTerms?.map(y => toJson_NodeSelectorTerm(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Node affinity is a group of node affinity scheduling rules. + * + * @schema io.k8s.api.core.v1.NodeAffinity + */ +export interface NodeAffinity { + /** + * The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. + * + * @schema io.k8s.api.core.v1.NodeAffinity#preferredDuringSchedulingIgnoredDuringExecution + */ + readonly preferredDuringSchedulingIgnoredDuringExecution?: PreferredSchedulingTerm[]; + + /** + * If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. + * + * @schema io.k8s.api.core.v1.NodeAffinity#requiredDuringSchedulingIgnoredDuringExecution + */ + readonly requiredDuringSchedulingIgnoredDuringExecution?: NodeSelector; + +} + +/** + * Converts an object of type 'NodeAffinity' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NodeAffinity(obj: NodeAffinity | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'preferredDuringSchedulingIgnoredDuringExecution': obj.preferredDuringSchedulingIgnoredDuringExecution?.map(y => toJson_PreferredSchedulingTerm(y)), + 'requiredDuringSchedulingIgnoredDuringExecution': toJson_NodeSelector(obj.requiredDuringSchedulingIgnoredDuringExecution), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Pod affinity is a group of inter pod affinity scheduling rules. + * + * @schema io.k8s.api.core.v1.PodAffinity + */ +export interface PodAffinity { + /** + * The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. + * + * @schema io.k8s.api.core.v1.PodAffinity#preferredDuringSchedulingIgnoredDuringExecution + */ + readonly preferredDuringSchedulingIgnoredDuringExecution?: WeightedPodAffinityTerm[]; + + /** + * If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. + * + * @schema io.k8s.api.core.v1.PodAffinity#requiredDuringSchedulingIgnoredDuringExecution + */ + readonly requiredDuringSchedulingIgnoredDuringExecution?: PodAffinityTerm[]; + +} + +/** + * Converts an object of type 'PodAffinity' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PodAffinity(obj: PodAffinity | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'preferredDuringSchedulingIgnoredDuringExecution': obj.preferredDuringSchedulingIgnoredDuringExecution?.map(y => toJson_WeightedPodAffinityTerm(y)), + 'requiredDuringSchedulingIgnoredDuringExecution': obj.requiredDuringSchedulingIgnoredDuringExecution?.map(y => toJson_PodAffinityTerm(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Pod anti affinity is a group of inter pod anti affinity scheduling rules. + * + * @schema io.k8s.api.core.v1.PodAntiAffinity + */ +export interface PodAntiAffinity { + /** + * The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. + * + * @schema io.k8s.api.core.v1.PodAntiAffinity#preferredDuringSchedulingIgnoredDuringExecution + */ + readonly preferredDuringSchedulingIgnoredDuringExecution?: WeightedPodAffinityTerm[]; + + /** + * If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. + * + * @schema io.k8s.api.core.v1.PodAntiAffinity#requiredDuringSchedulingIgnoredDuringExecution + */ + readonly requiredDuringSchedulingIgnoredDuringExecution?: PodAffinityTerm[]; + +} + +/** + * Converts an object of type 'PodAntiAffinity' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PodAntiAffinity(obj: PodAntiAffinity | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'preferredDuringSchedulingIgnoredDuringExecution': obj.preferredDuringSchedulingIgnoredDuringExecution?.map(y => toJson_WeightedPodAffinityTerm(y)), + 'requiredDuringSchedulingIgnoredDuringExecution': obj.requiredDuringSchedulingIgnoredDuringExecution?.map(y => toJson_PodAffinityTerm(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PodDNSConfigOption defines DNS resolver options of a pod. + * + * @schema io.k8s.api.core.v1.PodDNSConfigOption + */ +export interface PodDnsConfigOption { + /** + * Required. + * + * @schema io.k8s.api.core.v1.PodDNSConfigOption#name + */ + readonly name?: string; + + /** + * @schema io.k8s.api.core.v1.PodDNSConfigOption#value + */ + readonly value?: string; + +} + +/** + * Converts an object of type 'PodDnsConfigOption' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PodDnsConfigOption(obj: PodDnsConfigOption | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + 'value': obj.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Sysctl defines a kernel parameter to be set + * + * @schema io.k8s.api.core.v1.Sysctl + */ +export interface Sysctl { + /** + * Name of a property to set + * + * @schema io.k8s.api.core.v1.Sysctl#name + */ + readonly name: string; + + /** + * Value of a property to set + * + * @schema io.k8s.api.core.v1.Sysctl#value + */ + readonly value: string; + +} + +/** + * Converts an object of type 'Sysctl' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_Sysctl(obj: Sysctl | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + 'value': obj.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * AzureFile represents an Azure File Service mount on the host and bind mount to the pod. + * + * @schema io.k8s.api.core.v1.AzureFileVolumeSource + */ +export interface AzureFileVolumeSource { + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.AzureFileVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * the name of secret that contains Azure Storage Account Name and Key + * + * @schema io.k8s.api.core.v1.AzureFileVolumeSource#secretName + */ + readonly secretName: string; + + /** + * Share Name + * + * @schema io.k8s.api.core.v1.AzureFileVolumeSource#shareName + */ + readonly shareName: string; + +} + +/** + * Converts an object of type 'AzureFileVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_AzureFileVolumeSource(obj: AzureFileVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'readOnly': obj.readOnly, + 'secretName': obj.secretName, + 'shareName': obj.shareName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.CephFSVolumeSource + */ +export interface CephFsVolumeSource { + /** + * Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSVolumeSource#monitors + */ + readonly monitors: string[]; + + /** + * Optional: Used as the mounted root, rather than the full Ceph tree, default is / + * + * @schema io.k8s.api.core.v1.CephFSVolumeSource#path + */ + readonly path?: string; + + /** + * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.CephFSVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSVolumeSource#secretFile + */ + readonly secretFile?: string; + + /** + * Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSVolumeSource#secretRef + */ + readonly secretRef?: LocalObjectReference; + + /** + * Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.CephFSVolumeSource#user + */ + readonly user?: string; + +} + +/** + * Converts an object of type 'CephFsVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CephFsVolumeSource(obj: CephFsVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'monitors': obj.monitors?.map(y => y), + 'path': obj.path, + 'readOnly': obj.readOnly, + 'secretFile': obj.secretFile, + 'secretRef': toJson_LocalObjectReference(obj.secretRef), + 'user': obj.user, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.CinderVolumeSource + */ +export interface CinderVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @schema io.k8s.api.core.v1.CinderVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * @schema io.k8s.api.core.v1.CinderVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Optional: points to a secret object containing parameters used to connect to OpenStack. + * + * @schema io.k8s.api.core.v1.CinderVolumeSource#secretRef + */ + readonly secretRef?: LocalObjectReference; + + /** + * volume id used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md + * + * @schema io.k8s.api.core.v1.CinderVolumeSource#volumeID + */ + readonly volumeId: string; + +} + +/** + * Converts an object of type 'CinderVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CinderVolumeSource(obj: CinderVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'readOnly': obj.readOnly, + 'secretRef': toJson_LocalObjectReference(obj.secretRef), + 'volumeID': obj.volumeId, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Adapts a ConfigMap into a volume. + * + * The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.ConfigMapVolumeSource + */ +export interface ConfigMapVolumeSource { + /** + * Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * + * @default 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * @schema io.k8s.api.core.v1.ConfigMapVolumeSource#defaultMode + */ + readonly defaultMode?: number; + + /** + * 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. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + * + * @schema io.k8s.api.core.v1.ConfigMapVolumeSource#items + */ + readonly items?: KeyToPath[]; + + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.ConfigMapVolumeSource#name + */ + readonly name?: string; + + /** + * Specify whether the ConfigMap or its keys must be defined + * + * @schema io.k8s.api.core.v1.ConfigMapVolumeSource#optional + */ + readonly optional?: boolean; + +} + +/** + * Converts an object of type 'ConfigMapVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ConfigMapVolumeSource(obj: ConfigMapVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'defaultMode': obj.defaultMode, + 'items': obj.items?.map(y => toJson_KeyToPath(y)), + 'name': obj.name, + 'optional': obj.optional, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a source location of a volume to mount, managed by an external CSI driver + * + * @schema io.k8s.api.core.v1.CSIVolumeSource + */ +export interface CsiVolumeSource { + /** + * Driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. + * + * @schema io.k8s.api.core.v1.CSIVolumeSource#driver + */ + readonly driver: string; + + /** + * Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. + * + * @schema io.k8s.api.core.v1.CSIVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * NodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. + * + * @schema io.k8s.api.core.v1.CSIVolumeSource#nodePublishSecretRef + */ + readonly nodePublishSecretRef?: LocalObjectReference; + + /** + * Specifies a read-only configuration for the volume. Defaults to false (read/write). + * + * @default false (read/write). + * @schema io.k8s.api.core.v1.CSIVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. + * + * @schema io.k8s.api.core.v1.CSIVolumeSource#volumeAttributes + */ + readonly volumeAttributes?: { [key: string]: string }; + +} + +/** + * Converts an object of type 'CsiVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CsiVolumeSource(obj: CsiVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'driver': obj.driver, + 'fsType': obj.fsType, + 'nodePublishSecretRef': toJson_LocalObjectReference(obj.nodePublishSecretRef), + 'readOnly': obj.readOnly, + 'volumeAttributes': ((obj.volumeAttributes) === undefined) ? undefined : (Object.entries(obj.volumeAttributes).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.DownwardAPIVolumeSource + */ +export interface DownwardApiVolumeSource { + /** + * Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * + * @default 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * @schema io.k8s.api.core.v1.DownwardAPIVolumeSource#defaultMode + */ + readonly defaultMode?: number; + + /** + * Items is a list of downward API volume file + * + * @schema io.k8s.api.core.v1.DownwardAPIVolumeSource#items + */ + readonly items?: DownwardApiVolumeFile[]; + +} + +/** + * Converts an object of type 'DownwardApiVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_DownwardApiVolumeSource(obj: DownwardApiVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'defaultMode': obj.defaultMode, + 'items': obj.items?.map(y => toJson_DownwardApiVolumeFile(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.EmptyDirVolumeSource + */ +export interface EmptyDirVolumeSource { + /** + * What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + * + * @schema io.k8s.api.core.v1.EmptyDirVolumeSource#medium + */ + readonly medium?: string; + + /** + * Total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir + * + * @schema io.k8s.api.core.v1.EmptyDirVolumeSource#sizeLimit + */ + readonly sizeLimit?: Quantity; + +} + +/** + * Converts an object of type 'EmptyDirVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EmptyDirVolumeSource(obj: EmptyDirVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'medium': obj.medium, + 'sizeLimit': obj.sizeLimit?.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents an ephemeral volume that is handled by a normal storage driver. + * + * @schema io.k8s.api.core.v1.EphemeralVolumeSource + */ +export interface EphemeralVolumeSource { + /** + * Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). + * + * An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. + * + * This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. + * + * Required, must not be nil. + * + * @schema io.k8s.api.core.v1.EphemeralVolumeSource#volumeClaimTemplate + */ + readonly volumeClaimTemplate?: PersistentVolumeClaimTemplate; + +} + +/** + * Converts an object of type 'EphemeralVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_EphemeralVolumeSource(obj: EphemeralVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'volumeClaimTemplate': toJson_PersistentVolumeClaimTemplate(obj.volumeClaimTemplate), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. + * + * @schema io.k8s.api.core.v1.FlexVolumeSource + */ +export interface FlexVolumeSource { + /** + * Driver is the name of the driver to use for this volume. + * + * @schema io.k8s.api.core.v1.FlexVolumeSource#driver + */ + readonly driver: string; + + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. + * + * @schema io.k8s.api.core.v1.FlexVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Optional: Extra command options if any. + * + * @schema io.k8s.api.core.v1.FlexVolumeSource#options + */ + readonly options?: { [key: string]: string }; + + /** + * Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.FlexVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. + * + * @schema io.k8s.api.core.v1.FlexVolumeSource#secretRef + */ + readonly secretRef?: LocalObjectReference; + +} + +/** + * Converts an object of type 'FlexVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_FlexVolumeSource(obj: FlexVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'driver': obj.driver, + 'fsType': obj.fsType, + 'options': ((obj.options) === undefined) ? undefined : (Object.entries(obj.options).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'readOnly': obj.readOnly, + 'secretRef': toJson_LocalObjectReference(obj.secretRef), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. + * + * DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. + * + * @schema io.k8s.api.core.v1.GitRepoVolumeSource + */ +export interface GitRepoVolumeSource { + /** + * Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. + * + * @schema io.k8s.api.core.v1.GitRepoVolumeSource#directory + */ + readonly directory?: string; + + /** + * Repository URL + * + * @schema io.k8s.api.core.v1.GitRepoVolumeSource#repository + */ + readonly repository: string; + + /** + * Commit hash for the specified revision. + * + * @schema io.k8s.api.core.v1.GitRepoVolumeSource#revision + */ + readonly revision?: string; + +} + +/** + * Converts an object of type 'GitRepoVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_GitRepoVolumeSource(obj: GitRepoVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'directory': obj.directory, + 'repository': obj.repository, + 'revision': obj.revision, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. + * + * @schema io.k8s.api.core.v1.GlusterfsVolumeSource + */ +export interface GlusterfsVolumeSource { + /** + * EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * + * @schema io.k8s.api.core.v1.GlusterfsVolumeSource#endpoints + */ + readonly endpoints: string; + + /** + * Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * + * @schema io.k8s.api.core.v1.GlusterfsVolumeSource#path + */ + readonly path: string; + + /** + * ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * + * @default false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod + * @schema io.k8s.api.core.v1.GlusterfsVolumeSource#readOnly + */ + readonly readOnly?: boolean; + +} + +/** + * Converts an object of type 'GlusterfsVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_GlusterfsVolumeSource(obj: GlusterfsVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'endpoints': obj.endpoints, + 'path': obj.path, + 'readOnly': obj.readOnly, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource + */ +export interface IscsiVolumeSource { + /** + * whether support iSCSI Discovery CHAP authentication + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#chapAuthDiscovery + */ + readonly chapAuthDiscovery?: boolean; + + /** + * whether support iSCSI Session CHAP authentication + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#chapAuthSession + */ + readonly chapAuthSession?: boolean; + + /** + * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#initiatorName + */ + readonly initiatorName?: string; + + /** + * Target iSCSI Qualified Name. + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#iqn + */ + readonly iqn: string; + + /** + * iSCSI Interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). + * + * @default default' (tcp). + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#iscsiInterface + */ + readonly iscsiInterface?: string; + + /** + * iSCSI Target Lun number. + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#lun + */ + readonly lun: number; + + /** + * iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#portals + */ + readonly portals?: string[]; + + /** + * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. + * + * @default false. + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * CHAP Secret for iSCSI target and initiator authentication + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#secretRef + */ + readonly secretRef?: LocalObjectReference; + + /** + * iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). + * + * @schema io.k8s.api.core.v1.ISCSIVolumeSource#targetPortal + */ + readonly targetPortal: string; + +} + +/** + * Converts an object of type 'IscsiVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IscsiVolumeSource(obj: IscsiVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'chapAuthDiscovery': obj.chapAuthDiscovery, + 'chapAuthSession': obj.chapAuthSession, + 'fsType': obj.fsType, + 'initiatorName': obj.initiatorName, + 'iqn': obj.iqn, + 'iscsiInterface': obj.iscsiInterface, + 'lun': obj.lun, + 'portals': obj.portals?.map(y => y), + 'readOnly': obj.readOnly, + 'secretRef': toJson_LocalObjectReference(obj.secretRef), + 'targetPortal': obj.targetPortal, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource + */ +export interface PersistentVolumeClaimVolumeSource { + /** + * ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource#claimName + */ + readonly claimName: string; + + /** + * Will force the ReadOnly setting in VolumeMounts. Default false. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource#readOnly + */ + readonly readOnly?: boolean; + +} + +/** + * Converts an object of type 'PersistentVolumeClaimVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PersistentVolumeClaimVolumeSource(obj: PersistentVolumeClaimVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'claimName': obj.claimName, + 'readOnly': obj.readOnly, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a projected volume source + * + * @schema io.k8s.api.core.v1.ProjectedVolumeSource + */ +export interface ProjectedVolumeSource { + /** + * Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * + * @schema io.k8s.api.core.v1.ProjectedVolumeSource#defaultMode + */ + readonly defaultMode?: number; + + /** + * list of volume projections + * + * @schema io.k8s.api.core.v1.ProjectedVolumeSource#sources + */ + readonly sources?: VolumeProjection[]; + +} + +/** + * Converts an object of type 'ProjectedVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ProjectedVolumeSource(obj: ProjectedVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'defaultMode': obj.defaultMode, + 'sources': obj.sources?.map(y => toJson_VolumeProjection(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.RBDVolumeSource + */ +export interface RbdVolumeSource { + /** + * Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd + * + * @schema io.k8s.api.core.v1.RBDVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.RBDVolumeSource#image + */ + readonly image: string; + + /** + * Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDVolumeSource#keyring + */ + readonly keyring?: string; + + /** + * A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @schema io.k8s.api.core.v1.RBDVolumeSource#monitors + */ + readonly monitors: string[]; + + /** + * The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDVolumeSource#pool + */ + readonly pool?: string; + + /** + * ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDVolumeSource#secretRef + */ + readonly secretRef?: LocalObjectReference; + + /** + * The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * + * @default admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + * @schema io.k8s.api.core.v1.RBDVolumeSource#user + */ + readonly user?: string; + +} + +/** + * Converts an object of type 'RbdVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_RbdVolumeSource(obj: RbdVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'image': obj.image, + 'keyring': obj.keyring, + 'monitors': obj.monitors?.map(y => y), + 'pool': obj.pool, + 'readOnly': obj.readOnly, + 'secretRef': toJson_LocalObjectReference(obj.secretRef), + 'user': obj.user, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ScaleIOVolumeSource represents a persistent ScaleIO volume + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource + */ +export interface ScaleIoVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". + * + * @default xfs". + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * The host address of the ScaleIO API Gateway. + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#gateway + */ + readonly gateway: string; + + /** + * The name of the ScaleIO Protection Domain for the configured storage. + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#protectionDomain + */ + readonly protectionDomain?: string; + + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#secretRef + */ + readonly secretRef: LocalObjectReference; + + /** + * Flag to enable/disable SSL communication with Gateway, default false + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#sslEnabled + */ + readonly sslEnabled?: boolean; + + /** + * Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. + * + * @default ThinProvisioned. + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#storageMode + */ + readonly storageMode?: string; + + /** + * The ScaleIO Storage Pool associated with the protection domain. + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#storagePool + */ + readonly storagePool?: string; + + /** + * The name of the storage system as configured in ScaleIO. + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#system + */ + readonly system: string; + + /** + * The name of a volume already created in the ScaleIO system that is associated with this volume source. + * + * @schema io.k8s.api.core.v1.ScaleIOVolumeSource#volumeName + */ + readonly volumeName?: string; + +} + +/** + * Converts an object of type 'ScaleIoVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ScaleIoVolumeSource(obj: ScaleIoVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'gateway': obj.gateway, + 'protectionDomain': obj.protectionDomain, + 'readOnly': obj.readOnly, + 'secretRef': toJson_LocalObjectReference(obj.secretRef), + 'sslEnabled': obj.sslEnabled, + 'storageMode': obj.storageMode, + 'storagePool': obj.storagePool, + 'system': obj.system, + 'volumeName': obj.volumeName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Adapts a Secret into a volume. + * + * The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. + * + * @schema io.k8s.api.core.v1.SecretVolumeSource + */ +export interface SecretVolumeSource { + /** + * Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * + * @default 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * @schema io.k8s.api.core.v1.SecretVolumeSource#defaultMode + */ + readonly defaultMode?: number; + + /** + * 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. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + * + * @schema io.k8s.api.core.v1.SecretVolumeSource#items + */ + readonly items?: KeyToPath[]; + + /** + * Specify whether the Secret or its keys must be defined + * + * @schema io.k8s.api.core.v1.SecretVolumeSource#optional + */ + readonly optional?: boolean; + + /** + * Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + * + * @schema io.k8s.api.core.v1.SecretVolumeSource#secretName + */ + readonly secretName?: string; + +} + +/** + * Converts an object of type 'SecretVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SecretVolumeSource(obj: SecretVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'defaultMode': obj.defaultMode, + 'items': obj.items?.map(y => toJson_KeyToPath(y)), + 'optional': obj.optional, + 'secretName': obj.secretName, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents a StorageOS persistent volume resource. + * + * @schema io.k8s.api.core.v1.StorageOSVolumeSource + */ +export interface StorageOsVolumeSource { + /** + * Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. + * + * @schema io.k8s.api.core.v1.StorageOSVolumeSource#fsType + */ + readonly fsType?: string; + + /** + * Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * + * @default false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. + * @schema io.k8s.api.core.v1.StorageOSVolumeSource#readOnly + */ + readonly readOnly?: boolean; + + /** + * SecretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. + * + * @schema io.k8s.api.core.v1.StorageOSVolumeSource#secretRef + */ + readonly secretRef?: LocalObjectReference; + + /** + * VolumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. + * + * @schema io.k8s.api.core.v1.StorageOSVolumeSource#volumeName + */ + readonly volumeName?: string; + + /** + * VolumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. + * + * @schema io.k8s.api.core.v1.StorageOSVolumeSource#volumeNamespace + */ + readonly volumeNamespace?: string; + +} + +/** + * Converts an object of type 'StorageOsVolumeSource' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_StorageOsVolumeSource(obj: StorageOsVolumeSource | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fsType': obj.fsType, + 'readOnly': obj.readOnly, + 'secretRef': toJson_LocalObjectReference(obj.secretRef), + 'volumeName': obj.volumeName, + 'volumeNamespace': obj.volumeNamespace, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values. + * + * @schema io.k8s.api.core.v1.ScopedResourceSelectorRequirement + */ +export interface ScopedResourceSelectorRequirement { + /** + * Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. + * + * @schema io.k8s.api.core.v1.ScopedResourceSelectorRequirement#operator + */ + readonly operator: string; + + /** + * The name of the scope that the selector applies to. + * + * @schema io.k8s.api.core.v1.ScopedResourceSelectorRequirement#scopeName + */ + readonly scopeName: string; + + /** + * An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. + * + * @schema io.k8s.api.core.v1.ScopedResourceSelectorRequirement#values + */ + readonly values?: string[]; + +} + +/** + * Converts an object of type 'ScopedResourceSelectorRequirement' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ScopedResourceSelectorRequirement(obj: ScopedResourceSelectorRequirement | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'operator': obj.operator, + 'scopeName': obj.scopeName, + 'values': obj.values?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ClientIPConfig represents the configurations of Client IP based session affinity. + * + * @schema io.k8s.api.core.v1.ClientIPConfig + */ +export interface ClientIpConfig { + /** + * timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). + * + * @schema io.k8s.api.core.v1.ClientIPConfig#timeoutSeconds + */ + readonly timeoutSeconds?: number; + +} + +/** + * Converts an object of type 'ClientIpConfig' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ClientIpConfig(obj: ClientIpConfig | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'timeoutSeconds': obj.timeoutSeconds, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ForZone provides information about which zones should consume this endpoint. + * + * @schema io.k8s.api.discovery.v1.ForZone + */ +export interface ForZone { + /** + * name represents the name of the zone. + * + * @schema io.k8s.api.discovery.v1.ForZone#name + */ + readonly name: string; + +} + +/** + * Converts an object of type 'ForZone' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ForZone(obj: ForZone | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ForZone provides information about which zones should consume this endpoint. + * + * @schema io.k8s.api.discovery.v1beta1.ForZone + */ +export interface ForZoneV1Beta1 { + /** + * name represents the name of the zone. + * + * @schema io.k8s.api.discovery.v1beta1.ForZone#name + */ + readonly name: string; + +} + +/** + * Converts an object of type 'ForZoneV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ForZoneV1Beta1(obj: ForZoneV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http:///? -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'. + * + * @schema io.k8s.api.networking.v1beta1.HTTPIngressRuleValue + */ +export interface HttpIngressRuleValueV1Beta1 { + /** + * A collection of paths that map requests to backends. + * + * @schema io.k8s.api.networking.v1beta1.HTTPIngressRuleValue#paths + */ + readonly paths: HttpIngressPathV1Beta1[]; + +} + +/** + * Converts an object of type 'HttpIngressRuleValueV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HttpIngressRuleValueV1Beta1(obj: HttpIngressRuleValueV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'paths': obj.paths?.map(y => toJson_HttpIngressPathV1Beta1(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request. + * + * @schema io.k8s.api.flowcontrol.v1beta1.NonResourcePolicyRule + */ +export interface NonResourcePolicyRuleV1Beta1 { + /** + * `nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example: + * - "/healthz" is legal + * - "/hea*" is illegal + * - "/hea" is legal but matches nothing + * - "/hea/*" also matches nothing + * - "/healthz/*" matches all per-component health checks. + * "*" matches all non-resource urls. if it is present, it must be the only entry. Required. + * + * @schema io.k8s.api.flowcontrol.v1beta1.NonResourcePolicyRule#nonResourceURLs + */ + readonly nonResourceUrLs: string[]; + + /** + * `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required. + * + * @schema io.k8s.api.flowcontrol.v1beta1.NonResourcePolicyRule#verbs + */ + readonly verbs: string[]; + +} + +/** + * Converts an object of type 'NonResourcePolicyRuleV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NonResourcePolicyRuleV1Beta1(obj: NonResourcePolicyRuleV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'nonResourceURLs': obj.nonResourceUrLs?.map(y => y), + 'verbs': obj.verbs?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) least one member of namespaces matches the request. + * + * @schema io.k8s.api.flowcontrol.v1beta1.ResourcePolicyRule + */ +export interface ResourcePolicyRuleV1Beta1 { + /** + * `apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required. + * + * @schema io.k8s.api.flowcontrol.v1beta1.ResourcePolicyRule#apiGroups + */ + readonly apiGroups: string[]; + + /** + * `clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list. + * + * @schema io.k8s.api.flowcontrol.v1beta1.ResourcePolicyRule#clusterScope + */ + readonly clusterScope?: boolean; + + /** + * `namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true. + * + * @schema io.k8s.api.flowcontrol.v1beta1.ResourcePolicyRule#namespaces + */ + readonly namespaces?: string[]; + + /** + * `resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required. + * + * @schema io.k8s.api.flowcontrol.v1beta1.ResourcePolicyRule#resources + */ + readonly resources: string[]; + + /** + * `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required. + * + * @schema io.k8s.api.flowcontrol.v1beta1.ResourcePolicyRule#verbs + */ + readonly verbs: string[]; + +} + +/** + * Converts an object of type 'ResourcePolicyRuleV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ResourcePolicyRuleV1Beta1(obj: ResourcePolicyRuleV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiGroups': obj.apiGroups?.map(y => y), + 'clusterScope': obj.clusterScope, + 'namespaces': obj.namespaces?.map(y => y), + 'resources': obj.resources?.map(y => y), + 'verbs': obj.verbs?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * LimitResponse defines how to handle requests that can not be executed right now. + * + * @schema io.k8s.api.flowcontrol.v1beta1.LimitResponse + */ +export interface LimitResponseV1Beta1 { + /** + * `queuing` holds the configuration parameters for queuing. This field may be non-empty only if `type` is `"Queue"`. + * + * @schema io.k8s.api.flowcontrol.v1beta1.LimitResponse#queuing + */ + readonly queuing?: QueuingConfigurationV1Beta1; + + /** + * `type` is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required. + * + * @schema io.k8s.api.flowcontrol.v1beta1.LimitResponse#type + */ + readonly type: string; + +} + +/** + * Converts an object of type 'LimitResponseV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_LimitResponseV1Beta1(obj: LimitResponseV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'queuing': toJson_QueuingConfigurationV1Beta1(obj.queuing), + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IngressServiceBackend references a Kubernetes Service as a Backend. + * + * @schema io.k8s.api.networking.v1.IngressServiceBackend + */ +export interface IngressServiceBackend { + /** + * Name is the referenced service. The service must exist in the same namespace as the Ingress object. + * + * @schema io.k8s.api.networking.v1.IngressServiceBackend#name + */ + readonly name: string; + + /** + * Port of the referenced service. A port name or port number is required for a IngressServiceBackend. + * + * @schema io.k8s.api.networking.v1.IngressServiceBackend#port + */ + readonly port?: ServiceBackendPort; + +} + +/** + * Converts an object of type 'IngressServiceBackend' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IngressServiceBackend(obj: IngressServiceBackend | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + 'port': toJson_ServiceBackendPort(obj.port), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http:///? -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'. + * + * @schema io.k8s.api.networking.v1.HTTPIngressRuleValue + */ +export interface HttpIngressRuleValue { + /** + * A collection of paths that map requests to backends. + * + * @schema io.k8s.api.networking.v1.HTTPIngressRuleValue#paths + */ + readonly paths: HttpIngressPath[]; + +} + +/** + * Converts an object of type 'HttpIngressRuleValue' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HttpIngressRuleValue(obj: HttpIngressRuleValue | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'paths': obj.paths?.map(y => toJson_HttpIngressPath(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NetworkPolicyPort describes a port to allow traffic on + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPort + */ +export interface NetworkPolicyPort { + /** + * If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. This feature is in Alpha state and should be enabled using the Feature Gate "NetworkPolicyEndPort". + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPort#endPort + */ + readonly endPort?: number; + + /** + * The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPort#port + */ + readonly port?: IntOrString; + + /** + * The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPort#protocol + */ + readonly protocol?: string; + +} + +/** + * Converts an object of type 'NetworkPolicyPort' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NetworkPolicyPort(obj: NetworkPolicyPort | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'endPort': obj.endPort, + 'port': obj.port?.value, + 'protocol': obj.protocol, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPeer + */ +export interface NetworkPolicyPeer { + /** + * IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPeer#ipBlock + */ + readonly ipBlock?: IpBlock; + + /** + * Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. + * + * If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPeer#namespaceSelector + */ + readonly namespaceSelector?: LabelSelector; + + /** + * This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. + * + * If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace. + * + * @schema io.k8s.api.networking.v1.NetworkPolicyPeer#podSelector + */ + readonly podSelector?: LabelSelector; + +} + +/** + * Converts an object of type 'NetworkPolicyPeer' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NetworkPolicyPeer(obj: NetworkPolicyPeer | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'ipBlock': toJson_IpBlock(obj.ipBlock), + 'namespaceSelector': toJson_LabelSelector(obj.namespaceSelector), + 'podSelector': toJson_LabelSelector(obj.podSelector), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IDRange provides a min/max of an allowed range of IDs. + * + * @schema io.k8s.api.policy.v1beta1.IDRange + */ +export interface IdRangeV1Beta1 { + /** + * max is the end of the range, inclusive. + * + * @schema io.k8s.api.policy.v1beta1.IDRange#max + */ + readonly max: number; + + /** + * min is the start of the range, inclusive. + * + * @schema io.k8s.api.policy.v1beta1.IDRange#min + */ + readonly min: number; + +} + +/** + * Converts an object of type 'IdRangeV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IdRangeV1Beta1(obj: IdRangeV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'max': obj.max, + 'min': obj.min, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeNodeResources is a set of resource limits for scheduling of volumes. + * + * @schema io.k8s.api.storage.v1.VolumeNodeResources + */ +export interface VolumeNodeResources { + /** + * Maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded. + * + * @schema io.k8s.api.storage.v1.VolumeNodeResources#count + */ + readonly count?: number; + +} + +/** + * Converts an object of type 'VolumeNodeResources' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_VolumeNodeResources(obj: VolumeNodeResources | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'count': obj.count, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * VolumeNodeResources is a set of resource limits for scheduling of volumes. + * + * @schema io.k8s.api.storage.v1beta1.VolumeNodeResources + */ +export interface VolumeNodeResourcesV1Beta1 { + /** + * Maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is nil, then the supported number of volumes on this node is unbounded. + * + * @schema io.k8s.api.storage.v1beta1.VolumeNodeResources#count + */ + readonly count?: number; + +} + +/** + * Converts an object of type 'VolumeNodeResourcesV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_VolumeNodeResourcesV1Beta1(obj: VolumeNodeResourcesV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'count': obj.count, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * WebhookConversion describes how to call a conversion webhook + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.WebhookConversion + */ +export interface WebhookConversion { + /** + * clientConfig is the instructions for how to call the webhook if strategy is `Webhook`. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.WebhookConversion#clientConfig + */ + readonly clientConfig?: WebhookClientConfig; + + /** + * conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.WebhookConversion#conversionReviewVersions + */ + readonly conversionReviewVersions: string[]; + +} + +/** + * Converts an object of type 'WebhookConversion' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_WebhookConversion(obj: WebhookConversion | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'clientConfig': toJson_WebhookClientConfig(obj.clientConfig), + 'conversionReviewVersions': obj.conversionReviewVersions?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceColumnDefinition specifies a column for server side printing. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition + */ +export interface CustomResourceColumnDefinition { + /** + * description is a human readable description of this column. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#description + */ + readonly description?: string; + + /** + * format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#format + */ + readonly format?: string; + + /** + * jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#jsonPath + */ + readonly jsonPath: string; + + /** + * name is a human readable name for the column. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#name + */ + readonly name: string; + + /** + * priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#priority + */ + readonly priority?: number; + + /** + * type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition#type + */ + readonly type: string; + +} + +/** + * Converts an object of type 'CustomResourceColumnDefinition' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceColumnDefinition(obj: CustomResourceColumnDefinition | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'description': obj.description, + 'format': obj.format, + 'jsonPath': obj.jsonPath, + 'name': obj.name, + 'priority': obj.priority, + 'type': obj.type, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceValidation is a list of validation methods for CustomResources. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceValidation + */ +export interface CustomResourceValidation { + /** + * openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceValidation#openAPIV3Schema + */ + readonly openApiv3Schema?: JsonSchemaProps; + +} + +/** + * Converts an object of type 'CustomResourceValidation' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceValidation(obj: CustomResourceValidation | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'openAPIV3Schema': toJson_JsonSchemaProps(obj.openApiv3Schema), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceSubresources defines the status and scale subresources for CustomResources. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresources + */ +export interface CustomResourceSubresources { + /** + * scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresources#scale + */ + readonly scale?: CustomResourceSubresourceScale; + + /** + * status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresources#status + */ + readonly status?: any; + +} + +/** + * Converts an object of type 'CustomResourceSubresources' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceSubresources(obj: CustomResourceSubresources | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'scale': toJson_CustomResourceSubresourceScale(obj.scale), + 'status': obj.status, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceSubresourceScale + */ +export interface CustomResourceSubresourceScaleV1Beta1 { + /** + * labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceSubresourceScale#labelSelectorPath + */ + readonly labelSelectorPath?: string; + + /** + * specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceSubresourceScale#specReplicasPath + */ + readonly specReplicasPath: string; + + /** + * statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.CustomResourceSubresourceScale#statusReplicasPath + */ + readonly statusReplicasPath: string; + +} + +/** + * Converts an object of type 'CustomResourceSubresourceScaleV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceSubresourceScaleV1Beta1(obj: CustomResourceSubresourceScaleV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'labelSelectorPath': obj.labelSelectorPath, + 'specReplicasPath': obj.specReplicasPath, + 'statusReplicasPath': obj.statusReplicasPath, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/). + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps + */ +export interface JsonSchemaPropsV1Beta1 { + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#$ref + */ + readonly ref?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#$schema + */ + readonly schema?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#additionalItems + */ + readonly additionalItems?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#additionalProperties + */ + readonly additionalProperties?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#allOf + */ + readonly allOf?: JsonSchemaPropsV1Beta1[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#anyOf + */ + readonly anyOf?: JsonSchemaPropsV1Beta1[]; + + /** + * default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. CustomResourceDefinitions with defaults must be created using the v1 (or newer) CustomResourceDefinition API. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#default + */ + readonly default?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#definitions + */ + readonly definitions?: { [key: string]: JsonSchemaPropsV1Beta1 }; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#dependencies + */ + readonly dependencies?: { [key: string]: any }; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#description + */ + readonly description?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#enum + */ + readonly enum?: any[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#example + */ + readonly example?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#exclusiveMaximum + */ + readonly exclusiveMaximum?: boolean; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#exclusiveMinimum + */ + readonly exclusiveMinimum?: boolean; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#externalDocs + */ + readonly externalDocs?: ExternalDocumentationV1Beta1; + + /** + * format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated: + * + * - bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#format + */ + readonly format?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#id + */ + readonly id?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#items + */ + readonly items?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#maxItems + */ + readonly maxItems?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#maxLength + */ + readonly maxLength?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#maxProperties + */ + readonly maxProperties?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#maximum + */ + readonly maximum?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#minItems + */ + readonly minItems?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#minLength + */ + readonly minLength?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#minProperties + */ + readonly minProperties?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#minimum + */ + readonly minimum?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#multipleOf + */ + readonly multipleOf?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#not + */ + readonly not?: JsonSchemaPropsV1Beta1; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#nullable + */ + readonly nullable?: boolean; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#oneOf + */ + readonly oneOf?: JsonSchemaPropsV1Beta1[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#pattern + */ + readonly pattern?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#patternProperties + */ + readonly patternProperties?: { [key: string]: JsonSchemaPropsV1Beta1 }; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#properties + */ + readonly properties?: { [key: string]: JsonSchemaPropsV1Beta1 }; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#required + */ + readonly required?: string[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#title + */ + readonly title?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#type + */ + readonly type?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#uniqueItems + */ + readonly uniqueItems?: boolean; + + /** + * x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata). + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#x-kubernetes-embedded-resource + */ + readonly xKubernetesEmbeddedResource?: boolean; + + /** + * x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns: + * + * 1) anyOf: + * - type: integer + * - type: string + * 2) allOf: + * - anyOf: + * - type: integer + * - type: string + * - ... zero or more + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#x-kubernetes-int-or-string + */ + readonly xKubernetesIntOrString?: boolean; + + /** + * x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. + * + * This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported). + * + * The properties specified must either be required or have a default value, to ensure those properties are present for all list items. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#x-kubernetes-list-map-keys + */ + readonly xKubernetesListMapKeys?: string[]; + + /** + * x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values: + * + * 1) `atomic`: the list is treated as a single entity, like a scalar. + * Atomic lists will be entirely replaced when updated. This extension + * may be used on any type of list (struct, scalar, ...). + * 2) `set`: + * Sets are lists that must not have multiple items with the same value. Each + * value must be a scalar, an object with x-kubernetes-map-type `atomic` or an + * array with x-kubernetes-list-type `atomic`. + * 3) `map`: + * These lists are like maps in that their elements have a non-index key + * used to identify them. Order is preserved upon merge. The map tag + * must only be used on a list with elements of type object. + * Defaults to atomic for arrays. + * + * @default atomic for arrays. + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#x-kubernetes-list-type + */ + readonly xKubernetesListType?: string; + + /** + * x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values: + * + * 1) `granular`: + * These maps are actual maps (key-value pairs) and each fields are independent + * from each other (they can each be manipulated by separate actors). This is + * the default behaviour for all maps. + * 2) `atomic`: the list is treated as a single entity, like a scalar. + * Atomic maps will be entirely replaced when updated. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#x-kubernetes-map-type + */ + readonly xKubernetesMapType?: string; + + /** + * x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.JSONSchemaProps#x-kubernetes-preserve-unknown-fields + */ + readonly xKubernetesPreserveUnknownFields?: boolean; + +} + +/** + * Converts an object of type 'JsonSchemaPropsV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_JsonSchemaPropsV1Beta1(obj: JsonSchemaPropsV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + '$ref': obj.ref, + '$schema': obj.schema, + 'additionalItems': obj.additionalItems, + 'additionalProperties': obj.additionalProperties, + 'allOf': obj.allOf?.map(y => toJson_JsonSchemaPropsV1Beta1(y)), + 'anyOf': obj.anyOf?.map(y => toJson_JsonSchemaPropsV1Beta1(y)), + 'default': obj.default, + 'definitions': ((obj.definitions) === undefined) ? undefined : (Object.entries(obj.definitions).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: toJson_JsonSchemaPropsV1Beta1(i[1]) }), {})), + 'dependencies': ((obj.dependencies) === undefined) ? undefined : (Object.entries(obj.dependencies).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'description': obj.description, + 'enum': obj.enum?.map(y => y), + 'example': obj.example, + 'exclusiveMaximum': obj.exclusiveMaximum, + 'exclusiveMinimum': obj.exclusiveMinimum, + 'externalDocs': toJson_ExternalDocumentationV1Beta1(obj.externalDocs), + 'format': obj.format, + 'id': obj.id, + 'items': obj.items, + 'maxItems': obj.maxItems, + 'maxLength': obj.maxLength, + 'maxProperties': obj.maxProperties, + 'maximum': obj.maximum, + 'minItems': obj.minItems, + 'minLength': obj.minLength, + 'minProperties': obj.minProperties, + 'minimum': obj.minimum, + 'multipleOf': obj.multipleOf, + 'not': toJson_JsonSchemaPropsV1Beta1(obj.not), + 'nullable': obj.nullable, + 'oneOf': obj.oneOf?.map(y => toJson_JsonSchemaPropsV1Beta1(y)), + 'pattern': obj.pattern, + 'patternProperties': ((obj.patternProperties) === undefined) ? undefined : (Object.entries(obj.patternProperties).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: toJson_JsonSchemaPropsV1Beta1(i[1]) }), {})), + 'properties': ((obj.properties) === undefined) ? undefined : (Object.entries(obj.properties).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: toJson_JsonSchemaPropsV1Beta1(i[1]) }), {})), + 'required': obj.required?.map(y => y), + 'title': obj.title, + 'type': obj.type, + 'uniqueItems': obj.uniqueItems, + 'x-kubernetes-embedded-resource': obj.xKubernetesEmbeddedResource, + 'x-kubernetes-int-or-string': obj.xKubernetesIntOrString, + 'x-kubernetes-list-map-keys': obj.xKubernetesListMapKeys?.map(y => y), + 'x-kubernetes-list-type': obj.xKubernetesListType, + 'x-kubernetes-map-type': obj.xKubernetesMapType, + 'x-kubernetes-preserve-unknown-fields': obj.xKubernetesPreserveUnknownFields, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HPAScalingPolicy is a single policy which must hold true for a specified past interval. + * + * @schema io.k8s.api.autoscaling.v2beta2.HPAScalingPolicy + */ +export interface HpaScalingPolicyV2Beta2 { + /** + * PeriodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min). + * + * @schema io.k8s.api.autoscaling.v2beta2.HPAScalingPolicy#periodSeconds + */ + readonly periodSeconds: number; + + /** + * Type is used to specify the scaling policy. + * + * @schema io.k8s.api.autoscaling.v2beta2.HPAScalingPolicy#type + */ + readonly type: string; + + /** + * Value contains the amount of change which is permitted by the policy. It must be greater than zero + * + * @schema io.k8s.api.autoscaling.v2beta2.HPAScalingPolicy#value + */ + readonly value: number; + +} + +/** + * Converts an object of type 'HpaScalingPolicyV2Beta2' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HpaScalingPolicyV2Beta2(obj: HpaScalingPolicyV2Beta2 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'periodSeconds': obj.periodSeconds, + 'type': obj.type, + 'value': obj.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * MetricTarget defines the target value, average value, or average utilization of a specific metric + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricTarget + */ +export interface MetricTargetV2Beta2 { + /** + * averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricTarget#averageUtilization + */ + readonly averageUtilization?: number; + + /** + * averageValue is the target value of the average of the metric across all relevant pods (as a quantity) + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricTarget#averageValue + */ + readonly averageValue?: Quantity; + + /** + * type represents whether the metric type is Utilization, Value, or AverageValue + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricTarget#type + */ + readonly type: string; + + /** + * value is the target value of the metric (as a quantity). + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricTarget#value + */ + readonly value?: Quantity; + +} + +/** + * Converts an object of type 'MetricTargetV2Beta2' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_MetricTargetV2Beta2(obj: MetricTargetV2Beta2 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'averageUtilization': obj.averageUtilization, + 'averageValue': obj.averageValue?.value, + 'type': obj.type, + 'value': obj.value?.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * MetricIdentifier defines the name and optionally selector for a metric + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricIdentifier + */ +export interface MetricIdentifierV2Beta2 { + /** + * name is the name of the given metric + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricIdentifier#name + */ + readonly name: string; + + /** + * selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics. + * + * @schema io.k8s.api.autoscaling.v2beta2.MetricIdentifier#selector + */ + readonly selector?: LabelSelector; + +} + +/** + * Converts an object of type 'MetricIdentifierV2Beta2' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_MetricIdentifierV2Beta2(obj: MetricIdentifierV2Beta2 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + 'selector': toJson_LabelSelector(obj.selector), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Selects a key from a ConfigMap. + * + * @schema io.k8s.api.core.v1.ConfigMapKeySelector + */ +export interface ConfigMapKeySelector { + /** + * The key to select. + * + * @schema io.k8s.api.core.v1.ConfigMapKeySelector#key + */ + readonly key: string; + + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.ConfigMapKeySelector#name + */ + readonly name?: string; + + /** + * Specify whether the ConfigMap or its key must be defined + * + * @schema io.k8s.api.core.v1.ConfigMapKeySelector#optional + */ + readonly optional?: boolean; + +} + +/** + * Converts an object of type 'ConfigMapKeySelector' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ConfigMapKeySelector(obj: ConfigMapKeySelector | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'key': obj.key, + 'name': obj.name, + 'optional': obj.optional, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ObjectFieldSelector selects an APIVersioned field of an object. + * + * @schema io.k8s.api.core.v1.ObjectFieldSelector + */ +export interface ObjectFieldSelector { + /** + * Version of the schema the FieldPath is written in terms of, defaults to "v1". + * + * @schema io.k8s.api.core.v1.ObjectFieldSelector#apiVersion + */ + readonly apiVersion?: string; + + /** + * Path of the field to select in the specified API version. + * + * @schema io.k8s.api.core.v1.ObjectFieldSelector#fieldPath + */ + readonly fieldPath: string; + +} + +/** + * Converts an object of type 'ObjectFieldSelector' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ObjectFieldSelector(obj: ObjectFieldSelector | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'apiVersion': obj.apiVersion, + 'fieldPath': obj.fieldPath, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ResourceFieldSelector represents container resources (cpu, memory) and their output format + * + * @schema io.k8s.api.core.v1.ResourceFieldSelector + */ +export interface ResourceFieldSelector { + /** + * Container name: required for volumes, optional for env vars + * + * @schema io.k8s.api.core.v1.ResourceFieldSelector#containerName + */ + readonly containerName?: string; + + /** + * Specifies the output format of the exposed resources, defaults to "1" + * + * @schema io.k8s.api.core.v1.ResourceFieldSelector#divisor + */ + readonly divisor?: Quantity; + + /** + * Required: resource to select + * + * @schema io.k8s.api.core.v1.ResourceFieldSelector#resource + */ + readonly resource: string; + +} + +/** + * Converts an object of type 'ResourceFieldSelector' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ResourceFieldSelector(obj: ResourceFieldSelector | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'containerName': obj.containerName, + 'divisor': obj.divisor?.value, + 'resource': obj.resource, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * SecretKeySelector selects a key of a Secret. + * + * @schema io.k8s.api.core.v1.SecretKeySelector + */ +export interface SecretKeySelector { + /** + * The key of the secret to select from. Must be a valid secret key. + * + * @schema io.k8s.api.core.v1.SecretKeySelector#key + */ + readonly key: string; + + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.SecretKeySelector#name + */ + readonly name?: string; + + /** + * Specify whether the Secret or its key must be defined + * + * @schema io.k8s.api.core.v1.SecretKeySelector#optional + */ + readonly optional?: boolean; + +} + +/** + * Converts an object of type 'SecretKeySelector' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SecretKeySelector(obj: SecretKeySelector | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'key': obj.key, + 'name': obj.name, + 'optional': obj.optional, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HTTPHeader describes a custom header to be used in HTTP probes + * + * @schema io.k8s.api.core.v1.HTTPHeader + */ +export interface HttpHeader { + /** + * The header field name + * + * @schema io.k8s.api.core.v1.HTTPHeader#name + */ + readonly name: string; + + /** + * The header field value + * + * @schema io.k8s.api.core.v1.HTTPHeader#value + */ + readonly value: string; + +} + +/** + * Converts an object of type 'HttpHeader' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HttpHeader(obj: HttpHeader | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + 'value': obj.value, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. + * + * @schema io.k8s.api.core.v1.NodeSelectorTerm + */ +export interface NodeSelectorTerm { + /** + * A list of node selector requirements by node's labels. + * + * @schema io.k8s.api.core.v1.NodeSelectorTerm#matchExpressions + */ + readonly matchExpressions?: NodeSelectorRequirement[]; + + /** + * A list of node selector requirements by node's fields. + * + * @schema io.k8s.api.core.v1.NodeSelectorTerm#matchFields + */ + readonly matchFields?: NodeSelectorRequirement[]; + +} + +/** + * Converts an object of type 'NodeSelectorTerm' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NodeSelectorTerm(obj: NodeSelectorTerm | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'matchExpressions': obj.matchExpressions?.map(y => toJson_NodeSelectorRequirement(y)), + 'matchFields': obj.matchFields?.map(y => toJson_NodeSelectorRequirement(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). + * + * @schema io.k8s.api.core.v1.PreferredSchedulingTerm + */ +export interface PreferredSchedulingTerm { + /** + * A node selector term, associated with the corresponding weight. + * + * @schema io.k8s.api.core.v1.PreferredSchedulingTerm#preference + */ + readonly preference: NodeSelectorTerm; + + /** + * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. + * + * @schema io.k8s.api.core.v1.PreferredSchedulingTerm#weight + */ + readonly weight: number; + +} + +/** + * Converts an object of type 'PreferredSchedulingTerm' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PreferredSchedulingTerm(obj: PreferredSchedulingTerm | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'preference': toJson_NodeSelectorTerm(obj.preference), + 'weight': obj.weight, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) + * + * @schema io.k8s.api.core.v1.WeightedPodAffinityTerm + */ +export interface WeightedPodAffinityTerm { + /** + * Required. A pod affinity term, associated with the corresponding weight. + * + * @schema io.k8s.api.core.v1.WeightedPodAffinityTerm#podAffinityTerm + */ + readonly podAffinityTerm: PodAffinityTerm; + + /** + * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. + * + * @schema io.k8s.api.core.v1.WeightedPodAffinityTerm#weight + */ + readonly weight: number; + +} + +/** + * Converts an object of type 'WeightedPodAffinityTerm' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_WeightedPodAffinityTerm(obj: WeightedPodAffinityTerm | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'podAffinityTerm': toJson_PodAffinityTerm(obj.podAffinityTerm), + 'weight': obj.weight, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running + * + * @schema io.k8s.api.core.v1.PodAffinityTerm + */ +export interface PodAffinityTerm { + /** + * A label query over a set of resources, in this case pods. + * + * @schema io.k8s.api.core.v1.PodAffinityTerm#labelSelector + */ + readonly labelSelector?: LabelSelector; + + /** + * A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. This field is alpha-level and is only honored when PodAffinityNamespaceSelector feature is enabled. + * + * @schema io.k8s.api.core.v1.PodAffinityTerm#namespaceSelector + */ + readonly namespaceSelector?: LabelSelector; + + /** + * namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace" + * + * @schema io.k8s.api.core.v1.PodAffinityTerm#namespaces + */ + readonly namespaces?: string[]; + + /** + * This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. + * + * @schema io.k8s.api.core.v1.PodAffinityTerm#topologyKey + */ + readonly topologyKey: string; + +} + +/** + * Converts an object of type 'PodAffinityTerm' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PodAffinityTerm(obj: PodAffinityTerm | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'labelSelector': toJson_LabelSelector(obj.labelSelector), + 'namespaceSelector': toJson_LabelSelector(obj.namespaceSelector), + 'namespaces': obj.namespaces?.map(y => y), + 'topologyKey': obj.topologyKey, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Maps a string key to a path within a volume. + * + * @schema io.k8s.api.core.v1.KeyToPath + */ +export interface KeyToPath { + /** + * The key to project. + * + * @schema io.k8s.api.core.v1.KeyToPath#key + */ + readonly key: string; + + /** + * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * + * @schema io.k8s.api.core.v1.KeyToPath#mode + */ + readonly mode?: number; + + /** + * The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. + * + * @schema io.k8s.api.core.v1.KeyToPath#path + */ + readonly path: string; + +} + +/** + * Converts an object of type 'KeyToPath' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_KeyToPath(obj: KeyToPath | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'key': obj.key, + 'mode': obj.mode, + 'path': obj.path, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * DownwardAPIVolumeFile represents information to create the file containing the pod field + * + * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile + */ +export interface DownwardApiVolumeFile { + /** + * Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. + * + * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile#fieldRef + */ + readonly fieldRef?: ObjectFieldSelector; + + /** + * Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. + * + * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile#mode + */ + readonly mode?: number; + + /** + * Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' + * + * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile#path + */ + readonly path: string; + + /** + * Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + * + * @schema io.k8s.api.core.v1.DownwardAPIVolumeFile#resourceFieldRef + */ + readonly resourceFieldRef?: ResourceFieldSelector; + +} + +/** + * Converts an object of type 'DownwardApiVolumeFile' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_DownwardApiVolumeFile(obj: DownwardApiVolumeFile | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'fieldRef': toJson_ObjectFieldSelector(obj.fieldRef), + 'mode': obj.mode, + 'path': obj.path, + 'resourceFieldRef': toJson_ResourceFieldSelector(obj.resourceFieldRef), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimTemplate + */ +export interface PersistentVolumeClaimTemplate { + /** + * May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimTemplate#metadata + */ + readonly metadata?: ObjectMeta; + + /** + * The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. + * + * @schema io.k8s.api.core.v1.PersistentVolumeClaimTemplate#spec + */ + readonly spec: PersistentVolumeClaimSpec; + +} + +/** + * Converts an object of type 'PersistentVolumeClaimTemplate' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_PersistentVolumeClaimTemplate(obj: PersistentVolumeClaimTemplate | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'metadata': toJson_ObjectMeta(obj.metadata), + 'spec': toJson_PersistentVolumeClaimSpec(obj.spec), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Projection that may be projected along with other supported volume types + * + * @schema io.k8s.api.core.v1.VolumeProjection + */ +export interface VolumeProjection { + /** + * information about the configMap data to project + * + * @schema io.k8s.api.core.v1.VolumeProjection#configMap + */ + readonly configMap?: ConfigMapProjection; + + /** + * information about the downwardAPI data to project + * + * @schema io.k8s.api.core.v1.VolumeProjection#downwardAPI + */ + readonly downwardApi?: DownwardApiProjection; + + /** + * information about the secret data to project + * + * @schema io.k8s.api.core.v1.VolumeProjection#secret + */ + readonly secret?: SecretProjection; + + /** + * information about the serviceAccountToken data to project + * + * @schema io.k8s.api.core.v1.VolumeProjection#serviceAccountToken + */ + readonly serviceAccountToken?: ServiceAccountTokenProjection; + +} + +/** + * Converts an object of type 'VolumeProjection' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_VolumeProjection(obj: VolumeProjection | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'configMap': toJson_ConfigMapProjection(obj.configMap), + 'downwardAPI': toJson_DownwardApiProjection(obj.downwardApi), + 'secret': toJson_SecretProjection(obj.secret), + 'serviceAccountToken': toJson_ServiceAccountTokenProjection(obj.serviceAccountToken), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend. + * + * @schema io.k8s.api.networking.v1beta1.HTTPIngressPath + */ +export interface HttpIngressPathV1Beta1 { + /** + * Backend defines the referenced service endpoint to which the traffic will be forwarded to. + * + * @schema io.k8s.api.networking.v1beta1.HTTPIngressPath#backend + */ + readonly backend: IngressBackendV1Beta1; + + /** + * Path is 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 '/'. When unspecified, all paths from incoming requests are matched. + * + * @schema io.k8s.api.networking.v1beta1.HTTPIngressPath#path + */ + readonly path?: string; + + /** + * PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is + * done on a path element by element basis. A path element refers is the + * list of labels in the path split by the '/' separator. A request is a + * match for path p if every p is an element-wise prefix of p of the + * request path. Note that if the last element of the path is a substring + * of the last element in request path, it is not a match (e.g. /foo/bar + * matches /foo/bar/baz, but does not match /foo/barbaz). + * * ImplementationSpecific: Interpretation of the Path matching is up to + * the IngressClass. Implementations can treat this as a separate PathType + * or treat it identically to Prefix or Exact path types. + * Implementations are required to support all path types. Defaults to ImplementationSpecific. + * + * @default ImplementationSpecific. + * @schema io.k8s.api.networking.v1beta1.HTTPIngressPath#pathType + */ + readonly pathType?: string; + +} + +/** + * Converts an object of type 'HttpIngressPathV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HttpIngressPathV1Beta1(obj: HttpIngressPathV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'backend': toJson_IngressBackendV1Beta1(obj.backend), + 'path': obj.path, + 'pathType': obj.pathType, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * QueuingConfiguration holds the configuration parameters for queuing + * + * @schema io.k8s.api.flowcontrol.v1beta1.QueuingConfiguration + */ +export interface QueuingConfigurationV1Beta1 { + /** + * `handSize` is a small positive number that configures the shuffle sharding of requests into queues. When enqueuing a request at this priority level the request's flow identifier (a string pair) is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here. The request is put into one of the shortest queues in that hand. `handSize` must be no larger than `queues`, and should be significantly smaller (so that a few heavy flows do not saturate most of the queues). See the user-facing documentation for more extensive guidance on setting this field. This field has a default value of 8. + * + * @schema io.k8s.api.flowcontrol.v1beta1.QueuingConfiguration#handSize + */ + readonly handSize?: number; + + /** + * `queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; excess requests are rejected. This value must be positive. If not specified, it will be defaulted to 50. + * + * @schema io.k8s.api.flowcontrol.v1beta1.QueuingConfiguration#queueLengthLimit + */ + readonly queueLengthLimit?: number; + + /** + * `queues` is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64. + * + * @schema io.k8s.api.flowcontrol.v1beta1.QueuingConfiguration#queues + */ + readonly queues?: number; + +} + +/** + * Converts an object of type 'QueuingConfigurationV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_QueuingConfigurationV1Beta1(obj: QueuingConfigurationV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'handSize': obj.handSize, + 'queueLengthLimit': obj.queueLengthLimit, + 'queues': obj.queues, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ServiceBackendPort is the service port being referenced. + * + * @schema io.k8s.api.networking.v1.ServiceBackendPort + */ +export interface ServiceBackendPort { + /** + * Name is the name of the port on the Service. This is a mutually exclusive setting with "Number". + * + * @schema io.k8s.api.networking.v1.ServiceBackendPort#name + */ + readonly name?: string; + + /** + * Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name". + * + * @schema io.k8s.api.networking.v1.ServiceBackendPort#number + */ + readonly number?: number; + +} + +/** + * Converts an object of type 'ServiceBackendPort' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ServiceBackendPort(obj: ServiceBackendPort | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'name': obj.name, + 'number': obj.number, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend. + * + * @schema io.k8s.api.networking.v1.HTTPIngressPath + */ +export interface HttpIngressPath { + /** + * Backend defines the referenced service endpoint to which the traffic will be forwarded to. + * + * @schema io.k8s.api.networking.v1.HTTPIngressPath#backend + */ + readonly backend: IngressBackend; + + /** + * Path is 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 '/'. When unspecified, all paths from incoming requests are matched. + * + * @schema io.k8s.api.networking.v1.HTTPIngressPath#path + */ + readonly path?: string; + + /** + * PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is + * done on a path element by element basis. A path element refers is the + * list of labels in the path split by the '/' separator. A request is a + * match for path p if every p is an element-wise prefix of p of the + * request path. Note that if the last element of the path is a substring + * of the last element in request path, it is not a match (e.g. /foo/bar + * matches /foo/bar/baz, but does not match /foo/barbaz). + * * ImplementationSpecific: Interpretation of the Path matching is up to + * the IngressClass. Implementations can treat this as a separate PathType + * or treat it identically to Prefix or Exact path types. + * Implementations are required to support all path types. + * + * @schema io.k8s.api.networking.v1.HTTPIngressPath#pathType + */ + readonly pathType?: string; + +} + +/** + * Converts an object of type 'HttpIngressPath' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_HttpIngressPath(obj: HttpIngressPath | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'backend': toJson_IngressBackend(obj.backend), + 'path': obj.path, + 'pathType': obj.pathType, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule. + * + * @schema io.k8s.api.networking.v1.IPBlock + */ +export interface IpBlock { + /** + * CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" + * + * @schema io.k8s.api.networking.v1.IPBlock#cidr + */ + readonly cidr: string; + + /** + * Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range + * + * @schema io.k8s.api.networking.v1.IPBlock#except + */ + readonly except?: string[]; + +} + +/** + * Converts an object of type 'IpBlock' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_IpBlock(obj: IpBlock | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'cidr': obj.cidr, + 'except': obj.except?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/). + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps + */ +export interface JsonSchemaProps { + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#$ref + */ + readonly ref?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#$schema + */ + readonly schema?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#additionalItems + */ + readonly additionalItems?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#additionalProperties + */ + readonly additionalProperties?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#allOf + */ + readonly allOf?: JsonSchemaProps[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#anyOf + */ + readonly anyOf?: JsonSchemaProps[]; + + /** + * default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#default + */ + readonly default?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#definitions + */ + readonly definitions?: { [key: string]: JsonSchemaProps }; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#dependencies + */ + readonly dependencies?: { [key: string]: any }; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#description + */ + readonly description?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#enum + */ + readonly enum?: any[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#example + */ + readonly example?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#exclusiveMaximum + */ + readonly exclusiveMaximum?: boolean; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#exclusiveMinimum + */ + readonly exclusiveMinimum?: boolean; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#externalDocs + */ + readonly externalDocs?: ExternalDocumentation; + + /** + * format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated: + * + * - bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#format + */ + readonly format?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#id + */ + readonly id?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#items + */ + readonly items?: any; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#maxItems + */ + readonly maxItems?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#maxLength + */ + readonly maxLength?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#maxProperties + */ + readonly maxProperties?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#maximum + */ + readonly maximum?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#minItems + */ + readonly minItems?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#minLength + */ + readonly minLength?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#minProperties + */ + readonly minProperties?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#minimum + */ + readonly minimum?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#multipleOf + */ + readonly multipleOf?: number; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#not + */ + readonly not?: JsonSchemaProps; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#nullable + */ + readonly nullable?: boolean; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#oneOf + */ + readonly oneOf?: JsonSchemaProps[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#pattern + */ + readonly pattern?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#patternProperties + */ + readonly patternProperties?: { [key: string]: JsonSchemaProps }; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#properties + */ + readonly properties?: { [key: string]: JsonSchemaProps }; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#required + */ + readonly required?: string[]; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#title + */ + readonly title?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#type + */ + readonly type?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#uniqueItems + */ + readonly uniqueItems?: boolean; + + /** + * x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata). + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#x-kubernetes-embedded-resource + */ + readonly xKubernetesEmbeddedResource?: boolean; + + /** + * x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns: + * + * 1) anyOf: + * - type: integer + * - type: string + * 2) allOf: + * - anyOf: + * - type: integer + * - type: string + * - ... zero or more + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#x-kubernetes-int-or-string + */ + readonly xKubernetesIntOrString?: boolean; + + /** + * x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. + * + * This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported). + * + * The properties specified must either be required or have a default value, to ensure those properties are present for all list items. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#x-kubernetes-list-map-keys + */ + readonly xKubernetesListMapKeys?: string[]; + + /** + * x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values: + * + * 1) `atomic`: the list is treated as a single entity, like a scalar. + * Atomic lists will be entirely replaced when updated. This extension + * may be used on any type of list (struct, scalar, ...). + * 2) `set`: + * Sets are lists that must not have multiple items with the same value. Each + * value must be a scalar, an object with x-kubernetes-map-type `atomic` or an + * array with x-kubernetes-list-type `atomic`. + * 3) `map`: + * These lists are like maps in that their elements have a non-index key + * used to identify them. Order is preserved upon merge. The map tag + * must only be used on a list with elements of type object. + * Defaults to atomic for arrays. + * + * @default atomic for arrays. + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#x-kubernetes-list-type + */ + readonly xKubernetesListType?: string; + + /** + * x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values: + * + * 1) `granular`: + * These maps are actual maps (key-value pairs) and each fields are independent + * from each other (they can each be manipulated by separate actors). This is + * the default behaviour for all maps. + * 2) `atomic`: the list is treated as a single entity, like a scalar. + * Atomic maps will be entirely replaced when updated. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#x-kubernetes-map-type + */ + readonly xKubernetesMapType?: string; + + /** + * x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps#x-kubernetes-preserve-unknown-fields + */ + readonly xKubernetesPreserveUnknownFields?: boolean; + +} + +/** + * Converts an object of type 'JsonSchemaProps' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_JsonSchemaProps(obj: JsonSchemaProps | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + '$ref': obj.ref, + '$schema': obj.schema, + 'additionalItems': obj.additionalItems, + 'additionalProperties': obj.additionalProperties, + 'allOf': obj.allOf?.map(y => toJson_JsonSchemaProps(y)), + 'anyOf': obj.anyOf?.map(y => toJson_JsonSchemaProps(y)), + 'default': obj.default, + 'definitions': ((obj.definitions) === undefined) ? undefined : (Object.entries(obj.definitions).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: toJson_JsonSchemaProps(i[1]) }), {})), + 'dependencies': ((obj.dependencies) === undefined) ? undefined : (Object.entries(obj.dependencies).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {})), + 'description': obj.description, + 'enum': obj.enum?.map(y => y), + 'example': obj.example, + 'exclusiveMaximum': obj.exclusiveMaximum, + 'exclusiveMinimum': obj.exclusiveMinimum, + 'externalDocs': toJson_ExternalDocumentation(obj.externalDocs), + 'format': obj.format, + 'id': obj.id, + 'items': obj.items, + 'maxItems': obj.maxItems, + 'maxLength': obj.maxLength, + 'maxProperties': obj.maxProperties, + 'maximum': obj.maximum, + 'minItems': obj.minItems, + 'minLength': obj.minLength, + 'minProperties': obj.minProperties, + 'minimum': obj.minimum, + 'multipleOf': obj.multipleOf, + 'not': toJson_JsonSchemaProps(obj.not), + 'nullable': obj.nullable, + 'oneOf': obj.oneOf?.map(y => toJson_JsonSchemaProps(y)), + 'pattern': obj.pattern, + 'patternProperties': ((obj.patternProperties) === undefined) ? undefined : (Object.entries(obj.patternProperties).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: toJson_JsonSchemaProps(i[1]) }), {})), + 'properties': ((obj.properties) === undefined) ? undefined : (Object.entries(obj.properties).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: toJson_JsonSchemaProps(i[1]) }), {})), + 'required': obj.required?.map(y => y), + 'title': obj.title, + 'type': obj.type, + 'uniqueItems': obj.uniqueItems, + 'x-kubernetes-embedded-resource': obj.xKubernetesEmbeddedResource, + 'x-kubernetes-int-or-string': obj.xKubernetesIntOrString, + 'x-kubernetes-list-map-keys': obj.xKubernetesListMapKeys?.map(y => y), + 'x-kubernetes-list-type': obj.xKubernetesListType, + 'x-kubernetes-map-type': obj.xKubernetesMapType, + 'x-kubernetes-preserve-unknown-fields': obj.xKubernetesPreserveUnknownFields, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresourceScale + */ +export interface CustomResourceSubresourceScale { + /** + * labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresourceScale#labelSelectorPath + */ + readonly labelSelectorPath?: string; + + /** + * specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresourceScale#specReplicasPath + */ + readonly specReplicasPath: string; + + /** + * statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresourceScale#statusReplicasPath + */ + readonly statusReplicasPath: string; + +} + +/** + * Converts an object of type 'CustomResourceSubresourceScale' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_CustomResourceSubresourceScale(obj: CustomResourceSubresourceScale | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'labelSelectorPath': obj.labelSelectorPath, + 'specReplicasPath': obj.specReplicasPath, + 'statusReplicasPath': obj.statusReplicasPath, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ExternalDocumentation allows referencing an external resource for extended documentation. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.ExternalDocumentation + */ +export interface ExternalDocumentationV1Beta1 { + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.ExternalDocumentation#description + */ + readonly description?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1beta1.ExternalDocumentation#url + */ + readonly url?: string; + +} + +/** + * Converts an object of type 'ExternalDocumentationV1Beta1' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ExternalDocumentationV1Beta1(obj: ExternalDocumentationV1Beta1 | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'description': obj.description, + 'url': obj.url, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + * + * @schema io.k8s.api.core.v1.NodeSelectorRequirement + */ +export interface NodeSelectorRequirement { + /** + * The label key that the selector applies to. + * + * @schema io.k8s.api.core.v1.NodeSelectorRequirement#key + */ + readonly key: string; + + /** + * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. + * + * @schema io.k8s.api.core.v1.NodeSelectorRequirement#operator + */ + readonly operator: string; + + /** + * An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. + * + * @schema io.k8s.api.core.v1.NodeSelectorRequirement#values + */ + readonly values?: string[]; + +} + +/** + * Converts an object of type 'NodeSelectorRequirement' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_NodeSelectorRequirement(obj: NodeSelectorRequirement | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'key': obj.key, + 'operator': obj.operator, + 'values': obj.values?.map(y => y), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Adapts a ConfigMap into a projected volume. + * + * The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. + * + * @schema io.k8s.api.core.v1.ConfigMapProjection + */ +export interface ConfigMapProjection { + /** + * 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. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + * + * @schema io.k8s.api.core.v1.ConfigMapProjection#items + */ + readonly items?: KeyToPath[]; + + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.ConfigMapProjection#name + */ + readonly name?: string; + + /** + * Specify whether the ConfigMap or its keys must be defined + * + * @schema io.k8s.api.core.v1.ConfigMapProjection#optional + */ + readonly optional?: boolean; + +} + +/** + * Converts an object of type 'ConfigMapProjection' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ConfigMapProjection(obj: ConfigMapProjection | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KeyToPath(y)), + 'name': obj.name, + 'optional': obj.optional, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. + * + * @schema io.k8s.api.core.v1.DownwardAPIProjection + */ +export interface DownwardApiProjection { + /** + * Items is a list of DownwardAPIVolume file + * + * @schema io.k8s.api.core.v1.DownwardAPIProjection#items + */ + readonly items?: DownwardApiVolumeFile[]; + +} + +/** + * Converts an object of type 'DownwardApiProjection' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_DownwardApiProjection(obj: DownwardApiProjection | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_DownwardApiVolumeFile(y)), + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * Adapts a secret into a projected volume. + * + * The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. + * + * @schema io.k8s.api.core.v1.SecretProjection + */ +export interface SecretProjection { + /** + * 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. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. + * + * @schema io.k8s.api.core.v1.SecretProjection#items + */ + readonly items?: KeyToPath[]; + + /** + * Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + * + * @schema io.k8s.api.core.v1.SecretProjection#name + */ + readonly name?: string; + + /** + * Specify whether the Secret or its key must be defined + * + * @schema io.k8s.api.core.v1.SecretProjection#optional + */ + readonly optional?: boolean; + +} + +/** + * Converts an object of type 'SecretProjection' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_SecretProjection(obj: SecretProjection | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'items': obj.items?.map(y => toJson_KeyToPath(y)), + 'name': obj.name, + 'optional': obj.optional, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). + * + * @schema io.k8s.api.core.v1.ServiceAccountTokenProjection + */ +export interface ServiceAccountTokenProjection { + /** + * Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. + * + * @schema io.k8s.api.core.v1.ServiceAccountTokenProjection#audience + */ + readonly audience?: string; + + /** + * ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. + * + * @default 1 hour and must be at least 10 minutes. + * @schema io.k8s.api.core.v1.ServiceAccountTokenProjection#expirationSeconds + */ + readonly expirationSeconds?: number; + + /** + * Path is the path relative to the mount point of the file to project the token into. + * + * @schema io.k8s.api.core.v1.ServiceAccountTokenProjection#path + */ + readonly path: string; + +} + +/** + * Converts an object of type 'ServiceAccountTokenProjection' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ServiceAccountTokenProjection(obj: ServiceAccountTokenProjection | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'audience': obj.audience, + 'expirationSeconds': obj.expirationSeconds, + 'path': obj.path, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + +/** + * ExternalDocumentation allows referencing an external resource for extended documentation. + * + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ExternalDocumentation + */ +export interface ExternalDocumentation { + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ExternalDocumentation#description + */ + readonly description?: string; + + /** + * @schema io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ExternalDocumentation#url + */ + readonly url?: string; + +} + +/** + * Converts an object of type 'ExternalDocumentation' to JSON representation. + */ +/* eslint-disable max-len, quote-props */ +export function toJson_ExternalDocumentation(obj: ExternalDocumentation | undefined): Record | undefined { + if (obj === undefined) { return undefined; } + const result = { + 'description': obj.description, + 'url': obj.url, + }; + // filter undefined values + return Object.entries(result).reduce((r, i) => (i[1] === undefined) ? r : ({ ...r, [i[0]]: i[1] }), {}); +} +/* eslint-enable max-len, quote-props */ + diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..7538152 --- /dev/null +++ b/src/index.ts @@ -0,0 +1,190 @@ +import * as fs from 'fs'; +import * as path from 'path'; +import { Construct } from 'constructs'; +import * as k8s from './imports/k8s'; +export * as k8s from './imports/k8s'; + +export interface BotKubeOptions { + /** + * Your BotKube communication secret name. + * + * @default - botkube-communication-secret + */ + readonly secretName?: string; + + /** + * String formatted in YAML format defining your BotKube monitoring configuration. + * + * @default - botkube default + */ + readonly configMapData?: string; + + /** + * Number of BotKubt replicas to be spawned. + * + * @default - 1 + */ + readonly replicas?: number; + + /** + * Node selector value for the BotKube deployment. + * + * @default - empty object + */ + readonly nodeSelector?: { [key: string]: string }; + + /** + * Tolerations value for the BotKube deployment. + * + * @default - empty array + */ + readonly tolerations?: k8s.Toleration[]; +} + +export class BotKube extends Construct { + constructor(scope: Construct, id: string, options?: BotKubeOptions) { + super(scope, id); + + const configMap = fs + .readFileSync(path.resolve(__dirname, '../configmap.yaml'), 'utf-8') + .split('\n'); + const secretName = options?.secretName ?? 'botkube-communication-secret'; + const configMapData = options?.configMapData ?? JSON.stringify(configMap); + const replicas = options?.replicas ?? 1; + const nodeSelector = options?.nodeSelector ?? {}; + const tolerations = options?.tolerations ?? []; + + new k8s.KubeConfigMap(this, 'botkube-config-map', { + metadata: { + name: 'botkube-configmap', + labels: { + app: 'botkube', + }, + }, + data: { + 'resource_config.yaml': configMapData, + }, + }); + + new k8s.KubeServiceAccount(this, 'botkube-service-account', { + metadata: { + name: 'botkube-service-account', + labels: { + app: 'botkube', + }, + }, + }); + + new k8s.KubeClusterRole(this, 'botkube-cluster-role', { + metadata: { + name: 'botkube-cluster-role', + }, + rules: [ + { + apiGroups: ['*'], + resources: ['*'], + verbs: ['get', 'watch', 'list'], + }, + ], + }); + + new k8s.KubeClusterRoleBinding(this, 'botkube-cluster-role-binding', { + metadata: { + name: 'botkube-service-account', + labels: { + app: 'botkube', + }, + }, + roleRef: { + apiGroup: 'rbac.authorization.k8s.io', + kind: 'ClusterRole', + name: 'botkube-clusterrole', + }, + subjects: [ + { + kind: 'ServiceAccounts', + name: 'botkube-service-account', + }, + ], + }); + + new k8s.KubeDeployment(this, 'botkube', { + metadata: { + name: 'botkube', + + labels: { + component: 'controller', + app: 'botkube', + }, + }, + spec: { + replicas: replicas, + selector: { + matchLabels: { + component: 'controller', + app: 'botkube', + }, + }, + template: { + metadata: { + labels: { + component: 'controller', + app: 'botkube', + }, + }, + spec: { + serviceAccountName: 'botkube-sa', + nodeSelector: nodeSelector, + tolerations: tolerations, + containers: [ + { + name: 'botkube', + image: 'ghcr.io/infracloudio/botkube:v0.12.4', + imagePullPolicy: 'IfNotPresent', + volumeMounts: [ + { + name: 'config-volume', + mountPath: '/config', + }, + ], + env: [ + { + name: 'CONFIG_PATH', + value: '/config/', + }, + { + name: 'LOG_LEVEL', + value: 'info', + }, + ], + }, + ], + volumes: [ + { + name: 'config-volume', + projected: { + sources: [ + { + configMap: { + name: 'botkube-config-map', + }, + }, + { + secret: { + name: secretName, + }, + }, + ], + }, + }, + ], + securityContext: { + runAsUser: 101, + runAsGroup: 101, + }, + }, + }, + }, + }); + } +} diff --git a/test/__snapshots__/hello.test.ts.snap b/test/__snapshots__/hello.test.ts.snap new file mode 100644 index 0000000..ba47c38 --- /dev/null +++ b/test/__snapshots__/hello.test.ts.snap @@ -0,0 +1,760 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`botkube-configmap 1`] = ` +Array [ + Object { + "apiVersion": "v1", + "data": Object { + "resource_config.yaml": "testConfigMap", + }, + "kind": "ConfigMap", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-configmap", + }, + }, + Object { + "apiVersion": "v1", + "kind": "ServiceAccount", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-service-account", + }, + }, + Object { + "apiVersion": "rbac.authorization.k8s.io/v1", + "kind": "ClusterRole", + "metadata": Object { + "name": "botkube-cluster-role", + }, + "rules": Array [ + Object { + "apiGroups": Array [ + "*", + ], + "resources": Array [ + "*", + ], + "verbs": Array [ + "get", + "watch", + "list", + ], + }, + ], + }, + Object { + "apiVersion": "rbac.authorization.k8s.io/v1", + "kind": "ClusterRoleBinding", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-service-account", + }, + "roleRef": Object { + "apiGroup": "rbac.authorization.k8s.io", + "kind": "ClusterRole", + "name": "botkube-clusterrole", + }, + "subjects": Array [ + Object { + "kind": "ServiceAccounts", + "name": "botkube-service-account", + }, + ], + }, + Object { + "apiVersion": "apps/v1", + "kind": "Deployment", + "metadata": Object { + "labels": Object { + "app": "botkube", + "component": "controller", + }, + "name": "botkube", + }, + "spec": Object { + "replicas": 1, + "selector": Object { + "matchLabels": Object { + "app": "botkube", + "component": "controller", + }, + }, + "template": Object { + "metadata": Object { + "labels": Object { + "app": "botkube", + "component": "controller", + }, + }, + "spec": Object { + "containers": Array [ + Object { + "env": Array [ + Object { + "name": "CONFIG_PATH", + "value": "/config/", + }, + Object { + "name": "LOG_LEVEL", + "value": "info", + }, + ], + "image": "ghcr.io/infracloudio/botkube:v0.12.4", + "imagePullPolicy": "IfNotPresent", + "name": "botkube", + "volumeMounts": Array [ + Object { + "mountPath": "/config", + "name": "config-volume", + }, + ], + }, + ], + "nodeSelector": Object {}, + "securityContext": Object { + "runAsGroup": 101, + "runAsUser": 101, + }, + "serviceAccountName": "botkube-sa", + "tolerations": Array [], + "volumes": Array [ + Object { + "name": "config-volume", + "projected": Object { + "sources": Array [ + Object { + "configMap": Object { + "name": "botkube-config-map", + }, + }, + Object { + "secret": Object { + "name": "botkube-communication-secret", + }, + }, + ], + }, + }, + ], + }, + }, + }, + }, +] +`; + +exports[`botkube-default 1`] = ` +Array [ + Object { + "apiVersion": "v1", + "data": Object { + "resource_config.yaml": "[\\"## Resources you want to watch\\",\\"resources:\\",\\"- name: RESOURCE # K8s Resource you want to monitor.\\",\\" # Resource name must be in\\",\\" # group/version/resource (G/V/R) format\\",\\" # for core resources with no group,\\",\\" # ignore group fron g/v/r and use v/r\\",\\" # resource name should be plural\\",\\" # (e.g v1/pods, v1.ingresses, etc)\\",\\"\\",\\" namespaces: \\",\\" include: # List of namespaces to monitor for\\",\\" # the RESOURCE events\\",\\" - namespace/all # Use all to monitor all the resources\\",\\"\\",\\" ignore: # List of namespaces to be ignored\\",\\" # used only with include: all\\",\\" - # example : include [all], ignore [x,y,z]\\",\\"\\",\\" events: # List of lifecycle events you want to\\",\\" - create # receive notifications about\\",\\" - update # Valid options are: \\",\\" - delete # create, update, delete, error OR all\\",\\" - error\\",\\" \\",\\" updateSetting: # Set include diff with the update event \\",\\" # about the changes in specific fields\\",\\" includeDiff: true # updateSettings are ignored if \`update\`\\",\\" # events are not configured for the resource\\",\\"\\",\\" fields:\\",\\" - JSONPath # List of JSONPath expressions to monitor\\",\\" # changes in specific fields\\",\\"- name: apps/v1/deployments\\",\\" namespaces:\\",\\" include:\\",\\" - dev\\",\\" - qa\\",\\" - default\\",\\" ignore:\\",\\" - kube-system\\",\\" - prod\\",\\" updateSetting:\\",\\" includeDiff: true\\",\\" fields:\\",\\" - spec.template.spec.containers[*].image\\",\\" - status.availableReplicas\\",\\" events:\\",\\" - all\\",\\"\\",\\"# Check true if you want to receive recommendations\\",\\"# about the best practices for the created resource\\",\\"recommendations: true\\",\\"\\",\\"# Cluster Setting to manage command execution access\\",\\"settings:\\",\\" # Set cluster name to differentiate incoming messages\\",\\" clustername: not-configured\\",\\" # Kubectl executor configs\\",\\" kubectl:\\",\\" # Set true to enable kubectl commands execution\\",\\" enabled: false\\",\\" # List of allowed commands\\",\\" commands:\\",\\" # kubectl method which are allowed with BotKube command\\",\\" verbs: [\\\\\\"api-resources\\\\\\", \\\\\\"api-versions\\\\\\", \\\\\\"cluster-info\\\\\\", \\\\\\"describe\\\\\\", \\\\\\"diff\\\\\\", \\\\\\"explain\\\\\\", \\\\\\"get\\\\\\", \\\\\\"logs\\\\\\", \\\\\\"top\\\\\\", \\\\\\"auth\\\\\\"]\\",\\" # resources on which kubectl methods are allowed with BotKube commands\\",\\" resources: [\\\\\\"deployments\\\\\\", \\\\\\"pods\\\\\\" , \\\\\\"namespaces\\\\\\", \\\\\\"daemonsets\\\\\\", \\\\\\"statefulsets\\\\\\", \\\\\\"storageclasses\\\\\\", \\\\\\"nodes\\\\\\"]\\",\\" # set Namespace to execute botkube kubectl commands by default\\",\\" defaultNamespace: default\\",\\" # Set true to enable commands execution from configured channel only\\",\\" restrictAccess: false\\",\\" # Set true to enable config watcher\\",\\" configwatcher: true\\",\\" # Set false to disable upgrade notification\\",\\" upgradeNotifier: true\\"]", + }, + "kind": "ConfigMap", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-configmap", + }, + }, + Object { + "apiVersion": "v1", + "kind": "ServiceAccount", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-service-account", + }, + }, + Object { + "apiVersion": "rbac.authorization.k8s.io/v1", + "kind": "ClusterRole", + "metadata": Object { + "name": "botkube-cluster-role", + }, + "rules": Array [ + Object { + "apiGroups": Array [ + "*", + ], + "resources": Array [ + "*", + ], + "verbs": Array [ + "get", + "watch", + "list", + ], + }, + ], + }, + Object { + "apiVersion": "rbac.authorization.k8s.io/v1", + "kind": "ClusterRoleBinding", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-service-account", + }, + "roleRef": Object { + "apiGroup": "rbac.authorization.k8s.io", + "kind": "ClusterRole", + "name": "botkube-clusterrole", + }, + "subjects": Array [ + Object { + "kind": "ServiceAccounts", + "name": "botkube-service-account", + }, + ], + }, + Object { + "apiVersion": "apps/v1", + "kind": "Deployment", + "metadata": Object { + "labels": Object { + "app": "botkube", + "component": "controller", + }, + "name": "botkube", + }, + "spec": Object { + "replicas": 1, + "selector": Object { + "matchLabels": Object { + "app": "botkube", + "component": "controller", + }, + }, + "template": Object { + "metadata": Object { + "labels": Object { + "app": "botkube", + "component": "controller", + }, + }, + "spec": Object { + "containers": Array [ + Object { + "env": Array [ + Object { + "name": "CONFIG_PATH", + "value": "/config/", + }, + Object { + "name": "LOG_LEVEL", + "value": "info", + }, + ], + "image": "ghcr.io/infracloudio/botkube:v0.12.4", + "imagePullPolicy": "IfNotPresent", + "name": "botkube", + "volumeMounts": Array [ + Object { + "mountPath": "/config", + "name": "config-volume", + }, + ], + }, + ], + "nodeSelector": Object {}, + "securityContext": Object { + "runAsGroup": 101, + "runAsUser": 101, + }, + "serviceAccountName": "botkube-sa", + "tolerations": Array [], + "volumes": Array [ + Object { + "name": "config-volume", + "projected": Object { + "sources": Array [ + Object { + "configMap": Object { + "name": "botkube-config-map", + }, + }, + Object { + "secret": Object { + "name": "botkube-communication-secret", + }, + }, + ], + }, + }, + ], + }, + }, + }, + }, +] +`; + +exports[`botkube-nodeselector 1`] = ` +Array [ + Object { + "apiVersion": "v1", + "data": Object { + "resource_config.yaml": "[\\"## Resources you want to watch\\",\\"resources:\\",\\"- name: RESOURCE # K8s Resource you want to monitor.\\",\\" # Resource name must be in\\",\\" # group/version/resource (G/V/R) format\\",\\" # for core resources with no group,\\",\\" # ignore group fron g/v/r and use v/r\\",\\" # resource name should be plural\\",\\" # (e.g v1/pods, v1.ingresses, etc)\\",\\"\\",\\" namespaces: \\",\\" include: # List of namespaces to monitor for\\",\\" # the RESOURCE events\\",\\" - namespace/all # Use all to monitor all the resources\\",\\"\\",\\" ignore: # List of namespaces to be ignored\\",\\" # used only with include: all\\",\\" - # example : include [all], ignore [x,y,z]\\",\\"\\",\\" events: # List of lifecycle events you want to\\",\\" - create # receive notifications about\\",\\" - update # Valid options are: \\",\\" - delete # create, update, delete, error OR all\\",\\" - error\\",\\" \\",\\" updateSetting: # Set include diff with the update event \\",\\" # about the changes in specific fields\\",\\" includeDiff: true # updateSettings are ignored if \`update\`\\",\\" # events are not configured for the resource\\",\\"\\",\\" fields:\\",\\" - JSONPath # List of JSONPath expressions to monitor\\",\\" # changes in specific fields\\",\\"- name: apps/v1/deployments\\",\\" namespaces:\\",\\" include:\\",\\" - dev\\",\\" - qa\\",\\" - default\\",\\" ignore:\\",\\" - kube-system\\",\\" - prod\\",\\" updateSetting:\\",\\" includeDiff: true\\",\\" fields:\\",\\" - spec.template.spec.containers[*].image\\",\\" - status.availableReplicas\\",\\" events:\\",\\" - all\\",\\"\\",\\"# Check true if you want to receive recommendations\\",\\"# about the best practices for the created resource\\",\\"recommendations: true\\",\\"\\",\\"# Cluster Setting to manage command execution access\\",\\"settings:\\",\\" # Set cluster name to differentiate incoming messages\\",\\" clustername: not-configured\\",\\" # Kubectl executor configs\\",\\" kubectl:\\",\\" # Set true to enable kubectl commands execution\\",\\" enabled: false\\",\\" # List of allowed commands\\",\\" commands:\\",\\" # kubectl method which are allowed with BotKube command\\",\\" verbs: [\\\\\\"api-resources\\\\\\", \\\\\\"api-versions\\\\\\", \\\\\\"cluster-info\\\\\\", \\\\\\"describe\\\\\\", \\\\\\"diff\\\\\\", \\\\\\"explain\\\\\\", \\\\\\"get\\\\\\", \\\\\\"logs\\\\\\", \\\\\\"top\\\\\\", \\\\\\"auth\\\\\\"]\\",\\" # resources on which kubectl methods are allowed with BotKube commands\\",\\" resources: [\\\\\\"deployments\\\\\\", \\\\\\"pods\\\\\\" , \\\\\\"namespaces\\\\\\", \\\\\\"daemonsets\\\\\\", \\\\\\"statefulsets\\\\\\", \\\\\\"storageclasses\\\\\\", \\\\\\"nodes\\\\\\"]\\",\\" # set Namespace to execute botkube kubectl commands by default\\",\\" defaultNamespace: default\\",\\" # Set true to enable commands execution from configured channel only\\",\\" restrictAccess: false\\",\\" # Set true to enable config watcher\\",\\" configwatcher: true\\",\\" # Set false to disable upgrade notification\\",\\" upgradeNotifier: true\\"]", + }, + "kind": "ConfigMap", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-configmap", + }, + }, + Object { + "apiVersion": "v1", + "kind": "ServiceAccount", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-service-account", + }, + }, + Object { + "apiVersion": "rbac.authorization.k8s.io/v1", + "kind": "ClusterRole", + "metadata": Object { + "name": "botkube-cluster-role", + }, + "rules": Array [ + Object { + "apiGroups": Array [ + "*", + ], + "resources": Array [ + "*", + ], + "verbs": Array [ + "get", + "watch", + "list", + ], + }, + ], + }, + Object { + "apiVersion": "rbac.authorization.k8s.io/v1", + "kind": "ClusterRoleBinding", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-service-account", + }, + "roleRef": Object { + "apiGroup": "rbac.authorization.k8s.io", + "kind": "ClusterRole", + "name": "botkube-clusterrole", + }, + "subjects": Array [ + Object { + "kind": "ServiceAccounts", + "name": "botkube-service-account", + }, + ], + }, + Object { + "apiVersion": "apps/v1", + "kind": "Deployment", + "metadata": Object { + "labels": Object { + "app": "botkube", + "component": "controller", + }, + "name": "botkube", + }, + "spec": Object { + "replicas": 1, + "selector": Object { + "matchLabels": Object { + "app": "botkube", + "component": "controller", + }, + }, + "template": Object { + "metadata": Object { + "labels": Object { + "app": "botkube", + "component": "controller", + }, + }, + "spec": Object { + "containers": Array [ + Object { + "env": Array [ + Object { + "name": "CONFIG_PATH", + "value": "/config/", + }, + Object { + "name": "LOG_LEVEL", + "value": "info", + }, + ], + "image": "ghcr.io/infracloudio/botkube:v0.12.4", + "imagePullPolicy": "IfNotPresent", + "name": "botkube", + "volumeMounts": Array [ + Object { + "mountPath": "/config", + "name": "config-volume", + }, + ], + }, + ], + "nodeSelector": Object { + "testing": "test-key", + }, + "securityContext": Object { + "runAsGroup": 101, + "runAsUser": 101, + }, + "serviceAccountName": "botkube-sa", + "tolerations": Array [], + "volumes": Array [ + Object { + "name": "config-volume", + "projected": Object { + "sources": Array [ + Object { + "configMap": Object { + "name": "botkube-config-map", + }, + }, + Object { + "secret": Object { + "name": "botkube-communication-secret", + }, + }, + ], + }, + }, + ], + }, + }, + }, + }, +] +`; + +exports[`botkube-secrets 1`] = ` +Array [ + Object { + "apiVersion": "v1", + "data": Object { + "resource_config.yaml": "[\\"## Resources you want to watch\\",\\"resources:\\",\\"- name: RESOURCE # K8s Resource you want to monitor.\\",\\" # Resource name must be in\\",\\" # group/version/resource (G/V/R) format\\",\\" # for core resources with no group,\\",\\" # ignore group fron g/v/r and use v/r\\",\\" # resource name should be plural\\",\\" # (e.g v1/pods, v1.ingresses, etc)\\",\\"\\",\\" namespaces: \\",\\" include: # List of namespaces to monitor for\\",\\" # the RESOURCE events\\",\\" - namespace/all # Use all to monitor all the resources\\",\\"\\",\\" ignore: # List of namespaces to be ignored\\",\\" # used only with include: all\\",\\" - # example : include [all], ignore [x,y,z]\\",\\"\\",\\" events: # List of lifecycle events you want to\\",\\" - create # receive notifications about\\",\\" - update # Valid options are: \\",\\" - delete # create, update, delete, error OR all\\",\\" - error\\",\\" \\",\\" updateSetting: # Set include diff with the update event \\",\\" # about the changes in specific fields\\",\\" includeDiff: true # updateSettings are ignored if \`update\`\\",\\" # events are not configured for the resource\\",\\"\\",\\" fields:\\",\\" - JSONPath # List of JSONPath expressions to monitor\\",\\" # changes in specific fields\\",\\"- name: apps/v1/deployments\\",\\" namespaces:\\",\\" include:\\",\\" - dev\\",\\" - qa\\",\\" - default\\",\\" ignore:\\",\\" - kube-system\\",\\" - prod\\",\\" updateSetting:\\",\\" includeDiff: true\\",\\" fields:\\",\\" - spec.template.spec.containers[*].image\\",\\" - status.availableReplicas\\",\\" events:\\",\\" - all\\",\\"\\",\\"# Check true if you want to receive recommendations\\",\\"# about the best practices for the created resource\\",\\"recommendations: true\\",\\"\\",\\"# Cluster Setting to manage command execution access\\",\\"settings:\\",\\" # Set cluster name to differentiate incoming messages\\",\\" clustername: not-configured\\",\\" # Kubectl executor configs\\",\\" kubectl:\\",\\" # Set true to enable kubectl commands execution\\",\\" enabled: false\\",\\" # List of allowed commands\\",\\" commands:\\",\\" # kubectl method which are allowed with BotKube command\\",\\" verbs: [\\\\\\"api-resources\\\\\\", \\\\\\"api-versions\\\\\\", \\\\\\"cluster-info\\\\\\", \\\\\\"describe\\\\\\", \\\\\\"diff\\\\\\", \\\\\\"explain\\\\\\", \\\\\\"get\\\\\\", \\\\\\"logs\\\\\\", \\\\\\"top\\\\\\", \\\\\\"auth\\\\\\"]\\",\\" # resources on which kubectl methods are allowed with BotKube commands\\",\\" resources: [\\\\\\"deployments\\\\\\", \\\\\\"pods\\\\\\" , \\\\\\"namespaces\\\\\\", \\\\\\"daemonsets\\\\\\", \\\\\\"statefulsets\\\\\\", \\\\\\"storageclasses\\\\\\", \\\\\\"nodes\\\\\\"]\\",\\" # set Namespace to execute botkube kubectl commands by default\\",\\" defaultNamespace: default\\",\\" # Set true to enable commands execution from configured channel only\\",\\" restrictAccess: false\\",\\" # Set true to enable config watcher\\",\\" configwatcher: true\\",\\" # Set false to disable upgrade notification\\",\\" upgradeNotifier: true\\"]", + }, + "kind": "ConfigMap", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-configmap", + }, + }, + Object { + "apiVersion": "v1", + "kind": "ServiceAccount", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-service-account", + }, + }, + Object { + "apiVersion": "rbac.authorization.k8s.io/v1", + "kind": "ClusterRole", + "metadata": Object { + "name": "botkube-cluster-role", + }, + "rules": Array [ + Object { + "apiGroups": Array [ + "*", + ], + "resources": Array [ + "*", + ], + "verbs": Array [ + "get", + "watch", + "list", + ], + }, + ], + }, + Object { + "apiVersion": "rbac.authorization.k8s.io/v1", + "kind": "ClusterRoleBinding", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-service-account", + }, + "roleRef": Object { + "apiGroup": "rbac.authorization.k8s.io", + "kind": "ClusterRole", + "name": "botkube-clusterrole", + }, + "subjects": Array [ + Object { + "kind": "ServiceAccounts", + "name": "botkube-service-account", + }, + ], + }, + Object { + "apiVersion": "apps/v1", + "kind": "Deployment", + "metadata": Object { + "labels": Object { + "app": "botkube", + "component": "controller", + }, + "name": "botkube", + }, + "spec": Object { + "replicas": 1, + "selector": Object { + "matchLabels": Object { + "app": "botkube", + "component": "controller", + }, + }, + "template": Object { + "metadata": Object { + "labels": Object { + "app": "botkube", + "component": "controller", + }, + }, + "spec": Object { + "containers": Array [ + Object { + "env": Array [ + Object { + "name": "CONFIG_PATH", + "value": "/config/", + }, + Object { + "name": "LOG_LEVEL", + "value": "info", + }, + ], + "image": "ghcr.io/infracloudio/botkube:v0.12.4", + "imagePullPolicy": "IfNotPresent", + "name": "botkube", + "volumeMounts": Array [ + Object { + "mountPath": "/config", + "name": "config-volume", + }, + ], + }, + ], + "nodeSelector": Object {}, + "securityContext": Object { + "runAsGroup": 101, + "runAsUser": 101, + }, + "serviceAccountName": "botkube-sa", + "tolerations": Array [], + "volumes": Array [ + Object { + "name": "config-volume", + "projected": Object { + "sources": Array [ + Object { + "configMap": Object { + "name": "botkube-config-map", + }, + }, + Object { + "secret": Object { + "name": "testSecretName", + }, + }, + ], + }, + }, + ], + }, + }, + }, + }, +] +`; + +exports[`botkube-tolerations 1`] = ` +Array [ + Object { + "apiVersion": "v1", + "data": Object { + "resource_config.yaml": "[\\"## Resources you want to watch\\",\\"resources:\\",\\"- name: RESOURCE # K8s Resource you want to monitor.\\",\\" # Resource name must be in\\",\\" # group/version/resource (G/V/R) format\\",\\" # for core resources with no group,\\",\\" # ignore group fron g/v/r and use v/r\\",\\" # resource name should be plural\\",\\" # (e.g v1/pods, v1.ingresses, etc)\\",\\"\\",\\" namespaces: \\",\\" include: # List of namespaces to monitor for\\",\\" # the RESOURCE events\\",\\" - namespace/all # Use all to monitor all the resources\\",\\"\\",\\" ignore: # List of namespaces to be ignored\\",\\" # used only with include: all\\",\\" - # example : include [all], ignore [x,y,z]\\",\\"\\",\\" events: # List of lifecycle events you want to\\",\\" - create # receive notifications about\\",\\" - update # Valid options are: \\",\\" - delete # create, update, delete, error OR all\\",\\" - error\\",\\" \\",\\" updateSetting: # Set include diff with the update event \\",\\" # about the changes in specific fields\\",\\" includeDiff: true # updateSettings are ignored if \`update\`\\",\\" # events are not configured for the resource\\",\\"\\",\\" fields:\\",\\" - JSONPath # List of JSONPath expressions to monitor\\",\\" # changes in specific fields\\",\\"- name: apps/v1/deployments\\",\\" namespaces:\\",\\" include:\\",\\" - dev\\",\\" - qa\\",\\" - default\\",\\" ignore:\\",\\" - kube-system\\",\\" - prod\\",\\" updateSetting:\\",\\" includeDiff: true\\",\\" fields:\\",\\" - spec.template.spec.containers[*].image\\",\\" - status.availableReplicas\\",\\" events:\\",\\" - all\\",\\"\\",\\"# Check true if you want to receive recommendations\\",\\"# about the best practices for the created resource\\",\\"recommendations: true\\",\\"\\",\\"# Cluster Setting to manage command execution access\\",\\"settings:\\",\\" # Set cluster name to differentiate incoming messages\\",\\" clustername: not-configured\\",\\" # Kubectl executor configs\\",\\" kubectl:\\",\\" # Set true to enable kubectl commands execution\\",\\" enabled: false\\",\\" # List of allowed commands\\",\\" commands:\\",\\" # kubectl method which are allowed with BotKube command\\",\\" verbs: [\\\\\\"api-resources\\\\\\", \\\\\\"api-versions\\\\\\", \\\\\\"cluster-info\\\\\\", \\\\\\"describe\\\\\\", \\\\\\"diff\\\\\\", \\\\\\"explain\\\\\\", \\\\\\"get\\\\\\", \\\\\\"logs\\\\\\", \\\\\\"top\\\\\\", \\\\\\"auth\\\\\\"]\\",\\" # resources on which kubectl methods are allowed with BotKube commands\\",\\" resources: [\\\\\\"deployments\\\\\\", \\\\\\"pods\\\\\\" , \\\\\\"namespaces\\\\\\", \\\\\\"daemonsets\\\\\\", \\\\\\"statefulsets\\\\\\", \\\\\\"storageclasses\\\\\\", \\\\\\"nodes\\\\\\"]\\",\\" # set Namespace to execute botkube kubectl commands by default\\",\\" defaultNamespace: default\\",\\" # Set true to enable commands execution from configured channel only\\",\\" restrictAccess: false\\",\\" # Set true to enable config watcher\\",\\" configwatcher: true\\",\\" # Set false to disable upgrade notification\\",\\" upgradeNotifier: true\\"]", + }, + "kind": "ConfigMap", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-configmap", + }, + }, + Object { + "apiVersion": "v1", + "kind": "ServiceAccount", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-service-account", + }, + }, + Object { + "apiVersion": "rbac.authorization.k8s.io/v1", + "kind": "ClusterRole", + "metadata": Object { + "name": "botkube-cluster-role", + }, + "rules": Array [ + Object { + "apiGroups": Array [ + "*", + ], + "resources": Array [ + "*", + ], + "verbs": Array [ + "get", + "watch", + "list", + ], + }, + ], + }, + Object { + "apiVersion": "rbac.authorization.k8s.io/v1", + "kind": "ClusterRoleBinding", + "metadata": Object { + "labels": Object { + "app": "botkube", + }, + "name": "botkube-service-account", + }, + "roleRef": Object { + "apiGroup": "rbac.authorization.k8s.io", + "kind": "ClusterRole", + "name": "botkube-clusterrole", + }, + "subjects": Array [ + Object { + "kind": "ServiceAccounts", + "name": "botkube-service-account", + }, + ], + }, + Object { + "apiVersion": "apps/v1", + "kind": "Deployment", + "metadata": Object { + "labels": Object { + "app": "botkube", + "component": "controller", + }, + "name": "botkube", + }, + "spec": Object { + "replicas": 1, + "selector": Object { + "matchLabels": Object { + "app": "botkube", + "component": "controller", + }, + }, + "template": Object { + "metadata": Object { + "labels": Object { + "app": "botkube", + "component": "controller", + }, + }, + "spec": Object { + "containers": Array [ + Object { + "env": Array [ + Object { + "name": "CONFIG_PATH", + "value": "/config/", + }, + Object { + "name": "LOG_LEVEL", + "value": "info", + }, + ], + "image": "ghcr.io/infracloudio/botkube:v0.12.4", + "imagePullPolicy": "IfNotPresent", + "name": "botkube", + "volumeMounts": Array [ + Object { + "mountPath": "/config", + "name": "config-volume", + }, + ], + }, + ], + "nodeSelector": Object {}, + "securityContext": Object { + "runAsGroup": 101, + "runAsUser": 101, + }, + "serviceAccountName": "botkube-sa", + "tolerations": Array [ + Object { + "effect": "NoExecute", + "key": "node.kubernetes.io/not-ready", + "operator": "Exists", + "tolerationSeconds": 300, + }, + ], + "volumes": Array [ + Object { + "name": "config-volume", + "projected": Object { + "sources": Array [ + Object { + "configMap": Object { + "name": "botkube-config-map", + }, + }, + Object { + "secret": Object { + "name": "botkube-communication-secret", + }, + }, + ], + }, + }, + ], + }, + }, + }, + }, +] +`; diff --git a/test/hello.test.ts b/test/hello.test.ts new file mode 100644 index 0000000..3252feb --- /dev/null +++ b/test/hello.test.ts @@ -0,0 +1,65 @@ +import { Chart, Testing } from 'cdk8s'; +import { BotKube } from '../src/index'; + +test('botkube-default', () => { + + const app = Testing.app(); + const chart = new Chart(app, 'test'); + + new BotKube(chart, 'botkube-default'); + + expect(Testing.synth(chart)).toMatchSnapshot(); +}); + +test('botkube-configmap', () => { + + const app = Testing.app(); + const chart = new Chart(app, 'test'); + + new BotKube(chart, 'botkube-default', { + configMapData: 'testConfigMap', + }); + + expect(Testing.synth(chart)).toMatchSnapshot(); +}); + +test('botkube-secrets', () => { + + const app = Testing.app(); + const chart = new Chart(app, 'test'); + + new BotKube(chart, 'botkube-default', { + secretName: 'testSecretName', + }); + + expect(Testing.synth(chart)).toMatchSnapshot(); +}); + +test('botkube-nodeselector', () => { + + const app = Testing.app(); + const chart = new Chart(app, 'test'); + + new BotKube(chart, 'botkube-default', { + nodeSelector: { testing: 'test-key' }, + }); + + expect(Testing.synth(chart)).toMatchSnapshot(); +}); + +test('botkube-tolerations', () => { + + const app = Testing.app(); + const chart = new Chart(app, 'test'); + + new BotKube(chart, 'botkube-default', { + tolerations: [{ + effect: 'NoExecute', + key: 'node.kubernetes.io/not-ready', + operator: 'Exists', + tolerationSeconds: 300, + }], + }); + + expect(Testing.synth(chart)).toMatchSnapshot(); +}); diff --git a/tsconfig.dev.json b/tsconfig.dev.json new file mode 100644 index 0000000..2e29dba --- /dev/null +++ b/tsconfig.dev.json @@ -0,0 +1,36 @@ +{ + "compilerOptions": { + "alwaysStrict": true, + "declaration": true, + "esModuleInterop": true, + "experimentalDecorators": true, + "inlineSourceMap": true, + "inlineSources": true, + "lib": [ + "es2019" + ], + "module": "CommonJS", + "noEmitOnError": false, + "noFallthroughCasesInSwitch": true, + "noImplicitAny": true, + "noImplicitReturns": true, + "noImplicitThis": true, + "noUnusedLocals": true, + "noUnusedParameters": true, + "resolveJsonModule": true, + "strict": true, + "strictNullChecks": true, + "strictPropertyInitialization": true, + "stripInternal": true, + "target": "ES2019" + }, + "include": [ + ".projenrc.js", + "src/**/*.ts", + "test/**/*.ts" + ], + "exclude": [ + "node_modules" + ], + "//": "~~ Generated by projen. To modify, edit .projenrc.js and run \"npx projen\"." +} diff --git a/yarn.lock b/yarn.lock new file mode 100644 index 0000000..4ab0aaa --- /dev/null +++ b/yarn.lock @@ -0,0 +1,6105 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@ampproject/remapping@^2.1.0": + version "2.1.2" + resolved "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.1.2.tgz#4edca94973ded9630d20101cd8559cedb8d8bd34" + integrity sha512-hoyByceqwKirw7w3Z7gnIIZC3Wx3J484Y3L/cMpXFbr7d9ZQj2mODrirNzcJa+SM3UlpWXYvKV4RlRpFXlWgXg== + dependencies: + "@jridgewell/trace-mapping" "^0.3.0" + +"@babel/code-frame@^7.0.0", "@babel/code-frame@^7.12.13", "@babel/code-frame@^7.16.7": + version "7.16.7" + resolved "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.16.7.tgz#44416b6bd7624b998f5b1af5d470856c40138789" + integrity sha512-iAXqUn8IIeBTNd72xsFlgaXHkMBMt6y4HJp1tIaK465CWLT/fG1aqB7ykr95gHHmlBdGbFeWWfyB4NJJ0nmeIg== + dependencies: + "@babel/highlight" "^7.16.7" + +"@babel/compat-data@^7.17.7": + version "7.17.7" + resolved "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.17.7.tgz#078d8b833fbbcc95286613be8c716cef2b519fa2" + integrity sha512-p8pdE6j0a29TNGebNm7NzYZWB3xVZJBZ7XGs42uAKzQo8VQ3F0By/cQCtUEABwIqw5zo6WA4NbmxsfzADzMKnQ== + +"@babel/core@^7.1.0", "@babel/core@^7.12.3", "@babel/core@^7.7.2", "@babel/core@^7.8.0": + version "7.17.8" + resolved "https://registry.npmjs.org/@babel/core/-/core-7.17.8.tgz#3dac27c190ebc3a4381110d46c80e77efe172e1a" + integrity sha512-OdQDV/7cRBtJHLSOBqqbYNkOcydOgnX59TZx4puf41fzcVtN3e/4yqY8lMQsK+5X2lJtAdmA+6OHqsj1hBJ4IQ== + dependencies: + "@ampproject/remapping" "^2.1.0" + "@babel/code-frame" "^7.16.7" + "@babel/generator" "^7.17.7" + "@babel/helper-compilation-targets" "^7.17.7" + "@babel/helper-module-transforms" "^7.17.7" + "@babel/helpers" "^7.17.8" + "@babel/parser" "^7.17.8" + "@babel/template" "^7.16.7" + "@babel/traverse" "^7.17.3" + "@babel/types" "^7.17.0" + convert-source-map "^1.7.0" + debug "^4.1.0" + gensync "^1.0.0-beta.2" + json5 "^2.1.2" + semver "^6.3.0" + +"@babel/generator@^7.17.3", "@babel/generator@^7.17.7", "@babel/generator@^7.7.2": + version "7.17.7" + resolved "https://registry.npmjs.org/@babel/generator/-/generator-7.17.7.tgz#8da2599beb4a86194a3b24df6c085931d9ee45ad" + integrity sha512-oLcVCTeIFadUoArDTwpluncplrYBmTCCZZgXCbgNGvOBBiSDDK3eWO4b/+eOTli5tKv1lg+a5/NAXg+nTcei1w== + dependencies: + "@babel/types" "^7.17.0" + jsesc "^2.5.1" + source-map "^0.5.0" + +"@babel/helper-compilation-targets@^7.17.7": + version "7.17.7" + resolved "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.17.7.tgz#a3c2924f5e5f0379b356d4cfb313d1414dc30e46" + integrity sha512-UFzlz2jjd8kroj0hmCFV5zr+tQPi1dpC2cRsDV/3IEW8bJfCPrPpmcSN6ZS8RqIq4LXcmpipCQFPddyFA5Yc7w== + dependencies: + "@babel/compat-data" "^7.17.7" + "@babel/helper-validator-option" "^7.16.7" + browserslist "^4.17.5" + semver "^6.3.0" + +"@babel/helper-environment-visitor@^7.16.7": + version "7.16.7" + resolved "https://registry.npmjs.org/@babel/helper-environment-visitor/-/helper-environment-visitor-7.16.7.tgz#ff484094a839bde9d89cd63cba017d7aae80ecd7" + integrity sha512-SLLb0AAn6PkUeAfKJCCOl9e1R53pQlGAfc4y4XuMRZfqeMYLE0dM1LMhqbGAlGQY0lfw5/ohoYWAe9V1yibRag== + dependencies: + "@babel/types" "^7.16.7" + +"@babel/helper-function-name@^7.16.7": + version "7.16.7" + resolved "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.16.7.tgz#f1ec51551fb1c8956bc8dd95f38523b6cf375f8f" + integrity sha512-QfDfEnIUyyBSR3HtrtGECuZ6DAyCkYFp7GHl75vFtTnn6pjKeK0T1DB5lLkFvBea8MdaiUABx3osbgLyInoejA== + dependencies: + "@babel/helper-get-function-arity" "^7.16.7" + "@babel/template" "^7.16.7" + "@babel/types" "^7.16.7" + +"@babel/helper-get-function-arity@^7.16.7": + version "7.16.7" + resolved "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.16.7.tgz#ea08ac753117a669f1508ba06ebcc49156387419" + integrity sha512-flc+RLSOBXzNzVhcLu6ujeHUrD6tANAOU5ojrRx/as+tbzf8+stUCj7+IfRRoAbEZqj/ahXEMsjhOhgeZsrnTw== + dependencies: + "@babel/types" "^7.16.7" + +"@babel/helper-hoist-variables@^7.16.7": + version "7.16.7" + resolved "https://registry.npmjs.org/@babel/helper-hoist-variables/-/helper-hoist-variables-7.16.7.tgz#86bcb19a77a509c7b77d0e22323ef588fa58c246" + integrity sha512-m04d/0Op34H5v7pbZw6pSKP7weA6lsMvfiIAMeIvkY/R4xQtBSMFEigu9QTZ2qB/9l22vsxtM8a+Q8CzD255fg== + dependencies: + "@babel/types" "^7.16.7" + +"@babel/helper-module-imports@^7.16.7": + version "7.16.7" + resolved "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.16.7.tgz#25612a8091a999704461c8a222d0efec5d091437" + integrity sha512-LVtS6TqjJHFc+nYeITRo6VLXve70xmq7wPhWTqDJusJEgGmkAACWwMiTNrvfoQo6hEhFwAIixNkvB0jPXDL8Wg== + dependencies: + "@babel/types" "^7.16.7" + +"@babel/helper-module-transforms@^7.17.7": + version "7.17.7" + resolved "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.17.7.tgz#3943c7f777139e7954a5355c815263741a9c1cbd" + integrity sha512-VmZD99F3gNTYB7fJRDTi+u6l/zxY0BE6OIxPSU7a50s6ZUQkHwSDmV92FfM+oCG0pZRVojGYhkR8I0OGeCVREw== + dependencies: + "@babel/helper-environment-visitor" "^7.16.7" + "@babel/helper-module-imports" "^7.16.7" + "@babel/helper-simple-access" "^7.17.7" + "@babel/helper-split-export-declaration" "^7.16.7" + "@babel/helper-validator-identifier" "^7.16.7" + "@babel/template" "^7.16.7" + "@babel/traverse" "^7.17.3" + "@babel/types" "^7.17.0" + +"@babel/helper-plugin-utils@^7.0.0", "@babel/helper-plugin-utils@^7.10.4", "@babel/helper-plugin-utils@^7.12.13", "@babel/helper-plugin-utils@^7.14.5", "@babel/helper-plugin-utils@^7.16.7", "@babel/helper-plugin-utils@^7.8.0": + version "7.16.7" + resolved "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.16.7.tgz#aa3a8ab4c3cceff8e65eb9e73d87dc4ff320b2f5" + integrity sha512-Qg3Nk7ZxpgMrsox6HreY1ZNKdBq7K72tDSliA6dCl5f007jR4ne8iD5UzuNnCJH2xBf2BEEVGr+/OL6Gdp7RxA== + +"@babel/helper-simple-access@^7.17.7": + version "7.17.7" + resolved "https://registry.npmjs.org/@babel/helper-simple-access/-/helper-simple-access-7.17.7.tgz#aaa473de92b7987c6dfa7ce9a7d9674724823367" + integrity sha512-txyMCGroZ96i+Pxr3Je3lzEJjqwaRC9buMUgtomcrLe5Nd0+fk1h0LLA+ixUF5OW7AhHuQ7Es1WcQJZmZsz2XA== + dependencies: + "@babel/types" "^7.17.0" + +"@babel/helper-split-export-declaration@^7.16.7": + version "7.16.7" + resolved "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.16.7.tgz#0b648c0c42da9d3920d85ad585f2778620b8726b" + integrity sha512-xbWoy/PFoxSWazIToT9Sif+jJTlrMcndIsaOKvTA6u7QEo7ilkRZpjew18/W3c7nm8fXdUDXh02VXTbZ0pGDNw== + dependencies: + "@babel/types" "^7.16.7" + +"@babel/helper-validator-identifier@^7.16.7": + version "7.16.7" + resolved "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.16.7.tgz#e8c602438c4a8195751243da9031d1607d247cad" + integrity sha512-hsEnFemeiW4D08A5gUAZxLBTXpZ39P+a+DGDsHw1yxqyQ/jzFEnxf5uTEGp+3bzAbNOxU1paTgYS4ECU/IgfDw== + +"@babel/helper-validator-option@^7.16.7": + version "7.16.7" + resolved "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.16.7.tgz#b203ce62ce5fe153899b617c08957de860de4d23" + integrity sha512-TRtenOuRUVo9oIQGPC5G9DgK4743cdxvtOw0weQNpZXaS16SCBi5MNjZF8vba3ETURjZpTbVn7Vvcf2eAwFozQ== + +"@babel/helpers@^7.17.8": + version "7.17.8" + resolved "https://registry.npmjs.org/@babel/helpers/-/helpers-7.17.8.tgz#288450be8c6ac7e4e44df37bcc53d345e07bc106" + integrity sha512-QcL86FGxpfSJwGtAvv4iG93UL6bmqBdmoVY0CMCU2g+oD2ezQse3PT5Pa+jiD6LJndBQi0EDlpzOWNlLuhz5gw== + dependencies: + "@babel/template" "^7.16.7" + "@babel/traverse" "^7.17.3" + "@babel/types" "^7.17.0" + +"@babel/highlight@^7.16.7": + version "7.16.10" + resolved "https://registry.npmjs.org/@babel/highlight/-/highlight-7.16.10.tgz#744f2eb81579d6eea753c227b0f570ad785aba88" + integrity sha512-5FnTQLSLswEj6IkgVw5KusNUUFY9ZGqe/TRFnP/BKYHYgfh7tc+C7mwiy95/yNP7Dh9x580Vv8r7u7ZfTBFxdw== + dependencies: + "@babel/helper-validator-identifier" "^7.16.7" + chalk "^2.0.0" + js-tokens "^4.0.0" + +"@babel/parser@^7.1.0", "@babel/parser@^7.14.7", "@babel/parser@^7.16.7", "@babel/parser@^7.17.3", "@babel/parser@^7.17.8": + version "7.17.8" + resolved "https://registry.npmjs.org/@babel/parser/-/parser-7.17.8.tgz#2817fb9d885dd8132ea0f8eb615a6388cca1c240" + integrity sha512-BoHhDJrJXqcg+ZL16Xv39H9n+AqJ4pcDrQBGZN+wHxIysrLZ3/ECwCBUch/1zUNhnsXULcONU3Ei5Hmkfk6kiQ== + +"@babel/plugin-syntax-async-generators@^7.8.4": + version "7.8.4" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-async-generators/-/plugin-syntax-async-generators-7.8.4.tgz#a983fb1aeb2ec3f6ed042a210f640e90e786fe0d" + integrity sha512-tycmZxkGfZaxhMRbXlPXuVFpdWlXpir2W4AMhSJgRKzk/eDlIXOhb2LHWoLpDF7TEHylV5zNhykX6KAgHJmTNw== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-bigint@^7.8.3": + version "7.8.3" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-bigint/-/plugin-syntax-bigint-7.8.3.tgz#4c9a6f669f5d0cdf1b90a1671e9a146be5300cea" + integrity sha512-wnTnFlG+YxQm3vDxpGE57Pj0srRU4sHE/mDkt1qv2YJJSeUAec2ma4WLUnUPeKjyrfntVwe/N6dCXpU+zL3Npg== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-class-properties@^7.8.3": + version "7.12.13" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-class-properties/-/plugin-syntax-class-properties-7.12.13.tgz#b5c987274c4a3a82b89714796931a6b53544ae10" + integrity sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA== + dependencies: + "@babel/helper-plugin-utils" "^7.12.13" + +"@babel/plugin-syntax-import-meta@^7.8.3": + version "7.10.4" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-import-meta/-/plugin-syntax-import-meta-7.10.4.tgz#ee601348c370fa334d2207be158777496521fd51" + integrity sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g== + dependencies: + "@babel/helper-plugin-utils" "^7.10.4" + +"@babel/plugin-syntax-json-strings@^7.8.3": + version "7.8.3" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-json-strings/-/plugin-syntax-json-strings-7.8.3.tgz#01ca21b668cd8218c9e640cb6dd88c5412b2c96a" + integrity sha512-lY6kdGpWHvjoe2vk4WrAapEuBR69EMxZl+RoGRhrFGNYVK8mOPAW8VfbT/ZgrFbXlDNiiaxQnAtgVCZ6jv30EA== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-logical-assignment-operators@^7.8.3": + version "7.10.4" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-logical-assignment-operators/-/plugin-syntax-logical-assignment-operators-7.10.4.tgz#ca91ef46303530448b906652bac2e9fe9941f699" + integrity sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig== + dependencies: + "@babel/helper-plugin-utils" "^7.10.4" + +"@babel/plugin-syntax-nullish-coalescing-operator@^7.8.3": + version "7.8.3" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-nullish-coalescing-operator/-/plugin-syntax-nullish-coalescing-operator-7.8.3.tgz#167ed70368886081f74b5c36c65a88c03b66d1a9" + integrity sha512-aSff4zPII1u2QD7y+F8oDsz19ew4IGEJg9SVW+bqwpwtfFleiQDMdzA/R+UlWDzfnHFCxxleFT0PMIrR36XLNQ== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-numeric-separator@^7.8.3": + version "7.10.4" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-numeric-separator/-/plugin-syntax-numeric-separator-7.10.4.tgz#b9b070b3e33570cd9fd07ba7fa91c0dd37b9af97" + integrity sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug== + dependencies: + "@babel/helper-plugin-utils" "^7.10.4" + +"@babel/plugin-syntax-object-rest-spread@^7.8.3": + version "7.8.3" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-object-rest-spread/-/plugin-syntax-object-rest-spread-7.8.3.tgz#60e225edcbd98a640332a2e72dd3e66f1af55871" + integrity sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-optional-catch-binding@^7.8.3": + version "7.8.3" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-optional-catch-binding/-/plugin-syntax-optional-catch-binding-7.8.3.tgz#6111a265bcfb020eb9efd0fdfd7d26402b9ed6c1" + integrity sha512-6VPD0Pc1lpTqw0aKoeRTMiB+kWhAoT24PA+ksWSBrFtl5SIRVpZlwN3NNPQjehA2E/91FV3RjLWoVTglWcSV3Q== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-optional-chaining@^7.8.3": + version "7.8.3" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-optional-chaining/-/plugin-syntax-optional-chaining-7.8.3.tgz#4f69c2ab95167e0180cd5336613f8c5788f7d48a" + integrity sha512-KoK9ErH1MBlCPxV0VANkXW2/dw4vlbGDrFgz8bmUsBGYkFRcbRwMh6cIJubdPrkxRwuGdtCk0v/wPTKbQgBjkg== + dependencies: + "@babel/helper-plugin-utils" "^7.8.0" + +"@babel/plugin-syntax-top-level-await@^7.8.3": + version "7.14.5" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-top-level-await/-/plugin-syntax-top-level-await-7.14.5.tgz#c1cfdadc35a646240001f06138247b741c34d94c" + integrity sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw== + dependencies: + "@babel/helper-plugin-utils" "^7.14.5" + +"@babel/plugin-syntax-typescript@^7.7.2": + version "7.16.7" + resolved "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.16.7.tgz#39c9b55ee153151990fb038651d58d3fd03f98f8" + integrity sha512-YhUIJHHGkqPgEcMYkPCKTyGUdoGKWtopIycQyjJH8OjvRgOYsXsaKehLVPScKJWAULPxMa4N1vCe6szREFlZ7A== + dependencies: + "@babel/helper-plugin-utils" "^7.16.7" + +"@babel/template@^7.16.7", "@babel/template@^7.3.3": + version "7.16.7" + resolved "https://registry.npmjs.org/@babel/template/-/template-7.16.7.tgz#8d126c8701fde4d66b264b3eba3d96f07666d155" + integrity sha512-I8j/x8kHUrbYRTUxXrrMbfCa7jxkE7tZre39x3kjr9hvI82cK1FfqLygotcWN5kdPGWcLdWMHpSBavse5tWw3w== + dependencies: + "@babel/code-frame" "^7.16.7" + "@babel/parser" "^7.16.7" + "@babel/types" "^7.16.7" + +"@babel/traverse@^7.17.3", "@babel/traverse@^7.7.2": + version "7.17.3" + resolved "https://registry.npmjs.org/@babel/traverse/-/traverse-7.17.3.tgz#0ae0f15b27d9a92ba1f2263358ea7c4e7db47b57" + integrity sha512-5irClVky7TxRWIRtxlh2WPUUOLhcPN06AGgaQSB8AEwuyEBgJVuJ5imdHm5zxk8w0QS5T+tDfnDxAlhWjpb7cw== + dependencies: + "@babel/code-frame" "^7.16.7" + "@babel/generator" "^7.17.3" + "@babel/helper-environment-visitor" "^7.16.7" + "@babel/helper-function-name" "^7.16.7" + "@babel/helper-hoist-variables" "^7.16.7" + "@babel/helper-split-export-declaration" "^7.16.7" + "@babel/parser" "^7.17.3" + "@babel/types" "^7.17.0" + debug "^4.1.0" + globals "^11.1.0" + +"@babel/types@^7.0.0", "@babel/types@^7.16.7", "@babel/types@^7.17.0", "@babel/types@^7.3.0", "@babel/types@^7.3.3": + version "7.17.0" + resolved "https://registry.npmjs.org/@babel/types/-/types-7.17.0.tgz#a826e368bccb6b3d84acd76acad5c0d87342390b" + integrity sha512-TmKSNO4D5rzhL5bjWFcVHHLETzfQ/AmbKpKPOSjlP0WoHZ6L911fgoOKY4Alp/emzG4cHJdyN49zpgkbXFEHHw== + dependencies: + "@babel/helper-validator-identifier" "^7.16.7" + to-fast-properties "^2.0.0" + +"@bcoe/v8-coverage@^0.2.3": + version "0.2.3" + resolved "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz#75a2e8b51cb758a7553d6804a5932d7aace75c39" + integrity sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw== + +"@eslint/eslintrc@^1.2.1": + version "1.2.1" + resolved "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-1.2.1.tgz#8b5e1c49f4077235516bc9ec7d41378c0f69b8c6" + integrity sha512-bxvbYnBPN1Gibwyp6NrpnFzA3YtRL3BBAyEAFVIpNTm2Rn4Vy87GA5M4aSn3InRrlsbX5N0GW7XIx+U4SAEKdQ== + dependencies: + ajv "^6.12.4" + debug "^4.3.2" + espree "^9.3.1" + globals "^13.9.0" + ignore "^5.2.0" + import-fresh "^3.2.1" + js-yaml "^4.1.0" + minimatch "^3.0.4" + strip-json-comments "^3.1.1" + +"@gar/promisify@^1.1.3": + version "1.1.3" + resolved "https://registry.yarnpkg.com/@gar/promisify/-/promisify-1.1.3.tgz#555193ab2e3bb3b6adc3d551c9c030d9e860daf6" + integrity sha512-k2Ty1JcVojjJFwrg/ThKi2ujJ7XNLYaFGNB/bWT9wGR+oSMJHMa5w+CUq6p/pVrKeNNgA7pCqEcjSnHVoqJQFw== + +"@humanwhocodes/config-array@^0.9.2": + version "0.9.5" + resolved "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.9.5.tgz#2cbaf9a89460da24b5ca6531b8bbfc23e1df50c7" + integrity sha512-ObyMyWxZiCu/yTisA7uzx81s40xR2fD5Cg/2Kq7G02ajkNubJf6BopgDTmDyc3U7sXpNKM8cYOw7s7Tyr+DnCw== + dependencies: + "@humanwhocodes/object-schema" "^1.2.1" + debug "^4.1.1" + minimatch "^3.0.4" + +"@humanwhocodes/object-schema@^1.2.1": + version "1.2.1" + resolved "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-1.2.1.tgz#b520529ec21d8e5945a1851dfd1c32e94e39ff45" + integrity sha512-ZnQMnLV4e7hDlUvw8H+U8ASL02SS2Gn6+9Ac3wGGLIe7+je2AeAOxPY+izIPJDfFDb7eDjev0Us8MO1iFRN8hA== + +"@hutson/parse-repository-url@^3.0.0": + version "3.0.2" + resolved "https://registry.npmjs.org/@hutson/parse-repository-url/-/parse-repository-url-3.0.2.tgz#98c23c950a3d9b6c8f0daed06da6c3af06981340" + integrity sha512-H9XAx3hc0BQHY6l+IFSWHDySypcXsvsuLhgYLUGywmJ5pswRVQJUHpOsobnLYp2ZUaUlKiKDrgWWhosOwAEM8Q== + +"@iarna/toml@^2.2.5": + version "2.2.5" + resolved "https://registry.yarnpkg.com/@iarna/toml/-/toml-2.2.5.tgz#b32366c89b43c6f8cefbdefac778b9c828e3ba8c" + integrity sha512-trnsAYxU3xnS1gPHPyU961coFyLkh4gAD/0zQ5mymY4yOZ+CYvsPqUbOFSw0aDM4y0tV7tiFxL/1XfXPNC6IPg== + +"@istanbuljs/load-nyc-config@^1.0.0": + version "1.1.0" + resolved "https://registry.npmjs.org/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz#fd3db1d59ecf7cf121e80650bb86712f9b55eced" + integrity sha512-VjeHSlIzpv/NyD3N0YuHfXOPDIixcA1q2ZV98wsMqcYlPmv2n3Yb2lYP9XMElnaFVXg5A7YLTeLu6V84uQDjmQ== + dependencies: + camelcase "^5.3.1" + find-up "^4.1.0" + get-package-type "^0.1.0" + js-yaml "^3.13.1" + resolve-from "^5.0.0" + +"@istanbuljs/schema@^0.1.2": + version "0.1.3" + resolved "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.3.tgz#e45e384e4b8ec16bce2fd903af78450f6bf7ec98" + integrity sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA== + +"@jest/console@^27.5.1": + version "27.5.1" + resolved "https://registry.npmjs.org/@jest/console/-/console-27.5.1.tgz#260fe7239602fe5130a94f1aa386eff54b014bba" + integrity sha512-kZ/tNpS3NXn0mlXXXPNuDZnb4c0oZ20r4K5eemM2k30ZC3G0T02nXUvyhf5YdbXWHPEJLc9qGLxEZ216MdL+Zg== + dependencies: + "@jest/types" "^27.5.1" + "@types/node" "*" + chalk "^4.0.0" + jest-message-util "^27.5.1" + jest-util "^27.5.1" + slash "^3.0.0" + +"@jest/core@^27.5.1": + version "27.5.1" + resolved "https://registry.npmjs.org/@jest/core/-/core-27.5.1.tgz#267ac5f704e09dc52de2922cbf3af9edcd64b626" + integrity sha512-AK6/UTrvQD0Cd24NSqmIA6rKsu0tKIxfiCducZvqxYdmMisOYAsdItspT+fQDQYARPf8XgjAFZi0ogW2agH5nQ== + dependencies: + "@jest/console" "^27.5.1" + "@jest/reporters" "^27.5.1" + "@jest/test-result" "^27.5.1" + "@jest/transform" "^27.5.1" + "@jest/types" "^27.5.1" + "@types/node" "*" + ansi-escapes "^4.2.1" + chalk "^4.0.0" + emittery "^0.8.1" + exit "^0.1.2" + graceful-fs "^4.2.9" + jest-changed-files "^27.5.1" + jest-config "^27.5.1" + jest-haste-map "^27.5.1" + jest-message-util "^27.5.1" + jest-regex-util "^27.5.1" + jest-resolve "^27.5.1" + jest-resolve-dependencies "^27.5.1" + jest-runner "^27.5.1" + jest-runtime "^27.5.1" + jest-snapshot "^27.5.1" + jest-util "^27.5.1" + jest-validate "^27.5.1" + jest-watcher "^27.5.1" + micromatch "^4.0.4" + rimraf "^3.0.0" + slash "^3.0.0" + strip-ansi "^6.0.0" + +"@jest/environment@^27.5.1": + version "27.5.1" + resolved "https://registry.npmjs.org/@jest/environment/-/environment-27.5.1.tgz#d7425820511fe7158abbecc010140c3fd3be9c74" + integrity sha512-/WQjhPJe3/ghaol/4Bq480JKXV/Rfw8nQdN7f41fM8VDHLcxKXou6QyXAh3EFr9/bVG3x74z1NWDkP87EiY8gA== + dependencies: + "@jest/fake-timers" "^27.5.1" + "@jest/types" "^27.5.1" + "@types/node" "*" + jest-mock "^27.5.1" + +"@jest/fake-timers@^27.5.1": + version "27.5.1" + resolved "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-27.5.1.tgz#76979745ce0579c8a94a4678af7a748eda8ada74" + integrity sha512-/aPowoolwa07k7/oM3aASneNeBGCmGQsc3ugN4u6s4C/+s5M64MFo/+djTdiwcbQlRfFElGuDXWzaWj6QgKObQ== + dependencies: + "@jest/types" "^27.5.1" + "@sinonjs/fake-timers" "^8.0.1" + "@types/node" "*" + jest-message-util "^27.5.1" + jest-mock "^27.5.1" + jest-util "^27.5.1" + +"@jest/globals@^27.5.1": + version "27.5.1" + resolved "https://registry.npmjs.org/@jest/globals/-/globals-27.5.1.tgz#7ac06ce57ab966566c7963431cef458434601b2b" + integrity sha512-ZEJNB41OBQQgGzgyInAv0UUfDDj3upmHydjieSxFvTRuZElrx7tXg/uVQ5hYVEwiXs3+aMsAeEc9X7xiSKCm4Q== + dependencies: + "@jest/environment" "^27.5.1" + "@jest/types" "^27.5.1" + expect "^27.5.1" + +"@jest/reporters@^27.5.1": + version "27.5.1" + resolved "https://registry.npmjs.org/@jest/reporters/-/reporters-27.5.1.tgz#ceda7be96170b03c923c37987b64015812ffec04" + integrity sha512-cPXh9hWIlVJMQkVk84aIvXuBB4uQQmFqZiacloFuGiP3ah1sbCxCosidXFDfqG8+6fO1oR2dTJTlsOy4VFmUfw== + dependencies: + "@bcoe/v8-coverage" "^0.2.3" + "@jest/console" "^27.5.1" + "@jest/test-result" "^27.5.1" + "@jest/transform" "^27.5.1" + "@jest/types" "^27.5.1" + "@types/node" "*" + chalk "^4.0.0" + collect-v8-coverage "^1.0.0" + exit "^0.1.2" + glob "^7.1.2" + graceful-fs "^4.2.9" + istanbul-lib-coverage "^3.0.0" + istanbul-lib-instrument "^5.1.0" + istanbul-lib-report "^3.0.0" + istanbul-lib-source-maps "^4.0.0" + istanbul-reports "^3.1.3" + jest-haste-map "^27.5.1" + jest-resolve "^27.5.1" + jest-util "^27.5.1" + jest-worker "^27.5.1" + slash "^3.0.0" + source-map "^0.6.0" + string-length "^4.0.1" + terminal-link "^2.0.0" + v8-to-istanbul "^8.1.0" + +"@jest/source-map@^27.5.1": + version "27.5.1" + resolved "https://registry.npmjs.org/@jest/source-map/-/source-map-27.5.1.tgz#6608391e465add4205eae073b55e7f279e04e8cf" + integrity sha512-y9NIHUYF3PJRlHk98NdC/N1gl88BL08aQQgu4k4ZopQkCw9t9cV8mtl3TV8b/YCB8XaVTFrmUTAJvjsntDireg== + dependencies: + callsites "^3.0.0" + graceful-fs "^4.2.9" + source-map "^0.6.0" + +"@jest/test-result@^27.5.1": + version "27.5.1" + resolved "https://registry.npmjs.org/@jest/test-result/-/test-result-27.5.1.tgz#56a6585fa80f7cdab72b8c5fc2e871d03832f5bb" + integrity sha512-EW35l2RYFUcUQxFJz5Cv5MTOxlJIQs4I7gxzi2zVU7PJhOwfYq1MdC5nhSmYjX1gmMmLPvB3sIaC+BkcHRBfag== + dependencies: + "@jest/console" "^27.5.1" + "@jest/types" "^27.5.1" + "@types/istanbul-lib-coverage" "^2.0.0" + collect-v8-coverage "^1.0.0" + +"@jest/test-sequencer@^27.5.1": + version "27.5.1" + resolved "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-27.5.1.tgz#4057e0e9cea4439e544c6353c6affe58d095745b" + integrity sha512-LCheJF7WB2+9JuCS7VB/EmGIdQuhtqjRNI9A43idHv3E4KltCTsPsLxvdaubFHSYwY/fNjMWjl6vNRhDiN7vpQ== + dependencies: + "@jest/test-result" "^27.5.1" + graceful-fs "^4.2.9" + jest-haste-map "^27.5.1" + jest-runtime "^27.5.1" + +"@jest/transform@^27.5.1": + version "27.5.1" + resolved "https://registry.npmjs.org/@jest/transform/-/transform-27.5.1.tgz#6c3501dcc00c4c08915f292a600ece5ecfe1f409" + integrity sha512-ipON6WtYgl/1329g5AIJVbUuEh0wZVbdpGwC99Jw4LwuoBNS95MVphU6zOeD9pDkon+LLbFL7lOQRapbB8SCHw== + dependencies: + "@babel/core" "^7.1.0" + "@jest/types" "^27.5.1" + babel-plugin-istanbul "^6.1.1" + chalk "^4.0.0" + convert-source-map "^1.4.0" + fast-json-stable-stringify "^2.0.0" + graceful-fs "^4.2.9" + jest-haste-map "^27.5.1" + jest-regex-util "^27.5.1" + jest-util "^27.5.1" + micromatch "^4.0.4" + pirates "^4.0.4" + slash "^3.0.0" + source-map "^0.6.1" + write-file-atomic "^3.0.0" + +"@jest/types@^27.5.1": + version "27.5.1" + resolved "https://registry.npmjs.org/@jest/types/-/types-27.5.1.tgz#3c79ec4a8ba61c170bf937bcf9e98a9df175ec80" + integrity sha512-Cx46iJ9QpwQTjIdq5VJu2QTMMs3QlEjI0x1QbBP5W1+nMzyc2XmimiRR/CbX9TO0cPTeUlxWMOu8mslYsJ8DEw== + dependencies: + "@types/istanbul-lib-coverage" "^2.0.0" + "@types/istanbul-reports" "^3.0.0" + "@types/node" "*" + "@types/yargs" "^16.0.0" + chalk "^4.0.0" + +"@jridgewell/resolve-uri@^3.0.3": + version "3.0.5" + resolved "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.0.5.tgz#68eb521368db76d040a6315cdb24bf2483037b9c" + integrity sha512-VPeQ7+wH0itvQxnG+lIzWgkysKIr3L9sslimFW55rHMdGu/qCQ5z5h9zq4gI8uBtqkpHhsF4Z/OwExufUCThew== + +"@jridgewell/sourcemap-codec@^1.4.10": + version "1.4.11" + resolved "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.11.tgz#771a1d8d744eeb71b6adb35808e1a6c7b9b8c8ec" + integrity sha512-Fg32GrJo61m+VqYSdRSjRXMjQ06j8YIYfcTqndLYVAaHmroZHLJZCydsWBOTDqXS2v+mjxohBWEMfg97GXmYQg== + +"@jridgewell/trace-mapping@^0.3.0": + version "0.3.4" + resolved "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.4.tgz#f6a0832dffd5b8a6aaa633b7d9f8e8e94c83a0c3" + integrity sha512-vFv9ttIedivx0ux3QSjhgtCVjPZd5l46ZOMDSCwnH1yUO2e964gO8LZGyv2QkqcgR6TnBU1v+1IFqmeoG+0UJQ== + dependencies: + "@jridgewell/resolve-uri" "^3.0.3" + "@jridgewell/sourcemap-codec" "^1.4.10" + +"@jsii/check-node@1.55.1": + version "1.55.1" + resolved "https://registry.npmjs.org/@jsii/check-node/-/check-node-1.55.1.tgz#f034cf63cfc31bdaee477008a96443faaf9f5895" + integrity sha512-JC9b+y4CXdIICDE6fYjaN0VKPc65lz4dj1T4lnaqMfbXIBGB7sBMLQJ/szVc9U3Z+o/HBzCJndNn86kGRM+lqw== + dependencies: + chalk "^4.1.2" + semver "^7.3.5" + +"@jsii/spec@1.55.1", "@jsii/spec@^1.55.1": + version "1.55.1" + resolved "https://registry.npmjs.org/@jsii/spec/-/spec-1.55.1.tgz#fb8b820a6aa6c809773207e1f6be65f92ff38296" + integrity sha512-KSKKN04eO0rTaqzw6j9RTx8HAzhePdmWRC3iJQ90QeZLv/L8Pj4l+nZ4wn77BGxmeULpXkGXUKbhkceArdr4GA== + dependencies: + jsonschema "^1.4.0" + +"@nodelib/fs.scandir@2.1.5": + version "2.1.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5" + integrity sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g== + dependencies: + "@nodelib/fs.stat" "2.0.5" + run-parallel "^1.1.9" + +"@nodelib/fs.stat@2.0.5", "@nodelib/fs.stat@^2.0.2": + version "2.0.5" + resolved "https://registry.yarnpkg.com/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz#5bd262af94e9d25bd1e71b05deed44876a222e8b" + integrity sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A== + +"@nodelib/fs.walk@^1.2.3": + version "1.2.8" + resolved "https://registry.yarnpkg.com/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz#e95737e8bb6746ddedf69c556953494f196fe69a" + integrity sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg== + dependencies: + "@nodelib/fs.scandir" "2.1.5" + fastq "^1.6.0" + +"@npmcli/fs@^2.1.0": + version "2.1.0" + resolved "https://registry.yarnpkg.com/@npmcli/fs/-/fs-2.1.0.tgz#f2a21c28386e299d1a9fae8051d35ad180e33109" + integrity sha512-DmfBvNXGaetMxj9LTp8NAN9vEidXURrf5ZTslQzEAi/6GbW+4yjaLFQc6Tue5cpZ9Frlk4OBo/Snf1Bh/S7qTQ== + dependencies: + "@gar/promisify" "^1.1.3" + semver "^7.3.5" + +"@npmcli/git@^3.0.0": + version "3.0.0" + resolved "https://registry.yarnpkg.com/@npmcli/git/-/git-3.0.0.tgz#466a18980da6b646a8112a7676688ae5347deba3" + integrity sha512-xfSBJ+KBMZWWqRHFbEgIaXG/LtELHrQZMJ72Gkb3yWdHysu/7+VGOs8ME0c3td7QNQX57Ggo3kYL6ylcd70/kA== + dependencies: + "@npmcli/promise-spawn" "^1.3.2" + lru-cache "^7.3.1" + mkdirp "^1.0.4" + npm-pick-manifest "^7.0.0" + proc-log "^2.0.0" + promise-inflight "^1.0.1" + promise-retry "^2.0.1" + semver "^7.3.5" + which "^2.0.2" + +"@npmcli/installed-package-contents@^1.0.7": + version "1.0.7" + resolved "https://registry.yarnpkg.com/@npmcli/installed-package-contents/-/installed-package-contents-1.0.7.tgz#ab7408c6147911b970a8abe261ce512232a3f4fa" + integrity sha512-9rufe0wnJusCQoLpV9ZPKIVP55itrM5BxOXs10DmdbRfgWtHy1LDyskbwRnBghuB0PrF7pNPOqREVtpz4HqzKw== + dependencies: + npm-bundled "^1.1.1" + npm-normalize-package-bin "^1.0.1" + +"@npmcli/move-file@^1.1.2": + version "1.1.2" + resolved "https://registry.yarnpkg.com/@npmcli/move-file/-/move-file-1.1.2.tgz#1a82c3e372f7cae9253eb66d72543d6b8685c674" + integrity sha512-1SUf/Cg2GzGDyaf15aR9St9TWlb+XvbZXWpDx8YKs7MLzMH/BCeopv+y9vzrzgkfykCGuWOlSu3mZhj2+FQcrg== + dependencies: + mkdirp "^1.0.4" + rimraf "^3.0.2" + +"@npmcli/node-gyp@^1.0.3": + version "1.0.3" + resolved "https://registry.yarnpkg.com/@npmcli/node-gyp/-/node-gyp-1.0.3.tgz#a912e637418ffc5f2db375e93b85837691a43a33" + integrity sha512-fnkhw+fmX65kiLqk6E3BFLXNC26rUhK90zVwe2yncPliVT/Qos3xjhTLE59Df8KnPlcwIERXKVlU1bXoUQ+liA== + +"@npmcli/promise-spawn@^1.2.0", "@npmcli/promise-spawn@^1.3.2": + version "1.3.2" + resolved "https://registry.yarnpkg.com/@npmcli/promise-spawn/-/promise-spawn-1.3.2.tgz#42d4e56a8e9274fba180dabc0aea6e38f29274f5" + integrity sha512-QyAGYo/Fbj4MXeGdJcFzZ+FkDkomfRBrPM+9QYJSg+PxgAUL+LU3FneQk37rKR2/zjqkCV1BLHccX98wRXG3Sg== + dependencies: + infer-owner "^1.0.4" + +"@npmcli/run-script@^3.0.1": + version "3.0.1" + resolved "https://registry.yarnpkg.com/@npmcli/run-script/-/run-script-3.0.1.tgz#9d10b46586300074cc9e53ef320130a69567e1ce" + integrity sha512-o2fkld5hYwu9sKYzoXTpqEocMnDLaigobaPzLaGB63k/ExmLBTaB+KpfKlpcIePPnuP8RFR+0GDI4KopJCM6Xg== + dependencies: + "@npmcli/node-gyp" "^1.0.3" + "@npmcli/promise-spawn" "^1.3.2" + node-gyp "^9.0.0" + read-package-json-fast "^2.0.3" + +"@oozcitak/dom@1.15.8": + version "1.15.8" + resolved "https://registry.yarnpkg.com/@oozcitak/dom/-/dom-1.15.8.tgz#0c0c7bb54cfdaadc07fd637913e706101721d15d" + integrity sha512-MoOnLBNsF+ok0HjpAvxYxR4piUhRDCEWK0ot3upwOOHYudJd30j6M+LNcE8RKpwfnclAX9T66nXXzkytd29XSw== + dependencies: + "@oozcitak/infra" "1.0.8" + "@oozcitak/url" "1.0.4" + "@oozcitak/util" "8.3.8" + +"@oozcitak/infra@1.0.8": + version "1.0.8" + resolved "https://registry.yarnpkg.com/@oozcitak/infra/-/infra-1.0.8.tgz#b0b089421f7d0f6878687608301fbaba837a7d17" + integrity sha512-JRAUc9VR6IGHOL7OGF+yrvs0LO8SlqGnPAMqyzOuFZPSZSXI7Xf2O9+awQPSMXgIWGtgUf/dA6Hs6X6ySEaWTg== + dependencies: + "@oozcitak/util" "8.3.8" + +"@oozcitak/url@1.0.4": + version "1.0.4" + resolved "https://registry.yarnpkg.com/@oozcitak/url/-/url-1.0.4.tgz#ca8b1c876319cf5a648dfa1123600a6aa5cda6ba" + integrity sha512-kDcD8y+y3FCSOvnBI6HJgl00viO/nGbQoCINmQ0h98OhnGITrWR3bOGfwYCthgcrV8AnTJz8MzslTQbC3SOAmw== + dependencies: + "@oozcitak/infra" "1.0.8" + "@oozcitak/util" "8.3.8" + +"@oozcitak/util@8.3.8": + version "8.3.8" + resolved "https://registry.yarnpkg.com/@oozcitak/util/-/util-8.3.8.tgz#10f65fe1891fd8cde4957360835e78fd1936bfdd" + integrity sha512-T8TbSnGsxo6TDBJx/Sgv/BlVJL3tshxZP7Aq5R1mSnM5OcHY2dQaxLMu2+E8u3gN0MLOzdjurqN4ZRVuzQycOQ== + +"@sindresorhus/is@^0.14.0": + version "0.14.0" + resolved "https://registry.yarnpkg.com/@sindresorhus/is/-/is-0.14.0.tgz#9fb3a3cf3132328151f353de4632e01e52102bea" + integrity sha512-9NET910DNaIPngYnLLPeg+Ogzqsi9uM4mSboU5y6p8S5DzMTVEsJZrawi+BoDNUVBa2DhJqQYUFvMDfgU062LQ== + +"@sinonjs/commons@^1.7.0": + version "1.8.3" + resolved "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz#3802ddd21a50a949b6721ddd72da36e67e7f1b2d" + integrity sha512-xkNcLAn/wZaX14RPlwizcKicDk9G3F8m2nU3L7Ukm5zBgTwiT0wsoFAHx9Jq56fJA1z/7uKGtCRu16sOUCLIHQ== + dependencies: + type-detect "4.0.8" + +"@sinonjs/fake-timers@^8.0.1": + version "8.1.0" + resolved "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-8.1.0.tgz#3fdc2b6cb58935b21bfb8d1625eb1300484316e7" + integrity sha512-OAPJUAtgeINhh/TAlUID4QTs53Njm7xzddaVlEs/SXwgtiD1tW22zAB/W1wdqfrpmikgaWQ9Fw6Ws+hsiRm5Vg== + dependencies: + "@sinonjs/commons" "^1.7.0" + +"@szmarczak/http-timer@^1.1.2": + version "1.1.2" + resolved "https://registry.yarnpkg.com/@szmarczak/http-timer/-/http-timer-1.1.2.tgz#b1665e2c461a2cd92f4c1bbf50d5454de0d4b421" + integrity sha512-XIB2XbzHTN6ieIjfIMV9hlVcfPU26s2vafYWQcZHWXHOxiaRZYEDKEwdl129Zyg50+foYV2jCgtrqSA6qNuNSA== + dependencies: + defer-to-connect "^1.0.1" + +"@tootallnate/once@1": + version "1.1.2" + resolved "https://registry.npmjs.org/@tootallnate/once/-/once-1.1.2.tgz#ccb91445360179a04e7fe6aff78c00ffc1eeaf82" + integrity sha512-RbzJvlNzmRq5c3O09UipeuXno4tA1FE6ikOjxZK0tuxVv3412l64l5t1W5pj4+rJq9vpkm/kwiR07aZXnsKPxw== + +"@tootallnate/once@2": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@tootallnate/once/-/once-2.0.0.tgz#f544a148d3ab35801c1f633a7441fd87c2e484bf" + integrity sha512-XCuKFP5PS55gnMVu3dty8KPatLqUoy/ZYzDzAGCQ8JNFCkLXzmI7vNHCR+XpbZaMWQK/vQubr7PkYq8g470J/A== + +"@types/babel__core@^7.0.0", "@types/babel__core@^7.1.14": + version "7.1.19" + resolved "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.1.19.tgz#7b497495b7d1b4812bdb9d02804d0576f43ee460" + integrity sha512-WEOTgRsbYkvA/KCsDwVEGkd7WAr1e3g31VHQ8zy5gul/V1qKullU/BU5I68X5v7V3GnB9eotmom4v5a5gjxorw== + dependencies: + "@babel/parser" "^7.1.0" + "@babel/types" "^7.0.0" + "@types/babel__generator" "*" + "@types/babel__template" "*" + "@types/babel__traverse" "*" + +"@types/babel__generator@*": + version "7.6.4" + resolved "https://registry.npmjs.org/@types/babel__generator/-/babel__generator-7.6.4.tgz#1f20ce4c5b1990b37900b63f050182d28c2439b7" + integrity sha512-tFkciB9j2K755yrTALxD44McOrk+gfpIpvC3sxHjRawj6PfnQxrse4Clq5y/Rq+G3mrBurMax/lG8Qn2t9mSsg== + dependencies: + "@babel/types" "^7.0.0" + +"@types/babel__template@*": + version "7.4.1" + resolved "https://registry.npmjs.org/@types/babel__template/-/babel__template-7.4.1.tgz#3d1a48fd9d6c0edfd56f2ff578daed48f36c8969" + integrity sha512-azBFKemX6kMg5Io+/rdGT0dkGreboUVR0Cdm3fz9QJWpaQGJRQXl7C+6hOTCZcMll7KFyEQpgbYI2lHdsS4U7g== + dependencies: + "@babel/parser" "^7.1.0" + "@babel/types" "^7.0.0" + +"@types/babel__traverse@*", "@types/babel__traverse@^7.0.4", "@types/babel__traverse@^7.0.6": + version "7.14.2" + resolved "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.14.2.tgz#ffcd470bbb3f8bf30481678fb5502278ca833a43" + integrity sha512-K2waXdXBi2302XUdcHcR1jCeU0LL4TD9HRs/gk0N2Xvrht+G/BfJa4QObBQZfhMdxiCpV3COl5Nfq4uKTeTnJA== + dependencies: + "@babel/types" "^7.3.0" + +"@types/glob@*": + version "7.2.0" + resolved "https://registry.npmjs.org/@types/glob/-/glob-7.2.0.tgz#bc1b5bf3aa92f25bd5dd39f35c57361bdce5b2eb" + integrity sha512-ZUxbzKl0IfJILTS6t7ip5fQQM/J3TJYubDm3nMbgubNNYS62eXeUpoLUC8/7fJNiFYHTrGPQn7hspDUzIHX3UA== + dependencies: + "@types/minimatch" "*" + "@types/node" "*" + +"@types/graceful-fs@^4.1.2": + version "4.1.5" + resolved "https://registry.npmjs.org/@types/graceful-fs/-/graceful-fs-4.1.5.tgz#21ffba0d98da4350db64891f92a9e5db3cdb4e15" + integrity sha512-anKkLmZZ+xm4p8JWBf4hElkM4XR+EZeA2M9BAkkTldmcyDY4mbdIJnRghDJH3Ov5ooY7/UAoENtmdMSkaAd7Cw== + dependencies: + "@types/node" "*" + +"@types/istanbul-lib-coverage@*", "@types/istanbul-lib-coverage@^2.0.0", "@types/istanbul-lib-coverage@^2.0.1": + version "2.0.4" + resolved "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.4.tgz#8467d4b3c087805d63580480890791277ce35c44" + integrity sha512-z/QT1XN4K4KYuslS23k62yDIDLwLFkzxOuMplDtObz0+y7VqJCaO2o+SPwHCvLFZh7xazvvoor2tA/hPz9ee7g== + +"@types/istanbul-lib-report@*": + version "3.0.0" + resolved "https://registry.npmjs.org/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.0.tgz#c14c24f18ea8190c118ee7562b7ff99a36552686" + integrity sha512-plGgXAPfVKFoYfa9NpYDAkseG+g6Jr294RqeqcqDixSbU34MZVJRi/P+7Y8GDpzkEwLaGZZOpKIEmeVZNtKsrg== + dependencies: + "@types/istanbul-lib-coverage" "*" + +"@types/istanbul-reports@^3.0.0": + version "3.0.1" + resolved "https://registry.npmjs.org/@types/istanbul-reports/-/istanbul-reports-3.0.1.tgz#9153fe98bba2bd565a63add9436d6f0d7f8468ff" + integrity sha512-c3mAZEuK0lvBp8tmuL74XRKn1+y2dcwOUpH7x4WrF6gk1GIgiluDRgMYQtw2OFcBvAJWlt6ASU3tSqxp0Uu0Aw== + dependencies: + "@types/istanbul-lib-report" "*" + +"@types/jest@^27.4.1": + version "27.4.1" + resolved "https://registry.npmjs.org/@types/jest/-/jest-27.4.1.tgz#185cbe2926eaaf9662d340cc02e548ce9e11ab6d" + integrity sha512-23iPJADSmicDVrWk+HT58LMJtzLAnB2AgIzplQuq/bSrGaxCrlvRFjGbXmamnnk/mAmCdLStiGqggu28ocUyiw== + dependencies: + jest-matcher-utils "^27.0.0" + pretty-format "^27.0.0" + +"@types/json-schema@^7.0.9": + version "7.0.11" + resolved "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.11.tgz#d421b6c527a3037f7c84433fd2c4229e016863d3" + integrity sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ== + +"@types/json5@^0.0.29": + version "0.0.29" + resolved "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz#ee28707ae94e11d2b827bcbe5270bcea7f3e71ee" + integrity sha1-7ihweulOEdK4J7y+UnC86n8+ce4= + +"@types/minimatch@*": + version "3.0.5" + resolved "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.5.tgz#1001cc5e6a3704b83c236027e77f2f58ea010f40" + integrity sha512-Klz949h02Gz2uZCMGwDUSDS1YBlTdDDgbWHi+81l29tQALUtvz4rAYi5uoVhE5Lagoq6DeqAUlbrHvW/mXDgdQ== + +"@types/minimist@^1.2.0": + version "1.2.2" + resolved "https://registry.npmjs.org/@types/minimist/-/minimist-1.2.2.tgz#ee771e2ba4b3dc5b372935d549fd9617bf345b8c" + integrity sha512-jhuKLIRrhvCPLqwPcx6INqmKeiA5EWrsCOPhrlFSrbrmU4ZMPjj5Ul/oLCMDO98XRUIwVm78xICz4EPCektzeQ== + +"@types/node@*": + version "17.0.23" + resolved "https://registry.yarnpkg.com/@types/node/-/node-17.0.23.tgz#3b41a6e643589ac6442bdbd7a4a3ded62f33f7da" + integrity sha512-UxDxWn7dl97rKVeVS61vErvw086aCYhDLyvRQZ5Rk65rZKepaFdm53GeqXaKBuOhED4e9uWq34IC3TdSdJJ2Gw== + +"@types/node@^12": + version "12.20.47" + resolved "https://registry.npmjs.org/@types/node/-/node-12.20.47.tgz#ca9237d51f2a2557419688511dab1c8daf475188" + integrity sha512-BzcaRsnFuznzOItW1WpQrDHM7plAa7GIDMZ6b5pnMbkqEtM/6WCOhvZar39oeMQP79gwvFUWjjptE7/KGcNqFg== + +"@types/normalize-package-data@^2.4.0": + version "2.4.1" + resolved "https://registry.npmjs.org/@types/normalize-package-data/-/normalize-package-data-2.4.1.tgz#d3357479a0fdfdd5907fe67e17e0a85c906e1301" + integrity sha512-Gj7cI7z+98M282Tqmp2K5EIsoouUEzbBJhQQzDE3jSIRk6r9gsz0oUokqIUR4u1R3dMHo0pDHM7sNOHyhulypw== + +"@types/prettier@^2.1.5": + version "2.4.4" + resolved "https://registry.npmjs.org/@types/prettier/-/prettier-2.4.4.tgz#5d9b63132df54d8909fce1c3f8ca260fdd693e17" + integrity sha512-ReVR2rLTV1kvtlWFyuot+d1pkpG2Fw/XKE3PDAdj57rbM97ttSp9JZ2UsP+2EHTylra9cUf6JA7tGwW1INzUrA== + +"@types/stack-utils@^2.0.0": + version "2.0.1" + resolved "https://registry.npmjs.org/@types/stack-utils/-/stack-utils-2.0.1.tgz#20f18294f797f2209b5f65c8e3b5c8e8261d127c" + integrity sha512-Hl219/BT5fLAaz6NDkSuhzasy49dwQS/DSdu4MdggFB8zcXv7vflBI3xp7FEmkmdDkBUI2bPUNeMttp2knYdxw== + +"@types/yargs-parser@*": + version "21.0.0" + resolved "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-21.0.0.tgz#0c60e537fa790f5f9472ed2776c2b71ec117351b" + integrity sha512-iO9ZQHkZxHn4mSakYV0vFHAVDyEOIJQrV2uZ06HxEPcx+mt8swXoZHIbaaJ2crJYFfErySgktuTZ3BeLz+XmFA== + +"@types/yargs@^16.0.0": + version "16.0.4" + resolved "https://registry.npmjs.org/@types/yargs/-/yargs-16.0.4.tgz#26aad98dd2c2a38e421086ea9ad42b9e51642977" + integrity sha512-T8Yc9wt/5LbJyCaLiHPReJa0kApcIgJ7Bn735GjItUfh08Z1pJvu8QZqb9s+mMvKV6WUQRV7K2R46YbjMXTTJw== + dependencies: + "@types/yargs-parser" "*" + +"@typescript-eslint/eslint-plugin@^5": + version "5.16.0" + resolved "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-5.16.0.tgz#78f246dd8d1b528fc5bfca99a8a64d4023a3d86d" + integrity sha512-SJoba1edXvQRMmNI505Uo4XmGbxCK9ARQpkvOd00anxzri9RNQk0DDCxD+LIl+jYhkzOJiOMMKYEHnHEODjdCw== + dependencies: + "@typescript-eslint/scope-manager" "5.16.0" + "@typescript-eslint/type-utils" "5.16.0" + "@typescript-eslint/utils" "5.16.0" + debug "^4.3.2" + functional-red-black-tree "^1.0.1" + ignore "^5.1.8" + regexpp "^3.2.0" + semver "^7.3.5" + tsutils "^3.21.0" + +"@typescript-eslint/parser@^5": + version "5.16.0" + resolved "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-5.16.0.tgz#e4de1bde4b4dad5b6124d3da227347616ed55508" + integrity sha512-fkDq86F0zl8FicnJtdXakFs4lnuebH6ZADDw6CYQv0UZeIjHvmEw87m9/29nk2Dv5Lmdp0zQ3zDQhiMWQf/GbA== + dependencies: + "@typescript-eslint/scope-manager" "5.16.0" + "@typescript-eslint/types" "5.16.0" + "@typescript-eslint/typescript-estree" "5.16.0" + debug "^4.3.2" + +"@typescript-eslint/scope-manager@5.16.0": + version "5.16.0" + resolved "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-5.16.0.tgz#7e7909d64bd0c4d8aef629cdc764b9d3e1d3a69a" + integrity sha512-P+Yab2Hovg8NekLIR/mOElCDPyGgFZKhGoZA901Yax6WR6HVeGLbsqJkZ+Cvk5nts/dAlFKm8PfL43UZnWdpIQ== + dependencies: + "@typescript-eslint/types" "5.16.0" + "@typescript-eslint/visitor-keys" "5.16.0" + +"@typescript-eslint/type-utils@5.16.0": + version "5.16.0" + resolved "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-5.16.0.tgz#b482bdde1d7d7c0c7080f7f2f67ea9580b9e0692" + integrity sha512-SKygICv54CCRl1Vq5ewwQUJV/8padIWvPgCxlWPGO/OgQLCijY9G7lDu6H+mqfQtbzDNlVjzVWQmeqbLMBLEwQ== + dependencies: + "@typescript-eslint/utils" "5.16.0" + debug "^4.3.2" + tsutils "^3.21.0" + +"@typescript-eslint/types@5.16.0": + version "5.16.0" + resolved "https://registry.npmjs.org/@typescript-eslint/types/-/types-5.16.0.tgz#5827b011982950ed350f075eaecb7f47d3c643ee" + integrity sha512-oUorOwLj/3/3p/HFwrp6m/J2VfbLC8gjW5X3awpQJ/bSG+YRGFS4dpsvtQ8T2VNveV+LflQHjlLvB6v0R87z4g== + +"@typescript-eslint/typescript-estree@5.16.0": + version "5.16.0" + resolved "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-5.16.0.tgz#32259459ec62f5feddca66adc695342f30101f61" + integrity sha512-SE4VfbLWUZl9MR+ngLSARptUv2E8brY0luCdgmUevU6arZRY/KxYoLI/3V/yxaURR8tLRN7bmZtJdgmzLHI6pQ== + dependencies: + "@typescript-eslint/types" "5.16.0" + "@typescript-eslint/visitor-keys" "5.16.0" + debug "^4.3.2" + globby "^11.0.4" + is-glob "^4.0.3" + semver "^7.3.5" + tsutils "^3.21.0" + +"@typescript-eslint/utils@5.16.0": + version "5.16.0" + resolved "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-5.16.0.tgz#42218b459d6d66418a4eb199a382bdc261650679" + integrity sha512-iYej2ER6AwmejLWMWzJIHy3nPJeGDuCqf8Jnb+jAQVoPpmWzwQOfa9hWVB8GIQE5gsCv/rfN4T+AYb/V06WseQ== + dependencies: + "@types/json-schema" "^7.0.9" + "@typescript-eslint/scope-manager" "5.16.0" + "@typescript-eslint/types" "5.16.0" + "@typescript-eslint/typescript-estree" "5.16.0" + eslint-scope "^5.1.1" + eslint-utils "^3.0.0" + +"@typescript-eslint/visitor-keys@5.16.0": + version "5.16.0" + resolved "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-5.16.0.tgz#f27dc3b943e6317264c7492e390c6844cd4efbbb" + integrity sha512-jqxO8msp5vZDhikTwq9ubyMHqZ67UIvawohr4qF3KhlpL7gzSjOd+8471H3nh5LyABkaI85laEKKU8SnGUK5/g== + dependencies: + "@typescript-eslint/types" "5.16.0" + eslint-visitor-keys "^3.0.0" + +"@xmldom/xmldom@^0.8.1": + version "0.8.1" + resolved "https://registry.npmjs.org/@xmldom/xmldom/-/xmldom-0.8.1.tgz#70c239275fc6d6a84e41b9a8d623a93c0d59b6b4" + integrity sha512-4wOae+5N2RZ+CZXd9ZKwkaDi55IxrSTOjHpxTvQQ4fomtOJmqVxbmICA9jE1jvnqNhpfgz8cnfFagG86wV/xLQ== + +JSONStream@^1.0.4: + version "1.3.5" + resolved "https://registry.npmjs.org/JSONStream/-/JSONStream-1.3.5.tgz#3208c1f08d3a4d99261ab64f92302bc15e111ca0" + integrity sha512-E+iruNOY8VV9s4JEbe1aNEm6MiszPRr/UfcHMz0TQh1BXSxHK+ASV1R6W4HpjBhSeS+54PIsAMCBmwD06LLsqQ== + dependencies: + jsonparse "^1.2.0" + through ">=2.2.7 <3" + +abab@^2.0.3, abab@^2.0.5: + version "2.0.5" + resolved "https://registry.npmjs.org/abab/-/abab-2.0.5.tgz#c0b678fb32d60fc1219c784d6a826fe385aeb79a" + integrity sha512-9IK9EadsbHo6jLWIpxpR6pL0sazTXV6+SQv25ZB+F7Bj9mJNaOc4nCRabwd5M/JwmUa8idz6Eci6eKfJryPs6Q== + +abbrev@1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/abbrev/-/abbrev-1.1.1.tgz#f8f2c887ad10bf67f634f005b6987fed3179aac8" + integrity sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q== + +acorn-globals@^6.0.0: + version "6.0.0" + resolved "https://registry.npmjs.org/acorn-globals/-/acorn-globals-6.0.0.tgz#46cdd39f0f8ff08a876619b55f5ac8a6dc770b45" + integrity sha512-ZQl7LOWaF5ePqqcX4hLuv/bLXYQNfNWw2c0/yX/TsPRKamzHcTGQnlCjHT3TsmkOUVEPS3crCxiPfdzE/Trlhg== + dependencies: + acorn "^7.1.1" + acorn-walk "^7.1.1" + +acorn-jsx@^5.3.1: + version "5.3.2" + resolved "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz#7ed5bb55908b3b2f1bc55c6af1653bada7f07937" + integrity sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ== + +acorn-walk@^7.1.1: + version "7.2.0" + resolved "https://registry.npmjs.org/acorn-walk/-/acorn-walk-7.2.0.tgz#0de889a601203909b0fbe07b8938dc21d2e967bc" + integrity sha512-OPdCF6GsMIP+Az+aWfAAOEt2/+iVDKE7oy6lJ098aoe59oAmK76qV6Gw60SbZ8jHuG2wH058GF4pLFbYamYrVA== + +acorn@^7.1.1: + version "7.4.1" + resolved "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz#feaed255973d2e77555b83dbc08851a6c63520fa" + integrity sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A== + +acorn@^8.2.4, acorn@^8.7.0: + version "8.7.0" + resolved "https://registry.npmjs.org/acorn/-/acorn-8.7.0.tgz#90951fde0f8f09df93549481e5fc141445b791cf" + integrity sha512-V/LGr1APy+PXIwKebEWrkZPwoeoF+w1jiOBUmuxuiUIaOHtob8Qc9BTrYo7VuI5fR8tqsy+buA2WFooR5olqvQ== + +add-stream@^1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/add-stream/-/add-stream-1.0.0.tgz#6a7990437ca736d5e1288db92bd3266d5f5cb2aa" + integrity sha1-anmQQ3ynNtXhKI25K9MmbV9csqo= + +agent-base@6, agent-base@^6.0.2: + version "6.0.2" + resolved "https://registry.yarnpkg.com/agent-base/-/agent-base-6.0.2.tgz#49fff58577cfee3f37176feab4c22e00f86d7f77" + integrity sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ== + dependencies: + debug "4" + +agentkeepalive@^4.2.1: + version "4.2.1" + resolved "https://registry.yarnpkg.com/agentkeepalive/-/agentkeepalive-4.2.1.tgz#a7975cbb9f83b367f06c90cc51ff28fe7d499717" + integrity sha512-Zn4cw2NEqd+9fiSVWMscnjyQ1a8Yfoc5oBajLeo5w+YBHgDUcEBY2hS4YpTz6iN5f/2zQiktcuM6tS8x1p9dpA== + dependencies: + debug "^4.1.0" + depd "^1.1.2" + humanize-ms "^1.2.1" + +aggregate-error@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/aggregate-error/-/aggregate-error-3.1.0.tgz#92670ff50f5359bdb7a3e0d40d0ec30c5737687a" + integrity sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA== + dependencies: + clean-stack "^2.0.0" + indent-string "^4.0.0" + +ajv@^6.10.0, ajv@^6.12.4: + version "6.12.6" + resolved "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz#baf5a62e802b07d977034586f8c3baf5adf26df4" + integrity sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g== + dependencies: + fast-deep-equal "^3.1.1" + fast-json-stable-stringify "^2.0.0" + json-schema-traverse "^0.4.1" + uri-js "^4.2.2" + +ansi-align@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/ansi-align/-/ansi-align-3.0.1.tgz#0cdf12e111ace773a86e9a1fad1225c43cb19a59" + integrity sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w== + dependencies: + string-width "^4.1.0" + +ansi-escapes@^4.2.1: + version "4.3.2" + resolved "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz#6b2291d1db7d98b6521d5f1efa42d0f3a9feb65e" + integrity sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ== + dependencies: + type-fest "^0.21.3" + +ansi-regex@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304" + integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== + +ansi-styles@^3.2.1: + version "3.2.1" + resolved "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz#41fbb20243e50b12be0f04b8dedbf07520ce841d" + integrity sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA== + dependencies: + color-convert "^1.9.0" + +ansi-styles@^4.0.0, ansi-styles@^4.1.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-4.3.0.tgz#edd803628ae71c04c85ae7a0906edad34b648937" + integrity sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg== + dependencies: + color-convert "^2.0.1" + +ansi-styles@^5.0.0: + version "5.2.0" + resolved "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz#07449690ad45777d1924ac2abb2fc8895dba836b" + integrity sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA== + +anymatch@^3.0.3: + version "3.1.2" + resolved "https://registry.npmjs.org/anymatch/-/anymatch-3.1.2.tgz#c0557c096af32f106198f4f4e2a383537e378716" + integrity sha512-P43ePfOAIupkguHUycrc4qJ9kz8ZiuOUijaETwX7THt0Y/GNK7v0aa8rY816xWjZ7rJdA5XdMcpVFTKMq+RvWg== + dependencies: + normalize-path "^3.0.0" + picomatch "^2.0.4" + +"aproba@^1.0.3 || ^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/aproba/-/aproba-2.0.0.tgz#52520b8ae5b569215b354efc0caa3fe1e45a8adc" + integrity sha512-lYe4Gx7QT+MKGbDsA+Z+he/Wtef0BiwDOlK/XkBrdfsh9J/jPPXbX0tE9x9cl27Tmu5gg3QUbUrQYa/y+KOHPQ== + +are-we-there-yet@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/are-we-there-yet/-/are-we-there-yet-3.0.0.tgz#ba20bd6b553e31d62fc8c31bd23d22b95734390d" + integrity sha512-0GWpv50YSOcLXaN6/FAKY3vfRbllXWV2xvfA/oKJF8pzFhWXPV+yjhJXDBbjscDYowv7Yw1A3uigpzn5iEGTyw== + dependencies: + delegates "^1.0.0" + readable-stream "^3.6.0" + +argparse@^1.0.7: + version "1.0.10" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-1.0.10.tgz#bcd6791ea5ae09725e17e5ad988134cd40b3d911" + integrity sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg== + dependencies: + sprintf-js "~1.0.2" + +argparse@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38" + integrity sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q== + +array-ify@^1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/array-ify/-/array-ify-1.0.0.tgz#9e528762b4a9066ad163a6962a364418e9626ece" + integrity sha1-nlKHYrSpBmrRY6aWKjZEGOlibs4= + +array-includes@^3.1.4: + version "3.1.4" + resolved "https://registry.npmjs.org/array-includes/-/array-includes-3.1.4.tgz#f5b493162c760f3539631f005ba2bb46acb45ba9" + integrity sha512-ZTNSQkmWumEbiHO2GF4GmWxYVTiQyJy2XOTa15sdQSrvKn7l+180egQMqlrMOUMCyLMD7pmyQe4mMDUT6Behrw== + dependencies: + call-bind "^1.0.2" + define-properties "^1.1.3" + es-abstract "^1.19.1" + get-intrinsic "^1.1.1" + is-string "^1.0.7" + +array-union@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/array-union/-/array-union-2.1.0.tgz#b798420adbeb1de828d84acd8a2e23d3efe85e8d" + integrity sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw== + +array.prototype.flat@^1.2.5: + version "1.2.5" + resolved "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.2.5.tgz#07e0975d84bbc7c48cd1879d609e682598d33e13" + integrity sha512-KaYU+S+ndVqyUnignHftkwc58o3uVU1jzczILJ1tN2YaIZpFIKBiP/x/j97E5MVPsaCloPbqWLB/8qCTVvT2qg== + dependencies: + call-bind "^1.0.2" + define-properties "^1.1.3" + es-abstract "^1.19.0" + +arrify@^1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/arrify/-/arrify-1.0.1.tgz#898508da2226f380df904728456849c1501a4b0d" + integrity sha1-iYUI2iIm84DfkEcoRWhJwVAaSw0= + +asynckit@^0.4.0: + version "0.4.0" + resolved "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79" + integrity sha1-x57Zf380y48robyXkLzDZkdLS3k= + +at-least-node@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/at-least-node/-/at-least-node-1.0.0.tgz#602cd4b46e844ad4effc92a8011a3c46e0238dc2" + integrity sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg== + +available-typed-arrays@^1.0.5: + version "1.0.5" + resolved "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.5.tgz#92f95616501069d07d10edb2fc37d3e1c65123b7" + integrity sha512-DMD0KiN46eipeziST1LPP/STfDU0sufISXmjSgvVsoU2tqxctQeASejWcfNtxYKqETM1UxQ8sp2OrSBWpHY6sw== + +babel-jest@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/babel-jest/-/babel-jest-27.5.1.tgz#a1bf8d61928edfefd21da27eb86a695bfd691444" + integrity sha512-cdQ5dXjGRd0IBRATiQ4mZGlGlRE8kJpjPOixdNRdT+m3UcNqmYWN6rK6nvtXYfY3D76cb8s/O1Ss8ea24PIwcg== + dependencies: + "@jest/transform" "^27.5.1" + "@jest/types" "^27.5.1" + "@types/babel__core" "^7.1.14" + babel-plugin-istanbul "^6.1.1" + babel-preset-jest "^27.5.1" + chalk "^4.0.0" + graceful-fs "^4.2.9" + slash "^3.0.0" + +babel-plugin-istanbul@^6.1.1: + version "6.1.1" + resolved "https://registry.npmjs.org/babel-plugin-istanbul/-/babel-plugin-istanbul-6.1.1.tgz#fa88ec59232fd9b4e36dbbc540a8ec9a9b47da73" + integrity sha512-Y1IQok9821cC9onCx5otgFfRm7Lm+I+wwxOx738M/WLPZ9Q42m4IG5W0FNX8WLL2gYMZo3JkuXIH2DOpWM+qwA== + dependencies: + "@babel/helper-plugin-utils" "^7.0.0" + "@istanbuljs/load-nyc-config" "^1.0.0" + "@istanbuljs/schema" "^0.1.2" + istanbul-lib-instrument "^5.0.4" + test-exclude "^6.0.0" + +babel-plugin-jest-hoist@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-27.5.1.tgz#9be98ecf28c331eb9f5df9c72d6f89deb8181c2e" + integrity sha512-50wCwD5EMNW4aRpOwtqzyZHIewTYNxLA4nhB+09d8BIssfNfzBRhkBIHiaPv1Si226TQSvp8gxAJm2iY2qs2hQ== + dependencies: + "@babel/template" "^7.3.3" + "@babel/types" "^7.3.3" + "@types/babel__core" "^7.0.0" + "@types/babel__traverse" "^7.0.6" + +babel-preset-current-node-syntax@^1.0.0: + version "1.0.1" + resolved "https://registry.npmjs.org/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.0.1.tgz#b4399239b89b2a011f9ddbe3e4f401fc40cff73b" + integrity sha512-M7LQ0bxarkxQoN+vz5aJPsLBn77n8QgTFmo8WK0/44auK2xlCXrYcUxHFxgU7qW5Yzw/CjmLRK2uJzaCd7LvqQ== + dependencies: + "@babel/plugin-syntax-async-generators" "^7.8.4" + "@babel/plugin-syntax-bigint" "^7.8.3" + "@babel/plugin-syntax-class-properties" "^7.8.3" + "@babel/plugin-syntax-import-meta" "^7.8.3" + "@babel/plugin-syntax-json-strings" "^7.8.3" + "@babel/plugin-syntax-logical-assignment-operators" "^7.8.3" + "@babel/plugin-syntax-nullish-coalescing-operator" "^7.8.3" + "@babel/plugin-syntax-numeric-separator" "^7.8.3" + "@babel/plugin-syntax-object-rest-spread" "^7.8.3" + "@babel/plugin-syntax-optional-catch-binding" "^7.8.3" + "@babel/plugin-syntax-optional-chaining" "^7.8.3" + "@babel/plugin-syntax-top-level-await" "^7.8.3" + +babel-preset-jest@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-27.5.1.tgz#91f10f58034cb7989cb4f962b69fa6eef6a6bc81" + integrity sha512-Nptf2FzlPCWYuJg41HBqXVT8ym6bXOevuCTbhxlUpjwtysGaIWFvDEjp4y+G7fl13FgOdjs7P/DmErqH7da0Ag== + dependencies: + babel-plugin-jest-hoist "^27.5.1" + babel-preset-current-node-syntax "^1.0.0" + +balanced-match@^1.0.0: + version "1.0.2" + resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.2.tgz#e83e3a7e3f300b34cb9d87f615fa0cbf357690ee" + integrity sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw== + +boxen@^5.0.0: + version "5.1.2" + resolved "https://registry.yarnpkg.com/boxen/-/boxen-5.1.2.tgz#788cb686fc83c1f486dfa8a40c68fc2b831d2b50" + integrity sha512-9gYgQKXx+1nP8mP7CzFyaUARhg7D3n1dF/FnErWmu9l6JvGpNUN278h0aSb+QjoiKSWG+iZ3uHrcqk0qrY9RQQ== + dependencies: + ansi-align "^3.0.0" + camelcase "^6.2.0" + chalk "^4.1.0" + cli-boxes "^2.2.1" + string-width "^4.2.2" + type-fest "^0.20.2" + widest-line "^3.1.0" + wrap-ansi "^7.0.0" + +brace-expansion@^1.1.7: + version "1.1.11" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.11.tgz#3c7fcbf529d87226f3d2f52b966ff5271eb441dd" + integrity sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA== + dependencies: + balanced-match "^1.0.0" + concat-map "0.0.1" + +brace-expansion@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.1.tgz#1edc459e0f0c548486ecf9fc99f2221364b9a0ae" + integrity sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA== + dependencies: + balanced-match "^1.0.0" + +braces@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.2.tgz#3454e1a462ee8d599e236df336cd9ea4f8afe107" + integrity sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A== + dependencies: + fill-range "^7.0.1" + +browser-process-hrtime@^1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/browser-process-hrtime/-/browser-process-hrtime-1.0.0.tgz#3c9b4b7d782c8121e56f10106d84c0d0ffc94626" + integrity sha512-9o5UecI3GhkpM6DrXr69PblIuWxPKk9Y0jHBRhdocZ2y7YECBFCsHm79Pr3OyR2AvjhDkabFJaDJMYRazHgsow== + +browserslist@^4.17.5: + version "4.20.2" + resolved "https://registry.npmjs.org/browserslist/-/browserslist-4.20.2.tgz#567b41508757ecd904dab4d1c646c612cd3d4f88" + integrity sha512-CQOBCqp/9pDvDbx3xfMi+86pr4KXIf2FDkTTdeuYw8OxS9t898LA1Khq57gtufFILXpfgsSx5woNgsBgvGjpsA== + dependencies: + caniuse-lite "^1.0.30001317" + electron-to-chromium "^1.4.84" + escalade "^3.1.1" + node-releases "^2.0.2" + picocolors "^1.0.0" + +bs-logger@0.x: + version "0.2.6" + resolved "https://registry.npmjs.org/bs-logger/-/bs-logger-0.2.6.tgz#eb7d365307a72cf974cc6cda76b68354ad336bd8" + integrity sha512-pd8DCoxmbgc7hyPKOvxtqNcjYoOsABPQdcCUjGp3d42VR2CX1ORhk2A87oqqu5R1kk+76nsxZupkmyd+MVtCog== + dependencies: + fast-json-stable-stringify "2.x" + +bser@2.1.1: + version "2.1.1" + resolved "https://registry.npmjs.org/bser/-/bser-2.1.1.tgz#e6787da20ece9d07998533cfd9de6f5c38f4bc05" + integrity sha512-gQxTNE/GAfIIrmHLUE3oJyp5FO6HRBfhjnw4/wMmA63ZGDJnWBmgY/lyQBpnDUkGmAhbSe39tx2d/iTOAfglwQ== + dependencies: + node-int64 "^0.4.0" + +buffer-from@^1.0.0: + version "1.1.2" + resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.1.2.tgz#2b146a6fd72e80b4f55d255f35ed59a3a9a41bd5" + integrity sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ== + +builtins@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/builtins/-/builtins-1.0.3.tgz#cb94faeb61c8696451db36534e1422f94f0aee88" + integrity sha1-y5T662HIaWRR2zZTThQi+U8K7og= + +cacache@^16.0.0, cacache@^16.0.2: + version "16.0.3" + resolved "https://registry.yarnpkg.com/cacache/-/cacache-16.0.3.tgz#0b6314bde969bd4098b03a5f90a351e8a1483f48" + integrity sha512-eC7wYodNCVb97kuHGk5P+xZsvUJHkhSEOyNwkenqQPAsOtrTjvWOE5vSPNBpz9d8X3acIf6w2Ub5s4rvOCTs4g== + dependencies: + "@npmcli/fs" "^2.1.0" + "@npmcli/move-file" "^1.1.2" + chownr "^2.0.0" + fs-minipass "^2.1.0" + glob "^7.2.0" + infer-owner "^1.0.4" + lru-cache "^7.7.1" + minipass "^3.1.6" + minipass-collect "^1.0.2" + minipass-flush "^1.0.5" + minipass-pipeline "^1.2.4" + mkdirp "^1.0.4" + p-map "^4.0.0" + promise-inflight "^1.0.1" + rimraf "^3.0.2" + ssri "^8.0.1" + tar "^6.1.11" + unique-filename "^1.1.1" + +cacheable-request@^6.0.0: + version "6.1.0" + resolved "https://registry.yarnpkg.com/cacheable-request/-/cacheable-request-6.1.0.tgz#20ffb8bd162ba4be11e9567d823db651052ca912" + integrity sha512-Oj3cAGPCqOZX7Rz64Uny2GYAZNliQSqfbePrgAQ1wKAihYmCUnraBtJtKcGR4xz7wF+LoJC+ssFZvv5BgF9Igg== + dependencies: + clone-response "^1.0.2" + get-stream "^5.1.0" + http-cache-semantics "^4.0.0" + keyv "^3.0.0" + lowercase-keys "^2.0.0" + normalize-url "^4.1.0" + responselike "^1.0.2" + +call-bind@^1.0.0, call-bind@^1.0.2: + version "1.0.2" + resolved "https://registry.npmjs.org/call-bind/-/call-bind-1.0.2.tgz#b1d4e89e688119c3c9a903ad30abb2f6a919be3c" + integrity sha512-7O+FbCihrB5WGbFYesctwmTKae6rOiIzmz1icreWJ+0aA7LJfuqhEso2T9ncpcFtzMQtzXf2QGGueWJGTYsqrA== + dependencies: + function-bind "^1.1.1" + get-intrinsic "^1.0.2" + +callsites@^3.0.0: + version "3.1.0" + resolved "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz#b3630abd8943432f54b3f0519238e33cd7df2f73" + integrity sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ== + +camelcase-keys@^6.2.2: + version "6.2.2" + resolved "https://registry.npmjs.org/camelcase-keys/-/camelcase-keys-6.2.2.tgz#5e755d6ba51aa223ec7d3d52f25778210f9dc3c0" + integrity sha512-YrwaA0vEKazPBkn0ipTiMpSajYDSe+KjQfrjhcBMxJt/znbvlHd8Pw/Vamaz5EB4Wfhs3SUR3Z9mwRu/P3s3Yg== + dependencies: + camelcase "^5.3.1" + map-obj "^4.0.0" + quick-lru "^4.0.1" + +camelcase@^5.3.1: + version "5.3.1" + resolved "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz#e3c9b31569e106811df242f715725a1f4c494320" + integrity sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg== + +camelcase@^6.2.0, camelcase@^6.3.0: + version "6.3.0" + resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-6.3.0.tgz#5685b95eb209ac9c0c177467778c9c84df58ba9a" + integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA== + +caniuse-lite@^1.0.30001317: + version "1.0.30001320" + resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001320.tgz#8397391bec389b8ccce328636499b7284ee13285" + integrity sha512-MWPzG54AGdo3nWx7zHZTefseM5Y1ccM7hlQKHRqJkPozUaw3hNbBTMmLn16GG2FUzjR13Cr3NPfhIieX5PzXDA== + +case@^1.6.3: + version "1.6.3" + resolved "https://registry.yarnpkg.com/case/-/case-1.6.3.tgz#0a4386e3e9825351ca2e6216c60467ff5f1ea1c9" + integrity sha512-mzDSXIPaFwVDvZAHqZ9VlbyF4yyXRuX6IvB06WvPYkqJVO24kX1PPhv9bfpKNFZyxYFmmgo03HUiD8iklmJYRQ== + +cdk8s@1.4.10: + version "1.4.10" + resolved "https://registry.npmjs.org/cdk8s/-/cdk8s-1.4.10.tgz#9d837cd9a781c2f65eb3215519c5d6d07828cf7f" + integrity sha512-k0dLzCGg0i7MJFG6wr9mvaq3aaGS2nbwkOtwojiHiGj3wMNLPgZwrZ37s6ZRhquWdZqkOnAfgU7QgxRNmE6wgw== + dependencies: + fast-json-patch "^2.2.1" + follow-redirects "^1.14.7" + yaml "2.0.0-7" + +chalk@^2.0.0, chalk@^2.4.2: + version "2.4.2" + resolved "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz#cd42541677a54333cf541a49108c1432b44c9424" + integrity sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ== + dependencies: + ansi-styles "^3.2.1" + escape-string-regexp "^1.0.5" + supports-color "^5.3.0" + +chalk@^4, chalk@^4.0.0, chalk@^4.1.0, chalk@^4.1.2: + version "4.1.2" + resolved "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz#aac4e2b7734a740867aeb16bf02aad556a1e7a01" + integrity sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA== + dependencies: + ansi-styles "^4.1.0" + supports-color "^7.1.0" + +char-regex@^1.0.2: + version "1.0.2" + resolved "https://registry.npmjs.org/char-regex/-/char-regex-1.0.2.tgz#d744358226217f981ed58f479b1d6bcc29545dcf" + integrity sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw== + +chownr@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/chownr/-/chownr-2.0.0.tgz#15bfbe53d2eab4cf70f18a8cd68ebe5b3cb1dece" + integrity sha512-bIomtDF5KGpdogkLd9VspvFzk9KfpyyGlS8YFVZl7TGPBHL5snIOnxeshwVgPteQ9b4Eydl+pVbIyE1DcvCWgQ== + +ci-info@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-2.0.0.tgz#67a9e964be31a51e15e5010d58e6f12834002f46" + integrity sha512-5tK7EtrZ0N+OLFMthtqOj4fI2Jeb88C4CAZPu25LDVUgXJ0A3Js4PMGqrn0JU1W0Mh1/Z8wZzYPxqUrXeBboCQ== + +ci-info@^3.2.0: + version "3.3.0" + resolved "https://registry.npmjs.org/ci-info/-/ci-info-3.3.0.tgz#b4ed1fb6818dea4803a55c623041f9165d2066b2" + integrity sha512-riT/3vI5YpVH6/qomlDnJow6TBee2PBKSEpx3O32EGPYbWGIRsIlGRms3Sm74wYE1JMo8RnO04Hb12+v1J5ICw== + +cint@^8.2.1: + version "8.2.1" + resolved "https://registry.yarnpkg.com/cint/-/cint-8.2.1.tgz#70386b1b48e2773d0d63166a55aff94ef4456a12" + integrity sha1-cDhrG0jidz0NYxZqVa/5TvRFahI= + +cjs-module-lexer@^1.0.0: + version "1.2.2" + resolved "https://registry.npmjs.org/cjs-module-lexer/-/cjs-module-lexer-1.2.2.tgz#9f84ba3244a512f3a54e5277e8eef4c489864e40" + integrity sha512-cOU9usZw8/dXIXKtwa8pM0OTJQuJkxMN6w30csNRUerHfeQ5R6U3kkU/FtJeIf3M202OHfY2U8ccInBG7/xogA== + +clean-stack@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/clean-stack/-/clean-stack-2.2.0.tgz#ee8472dbb129e727b31e8a10a427dee9dfe4008b" + integrity sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A== + +cli-boxes@^2.2.1: + version "2.2.1" + resolved "https://registry.yarnpkg.com/cli-boxes/-/cli-boxes-2.2.1.tgz#ddd5035d25094fce220e9cab40a45840a440318f" + integrity sha512-y4coMcylgSCdVinjiDBuR8PCC2bLjyGTwEmPb9NHR/QaNU6EUOXcTY/s6VjGMD6ENSEaeQYHCY0GNGS5jfMwPw== + +cli-table@^0.3.11: + version "0.3.11" + resolved "https://registry.yarnpkg.com/cli-table/-/cli-table-0.3.11.tgz#ac69cdecbe81dccdba4889b9a18b7da312a9d3ee" + integrity sha512-IqLQi4lO0nIB4tcdTpN4LCB9FI3uqrJZK7RC515EnhZ6qBaglkIgICb1wjeAqpdoOabm1+SuQtkXIPdYC93jhQ== + dependencies: + colors "1.0.3" + +cliui@^7.0.2: + version "7.0.4" + resolved "https://registry.yarnpkg.com/cliui/-/cliui-7.0.4.tgz#a0265ee655476fc807aea9df3df8df7783808b4f" + integrity sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ== + dependencies: + string-width "^4.2.0" + strip-ansi "^6.0.0" + wrap-ansi "^7.0.0" + +clone-response@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/clone-response/-/clone-response-1.0.2.tgz#d1dc973920314df67fbeb94223b4ee350239e96b" + integrity sha1-0dyXOSAxTfZ/vrlCI7TuNQI56Ws= + dependencies: + mimic-response "^1.0.0" + +clone@^2.1.2: + version "2.1.2" + resolved "https://registry.npmjs.org/clone/-/clone-2.1.2.tgz#1b7f4b9f591f1e8f83670401600345a02887435f" + integrity sha1-G39Ln1kfHo+DZwQBYANFoCiHQ18= + +co@^4.6.0: + version "4.6.0" + resolved "https://registry.npmjs.org/co/-/co-4.6.0.tgz#6ea6bdf3d853ae54ccb8e47bfa0bf3f9031fb184" + integrity sha1-bqa989hTrlTMuOR7+gvz+QMfsYQ= + +codemaker@^1.55.1: + version "1.55.1" + resolved "https://registry.npmjs.org/codemaker/-/codemaker-1.55.1.tgz#ca2ae0e3c7a3e9909740a603648e68d4a20e1a76" + integrity sha512-W0MZSFgqfr9mgKbYLHsTNYTMKiXQE9hDHs6qke5dC5S9ZlFgcWG2zdpznknwvPLDDuWP8Z5QL71MjAM21hEPOg== + dependencies: + camelcase "^6.3.0" + decamelize "^5.0.1" + fs-extra "^9.1.0" + +collect-v8-coverage@^1.0.0: + version "1.0.1" + resolved "https://registry.npmjs.org/collect-v8-coverage/-/collect-v8-coverage-1.0.1.tgz#cc2c8e94fc18bbdffe64d6534570c8a673b27f59" + integrity sha512-iBPtljfCNcTKNAto0KEtDfZ3qzjJvqE3aTGZsbhjSBlorqpXJlaWWtPO35D+ZImoC3KWejX64o+yPGxhWSTzfg== + +color-convert@^1.9.0: + version "1.9.3" + resolved "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz#bb71850690e1f136567de629d2d5471deda4c1e8" + integrity sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg== + dependencies: + color-name "1.1.3" + +color-convert@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-2.0.1.tgz#72d3a68d598c9bdb3af2ad1e84f21d896abd4de3" + integrity sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ== + dependencies: + color-name "~1.1.4" + +color-name@1.1.3: + version "1.1.3" + resolved "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25" + integrity sha1-p9BVi9icQveV3UIyj3QIMcpTvCU= + +color-name@~1.1.4: + version "1.1.4" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2" + integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== + +color-support@^1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/color-support/-/color-support-1.1.3.tgz#93834379a1cc9a0c61f82f52f0d04322251bd5a2" + integrity sha512-qiBjkpbMLO/HL68y+lh4q0/O1MZFj2RX6X/KmMa3+gJD3z+WwI1ZzDHysvqHGS3mP6mznPckpXmw1nI9cJjyRg== + +colors@1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/colors/-/colors-1.0.3.tgz#0433f44d809680fdeb60ed260f1b0c262e82a40b" + integrity sha1-BDP0TYCWgP3rYO0mDxsMJi6CpAs= + +combined-stream@^1.0.8: + version "1.0.8" + resolved "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz#c3d45a8b34fd730631a110a8a2520682b31d5a7f" + integrity sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg== + dependencies: + delayed-stream "~1.0.0" + +commander@^9.0.0: + version "9.1.0" + resolved "https://registry.yarnpkg.com/commander/-/commander-9.1.0.tgz#a6b263b2327f2e188c6402c42623327909f2dbec" + integrity sha512-i0/MaqBtdbnJ4XQs4Pmyb+oFQl+q0lsAmokVUH92SlSw4fkeAcG3bVon+Qt7hmtF+u3Het6o4VgrcY3qAoEB6w== + +commonmark@^0.30.0: + version "0.30.0" + resolved "https://registry.npmjs.org/commonmark/-/commonmark-0.30.0.tgz#38811dc7bbf0f59d277ae09054d4d73a332f2e45" + integrity sha512-j1yoUo4gxPND1JWV9xj5ELih0yMv1iCWDG6eEQIPLSWLxzCXiFoyS7kvB+WwU+tZMf4snwJMMtaubV0laFpiBA== + dependencies: + entities "~2.0" + mdurl "~1.0.1" + minimist ">=1.2.2" + string.prototype.repeat "^0.2.0" + +compare-func@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/compare-func/-/compare-func-2.0.0.tgz#fb65e75edbddfd2e568554e8b5b05fff7a51fcb3" + integrity sha512-zHig5N+tPWARooBnb0Zx1MFcdfpyJrfTJ3Y5L+IFvUm8rM74hHz66z0gw0x4tijh5CorKkKUCnW82R2vmpeCRA== + dependencies: + array-ify "^1.0.0" + dot-prop "^5.1.0" + +concat-map@0.0.1: + version "0.0.1" + resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b" + integrity sha1-2Klr13/Wjfd5OnMDajug1UBdR3s= + +concat-stream@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/concat-stream/-/concat-stream-2.0.0.tgz#414cf5af790a48c60ab9be4527d56d5e41133cb1" + integrity sha512-MWufYdFw53ccGjCA+Ol7XJYpAlW6/prSMzuPOTRnJGcGzuhLn4Scrz7qf6o8bROZ514ltazcIFJZevcfbo0x7A== + dependencies: + buffer-from "^1.0.0" + inherits "^2.0.3" + readable-stream "^3.0.2" + typedarray "^0.0.6" + +configstore@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/configstore/-/configstore-5.0.1.tgz#d365021b5df4b98cdd187d6a3b0e3f6a7cc5ed96" + integrity sha512-aMKprgk5YhBNyH25hj8wGt2+D52Sw1DRRIzqBwLp2Ya9mFmY8KPvvtvmna8SxVR9JMZ4kzMD68N22vlaRpkeFA== + dependencies: + dot-prop "^5.2.0" + graceful-fs "^4.1.2" + make-dir "^3.0.0" + unique-string "^2.0.0" + write-file-atomic "^3.0.0" + xdg-basedir "^4.0.0" + +console-control-strings@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/console-control-strings/-/console-control-strings-1.1.0.tgz#3d7cf4464db6446ea644bf4b39507f9851008e8e" + integrity sha1-PXz0Rk22RG6mRL9LOVB/mFEAjo4= + +constructs@3.3.196: + version "3.3.196" + resolved "https://registry.npmjs.org/constructs/-/constructs-3.3.196.tgz#6662c3a07aa07e87e422f4120cb2d9eafdeae0a9" + integrity sha512-0Sz3L28vykhG57fc2DljNBph2MBkedSZZcYIArv+wDYKm3vvio2PNMbK66FB9Vl+dKicE/RV9LDMD/Cd3MSelg== + +conventional-changelog-angular@^5.0.12: + version "5.0.13" + resolved "https://registry.npmjs.org/conventional-changelog-angular/-/conventional-changelog-angular-5.0.13.tgz#896885d63b914a70d4934b59d2fe7bde1832b28c" + integrity sha512-i/gipMxs7s8L/QeuavPF2hLnJgH6pEZAttySB6aiQLWcX3puWDL3ACVmvBhJGxnAy52Qc15ua26BufY6KpmrVA== + dependencies: + compare-func "^2.0.0" + q "^1.5.1" + +conventional-changelog-atom@^2.0.8: + version "2.0.8" + resolved "https://registry.npmjs.org/conventional-changelog-atom/-/conventional-changelog-atom-2.0.8.tgz#a759ec61c22d1c1196925fca88fe3ae89fd7d8de" + integrity sha512-xo6v46icsFTK3bb7dY/8m2qvc8sZemRgdqLb/bjpBsH2UyOS8rKNTgcb5025Hri6IpANPApbXMg15QLb1LJpBw== + dependencies: + q "^1.5.1" + +conventional-changelog-codemirror@^2.0.8: + version "2.0.8" + resolved "https://registry.npmjs.org/conventional-changelog-codemirror/-/conventional-changelog-codemirror-2.0.8.tgz#398e9530f08ce34ec4640af98eeaf3022eb1f7dc" + integrity sha512-z5DAsn3uj1Vfp7po3gpt2Boc+Bdwmw2++ZHa5Ak9k0UKsYAO5mH1UBTN0qSCuJZREIhX6WU4E1p3IW2oRCNzQw== + dependencies: + q "^1.5.1" + +conventional-changelog-config-spec@2.1.0, conventional-changelog-config-spec@^2.1.0: + version "2.1.0" + resolved "https://registry.npmjs.org/conventional-changelog-config-spec/-/conventional-changelog-config-spec-2.1.0.tgz#874a635287ef8b581fd8558532bf655d4fb59f2d" + integrity sha512-IpVePh16EbbB02V+UA+HQnnPIohgXvJRxHcS5+Uwk4AT5LjzCZJm5sp/yqs5C6KZJ1jMsV4paEV13BN1pvDuxQ== + +conventional-changelog-conventionalcommits@4.6.1: + version "4.6.1" + resolved "https://registry.npmjs.org/conventional-changelog-conventionalcommits/-/conventional-changelog-conventionalcommits-4.6.1.tgz#f4c0921937050674e578dc7875f908351ccf4014" + integrity sha512-lzWJpPZhbM1R0PIzkwzGBCnAkH5RKJzJfFQZcl/D+2lsJxAwGnDKBqn/F4C1RD31GJNn8NuKWQzAZDAVXPp2Mw== + dependencies: + compare-func "^2.0.0" + lodash "^4.17.15" + q "^1.5.1" + +conventional-changelog-conventionalcommits@^4.5.0: + version "4.6.3" + resolved "https://registry.npmjs.org/conventional-changelog-conventionalcommits/-/conventional-changelog-conventionalcommits-4.6.3.tgz#0765490f56424b46f6cb4db9135902d6e5a36dc2" + integrity sha512-LTTQV4fwOM4oLPad317V/QNQ1FY4Hju5qeBIM1uTHbrnCE+Eg4CdRZ3gO2pUeR+tzWdp80M2j3qFFEDWVqOV4g== + dependencies: + compare-func "^2.0.0" + lodash "^4.17.15" + q "^1.5.1" + +conventional-changelog-core@^4.2.1: + version "4.2.4" + resolved "https://registry.npmjs.org/conventional-changelog-core/-/conventional-changelog-core-4.2.4.tgz#e50d047e8ebacf63fac3dc67bf918177001e1e9f" + integrity sha512-gDVS+zVJHE2v4SLc6B0sLsPiloR0ygU7HaDW14aNJE1v4SlqJPILPl/aJC7YdtRE4CybBf8gDwObBvKha8Xlyg== + dependencies: + add-stream "^1.0.0" + conventional-changelog-writer "^5.0.0" + conventional-commits-parser "^3.2.0" + dateformat "^3.0.0" + get-pkg-repo "^4.0.0" + git-raw-commits "^2.0.8" + git-remote-origin-url "^2.0.0" + git-semver-tags "^4.1.1" + lodash "^4.17.15" + normalize-package-data "^3.0.0" + q "^1.5.1" + read-pkg "^3.0.0" + read-pkg-up "^3.0.0" + through2 "^4.0.0" + +conventional-changelog-ember@^2.0.9: + version "2.0.9" + resolved "https://registry.npmjs.org/conventional-changelog-ember/-/conventional-changelog-ember-2.0.9.tgz#619b37ec708be9e74a220f4dcf79212ae1c92962" + integrity sha512-ulzIReoZEvZCBDhcNYfDIsLTHzYHc7awh+eI44ZtV5cx6LVxLlVtEmcO+2/kGIHGtw+qVabJYjdI5cJOQgXh1A== + dependencies: + q "^1.5.1" + +conventional-changelog-eslint@^3.0.9: + version "3.0.9" + resolved "https://registry.npmjs.org/conventional-changelog-eslint/-/conventional-changelog-eslint-3.0.9.tgz#689bd0a470e02f7baafe21a495880deea18b7cdb" + integrity sha512-6NpUCMgU8qmWmyAMSZO5NrRd7rTgErjrm4VASam2u5jrZS0n38V7Y9CzTtLT2qwz5xEChDR4BduoWIr8TfwvXA== + dependencies: + q "^1.5.1" + +conventional-changelog-express@^2.0.6: + version "2.0.6" + resolved "https://registry.npmjs.org/conventional-changelog-express/-/conventional-changelog-express-2.0.6.tgz#420c9d92a347b72a91544750bffa9387665a6ee8" + integrity sha512-SDez2f3iVJw6V563O3pRtNwXtQaSmEfTCaTBPCqn0oG0mfkq0rX4hHBq5P7De2MncoRixrALj3u3oQsNK+Q0pQ== + dependencies: + q "^1.5.1" + +conventional-changelog-jquery@^3.0.11: + version "3.0.11" + resolved "https://registry.npmjs.org/conventional-changelog-jquery/-/conventional-changelog-jquery-3.0.11.tgz#d142207400f51c9e5bb588596598e24bba8994bf" + integrity sha512-x8AWz5/Td55F7+o/9LQ6cQIPwrCjfJQ5Zmfqi8thwUEKHstEn4kTIofXub7plf1xvFA2TqhZlq7fy5OmV6BOMw== + dependencies: + q "^1.5.1" + +conventional-changelog-jshint@^2.0.9: + version "2.0.9" + resolved "https://registry.npmjs.org/conventional-changelog-jshint/-/conventional-changelog-jshint-2.0.9.tgz#f2d7f23e6acd4927a238555d92c09b50fe3852ff" + integrity sha512-wMLdaIzq6TNnMHMy31hql02OEQ8nCQfExw1SE0hYL5KvU+JCTuPaDO+7JiogGT2gJAxiUGATdtYYfh+nT+6riA== + dependencies: + compare-func "^2.0.0" + q "^1.5.1" + +conventional-changelog-preset-loader@^2.3.4: + version "2.3.4" + resolved "https://registry.npmjs.org/conventional-changelog-preset-loader/-/conventional-changelog-preset-loader-2.3.4.tgz#14a855abbffd59027fd602581f1f34d9862ea44c" + integrity sha512-GEKRWkrSAZeTq5+YjUZOYxdHq+ci4dNwHvpaBC3+ENalzFWuCWa9EZXSuZBpkr72sMdKB+1fyDV4takK1Lf58g== + +conventional-changelog-writer@^5.0.0: + version "5.0.1" + resolved "https://registry.npmjs.org/conventional-changelog-writer/-/conventional-changelog-writer-5.0.1.tgz#e0757072f045fe03d91da6343c843029e702f359" + integrity sha512-5WsuKUfxW7suLblAbFnxAcrvf6r+0b7GvNaWUwUIk0bXMnENP/PEieGKVUQrjPqwPT4o3EPAASBXiY6iHooLOQ== + dependencies: + conventional-commits-filter "^2.0.7" + dateformat "^3.0.0" + handlebars "^4.7.7" + json-stringify-safe "^5.0.1" + lodash "^4.17.15" + meow "^8.0.0" + semver "^6.0.0" + split "^1.0.0" + through2 "^4.0.0" + +conventional-changelog@3.1.24: + version "3.1.24" + resolved "https://registry.npmjs.org/conventional-changelog/-/conventional-changelog-3.1.24.tgz#ebd180b0fd1b2e1f0095c4b04fd088698348a464" + integrity sha512-ed6k8PO00UVvhExYohroVPXcOJ/K1N0/drJHx/faTH37OIZthlecuLIRX/T6uOp682CAoVoFpu+sSEaeuH6Asg== + dependencies: + conventional-changelog-angular "^5.0.12" + conventional-changelog-atom "^2.0.8" + conventional-changelog-codemirror "^2.0.8" + conventional-changelog-conventionalcommits "^4.5.0" + conventional-changelog-core "^4.2.1" + conventional-changelog-ember "^2.0.9" + conventional-changelog-eslint "^3.0.9" + conventional-changelog-express "^2.0.6" + conventional-changelog-jquery "^3.0.11" + conventional-changelog-jshint "^2.0.9" + conventional-changelog-preset-loader "^2.3.4" + +conventional-commits-filter@^2.0.7: + version "2.0.7" + resolved "https://registry.npmjs.org/conventional-commits-filter/-/conventional-commits-filter-2.0.7.tgz#f8d9b4f182fce00c9af7139da49365b136c8a0b3" + integrity sha512-ASS9SamOP4TbCClsRHxIHXRfcGCnIoQqkvAzCSbZzTFLfcTqJVugB0agRgsEELsqaeWgsXv513eS116wnlSSPA== + dependencies: + lodash.ismatch "^4.4.0" + modify-values "^1.0.0" + +conventional-commits-parser@^3.2.0: + version "3.2.4" + resolved "https://registry.npmjs.org/conventional-commits-parser/-/conventional-commits-parser-3.2.4.tgz#a7d3b77758a202a9b2293d2112a8d8052c740972" + integrity sha512-nK7sAtfi+QXbxHCYfhpZsfRtaitZLIA6889kFIouLvz6repszQDgxBu7wf2WbU+Dco7sAnNCJYERCwt54WPC2Q== + dependencies: + JSONStream "^1.0.4" + is-text-path "^1.0.1" + lodash "^4.17.15" + meow "^8.0.0" + split2 "^3.0.0" + through2 "^4.0.0" + +conventional-recommended-bump@6.1.0: + version "6.1.0" + resolved "https://registry.npmjs.org/conventional-recommended-bump/-/conventional-recommended-bump-6.1.0.tgz#cfa623285d1de554012f2ffde70d9c8a22231f55" + integrity sha512-uiApbSiNGM/kkdL9GTOLAqC4hbptObFo4wW2QRyHsKciGAfQuLU1ShZ1BIVI/+K2BE/W1AWYQMCXAsv4dyKPaw== + dependencies: + concat-stream "^2.0.0" + conventional-changelog-preset-loader "^2.3.4" + conventional-commits-filter "^2.0.7" + conventional-commits-parser "^3.2.0" + git-raw-commits "^2.0.8" + git-semver-tags "^4.1.1" + meow "^8.0.0" + q "^1.5.1" + +convert-source-map@^1.4.0, convert-source-map@^1.6.0, convert-source-map@^1.7.0: + version "1.8.0" + resolved "https://registry.npmjs.org/convert-source-map/-/convert-source-map-1.8.0.tgz#f3373c32d21b4d780dd8004514684fb791ca4369" + integrity sha512-+OQdjP49zViI/6i7nIJpA8rAl4sV/JdPfU9nZs3VqOwGIgizICvuN2ru6fMd+4llL0tar18UYJXfZ/TWtmhUjA== + dependencies: + safe-buffer "~5.1.1" + +core-util-is@~1.0.0: + version "1.0.3" + resolved "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.3.tgz#a6042d3634c2b27e9328f837b965fac83808db85" + integrity sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ== + +cross-spawn@^7.0.2, cross-spawn@^7.0.3: + version "7.0.3" + resolved "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz#f73a85b9d5d41d045551c177e2882d4ac85728a6" + integrity sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w== + dependencies: + path-key "^3.1.0" + shebang-command "^2.0.0" + which "^2.0.1" + +crypto-random-string@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/crypto-random-string/-/crypto-random-string-2.0.0.tgz#ef2a7a966ec11083388369baa02ebead229b30d5" + integrity sha512-v1plID3y9r/lPhviJ1wrXpLeyUIGAZ2SHNYTEapm7/8A9nLPoyvVp3RK/EPFqn5kEznyWgYZNsRtYYIWbuG8KA== + +cssom@^0.4.4: + version "0.4.4" + resolved "https://registry.npmjs.org/cssom/-/cssom-0.4.4.tgz#5a66cf93d2d0b661d80bf6a44fb65f5c2e4e0a10" + integrity sha512-p3pvU7r1MyyqbTk+WbNJIgJjG2VmTIaB10rI93LzVPrmDJKkzKYMtxxyAvQXR/NS6otuzveI7+7BBq3SjBS2mw== + +cssom@~0.3.6: + version "0.3.8" + resolved "https://registry.npmjs.org/cssom/-/cssom-0.3.8.tgz#9f1276f5b2b463f2114d3f2c75250af8c1a36f4a" + integrity sha512-b0tGHbfegbhPJpxpiBPU2sCkigAqtM9O121le6bbOlgyV+NyGyCmVfJ6QW9eRjz8CpNfWEOYBIMIGRYkLwsIYg== + +cssstyle@^2.3.0: + version "2.3.0" + resolved "https://registry.npmjs.org/cssstyle/-/cssstyle-2.3.0.tgz#ff665a0ddbdc31864b09647f34163443d90b0852" + integrity sha512-AZL67abkUzIuvcHqk7c09cezpGNcxUxU4Ioi/05xHk4DQeTkWmGYftIE6ctU6AEt+Gn4n1lDStOtj7FKycP71A== + dependencies: + cssom "~0.3.6" + +dargs@^7.0.0: + version "7.0.0" + resolved "https://registry.npmjs.org/dargs/-/dargs-7.0.0.tgz#04015c41de0bcb69ec84050f3d9be0caf8d6d5cc" + integrity sha512-2iy1EkLdlBzQGvbweYRFxmFath8+K7+AKB0TlhHWkNuH+TmovaMH/Wp7V7R4u7f4SnX3OgLsU9t1NI9ioDnUpg== + +data-urls@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/data-urls/-/data-urls-2.0.0.tgz#156485a72963a970f5d5821aaf642bef2bf2db9b" + integrity sha512-X5eWTSXO/BJmpdIKCRuKUgSCgAN0OwliVK3yPKbwIWU1Tdw5BRajxlzMidvh+gwko9AfQ9zIj52pzF91Q3YAvQ== + dependencies: + abab "^2.0.3" + whatwg-mimetype "^2.3.0" + whatwg-url "^8.0.0" + +date-format@^4.0.6: + version "4.0.6" + resolved "https://registry.npmjs.org/date-format/-/date-format-4.0.6.tgz#f6138b8f17968df9815b3d101fc06b0523f066c5" + integrity sha512-B9vvg5rHuQ8cbUXE/RMWMyX2YA5TecT3jKF5fLtGNlzPlU7zblSPmAm2OImDbWL+LDOQ6pUm+4LOFz+ywS41Zw== + +dateformat@^3.0.0: + version "3.0.3" + resolved "https://registry.npmjs.org/dateformat/-/dateformat-3.0.3.tgz#a6e37499a4d9a9cf85ef5872044d62901c9889ae" + integrity sha512-jyCETtSl3VMZMWeRo7iY1FL19ges1t55hMo5yaam4Jrsm5EPL89UQkoQRyiI+Yf4k8r2ZpdngkV8hr1lIdjb3Q== + +debug@4, debug@^4.1.0, debug@^4.1.1, debug@^4.3.1, debug@^4.3.2, debug@^4.3.4: + version "4.3.4" + resolved "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz#1319f6579357f2338d3337d2cdd4914bb5dcc865" + integrity sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ== + dependencies: + ms "2.1.2" + +debug@^2.6.9: + version "2.6.9" + resolved "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz#5d128515df134ff327e90a4c93f4e077a536341f" + integrity sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA== + dependencies: + ms "2.0.0" + +debug@^3.2.7: + version "3.2.7" + resolved "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz#72580b7e9145fb39b6676f9c5e5fb100b934179a" + integrity sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ== + dependencies: + ms "^2.1.1" + +decamelize-keys@^1.1.0: + version "1.1.0" + resolved "https://registry.npmjs.org/decamelize-keys/-/decamelize-keys-1.1.0.tgz#d171a87933252807eb3cb61dc1c1445d078df2d9" + integrity sha1-0XGoeTMlKAfrPLYdwcFEXQeN8tk= + dependencies: + decamelize "^1.1.0" + map-obj "^1.0.0" + +decamelize@^1.1.0: + version "1.2.0" + resolved "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290" + integrity sha1-9lNNFRSCabIDUue+4m9QH5oZEpA= + +decamelize@^5.0.1: + version "5.0.1" + resolved "https://registry.npmjs.org/decamelize/-/decamelize-5.0.1.tgz#db11a92e58c741ef339fb0a2868d8a06a9a7b1e9" + integrity sha512-VfxadyCECXgQlkoEAjeghAr5gY3Hf+IKjKb+X8tGVDtveCjN+USwprd2q3QXBR9T1+x2DG0XZF5/w+7HAtSaXA== + +decimal.js@^10.2.1: + version "10.3.1" + resolved "https://registry.npmjs.org/decimal.js/-/decimal.js-10.3.1.tgz#d8c3a444a9c6774ba60ca6ad7261c3a94fd5e783" + integrity sha512-V0pfhfr8suzyPGOx3nmq4aHqabehUZn6Ch9kyFpV79TGDTWFmHqUqXdabR7QHqxzrYolF4+tVmJhUG4OURg5dQ== + +decompress-response@^3.3.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/decompress-response/-/decompress-response-3.3.0.tgz#80a4dd323748384bfa248083622aedec982adff3" + integrity sha1-gKTdMjdIOEv6JICDYirt7Jgq3/M= + dependencies: + mimic-response "^1.0.0" + +dedent@^0.7.0: + version "0.7.0" + resolved "https://registry.npmjs.org/dedent/-/dedent-0.7.0.tgz#2495ddbaf6eb874abb0e1be9df22d2e5a544326c" + integrity sha1-JJXduvbrh0q7Dhvp3yLS5aVEMmw= + +deep-equal@^2.0.5: + version "2.0.5" + resolved "https://registry.npmjs.org/deep-equal/-/deep-equal-2.0.5.tgz#55cd2fe326d83f9cbf7261ef0e060b3f724c5cb9" + integrity sha512-nPiRgmbAtm1a3JsnLCf6/SLfXcjyN5v8L1TXzdCmHrXJ4hx+gW/w1YCcn7z8gJtSiDArZCgYtbao3QqLm/N1Sw== + dependencies: + call-bind "^1.0.0" + es-get-iterator "^1.1.1" + get-intrinsic "^1.0.1" + is-arguments "^1.0.4" + is-date-object "^1.0.2" + is-regex "^1.1.1" + isarray "^2.0.5" + object-is "^1.1.4" + object-keys "^1.1.1" + object.assign "^4.1.2" + regexp.prototype.flags "^1.3.0" + side-channel "^1.0.3" + which-boxed-primitive "^1.0.1" + which-collection "^1.0.1" + which-typed-array "^1.1.2" + +deep-extend@^0.6.0: + version "0.6.0" + resolved "https://registry.yarnpkg.com/deep-extend/-/deep-extend-0.6.0.tgz#c4fa7c95404a17a9c3e8ca7e1537312b736330ac" + integrity sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA== + +deep-is@^0.1.3, deep-is@~0.1.3: + version "0.1.4" + resolved "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz#a6f2dce612fadd2ef1f519b73551f17e85199831" + integrity sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ== + +deepmerge@^4.2.2: + version "4.2.2" + resolved "https://registry.npmjs.org/deepmerge/-/deepmerge-4.2.2.tgz#44d2ea3679b8f4d4ffba33f03d865fc1e7bf4955" + integrity sha512-FJ3UgI4gIl+PHZm53knsuSFpE+nESMr7M4v9QcgB7S63Kj/6WqMiFQJpBBYz1Pt+66bZpP3Q7Lye0Oo9MPKEdg== + +defer-to-connect@^1.0.1: + version "1.1.3" + resolved "https://registry.yarnpkg.com/defer-to-connect/-/defer-to-connect-1.1.3.tgz#331ae050c08dcf789f8c83a7b81f0ed94f4ac591" + integrity sha512-0ISdNousHvZT2EiFlZeZAHBUvSxmKswVCEf8hW7KWgG4a8MVEu/3Vb6uWYozkjylyCxe0JBIiRB1jV45S70WVQ== + +define-properties@^1.1.3: + version "1.1.3" + resolved "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz#cf88da6cbee26fe6db7094f61d870cbd84cee9f1" + integrity sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ== + dependencies: + object-keys "^1.0.12" + +delayed-stream@~1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz#df3ae199acadfb7d440aaae0b29e2272b24ec619" + integrity sha1-3zrhmayt+31ECqrgsp4icrJOxhk= + +delegates@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/delegates/-/delegates-1.0.0.tgz#84c6e159b81904fdca59a0ef44cd870d31250f9a" + integrity sha1-hMbhWbgZBP3KWaDvRM2HDTElD5o= + +depd@^1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/depd/-/depd-1.1.2.tgz#9bcd52e14c097763e749b274c4346ed2e560b5a9" + integrity sha1-m81S4UwJd2PnSbJ0xDRu0uVgtak= + +detect-indent@^5.0.0: + version "5.0.0" + resolved "https://registry.npmjs.org/detect-indent/-/detect-indent-5.0.0.tgz#3871cc0a6a002e8c3e5b3cf7f336264675f06b9d" + integrity sha1-OHHMCmoALow+Wzz38zYmRnXwa50= + +detect-indent@^6.0.0: + version "6.1.0" + resolved "https://registry.npmjs.org/detect-indent/-/detect-indent-6.1.0.tgz#592485ebbbf6b3b1ab2be175c8393d04ca0d57e6" + integrity sha512-reYkTUJAZb9gUuZ2RvVCNhVHdg62RHnJ7WJl8ftMi4diZ6NWlciOzQN88pUhSELEwflJht4oQDv0F0BMlwaYtA== + +detect-newline@^2.1.0: + version "2.1.0" + resolved "https://registry.npmjs.org/detect-newline/-/detect-newline-2.1.0.tgz#f41f1c10be4b00e87b5f13da680759f2c5bfd3e2" + integrity sha1-9B8cEL5LAOh7XxPaaAdZ8sW/0+I= + +detect-newline@^3.0.0, detect-newline@^3.1.0: + version "3.1.0" + resolved "https://registry.npmjs.org/detect-newline/-/detect-newline-3.1.0.tgz#576f5dfc63ae1a192ff192d8ad3af6308991b651" + integrity sha512-TLz+x/vEXm/Y7P7wn1EJFNLxYpUD4TgMosxY6fAVJUnJMbupHBOncxyWUG9OpTaH9EBD7uFI5LfEgmMOc54DsA== + +diff-sequences@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/diff-sequences/-/diff-sequences-27.5.1.tgz#eaecc0d327fd68c8d9672a1e64ab8dccb2ef5327" + integrity sha512-k1gCAXAsNgLwEL+Y8Wvl+M6oEFj5bgazfZULpS5CneoPPXRaCCW7dm+q21Ky2VEE5X+VeRDBVg1Pcvvsr4TtNQ== + +dir-glob@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/dir-glob/-/dir-glob-3.0.1.tgz#56dbf73d992a4a93ba1584f4534063fd2e41717f" + integrity sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA== + dependencies: + path-type "^4.0.0" + +doctrine@^2.1.0: + version "2.1.0" + resolved "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz#5cd01fc101621b42c4cd7f5d1a66243716d3f39d" + integrity sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw== + dependencies: + esutils "^2.0.2" + +doctrine@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz#addebead72a6574db783639dc87a121773973961" + integrity sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w== + dependencies: + esutils "^2.0.2" + +domexception@^2.0.1: + version "2.0.1" + resolved "https://registry.npmjs.org/domexception/-/domexception-2.0.1.tgz#fb44aefba793e1574b0af6aed2801d057529f304" + integrity sha512-yxJ2mFy/sibVQlu5qHjOkf9J3K6zgmCxgJ94u2EdvDOV09H+32LtRswEcUsmUWN72pVLOEnTSRaIVVzVQgS0dg== + dependencies: + webidl-conversions "^5.0.0" + +dot-prop@^5.1.0, dot-prop@^5.2.0: + version "5.3.0" + resolved "https://registry.npmjs.org/dot-prop/-/dot-prop-5.3.0.tgz#90ccce708cd9cd82cc4dc8c3ddd9abdd55b20e88" + integrity sha512-QM8q3zDe58hqUqjraQOmzZ1LIH9SWQJTlEKCH4kJ2oQvLZk7RbQXvtDM2XEq3fwkV9CCvvH4LA0AV+ogFsBM2Q== + dependencies: + is-obj "^2.0.0" + +dotgitignore@^2.1.0: + version "2.1.0" + resolved "https://registry.npmjs.org/dotgitignore/-/dotgitignore-2.1.0.tgz#a4b15a4e4ef3cf383598aaf1dfa4a04bcc089b7b" + integrity sha512-sCm11ak2oY6DglEPpCB8TixLjWAxd3kJTs6UIcSasNYxXdFPV+YKlye92c8H4kKFqV5qYMIh7d+cYecEg0dIkA== + dependencies: + find-up "^3.0.0" + minimatch "^3.0.4" + +duplexer3@^0.1.4: + version "0.1.4" + resolved "https://registry.yarnpkg.com/duplexer3/-/duplexer3-0.1.4.tgz#ee01dd1cac0ed3cbc7fdbea37dc0a8f1ce002ce2" + integrity sha1-7gHdHKwO08vH/b6jfcCo8c4ALOI= + +electron-to-chromium@^1.4.84: + version "1.4.96" + resolved "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.96.tgz#a97438a01d5db1460343fea4a344960b09330990" + integrity sha512-DPNjvNGPabv6FcyjzLAN4C0psN/GgD9rSGvMTuv81SeXG/EX3mCz0wiw9N1tUEnfQXYCJi3H8M0oFPRziZh7rw== + +emittery@^0.8.1: + version "0.8.1" + resolved "https://registry.npmjs.org/emittery/-/emittery-0.8.1.tgz#bb23cc86d03b30aa75a7f734819dee2e1ba70860" + integrity sha512-uDfvUjVrfGJJhymx/kz6prltenw1u7WrCg1oa94zYY8xxVpLLUu045LAT0dhDZdXG58/EpPL/5kA180fQ/qudg== + +emoji-regex@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37" + integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== + +encoding@^0.1.13: + version "0.1.13" + resolved "https://registry.yarnpkg.com/encoding/-/encoding-0.1.13.tgz#56574afdd791f54a8e9b2785c0582a2d26210fa9" + integrity sha512-ETBauow1T35Y/WZMkio9jiM0Z5xjHHmJ4XmjZOq1l/dXz3lr2sRn87nJy20RupqSh1F2m3HHPSp8ShIPQJrJ3A== + dependencies: + iconv-lite "^0.6.2" + +end-of-stream@^1.1.0: + version "1.4.4" + resolved "https://registry.yarnpkg.com/end-of-stream/-/end-of-stream-1.4.4.tgz#5ae64a5f45057baf3626ec14da0ca5e4b2431eb0" + integrity sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q== + dependencies: + once "^1.4.0" + +entities@~2.0: + version "2.0.3" + resolved "https://registry.npmjs.org/entities/-/entities-2.0.3.tgz#5c487e5742ab93c15abb5da22759b8590ec03b7f" + integrity sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ== + +env-paths@^2.2.0: + version "2.2.1" + resolved "https://registry.yarnpkg.com/env-paths/-/env-paths-2.2.1.tgz#420399d416ce1fbe9bc0a07c62fa68d67fd0f8f2" + integrity sha512-+h1lkLKhZMTYjog1VEpJNG7NZJWcuc2DDk/qsqSTRRCOXiLjeQ1d1/udrUGhqMxUgAlwKNZ0cf2uqan5GLuS2A== + +err-code@^2.0.2: + version "2.0.3" + resolved "https://registry.yarnpkg.com/err-code/-/err-code-2.0.3.tgz#23c2f3b756ffdfc608d30e27c9a941024807e7f9" + integrity sha512-2bmlRpNKBxT/CRmPOlyISQpNj+qSeYvcym/uT0Jx2bMOlKLtSy1ZmLuVxSEKKyor/N5yhvp/ZiG1oE3DEYMSFA== + +error-ex@^1.3.1: + version "1.3.2" + resolved "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz#b4ac40648107fdcdcfae242f428bea8a14d4f1bf" + integrity sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g== + dependencies: + is-arrayish "^0.2.1" + +es-abstract@^1.18.5, es-abstract@^1.19.0, es-abstract@^1.19.1: + version "1.19.1" + resolved "https://registry.npmjs.org/es-abstract/-/es-abstract-1.19.1.tgz#d4885796876916959de78edaa0df456627115ec3" + integrity sha512-2vJ6tjA/UfqLm2MPs7jxVybLoB8i1t1Jd9R3kISld20sIxPcTbLuggQOUxeWeAvIUkduv/CfMjuh4WmiXr2v9w== + dependencies: + call-bind "^1.0.2" + es-to-primitive "^1.2.1" + function-bind "^1.1.1" + get-intrinsic "^1.1.1" + get-symbol-description "^1.0.0" + has "^1.0.3" + has-symbols "^1.0.2" + internal-slot "^1.0.3" + is-callable "^1.2.4" + is-negative-zero "^2.0.1" + is-regex "^1.1.4" + is-shared-array-buffer "^1.0.1" + is-string "^1.0.7" + is-weakref "^1.0.1" + object-inspect "^1.11.0" + object-keys "^1.1.1" + object.assign "^4.1.2" + string.prototype.trimend "^1.0.4" + string.prototype.trimstart "^1.0.4" + unbox-primitive "^1.0.1" + +es-get-iterator@^1.1.1: + version "1.1.2" + resolved "https://registry.npmjs.org/es-get-iterator/-/es-get-iterator-1.1.2.tgz#9234c54aba713486d7ebde0220864af5e2b283f7" + integrity sha512-+DTO8GYwbMCwbywjimwZMHp8AuYXOS2JZFWoi2AlPOS3ebnII9w/NLpNZtA7A0YLaVDw+O7KFCeoIV7OPvM7hQ== + dependencies: + call-bind "^1.0.2" + get-intrinsic "^1.1.0" + has-symbols "^1.0.1" + is-arguments "^1.1.0" + is-map "^2.0.2" + is-set "^2.0.2" + is-string "^1.0.5" + isarray "^2.0.5" + +es-to-primitive@^1.2.1: + version "1.2.1" + resolved "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz#e55cd4c9cdc188bcefb03b366c736323fc5c898a" + integrity sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA== + dependencies: + is-callable "^1.1.4" + is-date-object "^1.0.1" + is-symbol "^1.0.2" + +escalade@^3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.1.1.tgz#d8cfdc7000965c5a0174b4a82eaa5c0552742e40" + integrity sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw== + +escape-goat@^2.0.0: + version "2.1.1" + resolved "https://registry.yarnpkg.com/escape-goat/-/escape-goat-2.1.1.tgz#1b2dc77003676c457ec760b2dc68edb648188675" + integrity sha512-8/uIhbG12Csjy2JEW7D9pHbreaVaS/OpN3ycnyvElTdwM5n6GY6W6e2IPemfvGZeUMqZ9A/3GqIZMgKnBhAw/Q== + +escape-string-regexp@^1.0.5: + version "1.0.5" + resolved "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4" + integrity sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ= + +escape-string-regexp@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz#a30304e99daa32e23b2fd20f51babd07cffca344" + integrity sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w== + +escape-string-regexp@^4.0.0: + version "4.0.0" + resolved "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz#14ba83a5d373e3d311e5afca29cf5bfad965bf34" + integrity sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA== + +escodegen@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/escodegen/-/escodegen-2.0.0.tgz#5e32b12833e8aa8fa35e1bf0befa89380484c7dd" + integrity sha512-mmHKys/C8BFUGI+MAWNcSYoORYLMdPzjrknd2Vc+bUsjN5bXcr8EhrNB+UTqfL1y3I9c4fw2ihgtMPQLBRiQxw== + dependencies: + esprima "^4.0.1" + estraverse "^5.2.0" + esutils "^2.0.2" + optionator "^0.8.1" + optionalDependencies: + source-map "~0.6.1" + +eslint-import-resolver-node@^0.3.6: + version "0.3.6" + resolved "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.6.tgz#4048b958395da89668252001dbd9eca6b83bacbd" + integrity sha512-0En0w03NRVMn9Uiyn8YRPDKvWjxCWkslUEhGNTdGx15RvPJYQ+lbOlqrlNI2vEAs4pDYK4f/HN2TbDmk5TP0iw== + dependencies: + debug "^3.2.7" + resolve "^1.20.0" + +eslint-import-resolver-typescript@^2.7.0: + version "2.7.0" + resolved "https://registry.npmjs.org/eslint-import-resolver-typescript/-/eslint-import-resolver-typescript-2.7.0.tgz#1f9d391b636dccdbaa4a3b1a87eb9a8237e23963" + integrity sha512-MNHS3u5pebvROX4MjGP9coda589ZGfL1SqdxUV4kSrcclfDRWvNE2D+eljbnWVMvWDVRgT89nhscMHPKYGcObQ== + dependencies: + debug "^4.3.4" + glob "^7.2.0" + is-glob "^4.0.3" + resolve "^1.22.0" + tsconfig-paths "^3.14.1" + +eslint-module-utils@^2.7.2: + version "2.7.3" + resolved "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.7.3.tgz#ad7e3a10552fdd0642e1e55292781bd6e34876ee" + integrity sha512-088JEC7O3lDZM9xGe0RerkOMd0EjFl+Yvd1jPWIkMT5u3H9+HC34mWWPnqPrN13gieT9pBOO+Qt07Nb/6TresQ== + dependencies: + debug "^3.2.7" + find-up "^2.1.0" + +eslint-plugin-import@^2.25.4: + version "2.25.4" + resolved "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.25.4.tgz#322f3f916a4e9e991ac7af32032c25ce313209f1" + integrity sha512-/KJBASVFxpu0xg1kIBn9AUa8hQVnszpwgE7Ld0lKAlx7Ie87yzEzCgSkekt+le/YVhiaosO4Y14GDAOc41nfxA== + dependencies: + array-includes "^3.1.4" + array.prototype.flat "^1.2.5" + debug "^2.6.9" + doctrine "^2.1.0" + eslint-import-resolver-node "^0.3.6" + eslint-module-utils "^2.7.2" + has "^1.0.3" + is-core-module "^2.8.0" + is-glob "^4.0.3" + minimatch "^3.0.4" + object.values "^1.1.5" + resolve "^1.20.0" + tsconfig-paths "^3.12.0" + +eslint-scope@^5.1.1: + version "5.1.1" + resolved "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz#e786e59a66cb92b3f6c1fb0d508aab174848f48c" + integrity sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw== + dependencies: + esrecurse "^4.3.0" + estraverse "^4.1.1" + +eslint-scope@^7.1.1: + version "7.1.1" + resolved "https://registry.npmjs.org/eslint-scope/-/eslint-scope-7.1.1.tgz#fff34894c2f65e5226d3041ac480b4513a163642" + integrity sha512-QKQM/UXpIiHcLqJ5AOyIW7XZmzjkzQXYE54n1++wb0u9V/abW3l9uQnxX8Z5Xd18xyKIMTUAyQ0k1e8pz6LUrw== + dependencies: + esrecurse "^4.3.0" + estraverse "^5.2.0" + +eslint-utils@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz#8aebaface7345bb33559db0a1f13a1d2d48c3672" + integrity sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA== + dependencies: + eslint-visitor-keys "^2.0.0" + +eslint-visitor-keys@^2.0.0: + version "2.1.0" + resolved "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz#f65328259305927392c938ed44eb0a5c9b2bd303" + integrity sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw== + +eslint-visitor-keys@^3.0.0, eslint-visitor-keys@^3.3.0: + version "3.3.0" + resolved "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.3.0.tgz#f6480fa6b1f30efe2d1968aa8ac745b862469826" + integrity sha512-mQ+suqKJVyeuwGYHAdjMFqjCyfl8+Ldnxuyp3ldiMBFKkvytrXUZWaiPCEav8qDHKty44bD+qV1IP4T+w+xXRA== + +eslint@^8: + version "8.12.0" + resolved "https://registry.npmjs.org/eslint/-/eslint-8.12.0.tgz#c7a5bd1cfa09079aae64c9076c07eada66a46e8e" + integrity sha512-it1oBL9alZg1S8UycLm5YDMAkIhtH6FtAzuZs6YvoGVldWjbS08BkAdb/ymP9LlAyq8koANu32U7Ib/w+UNh8Q== + dependencies: + "@eslint/eslintrc" "^1.2.1" + "@humanwhocodes/config-array" "^0.9.2" + ajv "^6.10.0" + chalk "^4.0.0" + cross-spawn "^7.0.2" + debug "^4.3.2" + doctrine "^3.0.0" + escape-string-regexp "^4.0.0" + eslint-scope "^7.1.1" + eslint-utils "^3.0.0" + eslint-visitor-keys "^3.3.0" + espree "^9.3.1" + esquery "^1.4.0" + esutils "^2.0.2" + fast-deep-equal "^3.1.3" + file-entry-cache "^6.0.1" + functional-red-black-tree "^1.0.1" + glob-parent "^6.0.1" + globals "^13.6.0" + ignore "^5.2.0" + import-fresh "^3.0.0" + imurmurhash "^0.1.4" + is-glob "^4.0.0" + js-yaml "^4.1.0" + json-stable-stringify-without-jsonify "^1.0.1" + levn "^0.4.1" + lodash.merge "^4.6.2" + minimatch "^3.0.4" + natural-compare "^1.4.0" + optionator "^0.9.1" + regexpp "^3.2.0" + strip-ansi "^6.0.1" + strip-json-comments "^3.1.0" + text-table "^0.2.0" + v8-compile-cache "^2.0.3" + +espree@^9.3.1: + version "9.3.1" + resolved "https://registry.npmjs.org/espree/-/espree-9.3.1.tgz#8793b4bc27ea4c778c19908e0719e7b8f4115bcd" + integrity sha512-bvdyLmJMfwkV3NCRl5ZhJf22zBFo1y8bYh3VYb+bfzqNB4Je68P2sSuXyuFquzWLebHpNd2/d5uv7yoP9ISnGQ== + dependencies: + acorn "^8.7.0" + acorn-jsx "^5.3.1" + eslint-visitor-keys "^3.3.0" + +esprima@^4.0.0, esprima@^4.0.1: + version "4.0.1" + resolved "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71" + integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A== + +esquery@^1.4.0: + version "1.4.0" + resolved "https://registry.npmjs.org/esquery/-/esquery-1.4.0.tgz#2148ffc38b82e8c7057dfed48425b3e61f0f24a5" + integrity sha512-cCDispWt5vHHtwMY2YrAQ4ibFkAL8RbH5YGBnZBc90MolvvfkkQcJro/aZiAQUlQ3qgrYS6D6v8Gc5G5CQsc9w== + dependencies: + estraverse "^5.1.0" + +esrecurse@^4.3.0: + version "4.3.0" + resolved "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz#7ad7964d679abb28bee72cec63758b1c5d2c9921" + integrity sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag== + dependencies: + estraverse "^5.2.0" + +estraverse@^4.1.1: + version "4.3.0" + resolved "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz#398ad3f3c5a24948be7725e83d11a7de28cdbd1d" + integrity sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw== + +estraverse@^5.1.0, estraverse@^5.2.0: + version "5.3.0" + resolved "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz#2eea5290702f26ab8fe5370370ff86c965d21123" + integrity sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA== + +esutils@^2.0.2: + version "2.0.3" + resolved "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz#74d2eb4de0b8da1293711910d50775b9b710ef64" + integrity sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g== + +execa@^5.0.0: + version "5.1.1" + resolved "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz#f80ad9cbf4298f7bd1d4c9555c21e93741c411dd" + integrity sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg== + dependencies: + cross-spawn "^7.0.3" + get-stream "^6.0.0" + human-signals "^2.1.0" + is-stream "^2.0.0" + merge-stream "^2.0.0" + npm-run-path "^4.0.1" + onetime "^5.1.2" + signal-exit "^3.0.3" + strip-final-newline "^2.0.0" + +exit@^0.1.2: + version "0.1.2" + resolved "https://registry.npmjs.org/exit/-/exit-0.1.2.tgz#0632638f8d877cc82107d30a0fff1a17cba1cd0c" + integrity sha1-BjJjj42HfMghB9MKD/8aF8uhzQw= + +expect@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/expect/-/expect-27.5.1.tgz#83ce59f1e5bdf5f9d2b94b61d2050db48f3fef74" + integrity sha512-E1q5hSUG2AmYQwQJ041nvgpkODHQvB+RKlB4IYdru6uJsyFTRyZAP463M+1lINorwbqAmUggi6+WwkD8lCS/Dw== + dependencies: + "@jest/types" "^27.5.1" + jest-get-type "^27.5.1" + jest-matcher-utils "^27.5.1" + jest-message-util "^27.5.1" + +fast-deep-equal@^2.0.1: + version "2.0.1" + resolved "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz#7b05218ddf9667bf7f370bf7fdb2cb15fdd0aa49" + integrity sha1-ewUhjd+WZ79/Nwv3/bLLFf3Qqkk= + +fast-deep-equal@^3.1.1, fast-deep-equal@^3.1.3: + version "3.1.3" + resolved "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" + integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== + +fast-glob@^3.2.11, fast-glob@^3.2.9: + version "3.2.11" + resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.2.11.tgz#a1172ad95ceb8a16e20caa5c5e56480e5129c1d9" + integrity sha512-xrO3+1bxSo3ZVHAnqzyuewYT6aMFHRAd4Kcs92MAonjwQZLsK9d0SF1IyQ3k5PoirxTW0Oe/RqFgMQ6TcNE5Ew== + dependencies: + "@nodelib/fs.stat" "^2.0.2" + "@nodelib/fs.walk" "^1.2.3" + glob-parent "^5.1.2" + merge2 "^1.3.0" + micromatch "^4.0.4" + +fast-json-patch@^2.2.1: + version "2.2.1" + resolved "https://registry.npmjs.org/fast-json-patch/-/fast-json-patch-2.2.1.tgz#18150d36c9ab65c7209e7d4eb113f4f8eaabe6d9" + integrity sha512-4j5uBaTnsYAV5ebkidvxiLUYOwjQ+JSFljeqfTxCrH9bDmlCQaOJFS84oDJ2rAXZq2yskmk3ORfoP9DCwqFNig== + dependencies: + fast-deep-equal "^2.0.1" + +fast-json-stable-stringify@2.x, fast-json-stable-stringify@^2.0.0: + version "2.1.0" + resolved "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633" + integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== + +fast-levenshtein@^2.0.6, fast-levenshtein@~2.0.6: + version "2.0.6" + resolved "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz#3d8a5c66883a16a30ca8643e851f19baa7797917" + integrity sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc= + +fast-memoize@^2.5.2: + version "2.5.2" + resolved "https://registry.yarnpkg.com/fast-memoize/-/fast-memoize-2.5.2.tgz#79e3bb6a4ec867ea40ba0e7146816f6cdce9b57e" + integrity sha512-Ue0LwpDYErFbmNnZSF0UH6eImUwDmogUO1jyE+JbN2gsQz/jICm1Ve7t9QT0rNSsfJt+Hs4/S3GnsDVjL4HVrw== + +fastq@^1.6.0: + version "1.13.0" + resolved "https://registry.yarnpkg.com/fastq/-/fastq-1.13.0.tgz#616760f88a7526bdfc596b7cab8c18938c36b98c" + integrity sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw== + dependencies: + reusify "^1.0.4" + +fb-watchman@^2.0.0: + version "2.0.1" + resolved "https://registry.npmjs.org/fb-watchman/-/fb-watchman-2.0.1.tgz#fc84fb39d2709cf3ff6d743706157bb5708a8a85" + integrity sha512-DkPJKQeY6kKwmuMretBhr7G6Vodr7bFwDYTXIkfG1gjvNpaxBTQV3PbXg6bR1c1UP4jPOX0jHUbbHANL9vRjVg== + dependencies: + bser "2.1.1" + +figgy-pudding@^3.5.1: + version "3.5.2" + resolved "https://registry.yarnpkg.com/figgy-pudding/-/figgy-pudding-3.5.2.tgz#b4eee8148abb01dcf1d1ac34367d59e12fa61d6e" + integrity sha512-0btnI/H8f2pavGMN8w40mlSKOfTK2SVJmBfBeVIj3kNw0swwgzyRq0d5TJVOwodFmtvpPeWPN/MCcfuWF0Ezbw== + +figures@^3.1.0: + version "3.2.0" + resolved "https://registry.npmjs.org/figures/-/figures-3.2.0.tgz#625c18bd293c604dc4a8ddb2febf0c88341746af" + integrity sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg== + dependencies: + escape-string-regexp "^1.0.5" + +file-entry-cache@^6.0.1: + version "6.0.1" + resolved "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz#211b2dd9659cb0394b073e7323ac3c933d522027" + integrity sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg== + dependencies: + flat-cache "^3.0.4" + +fill-range@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.0.1.tgz#1919a6a7c75fe38b2c7c77e5198535da9acdda40" + integrity sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ== + dependencies: + to-regex-range "^5.0.1" + +find-up@5.0.0, find-up@^5.0.0: + version "5.0.0" + resolved "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz#4c92819ecb7083561e4f4a240a86be5198f536fc" + integrity sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng== + dependencies: + locate-path "^6.0.0" + path-exists "^4.0.0" + +find-up@^2.0.0, find-up@^2.1.0: + version "2.1.0" + resolved "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz#45d1b7e506c717ddd482775a2b77920a3c0c57a7" + integrity sha1-RdG35QbHF93UgndaK3eSCjwMV6c= + dependencies: + locate-path "^2.0.0" + +find-up@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-3.0.0.tgz#49169f1d7993430646da61ecc5ae355c21c97b73" + integrity sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg== + dependencies: + locate-path "^3.0.0" + +find-up@^4.0.0, find-up@^4.1.0: + version "4.1.0" + resolved "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz#97afe7d6cdc0bc5928584b7c8d7b16e8a9aa5d19" + integrity sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw== + dependencies: + locate-path "^5.0.0" + path-exists "^4.0.0" + +flat-cache@^3.0.4: + version "3.0.4" + resolved "https://registry.npmjs.org/flat-cache/-/flat-cache-3.0.4.tgz#61b0338302b2fe9f957dcc32fc2a87f1c3048b11" + integrity sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg== + dependencies: + flatted "^3.1.0" + rimraf "^3.0.2" + +flatted@^3.1.0, flatted@^3.2.5: + version "3.2.5" + resolved "https://registry.npmjs.org/flatted/-/flatted-3.2.5.tgz#76c8584f4fc843db64702a6bd04ab7a8bd666da3" + integrity sha512-WIWGi2L3DyTUvUrwRKgGi9TwxQMUEqPOPQBVi71R96jZXJdFskXEmf54BoZaS1kknGODoIGASGEzBUYdyMCBJg== + +follow-redirects@^1.14.7: + version "1.14.9" + resolved "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.14.9.tgz#dd4ea157de7bfaf9ea9b3fbd85aa16951f78d8d7" + integrity sha512-MQDfihBQYMcyy5dhRDJUHcw7lb2Pv/TuE6xP1vyraLukNDHKbDxDNaOE3NbCAdKQApno+GPRyo1YAp89yCjK4w== + +foreach@^2.0.5: + version "2.0.5" + resolved "https://registry.npmjs.org/foreach/-/foreach-2.0.5.tgz#0bee005018aeb260d0a3af3ae658dd0136ec1b99" + integrity sha1-C+4AUBiusmDQo6865ljdATbsG5k= + +form-data@^3.0.0: + version "3.0.1" + resolved "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz#ebd53791b78356a99af9a300d4282c4d5eb9755f" + integrity sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg== + dependencies: + asynckit "^0.4.0" + combined-stream "^1.0.8" + mime-types "^2.1.12" + +fp-and-or@^0.1.3: + version "0.1.3" + resolved "https://registry.yarnpkg.com/fp-and-or/-/fp-and-or-0.1.3.tgz#e6fba83872a5853a56b3ebdf8d3167f5dfca1882" + integrity sha512-wJaE62fLaB3jCYvY2ZHjZvmKK2iiLiiehX38rz5QZxtdN8fVPJDeZUiVvJrHStdTc+23LHlyZuSEKgFc0pxi2g== + +fs-access@^1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/fs-access/-/fs-access-1.0.1.tgz#d6a87f262271cefebec30c553407fb995da8777a" + integrity sha1-1qh/JiJxzv6+wwxVNAf7mV2od3o= + dependencies: + null-check "^1.0.0" + +fs-extra@^10.0.1: + version "10.0.1" + resolved "https://registry.npmjs.org/fs-extra/-/fs-extra-10.0.1.tgz#27de43b4320e833f6867cc044bfce29fdf0ef3b8" + integrity sha512-NbdoVMZso2Lsrn/QwLXOy6rm0ufY2zEOKCDzJR/0kBsb0E6qed0P3iYK+Ath3BfvXEeu4JhEtXLgILx5psUfag== + dependencies: + graceful-fs "^4.2.0" + jsonfile "^6.0.1" + universalify "^2.0.0" + +fs-extra@^9.1.0: + version "9.1.0" + resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-9.1.0.tgz#5954460c764a8da2094ba3554bf839e6b9a7c86d" + integrity sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ== + dependencies: + at-least-node "^1.0.0" + graceful-fs "^4.2.0" + jsonfile "^6.0.1" + universalify "^2.0.0" + +fs-minipass@^2.0.0, fs-minipass@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/fs-minipass/-/fs-minipass-2.1.0.tgz#7f5036fdbf12c63c169190cbe4199c852271f9fb" + integrity sha512-V/JgOLFCS+R6Vcq0slCuaeWEdNC3ouDlJMNIsacH2VtALiu9mV4LPrHc5cDl8k5aw6J8jwgWWpiTo5RYhmIzvg== + dependencies: + minipass "^3.0.0" + +fs.realpath@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f" + integrity sha1-FQStJSMVjKpA20onh8sBQRmU6k8= + +fsevents@^2.3.2: + version "2.3.2" + resolved "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz#8a526f78b8fdf4623b709e0b975c52c24c02fd1a" + integrity sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA== + +function-bind@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/function-bind/-/function-bind-1.1.1.tgz#a56899d3ea3c9bab874bb9773b7c5ede92f4895d" + integrity sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A== + +functional-red-black-tree@^1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz#1b0ab3bd553b2a0d6399d29c0e3ea0b252078327" + integrity sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc= + +gauge@^4.0.0: + version "4.0.3" + resolved "https://registry.yarnpkg.com/gauge/-/gauge-4.0.3.tgz#286cf105c1962c659f0963058fb05116c1b82d3f" + integrity sha512-ICw1DhAwMtb22rYFwEHgJcx1JCwJGv3x6G0OQUq56Nge+H4Q8JEwr8iveS0XFlsUNSI67F5ffMGK25bK4Pmskw== + dependencies: + aproba "^1.0.3 || ^2.0.0" + color-support "^1.1.3" + console-control-strings "^1.1.0" + has-unicode "^2.0.1" + signal-exit "^3.0.7" + string-width "^4.2.3" + strip-ansi "^6.0.1" + wide-align "^1.1.5" + +gensync@^1.0.0-beta.2: + version "1.0.0-beta.2" + resolved "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz#32a6ee76c3d7f52d46b2b1ae5d93fea8580a25e0" + integrity sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg== + +get-caller-file@^2.0.5: + version "2.0.5" + resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-2.0.5.tgz#4f94412a82db32f36e3b0b9741f8a97feb031f7e" + integrity sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg== + +get-intrinsic@^1.0.1, get-intrinsic@^1.0.2, get-intrinsic@^1.1.0, get-intrinsic@^1.1.1: + version "1.1.1" + resolved "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.1.1.tgz#15f59f376f855c446963948f0d24cd3637b4abc6" + integrity sha512-kWZrnVM42QCiEA2Ig1bG8zjoIMOgxWwYCEeNdwY6Tv/cOSeGpcoX4pXHfKUxNKVoArnrEr2e9srnAxxGIraS9Q== + dependencies: + function-bind "^1.1.1" + has "^1.0.3" + has-symbols "^1.0.1" + +get-package-type@^0.1.0: + version "0.1.0" + resolved "https://registry.npmjs.org/get-package-type/-/get-package-type-0.1.0.tgz#8de2d803cff44df3bc6c456e6668b36c3926e11a" + integrity sha512-pjzuKtY64GYfWizNAJ0fr9VqttZkNiK2iS430LtIHzjBEr6bX8Am2zm4sW4Ro5wjWW5cAlRL1qAMTcXbjNAO2Q== + +get-pkg-repo@^4.0.0: + version "4.2.1" + resolved "https://registry.npmjs.org/get-pkg-repo/-/get-pkg-repo-4.2.1.tgz#75973e1c8050c73f48190c52047c4cee3acbf385" + integrity sha512-2+QbHjFRfGB74v/pYWjd5OhU3TDIC2Gv/YKUTk/tCvAz0pkn/Mz6P3uByuBimLOcPvN2jYdScl3xGFSrx0jEcA== + dependencies: + "@hutson/parse-repository-url" "^3.0.0" + hosted-git-info "^4.0.0" + through2 "^2.0.0" + yargs "^16.2.0" + +get-stdin@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/get-stdin/-/get-stdin-8.0.0.tgz#cbad6a73feb75f6eeb22ba9e01f89aa28aa97a53" + integrity sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg== + +get-stream@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-4.1.0.tgz#c1b255575f3dc21d59bfc79cd3d2b46b1c3a54b5" + integrity sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w== + dependencies: + pump "^3.0.0" + +get-stream@^5.1.0: + version "5.2.0" + resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-5.2.0.tgz#4966a1795ee5ace65e706c4b7beb71257d6e22d3" + integrity sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA== + dependencies: + pump "^3.0.0" + +get-stream@^6.0.0: + version "6.0.1" + resolved "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz#a262d8eef67aced57c2852ad6167526a43cbf7b7" + integrity sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg== + +get-symbol-description@^1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.0.tgz#7fdb81c900101fbd564dd5f1a30af5aadc1e58d6" + integrity sha512-2EmdH1YvIQiZpltCNgkuiUnyukzxM/R6NDJX31Ke3BG1Nq5b0S2PhX59UKi9vZpPDQVdqn+1IcaAwnzTT5vCjw== + dependencies: + call-bind "^1.0.2" + get-intrinsic "^1.1.1" + +git-raw-commits@^2.0.8: + version "2.0.11" + resolved "https://registry.npmjs.org/git-raw-commits/-/git-raw-commits-2.0.11.tgz#bc3576638071d18655e1cc60d7f524920008d723" + integrity sha512-VnctFhw+xfj8Va1xtfEqCUD2XDrbAPSJx+hSrE5K7fGdjZruW7XV+QOrN7LF/RJyvspRiD2I0asWsxFp0ya26A== + dependencies: + dargs "^7.0.0" + lodash "^4.17.15" + meow "^8.0.0" + split2 "^3.0.0" + through2 "^4.0.0" + +git-remote-origin-url@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/git-remote-origin-url/-/git-remote-origin-url-2.0.0.tgz#5282659dae2107145a11126112ad3216ec5fa65f" + integrity sha1-UoJlna4hBxRaERJhEq0yFuxfpl8= + dependencies: + gitconfiglocal "^1.0.0" + pify "^2.3.0" + +git-semver-tags@^4.0.0, git-semver-tags@^4.1.1: + version "4.1.1" + resolved "https://registry.npmjs.org/git-semver-tags/-/git-semver-tags-4.1.1.tgz#63191bcd809b0ec3e151ba4751c16c444e5b5780" + integrity sha512-OWyMt5zBe7xFs8vglMmhM9lRQzCWL3WjHtxNNfJTMngGym7pC1kh8sP6jevfydJ6LP3ZvGxfb6ABYgPUM0mtsA== + dependencies: + meow "^8.0.0" + semver "^6.0.0" + +gitconfiglocal@^1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/gitconfiglocal/-/gitconfiglocal-1.0.0.tgz#41d045f3851a5ea88f03f24ca1c6178114464b9b" + integrity sha1-QdBF84UaXqiPA/JMocYXgRRGS5s= + dependencies: + ini "^1.3.2" + +glob-parent@^5.1.2: + version "5.1.2" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4" + integrity sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow== + dependencies: + is-glob "^4.0.1" + +glob-parent@^6.0.1: + version "6.0.2" + resolved "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz#6d237d99083950c79290f24c7642a3de9a28f9e3" + integrity sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A== + dependencies: + is-glob "^4.0.3" + +glob-promise@^3.4.0: + version "3.4.0" + resolved "https://registry.npmjs.org/glob-promise/-/glob-promise-3.4.0.tgz#b6b8f084504216f702dc2ce8c9bc9ac8866fdb20" + integrity sha512-q08RJ6O+eJn+dVanerAndJwIcumgbDdYiUT7zFQl3Wm1xD6fBKtah7H8ZJChj4wP+8C+QfeVy8xautR7rdmKEw== + dependencies: + "@types/glob" "*" + +glob@^7, glob@^7.0.0, glob@^7.1.1, glob@^7.1.2, glob@^7.1.3, glob@^7.1.4, glob@^7.2.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.0.tgz#d15535af7732e02e948f4c41628bd910293f6023" + integrity sha512-lmLf6gtyrPq8tTjSmrO94wBeQbFR3HbLHbuyD69wuyQkImp2hWqMGB47OX65FBkPffO641IP9jWa1z4ivqG26Q== + dependencies: + fs.realpath "^1.0.0" + inflight "^1.0.4" + inherits "2" + minimatch "^3.0.4" + once "^1.3.0" + path-is-absolute "^1.0.0" + +global-dirs@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/global-dirs/-/global-dirs-3.0.0.tgz#70a76fe84ea315ab37b1f5576cbde7d48ef72686" + integrity sha512-v8ho2DS5RiCjftj1nD9NmnfaOzTdud7RRnVd9kFNOjqZbISlx5DQ+OrTkywgd0dIt7oFCvKetZSHoHcP3sDdiA== + dependencies: + ini "2.0.0" + +globals@^11.1.0: + version "11.12.0" + resolved "https://registry.npmjs.org/globals/-/globals-11.12.0.tgz#ab8795338868a0babd8525758018c2a7eb95c42e" + integrity sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA== + +globals@^13.6.0, globals@^13.9.0: + version "13.13.0" + resolved "https://registry.npmjs.org/globals/-/globals-13.13.0.tgz#ac32261060d8070e2719dd6998406e27d2b5727b" + integrity sha512-EQ7Q18AJlPwp3vUDL4mKA0KXrXyNIQyWon6T6XQiBQF0XHvRsiCSrWmmeATpUzdJN2HhWZU6Pdl0a9zdep5p6A== + dependencies: + type-fest "^0.20.2" + +globby@^11.0.4: + version "11.1.0" + resolved "https://registry.yarnpkg.com/globby/-/globby-11.1.0.tgz#bd4be98bb042f83d796f7e3811991fbe82a0d34b" + integrity sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g== + dependencies: + array-union "^2.1.0" + dir-glob "^3.0.1" + fast-glob "^3.2.9" + ignore "^5.2.0" + merge2 "^1.4.1" + slash "^3.0.0" + +got@^9.6.0: + version "9.6.0" + resolved "https://registry.yarnpkg.com/got/-/got-9.6.0.tgz#edf45e7d67f99545705de1f7bbeeeb121765ed85" + integrity sha512-R7eWptXuGYxwijs0eV+v3o6+XH1IqVK8dJOEecQfTmkncw9AV4dcw/Dhxi8MdlqPthxxpZyizMzyg8RTmEsG+Q== + dependencies: + "@sindresorhus/is" "^0.14.0" + "@szmarczak/http-timer" "^1.1.2" + cacheable-request "^6.0.0" + decompress-response "^3.3.0" + duplexer3 "^0.1.4" + get-stream "^4.1.0" + lowercase-keys "^1.0.1" + mimic-response "^1.0.1" + p-cancelable "^1.0.0" + to-readable-stream "^1.0.0" + url-parse-lax "^3.0.0" + +graceful-fs@^4.1.2, graceful-fs@^4.1.6, graceful-fs@^4.2.0, graceful-fs@^4.2.6, graceful-fs@^4.2.9: + version "4.2.9" + resolved "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.9.tgz#041b05df45755e587a24942279b9d113146e1c96" + integrity sha512-NtNxqUcXgpW2iMrfqSfR73Glt39K+BLwWsPs94yR63v45T0Wbej7eRmL5cWfwEgqXnmjQp3zaJTshdRW/qC2ZQ== + +handlebars@^4.7.7: + version "4.7.7" + resolved "https://registry.npmjs.org/handlebars/-/handlebars-4.7.7.tgz#9ce33416aad02dbd6c8fafa8240d5d98004945a1" + integrity sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA== + dependencies: + minimist "^1.2.5" + neo-async "^2.6.0" + source-map "^0.6.1" + wordwrap "^1.0.0" + optionalDependencies: + uglify-js "^3.1.4" + +hard-rejection@^2.1.0: + version "2.1.0" + resolved "https://registry.npmjs.org/hard-rejection/-/hard-rejection-2.1.0.tgz#1c6eda5c1685c63942766d79bb40ae773cecd883" + integrity sha512-VIZB+ibDhx7ObhAe7OVtoEbuP4h/MuOTHJ+J8h/eBXotJYl0fBgR72xDFCKgIh22OJZIOVNxBMWuhAr10r8HdA== + +has-bigints@^1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/has-bigints/-/has-bigints-1.0.1.tgz#64fe6acb020673e3b78db035a5af69aa9d07b113" + integrity sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA== + +has-flag@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz#b5d454dc2199ae225699f3467e5a07f3b955bafd" + integrity sha1-tdRU3CGZriJWmfNGfloH87lVuv0= + +has-flag@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b" + integrity sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ== + +has-symbols@^1.0.1, has-symbols@^1.0.2: + version "1.0.3" + resolved "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz#bb7b2c4349251dce87b125f7bdf874aa7c8b39f8" + integrity sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A== + +has-tostringtag@^1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.0.tgz#7e133818a7d394734f941e73c3d3f9291e658b25" + integrity sha512-kFjcSNhnlGV1kyoGk7OXKSawH5JOb/LzUc5w9B02hOTO0dfFRjbHQKvg1d6cf3HbeUmtU9VbbV3qzZ2Teh97WQ== + dependencies: + has-symbols "^1.0.2" + +has-unicode@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/has-unicode/-/has-unicode-2.0.1.tgz#e0e6fe6a28cf51138855e086d1691e771de2a8b9" + integrity sha1-4Ob+aijPUROIVeCG0Wkedx3iqLk= + +has-yarn@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/has-yarn/-/has-yarn-2.1.0.tgz#137e11354a7b5bf11aa5cb649cf0c6f3ff2b2e77" + integrity sha512-UqBRqi4ju7T+TqGNdqAO0PaSVGsDGJUBQvk9eUWNGRY1CFGDzYhLWoM7JQEemnlvVcv/YEmc2wNW8BC24EnUsw== + +has@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/has/-/has-1.0.3.tgz#722d7cbfc1f6aa8241f16dd814e011e1f41e8796" + integrity sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw== + dependencies: + function-bind "^1.1.1" + +hosted-git-info@^2.1.4: + version "2.8.9" + resolved "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.9.tgz#dffc0bf9a21c02209090f2aa69429e1414daf3f9" + integrity sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw== + +hosted-git-info@^4.0.0, hosted-git-info@^4.0.1, hosted-git-info@^4.1.0: + version "4.1.0" + resolved "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-4.1.0.tgz#827b82867e9ff1c8d0c4d9d53880397d2c86d224" + integrity sha512-kyCuEOWjJqZuDbRHzL8V93NzQhwIB71oFWSyzVo+KPZI+pnQPPxucdkrOZvkLRnrf5URsQM+IJ09Dw29cRALIA== + dependencies: + lru-cache "^6.0.0" + +hosted-git-info@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/hosted-git-info/-/hosted-git-info-5.0.0.tgz#df7a06678b4ebd722139786303db80fdf302ea56" + integrity sha512-rRnjWu0Bxj+nIfUOkz0695C0H6tRrN5iYIzYejb0tDEefe2AekHu/U5Kn9pEie5vsJqpNQU02az7TGSH3qpz4Q== + dependencies: + lru-cache "^7.5.1" + +html-encoding-sniffer@^2.0.1: + version "2.0.1" + resolved "https://registry.npmjs.org/html-encoding-sniffer/-/html-encoding-sniffer-2.0.1.tgz#42a6dc4fd33f00281176e8b23759ca4e4fa185f3" + integrity sha512-D5JbOMBIR/TVZkubHT+OyT2705QvogUW4IBn6nHd756OwieSF9aDYFj4dv6HHEVGYbHaLETa3WggZYWWMyy3ZQ== + dependencies: + whatwg-encoding "^1.0.5" + +html-escaper@^2.0.0: + version "2.0.2" + resolved "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz#dfd60027da36a36dfcbe236262c00a5822681453" + integrity sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg== + +http-cache-semantics@^4.0.0, http-cache-semantics@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-4.1.0.tgz#49e91c5cbf36c9b94bcfcd71c23d5249ec74e390" + integrity sha512-carPklcUh7ROWRK7Cv27RPtdhYhUsela/ue5/jKzjegVvXDqM2ILE9Q2BGn9JZJh1g87cp56su/FgQSzcWS8cQ== + +http-proxy-agent@^4.0.1: + version "4.0.1" + resolved "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-4.0.1.tgz#8a8c8ef7f5932ccf953c296ca8291b95aa74aa3a" + integrity sha512-k0zdNgqWTGA6aeIRVpvfVob4fL52dTfaehylg0Y4UvSySvOq/Y+BOyPrgpUrA7HylqvU8vIZGsRuXmspskV0Tg== + dependencies: + "@tootallnate/once" "1" + agent-base "6" + debug "4" + +http-proxy-agent@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/http-proxy-agent/-/http-proxy-agent-5.0.0.tgz#5129800203520d434f142bc78ff3c170800f2b43" + integrity sha512-n2hY8YdoRE1i7r6M0w9DIw5GgZN0G25P8zLCRQ8rjXtTU3vsNFBI/vWK/UIeE6g5MUUz6avwAPXmL6Fy9D/90w== + dependencies: + "@tootallnate/once" "2" + agent-base "6" + debug "4" + +https-proxy-agent@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/https-proxy-agent/-/https-proxy-agent-5.0.0.tgz#e2a90542abb68a762e0a0850f6c9edadfd8506b2" + integrity sha512-EkYm5BcKUGiduxzSt3Eppko+PiNWNEpa4ySk9vTC6wDsQJW9rHSa+UhGNJoRYp7bz6Ht1eaRIa6QaJqO5rCFbA== + dependencies: + agent-base "6" + debug "4" + +human-signals@^2.1.0: + version "2.1.0" + resolved "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0" + integrity sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw== + +humanize-ms@^1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/humanize-ms/-/humanize-ms-1.2.1.tgz#c46e3159a293f6b896da29316d8b6fe8bb79bbed" + integrity sha1-xG4xWaKT9riW2ikxbYtv6Lt5u+0= + dependencies: + ms "^2.0.0" + +iconv-lite@0.4.24: + version "0.4.24" + resolved "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b" + integrity sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA== + dependencies: + safer-buffer ">= 2.1.2 < 3" + +iconv-lite@^0.6.2: + version "0.6.3" + resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.6.3.tgz#a52f80bf38da1952eb5c681790719871a1a72501" + integrity sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw== + dependencies: + safer-buffer ">= 2.1.2 < 3.0.0" + +ignore-walk@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/ignore-walk/-/ignore-walk-4.0.1.tgz#fc840e8346cf88a3a9380c5b17933cd8f4d39fa3" + integrity sha512-rzDQLaW4jQbh2YrOFlJdCtX8qgJTehFRYiUB2r1osqTeDzV/3+Jh8fz1oAPzUThf3iku8Ds4IDqawI5d8mUiQw== + dependencies: + minimatch "^3.0.4" + +ignore@^5.1.8, ignore@^5.2.0: + version "5.2.0" + resolved "https://registry.npmjs.org/ignore/-/ignore-5.2.0.tgz#6d3bac8fa7fe0d45d9f9be7bac2fc279577e345a" + integrity sha512-CmxgYGiEPCLhfLnpPp1MoRmifwEIOgjcHXxOBjv7mY96c+eWScsOP9c112ZyLdWHi0FxHjI+4uVhKYp/gcdRmQ== + +import-fresh@^3.0.0, import-fresh@^3.2.1: + version "3.3.0" + resolved "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz#37162c25fcb9ebaa2e6e53d5b4d88ce17d9e0c2b" + integrity sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw== + dependencies: + parent-module "^1.0.0" + resolve-from "^4.0.0" + +import-lazy@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/import-lazy/-/import-lazy-2.1.0.tgz#05698e3d45c88e8d7e9d92cb0584e77f096f3e43" + integrity sha1-BWmOPUXIjo1+nZLLBYTnfwlvPkM= + +import-local@^3.0.2: + version "3.1.0" + resolved "https://registry.npmjs.org/import-local/-/import-local-3.1.0.tgz#b4479df8a5fd44f6cdce24070675676063c95cb4" + integrity sha512-ASB07uLtnDs1o6EHjKpX34BKYDSqnFerfTOJL2HvMqF70LnxpjkzDB8J44oT9pu4AMPkQwf8jl6szgvNd2tRIg== + dependencies: + pkg-dir "^4.2.0" + resolve-cwd "^3.0.0" + +imurmurhash@^0.1.4: + version "0.1.4" + resolved "https://registry.yarnpkg.com/imurmurhash/-/imurmurhash-0.1.4.tgz#9218b9b2b928a238b13dc4fb6b6d576f231453ea" + integrity sha1-khi5srkoojixPcT7a21XbyMUU+o= + +indent-string@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/indent-string/-/indent-string-4.0.0.tgz#624f8f4497d619b2d9768531d58f4122854d7251" + integrity sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg== + +infer-owner@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/infer-owner/-/infer-owner-1.0.4.tgz#c4cefcaa8e51051c2a40ba2ce8a3d27295af9467" + integrity sha512-IClj+Xz94+d7irH5qRyfJonOdfTzuDaifE6ZPWfx0N0+/ATZCbuTPq2prFl526urkQd90WyUKIh1DfBQ2hMz9A== + +inflight@^1.0.4: + version "1.0.6" + resolved "https://registry.yarnpkg.com/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9" + integrity sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk= + dependencies: + once "^1.3.0" + wrappy "1" + +inherits@2, inherits@^2.0.3, inherits@~2.0.3: + version "2.0.4" + resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c" + integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ== + +ini@2.0.0, ini@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/ini/-/ini-2.0.0.tgz#e5fd556ecdd5726be978fa1001862eacb0a94bc5" + integrity sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA== + +ini@^1.3.2, ini@^1.3.5, ini@~1.3.0: + version "1.3.8" + resolved "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz#a29da425b48806f34767a4efce397269af28432c" + integrity sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew== + +internal-slot@^1.0.3: + version "1.0.3" + resolved "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.3.tgz#7347e307deeea2faac2ac6205d4bc7d34967f59c" + integrity sha512-O0DB1JC/sPyZl7cIo78n5dR7eUSwwpYPiXRhTzNxZVAMUuB8vlnRFyLxdrVToks6XPLVnFfbzaVd5WLjhgg+vA== + dependencies: + get-intrinsic "^1.1.0" + has "^1.0.3" + side-channel "^1.0.4" + +interpret@^1.0.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/interpret/-/interpret-1.4.0.tgz#665ab8bc4da27a774a40584e812e3e0fa45b1a1e" + integrity sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA== + +ip@^1.1.5: + version "1.1.5" + resolved "https://registry.yarnpkg.com/ip/-/ip-1.1.5.tgz#bdded70114290828c0a039e72ef25f5aaec4354a" + integrity sha1-vd7XARQpCCjAoDnnLvJfWq7ENUo= + +is-arguments@^1.0.4, is-arguments@^1.1.0: + version "1.1.1" + resolved "https://registry.npmjs.org/is-arguments/-/is-arguments-1.1.1.tgz#15b3f88fda01f2a97fec84ca761a560f123efa9b" + integrity sha512-8Q7EARjzEnKpt/PCD7e1cgUS0a6X8u5tdSiMqXhojOdoV9TsMsiO+9VLC5vAmO8N7/GmXn7yjR8qnA6bVAEzfA== + dependencies: + call-bind "^1.0.2" + has-tostringtag "^1.0.0" + +is-arrayish@^0.2.1: + version "0.2.1" + resolved "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz#77c99840527aa8ecb1a8ba697b80645a7a926a9d" + integrity sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0= + +is-bigint@^1.0.1: + version "1.0.4" + resolved "https://registry.npmjs.org/is-bigint/-/is-bigint-1.0.4.tgz#08147a1875bc2b32005d41ccd8291dffc6691df3" + integrity sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg== + dependencies: + has-bigints "^1.0.1" + +is-boolean-object@^1.1.0: + version "1.1.2" + resolved "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.1.2.tgz#5c6dc200246dd9321ae4b885a114bb1f75f63719" + integrity sha512-gDYaKHJmnj4aWxyj6YHyXVpdQawtVLHU5cb+eztPGczf6cjuTdwve5ZIEfgXqH4e57An1D1AKf8CZ3kYrQRqYA== + dependencies: + call-bind "^1.0.2" + has-tostringtag "^1.0.0" + +is-callable@^1.1.4, is-callable@^1.2.4: + version "1.2.4" + resolved "https://registry.npmjs.org/is-callable/-/is-callable-1.2.4.tgz#47301d58dd0259407865547853df6d61fe471945" + integrity sha512-nsuwtxZfMX67Oryl9LCQ+upnC0Z0BgpwntpS89m1H/TLF0zNfzfLMV/9Wa/6MZsj0acpEjAO0KF1xT6ZdLl95w== + +is-ci@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/is-ci/-/is-ci-2.0.0.tgz#6bc6334181810e04b5c22b3d589fdca55026404c" + integrity sha512-YfJT7rkpQB0updsdHLGWrvhBJfcfzNNawYDNIyQXJz0IViGf75O8EBPKSdvw2rF+LGCsX4FZ8tcr3b19LcZq4w== + dependencies: + ci-info "^2.0.0" + +is-core-module@^2.5.0, is-core-module@^2.8.0, is-core-module@^2.8.1: + version "2.8.1" + resolved "https://registry.yarnpkg.com/is-core-module/-/is-core-module-2.8.1.tgz#f59fdfca701d5879d0a6b100a40aa1560ce27211" + integrity sha512-SdNCUs284hr40hFTFP6l0IfZ/RSrMXF3qgoRHd3/79unUTvrFO/JoXwkGm+5J/Oe3E/b5GsnG330uUNgRpu1PA== + dependencies: + has "^1.0.3" + +is-date-object@^1.0.1, is-date-object@^1.0.2: + version "1.0.5" + resolved "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.5.tgz#0841d5536e724c25597bf6ea62e1bd38298df31f" + integrity sha512-9YQaSxsAiSwcvS33MBk3wTCVnWK+HhF8VZR2jRxehM16QcVOdHqPn4VPHmRK4lSr38n9JriurInLcP90xsYNfQ== + dependencies: + has-tostringtag "^1.0.0" + +is-extglob@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/is-extglob/-/is-extglob-2.1.1.tgz#a88c02535791f02ed37c76a1b9ea9773c833f8c2" + integrity sha1-qIwCU1eR8C7TfHahueqXc8gz+MI= + +is-fullwidth-code-point@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d" + integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== + +is-generator-fn@^2.0.0: + version "2.1.0" + resolved "https://registry.npmjs.org/is-generator-fn/-/is-generator-fn-2.1.0.tgz#7d140adc389aaf3011a8f2a2a4cfa6faadffb118" + integrity sha512-cTIB4yPYL/Grw0EaSzASzg6bBy9gqCofvWN8okThAYIxKJZC+udlRAmGbM0XLeniEJSs8uEgHPGuHSe1XsOLSQ== + +is-glob@^4.0.0, is-glob@^4.0.1, is-glob@^4.0.3: + version "4.0.3" + resolved "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz#64f61e42cbbb2eec2071a9dac0b28ba1e65d5084" + integrity sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg== + dependencies: + is-extglob "^2.1.1" + +is-installed-globally@^0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/is-installed-globally/-/is-installed-globally-0.4.0.tgz#9a0fd407949c30f86eb6959ef1b7994ed0b7b520" + integrity sha512-iwGqO3J21aaSkC7jWnHP/difazwS7SFeIqxv6wEtLU8Y5KlzFTjyqcSIT0d8s4+dDhKytsk9PJZ2BkS5eZwQRQ== + dependencies: + global-dirs "^3.0.0" + is-path-inside "^3.0.2" + +is-lambda@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/is-lambda/-/is-lambda-1.0.1.tgz#3d9877899e6a53efc0160504cde15f82e6f061d5" + integrity sha1-PZh3iZ5qU+/AFgUEzeFfgubwYdU= + +is-map@^2.0.1, is-map@^2.0.2: + version "2.0.2" + resolved "https://registry.npmjs.org/is-map/-/is-map-2.0.2.tgz#00922db8c9bf73e81b7a335827bc2a43f2b91127" + integrity sha512-cOZFQQozTha1f4MxLFzlgKYPTyj26picdZTx82hbc/Xf4K/tZOOXSCkMvU4pKioRXGDLJRn0GM7Upe7kR721yg== + +is-negative-zero@^2.0.1: + version "2.0.2" + resolved "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.2.tgz#7bf6f03a28003b8b3965de3ac26f664d765f3150" + integrity sha512-dqJvarLawXsFbNDeJW7zAz8ItJ9cd28YufuuFzh0G8pNHjJMnY08Dv7sYX2uF5UpQOwieAeOExEYAWWfu7ZZUA== + +is-npm@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/is-npm/-/is-npm-5.0.0.tgz#43e8d65cc56e1b67f8d47262cf667099193f45a8" + integrity sha512-WW/rQLOazUq+ST/bCAVBp/2oMERWLsR7OrKyt052dNDk4DHcDE0/7QSXITlmi+VBcV13DfIbysG3tZJm5RfdBA== + +is-number-object@^1.0.4: + version "1.0.6" + resolved "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.6.tgz#6a7aaf838c7f0686a50b4553f7e54a96494e89f0" + integrity sha512-bEVOqiRcvo3zO1+G2lVMy+gkkEm9Yh7cDMRusKKu5ZJKPUYSJwICTKZrNKHA2EbSP0Tu0+6B/emsYNHZyn6K8g== + dependencies: + has-tostringtag "^1.0.0" + +is-number@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" + integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== + +is-obj@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-2.0.0.tgz#473fb05d973705e3fd9620545018ca8e22ef4982" + integrity sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w== + +is-path-inside@^3.0.2: + version "3.0.3" + resolved "https://registry.yarnpkg.com/is-path-inside/-/is-path-inside-3.0.3.tgz#d231362e53a07ff2b0e0ea7fed049161ffd16283" + integrity sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ== + +is-plain-obj@^1.1.0: + version "1.1.0" + resolved "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-1.1.0.tgz#71a50c8429dfca773c92a390a4a03b39fcd51d3e" + integrity sha1-caUMhCnfync8kqOQpKA7OfzVHT4= + +is-potential-custom-element-name@^1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/is-potential-custom-element-name/-/is-potential-custom-element-name-1.0.1.tgz#171ed6f19e3ac554394edf78caa05784a45bebb5" + integrity sha512-bCYeRA2rVibKZd+s2625gGnGF/t7DSqDs4dP7CrLA1m7jKWz6pps0LpYLJN8Q64HtmPKJ1hrN3nzPNKFEKOUiQ== + +is-regex@^1.1.1, is-regex@^1.1.4: + version "1.1.4" + resolved "https://registry.npmjs.org/is-regex/-/is-regex-1.1.4.tgz#eef5663cd59fa4c0ae339505323df6854bb15958" + integrity sha512-kvRdxDsxZjhzUX07ZnLydzS1TU/TJlTUHHY4YLL87e37oUA49DfkLqgy+VjFocowy29cKvcSiu+kIv728jTTVg== + dependencies: + call-bind "^1.0.2" + has-tostringtag "^1.0.0" + +is-set@^2.0.1, is-set@^2.0.2: + version "2.0.2" + resolved "https://registry.npmjs.org/is-set/-/is-set-2.0.2.tgz#90755fa4c2562dc1c5d4024760d6119b94ca18ec" + integrity sha512-+2cnTEZeY5z/iXGbLhPrOAaK/Mau5k5eXq9j14CpRTftq0pAJu2MwVRSZhyZWBzx3o6X795Lz6Bpb6R0GKf37g== + +is-shared-array-buffer@^1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.1.tgz#97b0c85fbdacb59c9c446fe653b82cf2b5b7cfe6" + integrity sha512-IU0NmyknYZN0rChcKhRO1X8LYz5Isj/Fsqh8NJOSf+N/hCOTwy29F32Ik7a+QszE63IdvmwdTPDd6cZ5pg4cwA== + +is-stream@^2.0.0: + version "2.0.1" + resolved "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz#fac1e3d53b97ad5a9d0ae9cef2389f5810a5c077" + integrity sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg== + +is-string@^1.0.5, is-string@^1.0.7: + version "1.0.7" + resolved "https://registry.npmjs.org/is-string/-/is-string-1.0.7.tgz#0dd12bf2006f255bb58f695110eff7491eebc0fd" + integrity sha512-tE2UXzivje6ofPW7l23cjDOMa09gb7xlAqG6jG5ej6uPV32TlWP3NKPigtaGeHNu9fohccRYvIiZMfOOnOYUtg== + dependencies: + has-tostringtag "^1.0.0" + +is-symbol@^1.0.2, is-symbol@^1.0.3: + version "1.0.4" + resolved "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.4.tgz#a6dac93b635b063ca6872236de88910a57af139c" + integrity sha512-C/CPBqKWnvdcxqIARxyOh4v1UUEOCHpgDa0WYgpKDFMszcrPcffg5uhwSgPCLD2WWxmq6isisz87tzT01tuGhg== + dependencies: + has-symbols "^1.0.2" + +is-text-path@^1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/is-text-path/-/is-text-path-1.0.1.tgz#4e1aa0fb51bfbcb3e92688001397202c1775b66e" + integrity sha1-Thqg+1G/vLPpJogAE5cgLBd1tm4= + dependencies: + text-extensions "^1.0.0" + +is-typed-array@^1.1.7: + version "1.1.8" + resolved "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.8.tgz#cbaa6585dc7db43318bc5b89523ea384a6f65e79" + integrity sha512-HqH41TNZq2fgtGT8WHVFVJhBVGuY3AnP3Q36K8JKXUxSxRgk/d+7NjmwG2vo2mYmXK8UYZKu0qH8bVP5gEisjA== + dependencies: + available-typed-arrays "^1.0.5" + call-bind "^1.0.2" + es-abstract "^1.18.5" + foreach "^2.0.5" + has-tostringtag "^1.0.0" + +is-typedarray@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-typedarray/-/is-typedarray-1.0.0.tgz#e479c80858df0c1b11ddda6940f96011fcda4a9a" + integrity sha1-5HnICFjfDBsR3dppQPlgEfzaSpo= + +is-weakmap@^2.0.1: + version "2.0.1" + resolved "https://registry.npmjs.org/is-weakmap/-/is-weakmap-2.0.1.tgz#5008b59bdc43b698201d18f62b37b2ca243e8cf2" + integrity sha512-NSBR4kH5oVj1Uwvv970ruUkCV7O1mzgVFO4/rev2cLRda9Tm9HrL70ZPut4rOHgY0FNrUu9BCbXA2sdQ+x0chA== + +is-weakref@^1.0.1: + version "1.0.2" + resolved "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz#9529f383a9338205e89765e0392efc2f100f06f2" + integrity sha512-qctsuLZmIQ0+vSSMfoVvyFe2+GSEvnmZ2ezTup1SBse9+twCCeial6EEi3Nc2KFcf6+qz2FBPnjXsk8xhKSaPQ== + dependencies: + call-bind "^1.0.2" + +is-weakset@^2.0.1: + version "2.0.2" + resolved "https://registry.npmjs.org/is-weakset/-/is-weakset-2.0.2.tgz#4569d67a747a1ce5a994dfd4ef6dcea76e7c0a1d" + integrity sha512-t2yVvttHkQktwnNNmBQ98AhENLdPUTDTE21uPqAQ0ARwQfGeQKRVS0NNurH7bTf7RrvcVn1OOge45CnBeHCSmg== + dependencies: + call-bind "^1.0.2" + get-intrinsic "^1.1.1" + +is-yarn-global@^0.3.0: + version "0.3.0" + resolved "https://registry.yarnpkg.com/is-yarn-global/-/is-yarn-global-0.3.0.tgz#d502d3382590ea3004893746754c89139973e232" + integrity sha512-VjSeb/lHmkoyd8ryPVIKvOCn4D1koMqY+vqyjjUfc3xyKtP4dYOxM44sZrnqQSzSds3xyOrUTLTC9LVCVgLngw== + +isarray@^2.0.5: + version "2.0.5" + resolved "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz#8af1e4c1221244cc62459faf38940d4e644a5723" + integrity sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw== + +isarray@~1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz#bb935d48582cba168c06834957a54a3e07124f11" + integrity sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE= + +isexe@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10" + integrity sha1-6PvzdNxVb/iUehDcsFctYz8s+hA= + +istanbul-lib-coverage@^3.0.0, istanbul-lib-coverage@^3.2.0: + version "3.2.0" + resolved "https://registry.npmjs.org/istanbul-lib-coverage/-/istanbul-lib-coverage-3.2.0.tgz#189e7909d0a39fa5a3dfad5b03f71947770191d3" + integrity sha512-eOeJ5BHCmHYvQK7xt9GkdHuzuCGS1Y6g9Gvnx3Ym33fz/HpLRYxiS0wHNr+m/MBC8B647Xt608vCDEvhl9c6Mw== + +istanbul-lib-instrument@^5.0.4, istanbul-lib-instrument@^5.1.0: + version "5.1.0" + resolved "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-5.1.0.tgz#7b49198b657b27a730b8e9cb601f1e1bff24c59a" + integrity sha512-czwUz525rkOFDJxfKK6mYfIs9zBKILyrZQxjz3ABhjQXhbhFsSbo1HW/BFcsDnfJYJWA6thRR5/TUY2qs5W99Q== + dependencies: + "@babel/core" "^7.12.3" + "@babel/parser" "^7.14.7" + "@istanbuljs/schema" "^0.1.2" + istanbul-lib-coverage "^3.2.0" + semver "^6.3.0" + +istanbul-lib-report@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/istanbul-lib-report/-/istanbul-lib-report-3.0.0.tgz#7518fe52ea44de372f460a76b5ecda9ffb73d8a6" + integrity sha512-wcdi+uAKzfiGT2abPpKZ0hSU1rGQjUQnLvtY5MpQ7QCTahD3VODhcu4wcfY1YtkGaDD5yuydOLINXsfbus9ROw== + dependencies: + istanbul-lib-coverage "^3.0.0" + make-dir "^3.0.0" + supports-color "^7.1.0" + +istanbul-lib-source-maps@^4.0.0: + version "4.0.1" + resolved "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-4.0.1.tgz#895f3a709fcfba34c6de5a42939022f3e4358551" + integrity sha512-n3s8EwkdFIJCG3BPKBYvskgXGoy88ARzvegkitk60NxRdwltLOTaH7CUiMRXvwYorl0Q712iEjcWB+fK/MrWVw== + dependencies: + debug "^4.1.1" + istanbul-lib-coverage "^3.0.0" + source-map "^0.6.1" + +istanbul-reports@^3.1.3: + version "3.1.4" + resolved "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.1.4.tgz#1b6f068ecbc6c331040aab5741991273e609e40c" + integrity sha512-r1/DshN4KSE7xWEknZLLLLDn5CJybV3nw01VTkp6D5jzLuELlcbudfj/eSQFvrKsJuTVCGnePO7ho82Nw9zzfw== + dependencies: + html-escaper "^2.0.0" + istanbul-lib-report "^3.0.0" + +jest-changed-files@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-27.5.1.tgz#a348aed00ec9bf671cc58a66fcbe7c3dfd6a68f5" + integrity sha512-buBLMiByfWGCoMsLLzGUUSpAmIAGnbR2KJoMN10ziLhOLvP4e0SlypHnAel8iqQXTrcbmfEY9sSqae5sgUsTvw== + dependencies: + "@jest/types" "^27.5.1" + execa "^5.0.0" + throat "^6.0.1" + +jest-circus@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-circus/-/jest-circus-27.5.1.tgz#37a5a4459b7bf4406e53d637b49d22c65d125ecc" + integrity sha512-D95R7x5UtlMA5iBYsOHFFbMD/GVA4R/Kdq15f7xYWUfWHBto9NYRsOvnSauTgdF+ogCpJ4tyKOXhUifxS65gdw== + dependencies: + "@jest/environment" "^27.5.1" + "@jest/test-result" "^27.5.1" + "@jest/types" "^27.5.1" + "@types/node" "*" + chalk "^4.0.0" + co "^4.6.0" + dedent "^0.7.0" + expect "^27.5.1" + is-generator-fn "^2.0.0" + jest-each "^27.5.1" + jest-matcher-utils "^27.5.1" + jest-message-util "^27.5.1" + jest-runtime "^27.5.1" + jest-snapshot "^27.5.1" + jest-util "^27.5.1" + pretty-format "^27.5.1" + slash "^3.0.0" + stack-utils "^2.0.3" + throat "^6.0.1" + +jest-cli@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-cli/-/jest-cli-27.5.1.tgz#278794a6e6458ea8029547e6c6cbf673bd30b145" + integrity sha512-Hc6HOOwYq4/74/c62dEE3r5elx8wjYqxY0r0G/nFrLDPMFRu6RA/u8qINOIkvhxG7mMQ5EJsOGfRpI8L6eFUVw== + dependencies: + "@jest/core" "^27.5.1" + "@jest/test-result" "^27.5.1" + "@jest/types" "^27.5.1" + chalk "^4.0.0" + exit "^0.1.2" + graceful-fs "^4.2.9" + import-local "^3.0.2" + jest-config "^27.5.1" + jest-util "^27.5.1" + jest-validate "^27.5.1" + prompts "^2.0.1" + yargs "^16.2.0" + +jest-config@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-config/-/jest-config-27.5.1.tgz#5c387de33dca3f99ad6357ddeccd91bf3a0e4a41" + integrity sha512-5sAsjm6tGdsVbW9ahcChPAFCk4IlkQUknH5AvKjuLTSlcO/wCZKyFdn7Rg0EkC+OGgWODEy2hDpWB1PgzH0JNA== + dependencies: + "@babel/core" "^7.8.0" + "@jest/test-sequencer" "^27.5.1" + "@jest/types" "^27.5.1" + babel-jest "^27.5.1" + chalk "^4.0.0" + ci-info "^3.2.0" + deepmerge "^4.2.2" + glob "^7.1.1" + graceful-fs "^4.2.9" + jest-circus "^27.5.1" + jest-environment-jsdom "^27.5.1" + jest-environment-node "^27.5.1" + jest-get-type "^27.5.1" + jest-jasmine2 "^27.5.1" + jest-regex-util "^27.5.1" + jest-resolve "^27.5.1" + jest-runner "^27.5.1" + jest-util "^27.5.1" + jest-validate "^27.5.1" + micromatch "^4.0.4" + parse-json "^5.2.0" + pretty-format "^27.5.1" + slash "^3.0.0" + strip-json-comments "^3.1.1" + +jest-diff@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-diff/-/jest-diff-27.5.1.tgz#a07f5011ac9e6643cf8a95a462b7b1ecf6680def" + integrity sha512-m0NvkX55LDt9T4mctTEgnZk3fmEg3NRYutvMPWM/0iPnkFj2wIeF45O1718cMSOFO1vINkqmxqD8vE37uTEbqw== + dependencies: + chalk "^4.0.0" + diff-sequences "^27.5.1" + jest-get-type "^27.5.1" + pretty-format "^27.5.1" + +jest-docblock@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-docblock/-/jest-docblock-27.5.1.tgz#14092f364a42c6108d42c33c8cf30e058e25f6c0" + integrity sha512-rl7hlABeTsRYxKiUfpHrQrG4e2obOiTQWfMEH3PxPjOtdsfLQO4ReWSZaQ7DETm4xu07rl4q/h4zcKXyU0/OzQ== + dependencies: + detect-newline "^3.0.0" + +jest-each@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-each/-/jest-each-27.5.1.tgz#5bc87016f45ed9507fed6e4702a5b468a5b2c44e" + integrity sha512-1Ff6p+FbhT/bXQnEouYy00bkNSY7OUpfIcmdl8vZ31A1UUaurOLPA8a8BbJOF2RDUElwJhmeaV7LnagI+5UwNQ== + dependencies: + "@jest/types" "^27.5.1" + chalk "^4.0.0" + jest-get-type "^27.5.1" + jest-util "^27.5.1" + pretty-format "^27.5.1" + +jest-environment-jsdom@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-environment-jsdom/-/jest-environment-jsdom-27.5.1.tgz#ea9ccd1fc610209655a77898f86b2b559516a546" + integrity sha512-TFBvkTC1Hnnnrka/fUb56atfDtJ9VMZ94JkjTbggl1PEpwrYtUBKMezB3inLmWqQsXYLcMwNoDQwoBTAvFfsfw== + dependencies: + "@jest/environment" "^27.5.1" + "@jest/fake-timers" "^27.5.1" + "@jest/types" "^27.5.1" + "@types/node" "*" + jest-mock "^27.5.1" + jest-util "^27.5.1" + jsdom "^16.6.0" + +jest-environment-node@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-27.5.1.tgz#dedc2cfe52fab6b8f5714b4808aefa85357a365e" + integrity sha512-Jt4ZUnxdOsTGwSRAfKEnE6BcwsSPNOijjwifq5sDFSA2kesnXTvNqKHYgM0hDq3549Uf/KzdXNYn4wMZJPlFLw== + dependencies: + "@jest/environment" "^27.5.1" + "@jest/fake-timers" "^27.5.1" + "@jest/types" "^27.5.1" + "@types/node" "*" + jest-mock "^27.5.1" + jest-util "^27.5.1" + +jest-get-type@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-get-type/-/jest-get-type-27.5.1.tgz#3cd613c507b0f7ace013df407a1c1cd578bcb4f1" + integrity sha512-2KY95ksYSaK7DMBWQn6dQz3kqAf3BB64y2udeG+hv4KfSOb9qwcYQstTJc1KCbsix+wLZWZYN8t7nwX3GOBLRw== + +jest-haste-map@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-27.5.1.tgz#9fd8bd7e7b4fa502d9c6164c5640512b4e811e7f" + integrity sha512-7GgkZ4Fw4NFbMSDSpZwXeBiIbx+t/46nJ2QitkOjvwPYyZmqttu2TDSimMHP1EkPOi4xUZAN1doE5Vd25H4Jng== + dependencies: + "@jest/types" "^27.5.1" + "@types/graceful-fs" "^4.1.2" + "@types/node" "*" + anymatch "^3.0.3" + fb-watchman "^2.0.0" + graceful-fs "^4.2.9" + jest-regex-util "^27.5.1" + jest-serializer "^27.5.1" + jest-util "^27.5.1" + jest-worker "^27.5.1" + micromatch "^4.0.4" + walker "^1.0.7" + optionalDependencies: + fsevents "^2.3.2" + +jest-jasmine2@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-jasmine2/-/jest-jasmine2-27.5.1.tgz#a037b0034ef49a9f3d71c4375a796f3b230d1ac4" + integrity sha512-jtq7VVyG8SqAorDpApwiJJImd0V2wv1xzdheGHRGyuT7gZm6gG47QEskOlzsN1PG/6WNaCo5pmwMHDf3AkG2pQ== + dependencies: + "@jest/environment" "^27.5.1" + "@jest/source-map" "^27.5.1" + "@jest/test-result" "^27.5.1" + "@jest/types" "^27.5.1" + "@types/node" "*" + chalk "^4.0.0" + co "^4.6.0" + expect "^27.5.1" + is-generator-fn "^2.0.0" + jest-each "^27.5.1" + jest-matcher-utils "^27.5.1" + jest-message-util "^27.5.1" + jest-runtime "^27.5.1" + jest-snapshot "^27.5.1" + jest-util "^27.5.1" + pretty-format "^27.5.1" + throat "^6.0.1" + +jest-junit@^13: + version "13.0.0" + resolved "https://registry.npmjs.org/jest-junit/-/jest-junit-13.0.0.tgz#479be347457aad98ae8a5983a23d7c3ec526c9a3" + integrity sha512-JSHR+Dhb32FGJaiKkqsB7AR3OqWKtldLd6ZH2+FJ8D4tsweb8Id8zEVReU4+OlrRO1ZluqJLQEETm+Q6/KilBg== + dependencies: + mkdirp "^1.0.4" + strip-ansi "^6.0.1" + uuid "^8.3.2" + xml "^1.0.1" + +jest-leak-detector@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-27.5.1.tgz#6ec9d54c3579dd6e3e66d70e3498adf80fde3fb8" + integrity sha512-POXfWAMvfU6WMUXftV4HolnJfnPOGEu10fscNCA76KBpRRhcMN2c8d3iT2pxQS3HLbA+5X4sOUPzYO2NUyIlHQ== + dependencies: + jest-get-type "^27.5.1" + pretty-format "^27.5.1" + +jest-matcher-utils@^27.0.0, jest-matcher-utils@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-27.5.1.tgz#9c0cdbda8245bc22d2331729d1091308b40cf8ab" + integrity sha512-z2uTx/T6LBaCoNWNFWwChLBKYxTMcGBRjAt+2SbP929/Fflb9aa5LGma654Rz8z9HLxsrUaYzxE9T/EFIL/PAw== + dependencies: + chalk "^4.0.0" + jest-diff "^27.5.1" + jest-get-type "^27.5.1" + pretty-format "^27.5.1" + +jest-message-util@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-message-util/-/jest-message-util-27.5.1.tgz#bdda72806da10d9ed6425e12afff38cd1458b6cf" + integrity sha512-rMyFe1+jnyAAf+NHwTclDz0eAaLkVDdKVHHBFWsBWHnnh5YeJMNWWsv7AbFYXfK3oTqvL7VTWkhNLu1jX24D+g== + dependencies: + "@babel/code-frame" "^7.12.13" + "@jest/types" "^27.5.1" + "@types/stack-utils" "^2.0.0" + chalk "^4.0.0" + graceful-fs "^4.2.9" + micromatch "^4.0.4" + pretty-format "^27.5.1" + slash "^3.0.0" + stack-utils "^2.0.3" + +jest-mock@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-mock/-/jest-mock-27.5.1.tgz#19948336d49ef4d9c52021d34ac7b5f36ff967d6" + integrity sha512-K4jKbY1d4ENhbrG2zuPWaQBvDly+iZ2yAW+T1fATN78hc0sInwn7wZB8XtlNnvHug5RMwV897Xm4LqmPM4e2Og== + dependencies: + "@jest/types" "^27.5.1" + "@types/node" "*" + +jest-pnp-resolver@^1.2.2: + version "1.2.2" + resolved "https://registry.npmjs.org/jest-pnp-resolver/-/jest-pnp-resolver-1.2.2.tgz#b704ac0ae028a89108a4d040b3f919dfddc8e33c" + integrity sha512-olV41bKSMm8BdnuMsewT4jqlZ8+3TCARAXjZGT9jcoSnrfUnRCqnMoF9XEeoWjbzObpqF9dRhHQj0Xb9QdF6/w== + +jest-regex-util@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-27.5.1.tgz#4da143f7e9fd1e542d4aa69617b38e4a78365b95" + integrity sha512-4bfKq2zie+x16okqDXjXn9ql2B0dScQu+vcwe4TvFVhkVyuWLqpZrZtXxLLWoXYgn0E87I6r6GRYHF7wFZBUvg== + +jest-resolve-dependencies@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-27.5.1.tgz#d811ecc8305e731cc86dd79741ee98fed06f1da8" + integrity sha512-QQOOdY4PE39iawDn5rzbIePNigfe5B9Z91GDD1ae/xNDlu9kaat8QQ5EKnNmVWPV54hUdxCVwwj6YMgR2O7IOg== + dependencies: + "@jest/types" "^27.5.1" + jest-regex-util "^27.5.1" + jest-snapshot "^27.5.1" + +jest-resolve@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-resolve/-/jest-resolve-27.5.1.tgz#a2f1c5a0796ec18fe9eb1536ac3814c23617b384" + integrity sha512-FFDy8/9E6CV83IMbDpcjOhumAQPDyETnU2KZ1O98DwTnz8AOBsW/Xv3GySr1mOZdItLR+zDZ7I/UdTFbgSOVCw== + dependencies: + "@jest/types" "^27.5.1" + chalk "^4.0.0" + graceful-fs "^4.2.9" + jest-haste-map "^27.5.1" + jest-pnp-resolver "^1.2.2" + jest-util "^27.5.1" + jest-validate "^27.5.1" + resolve "^1.20.0" + resolve.exports "^1.1.0" + slash "^3.0.0" + +jest-runner@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-runner/-/jest-runner-27.5.1.tgz#071b27c1fa30d90540805c5645a0ec167c7b62e5" + integrity sha512-g4NPsM4mFCOwFKXO4p/H/kWGdJp9V8kURY2lX8Me2drgXqG7rrZAx5kv+5H7wtt/cdFIjhqYx1HrlqWHaOvDaQ== + dependencies: + "@jest/console" "^27.5.1" + "@jest/environment" "^27.5.1" + "@jest/test-result" "^27.5.1" + "@jest/transform" "^27.5.1" + "@jest/types" "^27.5.1" + "@types/node" "*" + chalk "^4.0.0" + emittery "^0.8.1" + graceful-fs "^4.2.9" + jest-docblock "^27.5.1" + jest-environment-jsdom "^27.5.1" + jest-environment-node "^27.5.1" + jest-haste-map "^27.5.1" + jest-leak-detector "^27.5.1" + jest-message-util "^27.5.1" + jest-resolve "^27.5.1" + jest-runtime "^27.5.1" + jest-util "^27.5.1" + jest-worker "^27.5.1" + source-map-support "^0.5.6" + throat "^6.0.1" + +jest-runtime@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-runtime/-/jest-runtime-27.5.1.tgz#4896003d7a334f7e8e4a53ba93fb9bcd3db0a1af" + integrity sha512-o7gxw3Gf+H2IGt8fv0RiyE1+r83FJBRruoA+FXrlHw6xEyBsU8ugA6IPfTdVyA0w8HClpbK+DGJxH59UrNMx8A== + dependencies: + "@jest/environment" "^27.5.1" + "@jest/fake-timers" "^27.5.1" + "@jest/globals" "^27.5.1" + "@jest/source-map" "^27.5.1" + "@jest/test-result" "^27.5.1" + "@jest/transform" "^27.5.1" + "@jest/types" "^27.5.1" + chalk "^4.0.0" + cjs-module-lexer "^1.0.0" + collect-v8-coverage "^1.0.0" + execa "^5.0.0" + glob "^7.1.3" + graceful-fs "^4.2.9" + jest-haste-map "^27.5.1" + jest-message-util "^27.5.1" + jest-mock "^27.5.1" + jest-regex-util "^27.5.1" + jest-resolve "^27.5.1" + jest-snapshot "^27.5.1" + jest-util "^27.5.1" + slash "^3.0.0" + strip-bom "^4.0.0" + +jest-serializer@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-serializer/-/jest-serializer-27.5.1.tgz#81438410a30ea66fd57ff730835123dea1fb1f64" + integrity sha512-jZCyo6iIxO1aqUxpuBlwTDMkzOAJS4a3eYz3YzgxxVQFwLeSA7Jfq5cbqCY+JLvTDrWirgusI/0KwxKMgrdf7w== + dependencies: + "@types/node" "*" + graceful-fs "^4.2.9" + +jest-snapshot@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-27.5.1.tgz#b668d50d23d38054a51b42c4039cab59ae6eb6a1" + integrity sha512-yYykXI5a0I31xX67mgeLw1DZ0bJB+gpq5IpSuCAoyDi0+BhgU/RIrL+RTzDmkNTchvDFWKP8lp+w/42Z3us5sA== + dependencies: + "@babel/core" "^7.7.2" + "@babel/generator" "^7.7.2" + "@babel/plugin-syntax-typescript" "^7.7.2" + "@babel/traverse" "^7.7.2" + "@babel/types" "^7.0.0" + "@jest/transform" "^27.5.1" + "@jest/types" "^27.5.1" + "@types/babel__traverse" "^7.0.4" + "@types/prettier" "^2.1.5" + babel-preset-current-node-syntax "^1.0.0" + chalk "^4.0.0" + expect "^27.5.1" + graceful-fs "^4.2.9" + jest-diff "^27.5.1" + jest-get-type "^27.5.1" + jest-haste-map "^27.5.1" + jest-matcher-utils "^27.5.1" + jest-message-util "^27.5.1" + jest-util "^27.5.1" + natural-compare "^1.4.0" + pretty-format "^27.5.1" + semver "^7.3.2" + +jest-util@^27.0.0, jest-util@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-util/-/jest-util-27.5.1.tgz#3ba9771e8e31a0b85da48fe0b0891fb86c01c2f9" + integrity sha512-Kv2o/8jNvX1MQ0KGtw480E/w4fBCDOnH6+6DmeKi6LZUIlKA5kwY0YNdlzaWTiVgxqAqik11QyxDOKk543aKXw== + dependencies: + "@jest/types" "^27.5.1" + "@types/node" "*" + chalk "^4.0.0" + ci-info "^3.2.0" + graceful-fs "^4.2.9" + picomatch "^2.2.3" + +jest-validate@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-validate/-/jest-validate-27.5.1.tgz#9197d54dc0bdb52260b8db40b46ae668e04df067" + integrity sha512-thkNli0LYTmOI1tDB3FI1S1RTp/Bqyd9pTarJwL87OIBFuqEb5Apv5EaApEudYg4g86e3CT6kM0RowkhtEnCBQ== + dependencies: + "@jest/types" "^27.5.1" + camelcase "^6.2.0" + chalk "^4.0.0" + jest-get-type "^27.5.1" + leven "^3.1.0" + pretty-format "^27.5.1" + +jest-watcher@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-watcher/-/jest-watcher-27.5.1.tgz#71bd85fb9bde3a2c2ec4dc353437971c43c642a2" + integrity sha512-z676SuD6Z8o8qbmEGhoEUFOM1+jfEiL3DXHK/xgEiG2EyNYfFG60jluWcupY6dATjfEsKQuibReS1djInQnoVw== + dependencies: + "@jest/test-result" "^27.5.1" + "@jest/types" "^27.5.1" + "@types/node" "*" + ansi-escapes "^4.2.1" + chalk "^4.0.0" + jest-util "^27.5.1" + string-length "^4.0.1" + +jest-worker@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest-worker/-/jest-worker-27.5.1.tgz#8d146f0900e8973b106b6f73cc1e9a8cb86f8db0" + integrity sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg== + dependencies: + "@types/node" "*" + merge-stream "^2.0.0" + supports-color "^8.0.0" + +jest@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/jest/-/jest-27.5.1.tgz#dadf33ba70a779be7a6fc33015843b51494f63fc" + integrity sha512-Yn0mADZB89zTtjkPJEXwrac3LHudkQMR+Paqa8uxJHCBr9agxztUifWCyiYrjhMPBoUVBjyny0I7XH6ozDr7QQ== + dependencies: + "@jest/core" "^27.5.1" + import-local "^3.0.2" + jest-cli "^27.5.1" + +jju@^1.1.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/jju/-/jju-1.4.0.tgz#a3abe2718af241a2b2904f84a625970f389ae32a" + integrity sha1-o6vicYryQaKykE+EpiWXDzia4yo= + +js-tokens@^4.0.0: + version "4.0.0" + resolved "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" + integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== + +js-yaml@3.14.0: + version "3.14.0" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.14.0.tgz#a7a34170f26a21bb162424d8adacb4113a69e482" + integrity sha512-/4IbIeHcD9VMHFqDR/gQ7EdZdLimOvW2DdcxFjdyyZ9NsbS+ccrXqVWDtab/lRl5AlUqmpBx8EhPaWR+OtY17A== + dependencies: + argparse "^1.0.7" + esprima "^4.0.0" + +js-yaml@^3.13.1: + version "3.14.1" + resolved "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz#dae812fdb3825fa306609a8717383c50c36a0537" + integrity sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g== + dependencies: + argparse "^1.0.7" + esprima "^4.0.0" + +js-yaml@^4.0.0, js-yaml@^4.1.0: + version "4.1.0" + resolved "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz#c1fb65f8f5017901cdd2c951864ba18458a10602" + integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA== + dependencies: + argparse "^2.0.1" + +jsdom@^16.6.0: + version "16.7.0" + resolved "https://registry.npmjs.org/jsdom/-/jsdom-16.7.0.tgz#918ae71965424b197c819f8183a754e18977b710" + integrity sha512-u9Smc2G1USStM+s/x1ru5Sxrl6mPYCbByG1U/hUmqaVsm4tbNyS7CicOSRyuGQYZhTu0h84qkZZQ/I+dzizSVw== + dependencies: + abab "^2.0.5" + acorn "^8.2.4" + acorn-globals "^6.0.0" + cssom "^0.4.4" + cssstyle "^2.3.0" + data-urls "^2.0.0" + decimal.js "^10.2.1" + domexception "^2.0.1" + escodegen "^2.0.0" + form-data "^3.0.0" + html-encoding-sniffer "^2.0.1" + http-proxy-agent "^4.0.1" + https-proxy-agent "^5.0.0" + is-potential-custom-element-name "^1.0.1" + nwsapi "^2.2.0" + parse5 "6.0.1" + saxes "^5.0.1" + symbol-tree "^3.2.4" + tough-cookie "^4.0.0" + w3c-hr-time "^1.0.2" + w3c-xmlserializer "^2.0.0" + webidl-conversions "^6.1.0" + whatwg-encoding "^1.0.5" + whatwg-mimetype "^2.3.0" + whatwg-url "^8.5.0" + ws "^7.4.6" + xml-name-validator "^3.0.0" + +jsesc@^2.5.1: + version "2.5.2" + resolved "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz#80564d2e483dacf6e8ef209650a67df3f0c283a4" + integrity sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA== + +jsii-diff@^1.55.1: + version "1.55.1" + resolved "https://registry.npmjs.org/jsii-diff/-/jsii-diff-1.55.1.tgz#d2a2f8558f14ca19a6a1786fc3cf25e9564fd0e0" + integrity sha512-yjAJz+DYQA3Dc+/33PBcI+EKa3U6cTrxSokVzA3J1J8ExUwQ9BaDHaW/LnLitKaM7oh2I1Rxi8ETlL1IXZMang== + dependencies: + "@jsii/check-node" "1.55.1" + "@jsii/spec" "^1.55.1" + fs-extra "^9.1.0" + jsii-reflect "^1.55.1" + log4js "^6.4.2" + typescript "~3.9.10" + yargs "^16.2.0" + +jsii-docgen@^6.2.4: + version "6.2.4" + resolved "https://registry.npmjs.org/jsii-docgen/-/jsii-docgen-6.2.4.tgz#ec06686c9df4f83f03c24a451f253e700fd2635f" + integrity sha512-MAmtX1O0FECCYve8supWyjuy8JZ7iy4BAdV1cd4FwYj8vYABYGr4t01aT6QJGzu1YHl77CYhXHYeR8fnn68xFw== + dependencies: + "@jsii/spec" "^1.55.1" + case "^1.6.3" + fs-extra "^10.0.1" + glob "^7.2.0" + glob-promise "^3.4.0" + jsii-reflect "^1.55.1" + jsii-rosetta "^1.55.1" + semver "^7.3.5" + yargs "^16.2.0" + +jsii-pacmak@^1.55.1: + version "1.55.1" + resolved "https://registry.npmjs.org/jsii-pacmak/-/jsii-pacmak-1.55.1.tgz#9259a653b65ac570a10f86358b4a7b10e5b7856c" + integrity sha512-E208pgMfxbPbXgmcskDG0/hBbkPLGlU7S79VoXESy1Kegf7TnZjLqpBdJ3mNxIroS5gIC8DToArMHUFAQ6z0lA== + dependencies: + "@jsii/check-node" "1.55.1" + "@jsii/spec" "^1.55.1" + clone "^2.1.2" + codemaker "^1.55.1" + commonmark "^0.30.0" + escape-string-regexp "^4.0.0" + fs-extra "^9.1.0" + jsii-reflect "^1.55.1" + jsii-rosetta "^1.55.1" + semver "^7.3.5" + spdx-license-list "^6.4.0" + xmlbuilder "^15.1.1" + yargs "^16.2.0" + +jsii-reflect@^1.55.1: + version "1.55.1" + resolved "https://registry.npmjs.org/jsii-reflect/-/jsii-reflect-1.55.1.tgz#b192d4f1121f1a142581614fd68e26f25abe2dc9" + integrity sha512-/Ak+sCuIjJaRCflCWT2UKPdT88EQhbPYLhtF7F42uuUr2tchlNkybNE15bigZbtqLw7SP1fp/6Dedujvf90N9Q== + dependencies: + "@jsii/check-node" "1.55.1" + "@jsii/spec" "^1.55.1" + chalk "^4" + fs-extra "^9.1.0" + oo-ascii-tree "^1.55.1" + yargs "^16.2.0" + +jsii-rosetta@^1.55.1: + version "1.55.1" + resolved "https://registry.npmjs.org/jsii-rosetta/-/jsii-rosetta-1.55.1.tgz#30b44111d146534c42c8fef77931d3fdb888de7d" + integrity sha512-ZUzuO2JgnxE01tgIdZorsUZj5jiHP8uxeLDU/vsnmnAU2ZbMHFDT1cWacoAKESDnCyFF8VRCuPXHx8e5/SOXig== + dependencies: + "@jsii/check-node" "1.55.1" + "@jsii/spec" "1.55.1" + "@xmldom/xmldom" "^0.8.1" + commonmark "^0.30.0" + fast-glob "^3.2.11" + fs-extra "^9.1.0" + jsii "1.55.1" + semver "^7.3.5" + semver-intersect "^1.4.0" + sort-json "^2.0.1" + typescript "~3.9.10" + workerpool "^6.2.0" + yargs "^16.2.0" + +jsii@1.55.1, jsii@^1.55.1: + version "1.55.1" + resolved "https://registry.npmjs.org/jsii/-/jsii-1.55.1.tgz#e4018b4d5017b57857c608d2acb850f07a5f94a3" + integrity sha512-9L6BztDV8PwNY5C+vwuLRJTzijh5Kyh3eijaz8NS11Jc7rTeTN8AvLxyWsIaPO+ITTP4JTsDKOU3tBaoWabRzA== + dependencies: + "@jsii/check-node" "1.55.1" + "@jsii/spec" "^1.55.1" + case "^1.6.3" + chalk "^4" + deep-equal "^2.0.5" + fs-extra "^9.1.0" + log4js "^6.4.2" + semver "^7.3.5" + semver-intersect "^1.4.0" + sort-json "^2.0.1" + spdx-license-list "^6.4.0" + typescript "~3.9.10" + yargs "^16.2.0" + +json-buffer@3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/json-buffer/-/json-buffer-3.0.0.tgz#5b1f397afc75d677bde8bcfc0e47e1f9a3d9a898" + integrity sha1-Wx85evx11ne96Lz8Dkfh+aPZqJg= + +json-parse-better-errors@^1.0.1: + version "1.0.2" + resolved "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz#bb867cfb3450e69107c131d1c514bab3dc8bcaa9" + integrity sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw== + +json-parse-even-better-errors@^2.3.0, json-parse-even-better-errors@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz#7c47805a94319928e05777405dc12e1f7a4ee02d" + integrity sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w== + +json-parse-helpfulerror@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/json-parse-helpfulerror/-/json-parse-helpfulerror-1.0.3.tgz#13f14ce02eed4e981297b64eb9e3b932e2dd13dc" + integrity sha1-E/FM4C7tTpgSl7ZOueO5MuLdE9w= + dependencies: + jju "^1.1.0" + +json-schema-traverse@^0.4.1: + version "0.4.1" + resolved "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz#69f6a87d9513ab8bb8fe63bdb0979c448e684660" + integrity sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg== + +json-schema@^0.4.0: + version "0.4.0" + resolved "https://registry.npmjs.org/json-schema/-/json-schema-0.4.0.tgz#f7de4cf6efab838ebaeb3236474cbba5a1930ab5" + integrity sha512-es94M3nTIfsEPisRafak+HDLfHXnKBhV3vU5eqPcS3flIWqcxJWgXHXiey3YrpaNsanY5ei1VoYEbOzijuq9BA== + +json-stable-stringify-without-jsonify@^1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz#9db7b59496ad3f3cfef30a75142d2d930ad72651" + integrity sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE= + +json-stringify-safe@^5.0.1: + version "5.0.1" + resolved "https://registry.npmjs.org/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz#1296a2d58fd45f19a0f6ce01d65701e2c735b6eb" + integrity sha1-Epai1Y/UXxmg9s4B1lcB4sc1tus= + +json5@2.x, json5@^2.1.2: + version "2.2.1" + resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.1.tgz#655d50ed1e6f95ad1a3caababd2b0efda10b395c" + integrity sha512-1hqLFMSrGHRHxav9q9gNjJ5EXznIxGVO09xQRrwplcS8qs28pZ8s8hupZAmqDwZUmVZ2Qb2jnyPOWcDH8m8dlA== + +json5@^1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/json5/-/json5-1.0.1.tgz#779fb0018604fa854eacbf6252180d83543e3dbe" + integrity sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow== + dependencies: + minimist "^1.2.0" + +jsonfile@^6.0.1: + version "6.1.0" + resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.1.0.tgz#bc55b2634793c679ec6403094eb13698a6ec0aae" + integrity sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ== + dependencies: + universalify "^2.0.0" + optionalDependencies: + graceful-fs "^4.1.6" + +jsonlines@^0.1.1: + version "0.1.1" + resolved "https://registry.yarnpkg.com/jsonlines/-/jsonlines-0.1.1.tgz#4fcd246dc5d0e38691907c44ab002f782d1d94cc" + integrity sha1-T80kbcXQ44aRkHxEqwAveC0dlMw= + +jsonparse@^1.2.0, jsonparse@^1.3.1: + version "1.3.1" + resolved "https://registry.npmjs.org/jsonparse/-/jsonparse-1.3.1.tgz#3f4dae4a91fac315f71062f8521cc239f1366280" + integrity sha1-P02uSpH6wxX3EGL4UhzCOfE2YoA= + +jsonschema@^1.4.0: + version "1.4.0" + resolved "https://registry.npmjs.org/jsonschema/-/jsonschema-1.4.0.tgz#1afa34c4bc22190d8e42271ec17ac8b3404f87b2" + integrity sha512-/YgW6pRMr6M7C+4o8kS+B/2myEpHCrxO4PEWnqJNBFMjn7EWXqlQ4tGwL6xTHeRplwuZmcAncdvfOad1nT2yMw== + +keyv@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/keyv/-/keyv-3.1.0.tgz#ecc228486f69991e49e9476485a5be1e8fc5c4d9" + integrity sha512-9ykJ/46SN/9KPM/sichzQ7OvXyGDYKGTaDlKMGCAlg2UK8KRy4jb0d8sFc+0Tt0YYnThq8X2RZgCg74RPxgcVA== + dependencies: + json-buffer "3.0.0" + +kind-of@^6.0.3: + version "6.0.3" + resolved "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz#07c05034a6c349fa06e24fa35aa76db4580ce4dd" + integrity sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw== + +kleur@^3.0.3: + version "3.0.3" + resolved "https://registry.yarnpkg.com/kleur/-/kleur-3.0.3.tgz#a79c9ecc86ee1ce3fa6206d1216c501f147fc07e" + integrity sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w== + +latest-version@^5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/latest-version/-/latest-version-5.1.0.tgz#119dfe908fe38d15dfa43ecd13fa12ec8832face" + integrity sha512-weT+r0kTkRQdCdYCNtkMwWXQTMEswKrFBkm4ckQOMVhhqhIMI1UT2hMj+1iigIhgSZm5gTmrRXBNoGUgaTY1xA== + dependencies: + package-json "^6.3.0" + +leven@^3.1.0: + version "3.1.0" + resolved "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz#77891de834064cccba82ae7842bb6b14a13ed7f2" + integrity sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A== + +levn@^0.4.1: + version "0.4.1" + resolved "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz#ae4562c007473b932a6200d403268dd2fffc6ade" + integrity sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ== + dependencies: + prelude-ls "^1.2.1" + type-check "~0.4.0" + +levn@~0.3.0: + version "0.3.0" + resolved "https://registry.npmjs.org/levn/-/levn-0.3.0.tgz#3b09924edf9f083c0490fdd4c0bc4421e04764ee" + integrity sha1-OwmSTt+fCDwEkP3UwLxEIeBHZO4= + dependencies: + prelude-ls "~1.1.2" + type-check "~0.3.2" + +libnpmconfig@^1.2.1: + version "1.2.1" + resolved "https://registry.yarnpkg.com/libnpmconfig/-/libnpmconfig-1.2.1.tgz#c0c2f793a74e67d4825e5039e7a02a0044dfcbc0" + integrity sha512-9esX8rTQAHqarx6qeZqmGQKBNZR5OIbl/Ayr0qQDy3oXja2iFVQQI81R6GZ2a02bSNZ9p3YOGX1O6HHCb1X7kA== + dependencies: + figgy-pudding "^3.5.1" + find-up "^3.0.0" + ini "^1.3.5" + +lines-and-columns@^1.1.6: + version "1.2.4" + resolved "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz#eca284f75d2965079309dc0ad9255abb2ebc1632" + integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg== + +load-json-file@^4.0.0: + version "4.0.0" + resolved "https://registry.npmjs.org/load-json-file/-/load-json-file-4.0.0.tgz#2f5f45ab91e33216234fd53adab668eb4ec0993b" + integrity sha1-L19Fq5HjMhYjT9U62rZo607AmTs= + dependencies: + graceful-fs "^4.1.2" + parse-json "^4.0.0" + pify "^3.0.0" + strip-bom "^3.0.0" + +locate-path@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz#2b568b265eec944c6d9c0de9c3dbbbca0354cd8e" + integrity sha1-K1aLJl7slExtnA3pw9u7ygNUzY4= + dependencies: + p-locate "^2.0.0" + path-exists "^3.0.0" + +locate-path@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-3.0.0.tgz#dbec3b3ab759758071b58fe59fc41871af21400e" + integrity sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A== + dependencies: + p-locate "^3.0.0" + path-exists "^3.0.0" + +locate-path@^5.0.0: + version "5.0.0" + resolved "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz#1afba396afd676a6d42504d0a67a3a7eb9f62aa0" + integrity sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g== + dependencies: + p-locate "^4.1.0" + +locate-path@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-6.0.0.tgz#55321eb309febbc59c4801d931a72452a681d286" + integrity sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw== + dependencies: + p-locate "^5.0.0" + +lodash.ismatch@^4.4.0: + version "4.4.0" + resolved "https://registry.npmjs.org/lodash.ismatch/-/lodash.ismatch-4.4.0.tgz#756cb5150ca3ba6f11085a78849645f188f85f37" + integrity sha1-dWy1FQyjum8RCFp4hJZF8Yj4Xzc= + +lodash.memoize@4.x: + version "4.1.2" + resolved "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe" + integrity sha1-vMbEmkKihA7Zl/Mj6tpezRguC/4= + +lodash.merge@^4.6.2: + version "4.6.2" + resolved "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz#558aa53b43b661e1925a0afdfa36a9a1085fe57a" + integrity sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ== + +lodash@^4.17.15, lodash@^4.17.21, lodash@^4.7.0: + version "4.17.21" + resolved "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz#679591c564c3bffaae8454cf0b3df370c3d6911c" + integrity sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg== + +log4js@^6.4.2: + version "6.4.4" + resolved "https://registry.npmjs.org/log4js/-/log4js-6.4.4.tgz#c9bc75569f3f40bba22fe1bd0677afa7a6a13bac" + integrity sha512-ncaWPsuw9Vl1CKA406hVnJLGQKy1OHx6buk8J4rE2lVW+NW5Y82G5/DIloO7NkqLOUtNPEANaWC1kZYVjXssPw== + dependencies: + date-format "^4.0.6" + debug "^4.3.4" + flatted "^3.2.5" + rfdc "^1.3.0" + streamroller "^3.0.6" + +lowercase-keys@^1.0.0, lowercase-keys@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/lowercase-keys/-/lowercase-keys-1.0.1.tgz#6f9e30b47084d971a7c820ff15a6c5167b74c26f" + integrity sha512-G2Lj61tXDnVFFOi8VZds+SoQjtQC3dgokKdDG2mTm1tx4m50NUHBOZSBwQQHyy0V12A0JTG4icfZQH+xPyh8VA== + +lowercase-keys@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/lowercase-keys/-/lowercase-keys-2.0.0.tgz#2603e78b7b4b0006cbca2fbcc8a3202558ac9479" + integrity sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA== + +lru-cache@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-6.0.0.tgz#6d6fe6570ebd96aaf90fcad1dafa3b2566db3a94" + integrity sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA== + dependencies: + yallist "^4.0.0" + +lru-cache@^7.3.1, lru-cache@^7.5.1, lru-cache@^7.7.1: + version "7.7.1" + resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-7.7.1.tgz#03d2846b1ad2dcc7931a9340b8711d9798fcb0c6" + integrity sha512-cRffBiTW8s73eH4aTXqBcTLU0xQnwGV3/imttRHGWCrbergmnK4D6JXQd8qin5z43HnDwRI+o7mVW0LEB+tpAw== + +make-dir@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/make-dir/-/make-dir-3.1.0.tgz#415e967046b3a7f1d185277d84aa58203726a13f" + integrity sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw== + dependencies: + semver "^6.0.0" + +make-error@1.x: + version "1.3.6" + resolved "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz#2eb2e37ea9b67c4891f684a1394799af484cf7a2" + integrity sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw== + +make-fetch-happen@^10.0.3, make-fetch-happen@^10.0.6: + version "10.1.0" + resolved "https://registry.yarnpkg.com/make-fetch-happen/-/make-fetch-happen-10.1.0.tgz#7232ef7002a635c04d4deac325df144f21871408" + integrity sha512-HeP4QlkadP/Op+hE+Une1070kcyN85FshQObku3/rmzRh4zDcKXA19d2L3AQR6UoaX3uZmhSOpTLH15b1vOFvQ== + dependencies: + agentkeepalive "^4.2.1" + cacache "^16.0.2" + http-cache-semantics "^4.1.0" + http-proxy-agent "^5.0.0" + https-proxy-agent "^5.0.0" + is-lambda "^1.0.1" + lru-cache "^7.7.1" + minipass "^3.1.6" + minipass-collect "^1.0.2" + minipass-fetch "^2.0.3" + minipass-flush "^1.0.5" + minipass-pipeline "^1.2.4" + negotiator "^0.6.3" + promise-retry "^2.0.1" + socks-proxy-agent "^6.1.1" + ssri "^8.0.1" + +makeerror@1.0.12: + version "1.0.12" + resolved "https://registry.npmjs.org/makeerror/-/makeerror-1.0.12.tgz#3e5dd2079a82e812e983cc6610c4a2cb0eaa801a" + integrity sha512-JmqCvUhmt43madlpFzG4BQzG2Z3m6tvQDNKdClZnO3VbIudJYmxsT0FNJMeiB2+JTSlTQTSbU8QdesVmwJcmLg== + dependencies: + tmpl "1.0.5" + +map-obj@^1.0.0: + version "1.0.1" + resolved "https://registry.npmjs.org/map-obj/-/map-obj-1.0.1.tgz#d933ceb9205d82bdcf4886f6742bdc2b4dea146d" + integrity sha1-2TPOuSBdgr3PSIb2dCvcK03qFG0= + +map-obj@^4.0.0: + version "4.3.0" + resolved "https://registry.npmjs.org/map-obj/-/map-obj-4.3.0.tgz#9304f906e93faae70880da102a9f1df0ea8bb05a" + integrity sha512-hdN1wVrZbb29eBGiGjJbeP8JbKjq1urkHJ/LIP/NY48MZ1QVXUsQBV1G1zvYFHn1XE06cwjBsOI2K3Ulnj1YXQ== + +mdurl@~1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz#fe85b2ec75a59037f2adfec100fd6c601761152e" + integrity sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4= + +meow@^8.0.0: + version "8.1.2" + resolved "https://registry.npmjs.org/meow/-/meow-8.1.2.tgz#bcbe45bda0ee1729d350c03cffc8395a36c4e897" + integrity sha512-r85E3NdZ+mpYk1C6RjPFEMSE+s1iZMuHtsHAqY0DT3jZczl0diWUZ8g6oU7h0M9cD2EL+PzaYghhCLzR0ZNn5Q== + dependencies: + "@types/minimist" "^1.2.0" + camelcase-keys "^6.2.2" + decamelize-keys "^1.1.0" + hard-rejection "^2.1.0" + minimist-options "4.1.0" + normalize-package-data "^3.0.0" + read-pkg-up "^7.0.1" + redent "^3.0.0" + trim-newlines "^3.0.0" + type-fest "^0.18.0" + yargs-parser "^20.2.3" + +merge-stream@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz#52823629a14dd00c9770fb6ad47dc6310f2c1f60" + integrity sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w== + +merge2@^1.3.0, merge2@^1.4.1: + version "1.4.1" + resolved "https://registry.yarnpkg.com/merge2/-/merge2-1.4.1.tgz#4368892f885e907455a6fd7dc55c0c9d404990ae" + integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg== + +micromatch@^4.0.4: + version "4.0.5" + resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.5.tgz#bc8999a7cbbf77cdc89f132f6e467051b49090c6" + integrity sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA== + dependencies: + braces "^3.0.2" + picomatch "^2.3.1" + +mime-db@1.52.0: + version "1.52.0" + resolved "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz#bbabcdc02859f4987301c856e3387ce5ec43bf70" + integrity sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg== + +mime-types@^2.1.12: + version "2.1.35" + resolved "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz#381a871b62a734450660ae3deee44813f70d959a" + integrity sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw== + dependencies: + mime-db "1.52.0" + +mimic-fn@^2.1.0: + version "2.1.0" + resolved "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz#7ed2c2ccccaf84d3ffcb7a69b57711fc2083401b" + integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg== + +mimic-response@^1.0.0, mimic-response@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/mimic-response/-/mimic-response-1.0.1.tgz#4923538878eef42063cb8a3e3b0798781487ab1b" + integrity sha512-j5EctnkH7amfV/q5Hgmoal1g2QHFJRraOtmx0JpIqkxhBhI/lJSl1nMpQ45hVarwNETOoWEimndZ4QK0RHxuxQ== + +min-indent@^1.0.0: + version "1.0.1" + resolved "https://registry.npmjs.org/min-indent/-/min-indent-1.0.1.tgz#a63f681673b30571fbe8bc25686ae746eefa9869" + integrity sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg== + +minimatch@^3.0.4: + version "3.1.2" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b" + integrity sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw== + dependencies: + brace-expansion "^1.1.7" + +minimatch@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-5.0.1.tgz#fb9022f7528125187c92bd9e9b6366be1cf3415b" + integrity sha512-nLDxIFRyhDblz3qMuq+SoRZED4+miJ/G+tdDrjkkkRnjAsBexeGpgjLEQ0blJy7rHhR2b93rhQY4SvyWu9v03g== + dependencies: + brace-expansion "^2.0.1" + +minimist-options@4.1.0: + version "4.1.0" + resolved "https://registry.npmjs.org/minimist-options/-/minimist-options-4.1.0.tgz#c0655713c53a8a2ebd77ffa247d342c40f010619" + integrity sha512-Q4r8ghd80yhO/0j1O3B2BjweX3fiHg9cdOwjJd2J76Q135c+NDxGCqdYKQ1SKBuFfgWbAUzBfvYjPUEeNgqN1A== + dependencies: + arrify "^1.0.1" + is-plain-obj "^1.1.0" + kind-of "^6.0.3" + +minimist@>=1.2.2, minimist@^1.2.0, minimist@^1.2.3, minimist@^1.2.5, minimist@^1.2.6: + version "1.2.6" + resolved "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz#8637a5b759ea0d6e98702cfb3a9283323c93af44" + integrity sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q== + +minipass-collect@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/minipass-collect/-/minipass-collect-1.0.2.tgz#22b813bf745dc6edba2576b940022ad6edc8c617" + integrity sha512-6T6lH0H8OG9kITm/Jm6tdooIbogG9e0tLgpY6mphXSm/A9u8Nq1ryBG+Qspiub9LjWlBPsPS3tWQ/Botq4FdxA== + dependencies: + minipass "^3.0.0" + +minipass-fetch@^2.0.3: + version "2.1.0" + resolved "https://registry.yarnpkg.com/minipass-fetch/-/minipass-fetch-2.1.0.tgz#ca1754a5f857a3be99a9271277246ac0b44c3ff8" + integrity sha512-H9U4UVBGXEyyWJnqYDCLp1PwD8XIkJ4akNHp1aGVI+2Ym7wQMlxDKi4IB4JbmyU+pl9pEs/cVrK6cOuvmbK4Sg== + dependencies: + minipass "^3.1.6" + minipass-sized "^1.0.3" + minizlib "^2.1.2" + optionalDependencies: + encoding "^0.1.13" + +minipass-flush@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/minipass-flush/-/minipass-flush-1.0.5.tgz#82e7135d7e89a50ffe64610a787953c4c4cbb373" + integrity sha512-JmQSYYpPUqX5Jyn1mXaRwOda1uQ8HP5KAT/oDSLCzt1BYRhQU0/hDtsB1ufZfEEzMZ9aAVmsBw8+FWsIXlClWw== + dependencies: + minipass "^3.0.0" + +minipass-json-stream@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/minipass-json-stream/-/minipass-json-stream-1.0.1.tgz#7edbb92588fbfc2ff1db2fc10397acb7b6b44aa7" + integrity sha512-ODqY18UZt/I8k+b7rl2AENgbWE8IDYam+undIJONvigAz8KR5GWblsFTEfQs0WODsjbSXWlm+JHEv8Gr6Tfdbg== + dependencies: + jsonparse "^1.3.1" + minipass "^3.0.0" + +minipass-pipeline@^1.2.4: + version "1.2.4" + resolved "https://registry.yarnpkg.com/minipass-pipeline/-/minipass-pipeline-1.2.4.tgz#68472f79711c084657c067c5c6ad93cddea8214c" + integrity sha512-xuIq7cIOt09RPRJ19gdi4b+RiNvDFYe5JH+ggNvBqGqpQXcru3PcRmOZuHBKWK1Txf9+cQ+HMVN4d6z46LZP7A== + dependencies: + minipass "^3.0.0" + +minipass-sized@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/minipass-sized/-/minipass-sized-1.0.3.tgz#70ee5a7c5052070afacfbc22977ea79def353b70" + integrity sha512-MbkQQ2CTiBMlA2Dm/5cY+9SWFEN8pzzOXi6rlM5Xxq0Yqbda5ZQy9sU75a673FE9ZK0Zsbr6Y5iP6u9nktfg2g== + dependencies: + minipass "^3.0.0" + +minipass@^3.0.0, minipass@^3.1.1, minipass@^3.1.6: + version "3.1.6" + resolved "https://registry.yarnpkg.com/minipass/-/minipass-3.1.6.tgz#3b8150aa688a711a1521af5e8779c1d3bb4f45ee" + integrity sha512-rty5kpw9/z8SX9dmxblFA6edItUmwJgMeYDZRrwlIVN27i8gysGbznJwUggw2V/FVqFSDdWy040ZPS811DYAqQ== + dependencies: + yallist "^4.0.0" + +minizlib@^2.1.1, minizlib@^2.1.2: + version "2.1.2" + resolved "https://registry.yarnpkg.com/minizlib/-/minizlib-2.1.2.tgz#e90d3466ba209b932451508a11ce3d3632145931" + integrity sha512-bAxsR8BVfj60DWXHE3u30oHzfl4G7khkSuPW+qvpd7jFRHm7dLxOjUk1EHACJ/hxLY8phGJ0YhYHZo7jil7Qdg== + dependencies: + minipass "^3.0.0" + yallist "^4.0.0" + +mkdirp@^1.0.3, mkdirp@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-1.0.4.tgz#3eb5ed62622756d79a5f0e2a221dfebad75c2f7e" + integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw== + +modify-values@^1.0.0: + version "1.0.1" + resolved "https://registry.npmjs.org/modify-values/-/modify-values-1.0.1.tgz#b3939fa605546474e3e3e3c63d64bd43b4ee6022" + integrity sha512-xV2bxeN6F7oYjZWTe/YPAy6MN2M+sL4u/Rlm2AHCIVGfo2p1yGmBHQ6vHehl4bRTZBdHu3TSkWdYgkwpYzAGSw== + +ms@2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8" + integrity sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g= + +ms@2.1.2: + version "2.1.2" + resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009" + integrity sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w== + +ms@^2.0.0, ms@^2.1.1: + version "2.1.3" + resolved "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz#574c8138ce1d2b5861f0b44579dbadd60c6615b2" + integrity sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA== + +natural-compare@^1.4.0: + version "1.4.0" + resolved "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz#4abebfeed7541f2c27acfb29bdbbd15c8d5ba4f7" + integrity sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc= + +negotiator@^0.6.3: + version "0.6.3" + resolved "https://registry.yarnpkg.com/negotiator/-/negotiator-0.6.3.tgz#58e323a72fedc0d6f9cd4d31fe49f51479590ccd" + integrity sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg== + +neo-async@^2.6.0: + version "2.6.2" + resolved "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz#b4aafb93e3aeb2d8174ca53cf163ab7d7308305f" + integrity sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw== + +node-gyp@^9.0.0: + version "9.0.0" + resolved "https://registry.yarnpkg.com/node-gyp/-/node-gyp-9.0.0.tgz#e1da2067427f3eb5bb56820cb62bc6b1e4bd2089" + integrity sha512-Ma6p4s+XCTPxCuAMrOA/IJRmVy16R8Sdhtwl4PrCr7IBlj4cPawF0vg/l7nOT1jPbuNS7lIRJpBSvVsXwEZuzw== + dependencies: + env-paths "^2.2.0" + glob "^7.1.4" + graceful-fs "^4.2.6" + make-fetch-happen "^10.0.3" + nopt "^5.0.0" + npmlog "^6.0.0" + rimraf "^3.0.2" + semver "^7.3.5" + tar "^6.1.2" + which "^2.0.2" + +node-int64@^0.4.0: + version "0.4.0" + resolved "https://registry.npmjs.org/node-int64/-/node-int64-0.4.0.tgz#87a9065cdb355d3182d8f94ce11188b825c68a3b" + integrity sha1-h6kGXNs1XTGC2PlM4RGIuCXGijs= + +node-releases@^2.0.2: + version "2.0.2" + resolved "https://registry.npmjs.org/node-releases/-/node-releases-2.0.2.tgz#7139fe71e2f4f11b47d4d2986aaf8c48699e0c01" + integrity sha512-XxYDdcQ6eKqp/YjI+tb2C5WM2LgjnZrfYg4vgQt49EK268b6gYCHsBLrK2qvJo4FmCtqmKezb0WZFK4fkrZNsg== + +nopt@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/nopt/-/nopt-5.0.0.tgz#530942bb58a512fccafe53fe210f13a25355dc88" + integrity sha512-Tbj67rffqceeLpcRXrT7vKAN8CwfPeIBgM7E6iBkmKLV7bEMwpGgYLGv0jACUsECaa/vuxP0IjEont6umdMgtQ== + dependencies: + abbrev "1" + +normalize-package-data@^2.3.2, normalize-package-data@^2.5.0: + version "2.5.0" + resolved "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-2.5.0.tgz#e66db1838b200c1dfc233225d12cb36520e234a8" + integrity sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA== + dependencies: + hosted-git-info "^2.1.4" + resolve "^1.10.0" + semver "2 || 3 || 4 || 5" + validate-npm-package-license "^3.0.1" + +normalize-package-data@^3.0.0: + version "3.0.3" + resolved "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-3.0.3.tgz#dbcc3e2da59509a0983422884cd172eefdfa525e" + integrity sha512-p2W1sgqij3zMMyRC067Dg16bfzVH+w7hyegmpIvZ4JNjqtGOVAIvLmjBx3yP7YTe9vKJgkoNOPjwQGogDoMXFA== + dependencies: + hosted-git-info "^4.0.1" + is-core-module "^2.5.0" + semver "^7.3.4" + validate-npm-package-license "^3.0.1" + +normalize-package-data@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/normalize-package-data/-/normalize-package-data-4.0.0.tgz#1122d5359af21d4cd08718b92b058a658594177c" + integrity sha512-m+GL22VXJKkKbw62ZaBBjv8u6IE3UI4Mh5QakIqs3fWiKe0Xyi6L97hakwZK41/LD4R/2ly71Bayx0NLMwLA/g== + dependencies: + hosted-git-info "^5.0.0" + is-core-module "^2.8.1" + semver "^7.3.5" + validate-npm-package-license "^3.0.4" + +normalize-path@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz#0dcd69ff23a1c9b11fd0978316644a0388216a65" + integrity sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA== + +normalize-url@^4.1.0: + version "4.5.1" + resolved "https://registry.yarnpkg.com/normalize-url/-/normalize-url-4.5.1.tgz#0dd90cf1288ee1d1313b87081c9a5932ee48518a" + integrity sha512-9UZCFRHQdNrfTpGg8+1INIg93B6zE0aXMVFkw1WFwvO4SlZywU6aLg5Of0Ap/PgcbSw4LNxvMWXMeugwMCX0AA== + +npm-bundled@^1.1.1, npm-bundled@^1.1.2: + version "1.1.2" + resolved "https://registry.yarnpkg.com/npm-bundled/-/npm-bundled-1.1.2.tgz#944c78789bd739035b70baa2ca5cc32b8d860bc1" + integrity sha512-x5DHup0SuyQcmL3s7Rx/YQ8sbw/Hzg0rj48eN0dV7hf5cmQq5PXIeioroH3raV1QC1yh3uTYuMThvEQF3iKgGQ== + dependencies: + npm-normalize-package-bin "^1.0.1" + +npm-check-updates@^12: + version "12.5.4" + resolved "https://registry.yarnpkg.com/npm-check-updates/-/npm-check-updates-12.5.4.tgz#c783b9ec6e27508a91c97d343f7714f1b5e43ec4" + integrity sha512-4+27zaTdieWgvPLaCZ/A6Q2WC1cYVcrc2SqVmLFYgkWBrKw1QkwpeV16FSvkFGZr3OdFyr7Dpjw8JRn4H2QxFw== + dependencies: + chalk "^4.1.2" + cint "^8.2.1" + cli-table "^0.3.11" + commander "^9.0.0" + fast-memoize "^2.5.2" + find-up "5.0.0" + fp-and-or "^0.1.3" + get-stdin "^8.0.0" + globby "^11.0.4" + hosted-git-info "^4.1.0" + json-parse-helpfulerror "^1.0.3" + jsonlines "^0.1.1" + libnpmconfig "^1.2.1" + lodash "^4.17.21" + minimatch "^5.0.1" + p-map "^4.0.0" + pacote "^13.0.3" + parse-github-url "^1.0.2" + progress "^2.0.3" + prompts "^2.4.2" + rc-config-loader "^4.0.0" + remote-git-tags "^3.0.0" + rimraf "^3.0.2" + semver "^7.3.5" + semver-utils "^1.1.4" + source-map-support "^0.5.21" + spawn-please "^1.0.0" + update-notifier "^5.1.0" + yaml "^1.10.2" + +npm-install-checks@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/npm-install-checks/-/npm-install-checks-4.0.0.tgz#a37facc763a2fde0497ef2c6d0ac7c3fbe00d7b4" + integrity sha512-09OmyDkNLYwqKPOnbI8exiOZU2GVVmQp7tgez2BPi5OZC8M82elDAps7sxC4l//uSUtotWqoEIDwjRvWH4qz8w== + dependencies: + semver "^7.1.1" + +npm-normalize-package-bin@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/npm-normalize-package-bin/-/npm-normalize-package-bin-1.0.1.tgz#6e79a41f23fd235c0623218228da7d9c23b8f6e2" + integrity sha512-EPfafl6JL5/rU+ot6P3gRSCpPDW5VmIzX959Ob1+ySFUuuYHWHekXpwdUZcKP5C+DS4GEtdJluwBjnsNDl+fSA== + +npm-package-arg@^9.0.0, npm-package-arg@^9.0.1: + version "9.0.1" + resolved "https://registry.yarnpkg.com/npm-package-arg/-/npm-package-arg-9.0.1.tgz#db9c6379c45d79db88ee6dd40d3ec6a9d9a4d13a" + integrity sha512-Xs9wznfEAmZAR61qsYH3iN24V/qMYYkvAR5CRQNMvC6PjN2fHtO8y9XP/xdp5K+Icx+u1wMBMgWRPCmAEChSog== + dependencies: + hosted-git-info "^5.0.0" + semver "^7.3.5" + validate-npm-package-name "^3.0.0" + +npm-packlist@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/npm-packlist/-/npm-packlist-4.0.0.tgz#ba54713f8ee2ad919a6dc9f1b9ec7aa291466703" + integrity sha512-gL6XC/iw9YSmqArmZOGSkyy+yIZf2f7uH0p4Vmxef/irn73vd9/rDkCtvm+a9rh/QK2xGYfCAMOghM06ymzC0A== + dependencies: + glob "^7.2.0" + ignore-walk "^4.0.1" + npm-bundled "^1.1.2" + npm-normalize-package-bin "^1.0.1" + +npm-pick-manifest@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/npm-pick-manifest/-/npm-pick-manifest-7.0.0.tgz#e3b18b09678a47e894f90941bef8204ea5d96c3b" + integrity sha512-njM1AcdioFaKd0JSGtLO09YA1WRwctjGQJbnHGmKS+u+uwP8oFvtZtOQWPYdxrnY5eJud3wn8OpH4sEIx6+GEQ== + dependencies: + npm-install-checks "^4.0.0" + npm-normalize-package-bin "^1.0.1" + npm-package-arg "^9.0.0" + semver "^7.3.5" + +npm-registry-fetch@^13.0.1: + version "13.1.0" + resolved "https://registry.yarnpkg.com/npm-registry-fetch/-/npm-registry-fetch-13.1.0.tgz#71bed52e30a4b27441604bbba79c7db8e0e34cb5" + integrity sha512-TIYL5X8CcwDhbFMXFDShNcpG6OMCYK6VzvSr6MUWP20tCU2DJ4ao2qQg3DT+3Pet8mO6/cgbZpon4LMh3duYLg== + dependencies: + make-fetch-happen "^10.0.6" + minipass "^3.1.6" + minipass-fetch "^2.0.3" + minipass-json-stream "^1.0.1" + minizlib "^2.1.2" + npm-package-arg "^9.0.1" + proc-log "^2.0.0" + +npm-run-path@^4.0.1: + version "4.0.1" + resolved "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz#b7ecd1e5ed53da8e37a55e1c2269e0b97ed748ea" + integrity sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw== + dependencies: + path-key "^3.0.0" + +npmlog@^6.0.0: + version "6.0.1" + resolved "https://registry.yarnpkg.com/npmlog/-/npmlog-6.0.1.tgz#06f1344a174c06e8de9c6c70834cfba2964bba17" + integrity sha512-BTHDvY6nrRHuRfyjt1MAufLxYdVXZfd099H4+i1f0lPywNQyI4foeNXJRObB/uy+TYqUW0vAD9gbdSOXPst7Eg== + dependencies: + are-we-there-yet "^3.0.0" + console-control-strings "^1.1.0" + gauge "^4.0.0" + set-blocking "^2.0.0" + +null-check@^1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/null-check/-/null-check-1.0.0.tgz#977dffd7176012b9ec30d2a39db5cf72a0439edd" + integrity sha1-l33/1xdgErnsMNKjnbXPcqBDnt0= + +nwsapi@^2.2.0: + version "2.2.0" + resolved "https://registry.npmjs.org/nwsapi/-/nwsapi-2.2.0.tgz#204879a9e3d068ff2a55139c2c772780681a38b7" + integrity sha512-h2AatdwYH+JHiZpv7pt/gSX1XoRGb7L/qSIeuqA6GwYoF9w1vP1cw42TO0aI2pNyshRK5893hNSl+1//vHK7hQ== + +object-inspect@^1.11.0, object-inspect@^1.9.0: + version "1.12.0" + resolved "https://registry.npmjs.org/object-inspect/-/object-inspect-1.12.0.tgz#6e2c120e868fd1fd18cb4f18c31741d0d6e776f0" + integrity sha512-Ho2z80bVIvJloH+YzRmpZVQe87+qASmBUKZDWgx9cu+KDrX2ZDH/3tMy+gXbZETVGs2M8YdxObOh7XAtim9Y0g== + +object-is@^1.1.4: + version "1.1.5" + resolved "https://registry.npmjs.org/object-is/-/object-is-1.1.5.tgz#b9deeaa5fc7f1846a0faecdceec138e5778f53ac" + integrity sha512-3cyDsyHgtmi7I7DfSSI2LDp6SK2lwvtbg0p0R1e0RvTqF5ceGx+K2dfSjm1bKDMVCFEDAQvy+o8c6a7VujOddw== + dependencies: + call-bind "^1.0.2" + define-properties "^1.1.3" + +object-keys@^1.0.12, object-keys@^1.1.1: + version "1.1.1" + resolved "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz#1c47f272df277f3b1daf061677d9c82e2322c60e" + integrity sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA== + +object.assign@^4.1.2: + version "4.1.2" + resolved "https://registry.npmjs.org/object.assign/-/object.assign-4.1.2.tgz#0ed54a342eceb37b38ff76eb831a0e788cb63940" + integrity sha512-ixT2L5THXsApyiUPYKmW+2EHpXXe5Ii3M+f4e+aJFAHao5amFRW6J0OO6c/LU8Be47utCx2GL89hxGB6XSmKuQ== + dependencies: + call-bind "^1.0.0" + define-properties "^1.1.3" + has-symbols "^1.0.1" + object-keys "^1.1.1" + +object.values@^1.1.5: + version "1.1.5" + resolved "https://registry.npmjs.org/object.values/-/object.values-1.1.5.tgz#959f63e3ce9ef108720333082131e4a459b716ac" + integrity sha512-QUZRW0ilQ3PnPpbNtgdNV1PDbEqLIiSFB3l+EnGtBQ/8SUTLj1PZwtQHABZtLgwpJZTSZhuGLOGk57Drx2IvYg== + dependencies: + call-bind "^1.0.2" + define-properties "^1.1.3" + es-abstract "^1.19.1" + +once@^1.3.0, once@^1.3.1, once@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" + integrity sha1-WDsap3WWHUsROsF9nFC6753Xa9E= + dependencies: + wrappy "1" + +onetime@^5.1.2: + version "5.1.2" + resolved "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz#d0e96ebb56b07476df1dd9c4806e5237985ca45e" + integrity sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg== + dependencies: + mimic-fn "^2.1.0" + +oo-ascii-tree@^1.55.1: + version "1.55.1" + resolved "https://registry.npmjs.org/oo-ascii-tree/-/oo-ascii-tree-1.55.1.tgz#111b6dd8e2ec8f7068e3e89e687dc29e048880e8" + integrity sha512-wGtYFm45kmxdss2XrdXC14uDUfyekbaqqZJrfvPtYHSa98Bk+RXHdTHHLQ1kwem6HT5c3ogf7+ZUBhX0B034iA== + +optionator@^0.8.1: + version "0.8.3" + resolved "https://registry.npmjs.org/optionator/-/optionator-0.8.3.tgz#84fa1d036fe9d3c7e21d99884b601167ec8fb495" + integrity sha512-+IW9pACdk3XWmmTXG8m3upGUJst5XRGzxMRjXzAuJ1XnIFNvfhjjIuYkDvysnPQ7qzqVzLt78BCruntqRhWQbA== + dependencies: + deep-is "~0.1.3" + fast-levenshtein "~2.0.6" + levn "~0.3.0" + prelude-ls "~1.1.2" + type-check "~0.3.2" + word-wrap "~1.2.3" + +optionator@^0.9.1: + version "0.9.1" + resolved "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz#4f236a6373dae0566a6d43e1326674f50c291499" + integrity sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw== + dependencies: + deep-is "^0.1.3" + fast-levenshtein "^2.0.6" + levn "^0.4.1" + prelude-ls "^1.2.1" + type-check "^0.4.0" + word-wrap "^1.2.3" + +p-cancelable@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/p-cancelable/-/p-cancelable-1.1.0.tgz#d078d15a3af409220c886f1d9a0ca2e441ab26cc" + integrity sha512-s73XxOZ4zpt1edZYZzvhqFa6uvQc1vwUa0K0BdtIZgQMAJj9IbebH+JkgKZc9h+B05PKHLOTl4ajG1BmNrVZlw== + +p-limit@^1.1.0: + version "1.3.0" + resolved "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz#b86bd5f0c25690911c7590fcbfc2010d54b3ccb8" + integrity sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q== + dependencies: + p-try "^1.0.0" + +p-limit@^2.0.0, p-limit@^2.2.0: + version "2.3.0" + resolved "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz#3dd33c647a214fdfffd835933eb086da0dc21db1" + integrity sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w== + dependencies: + p-try "^2.0.0" + +p-limit@^3.0.2: + version "3.1.0" + resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-3.1.0.tgz#e1daccbe78d0d1388ca18c64fea38e3e57e3706b" + integrity sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ== + dependencies: + yocto-queue "^0.1.0" + +p-locate@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz#20a0103b222a70c8fd39cc2e580680f3dde5ec43" + integrity sha1-IKAQOyIqcMj9OcwuWAaA893l7EM= + dependencies: + p-limit "^1.1.0" + +p-locate@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-3.0.0.tgz#322d69a05c0264b25997d9f40cd8a891ab0064a4" + integrity sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ== + dependencies: + p-limit "^2.0.0" + +p-locate@^4.1.0: + version "4.1.0" + resolved "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz#a3428bb7088b3a60292f66919278b7c297ad4f07" + integrity sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A== + dependencies: + p-limit "^2.2.0" + +p-locate@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-5.0.0.tgz#83c8315c6785005e3bd021839411c9e110e6d834" + integrity sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw== + dependencies: + p-limit "^3.0.2" + +p-map@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/p-map/-/p-map-4.0.0.tgz#bb2f95a5eda2ec168ec9274e06a747c3e2904d2b" + integrity sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ== + dependencies: + aggregate-error "^3.0.0" + +p-try@^1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz#cbc79cdbaf8fd4228e13f621f2b1a237c1b207b3" + integrity sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M= + +p-try@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/p-try/-/p-try-2.2.0.tgz#cb2868540e313d61de58fafbe35ce9004d5540e6" + integrity sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ== + +package-json@^6.3.0: + version "6.5.0" + resolved "https://registry.yarnpkg.com/package-json/-/package-json-6.5.0.tgz#6feedaca35e75725876d0b0e64974697fed145b0" + integrity sha512-k3bdm2n25tkyxcjSKzB5x8kfVxlMdgsbPr0GkZcwHsLpba6cBjqCt1KlcChKEvxHIcTB1FVMuwoijZ26xex5MQ== + dependencies: + got "^9.6.0" + registry-auth-token "^4.0.0" + registry-url "^5.0.0" + semver "^6.2.0" + +pacote@^13.0.3: + version "13.0.5" + resolved "https://registry.yarnpkg.com/pacote/-/pacote-13.0.5.tgz#d6f370b11112492d8257ae1178a003b36d4bb261" + integrity sha512-6CYfot3/rUAn3qqzF2d/jrrXm5HlBtvaSgfmg0VtOUAdJ8fbSq21BJwftMGArkL71yXHIbUJ7Bt5B04547HELA== + dependencies: + "@npmcli/git" "^3.0.0" + "@npmcli/installed-package-contents" "^1.0.7" + "@npmcli/promise-spawn" "^1.2.0" + "@npmcli/run-script" "^3.0.1" + cacache "^16.0.0" + chownr "^2.0.0" + fs-minipass "^2.1.0" + infer-owner "^1.0.4" + minipass "^3.1.6" + mkdirp "^1.0.4" + npm-package-arg "^9.0.0" + npm-packlist "^4.0.0" + npm-pick-manifest "^7.0.0" + npm-registry-fetch "^13.0.1" + proc-log "^2.0.0" + promise-retry "^2.0.1" + read-package-json "^5.0.0" + read-package-json-fast "^2.0.3" + rimraf "^3.0.2" + ssri "^8.0.1" + tar "^6.1.11" + +parent-module@^1.0.0: + version "1.0.1" + resolved "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz#691d2709e78c79fae3a156622452d00762caaaa2" + integrity sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g== + dependencies: + callsites "^3.0.0" + +parse-github-url@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/parse-github-url/-/parse-github-url-1.0.2.tgz#242d3b65cbcdda14bb50439e3242acf6971db395" + integrity sha512-kgBf6avCbO3Cn6+RnzRGLkUsv4ZVqv/VfAYkRsyBcgkshNvVBkRn1FEZcW0Jb+npXQWm2vHPnnOqFteZxRRGNw== + +parse-json@^4.0.0: + version "4.0.0" + resolved "https://registry.npmjs.org/parse-json/-/parse-json-4.0.0.tgz#be35f5425be1f7f6c747184f98a788cb99477ee0" + integrity sha1-vjX1Qlvh9/bHRxhPmKeIy5lHfuA= + dependencies: + error-ex "^1.3.1" + json-parse-better-errors "^1.0.1" + +parse-json@^5.0.0, parse-json@^5.2.0: + version "5.2.0" + resolved "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz#c76fc66dee54231c962b22bcc8a72cf2f99753cd" + integrity sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg== + dependencies: + "@babel/code-frame" "^7.0.0" + error-ex "^1.3.1" + json-parse-even-better-errors "^2.3.0" + lines-and-columns "^1.1.6" + +parse5@6.0.1: + version "6.0.1" + resolved "https://registry.npmjs.org/parse5/-/parse5-6.0.1.tgz#e1a1c085c569b3dc08321184f19a39cc27f7c30b" + integrity sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw== + +path-exists@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-3.0.0.tgz#ce0ebeaa5f78cb18925ea7d810d7b59b010fd515" + integrity sha1-zg6+ql94yxiSXqfYENe1mwEP1RU= + +path-exists@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-4.0.0.tgz#513bdbe2d3b95d7762e8c1137efa195c6c61b5b3" + integrity sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w== + +path-is-absolute@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/path-is-absolute/-/path-is-absolute-1.0.1.tgz#174b9268735534ffbc7ace6bf53a5a9e1b5c5f5f" + integrity sha1-F0uSaHNVNP+8es5r9TpanhtcX18= + +path-key@^3.0.0, path-key@^3.1.0: + version "3.1.1" + resolved "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz#581f6ade658cbba65a0d3380de7753295054f375" + integrity sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q== + +path-parse@^1.0.7: + version "1.0.7" + resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.7.tgz#fbc114b60ca42b30d9daf5858e4bd68bbedb6735" + integrity sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw== + +path-type@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/path-type/-/path-type-3.0.0.tgz#cef31dc8e0a1a3bb0d105c0cd97cf3bf47f4e36f" + integrity sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg== + dependencies: + pify "^3.0.0" + +path-type@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/path-type/-/path-type-4.0.0.tgz#84ed01c0a7ba380afe09d90a8c180dcd9d03043b" + integrity sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw== + +picocolors@^1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz#cb5bdc74ff3f51892236eaf79d68bc44564ab81c" + integrity sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ== + +picomatch@^2.0.4, picomatch@^2.2.3, picomatch@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.3.1.tgz#3ba3833733646d9d3e4995946c1365a67fb07a42" + integrity sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA== + +pify@^2.3.0: + version "2.3.0" + resolved "https://registry.npmjs.org/pify/-/pify-2.3.0.tgz#ed141a6ac043a849ea588498e7dca8b15330e90c" + integrity sha1-7RQaasBDqEnqWISY59yosVMw6Qw= + +pify@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/pify/-/pify-3.0.0.tgz#e5a4acd2c101fdf3d9a4d07f0dbc4db49dd28176" + integrity sha1-5aSs0sEB/fPZpNB/DbxNtJ3SgXY= + +pirates@^4.0.4: + version "4.0.5" + resolved "https://registry.npmjs.org/pirates/-/pirates-4.0.5.tgz#feec352ea5c3268fb23a37c702ab1699f35a5f3b" + integrity sha512-8V9+HQPupnaXMA23c5hvl69zXvTwTzyAYasnkb0Tts4XvO4CliqONMOnvlq26rkhLC3nWDFBJf73LU1e1VZLaQ== + +pkg-dir@^4.2.0: + version "4.2.0" + resolved "https://registry.npmjs.org/pkg-dir/-/pkg-dir-4.2.0.tgz#f099133df7ede422e81d1d8448270eeb3e4261f3" + integrity sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ== + dependencies: + find-up "^4.0.0" + +prelude-ls@^1.2.1: + version "1.2.1" + resolved "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz#debc6489d7a6e6b0e7611888cec880337d316396" + integrity sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g== + +prelude-ls@~1.1.2: + version "1.1.2" + resolved "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.1.2.tgz#21932a549f5e52ffd9a827f570e04be62a97da54" + integrity sha1-IZMqVJ9eUv/ZqCf1cOBL5iqX2lQ= + +prepend-http@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/prepend-http/-/prepend-http-2.0.0.tgz#e92434bfa5ea8c19f41cdfd401d741a3c819d897" + integrity sha1-6SQ0v6XqjBn0HN/UAddBo8gZ2Jc= + +pretty-format@^27.0.0, pretty-format@^27.5.1: + version "27.5.1" + resolved "https://registry.npmjs.org/pretty-format/-/pretty-format-27.5.1.tgz#2181879fdea51a7a5851fb39d920faa63f01d88e" + integrity sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ== + dependencies: + ansi-regex "^5.0.1" + ansi-styles "^5.0.0" + react-is "^17.0.1" + +proc-log@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/proc-log/-/proc-log-2.0.0.tgz#25f8cb346a5d08e27f2422b3ca6ba8379bcbf8ba" + integrity sha512-I/35MfCX2H8jBUhKN8JB8nmqvQo/nKdrBodBY7L3RhDSPPyvOHwLYNmPuhwuJq7a7C3vgFKWGQM+ecPStcvOHA== + +process-nextick-args@~2.0.0: + version "2.0.1" + resolved "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz#7820d9b16120cc55ca9ae7792680ae7dba6d7fe2" + integrity sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag== + +progress@^2.0.3: + version "2.0.3" + resolved "https://registry.yarnpkg.com/progress/-/progress-2.0.3.tgz#7e8cf8d8f5b8f239c1bc68beb4eb78567d572ef8" + integrity sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA== + +projen@^0.53.15: + version "0.53.15" + resolved "https://registry.yarnpkg.com/projen/-/projen-0.53.15.tgz#aa798bb5cf871dc0db56241d7209832dbbdb9164" + integrity sha512-nBmA0Knzuc6IzzRtYC2f4fHO8kBt0UNPsTz2ABjDWygi/35QL25QNQzbkr/5gGn2LYgkHgIa35b4Yjpiq6SPug== + dependencies: + "@iarna/toml" "^2.2.5" + case "^1.6.3" + chalk "^4.1.2" + conventional-changelog-config-spec "^2.1.0" + fs-extra "^9.1.0" + glob "^7" + ini "^2.0.0" + semver "^7.3.5" + shx "^0.3.4" + xmlbuilder2 "^2.4.1" + yaml next + yargs "^16.2.0" + +promise-inflight@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/promise-inflight/-/promise-inflight-1.0.1.tgz#98472870bf228132fcbdd868129bad12c3c029e3" + integrity sha1-mEcocL8igTL8vdhoEputEsPAKeM= + +promise-retry@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/promise-retry/-/promise-retry-2.0.1.tgz#ff747a13620ab57ba688f5fc67855410c370da22" + integrity sha512-y+WKFlBR8BGXnsNlIHFGPZmyDf3DFMoLhaflAnyZgV6rG6xu+JwesTo2Q9R6XwYmtmwAFCkAk3e35jEdoeh/3g== + dependencies: + err-code "^2.0.2" + retry "^0.12.0" + +prompts@^2.0.1, prompts@^2.4.2: + version "2.4.2" + resolved "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz#7b57e73b3a48029ad10ebd44f74b01722a4cb069" + integrity sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q== + dependencies: + kleur "^3.0.3" + sisteransi "^1.0.5" + +psl@^1.1.33: + version "1.8.0" + resolved "https://registry.npmjs.org/psl/-/psl-1.8.0.tgz#9326f8bcfb013adcc005fdff056acce020e51c24" + integrity sha512-RIdOzyoavK+hA18OGGWDqUTsCLhtA7IcZ/6NCs4fFJaHBDab+pDDmDIByWFRQJq2Cd7r1OoQxBGKOaztq+hjIQ== + +pump@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/pump/-/pump-3.0.0.tgz#b4a2116815bde2f4e1ea602354e8c75565107a64" + integrity sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww== + dependencies: + end-of-stream "^1.1.0" + once "^1.3.1" + +punycode@^2.1.0, punycode@^2.1.1: + version "2.1.1" + resolved "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz#b58b010ac40c22c5657616c8d2c2c02c7bf479ec" + integrity sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A== + +pupa@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/pupa/-/pupa-2.1.1.tgz#f5e8fd4afc2c5d97828faa523549ed8744a20d62" + integrity sha512-l1jNAspIBSFqbT+y+5FosojNpVpF94nlI+wDUpqP9enwOTfHx9f0gh5nB96vl+6yTpsJsypeNrwfzPrKuHB41A== + dependencies: + escape-goat "^2.0.0" + +q@^1.5.1: + version "1.5.1" + resolved "https://registry.npmjs.org/q/-/q-1.5.1.tgz#7e32f75b41381291d04611f1bf14109ac00651d7" + integrity sha1-fjL3W0E4EpHQRhHxvxQQmsAGUdc= + +queue-microtask@^1.2.2: + version "1.2.3" + resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243" + integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A== + +quick-lru@^4.0.1: + version "4.0.1" + resolved "https://registry.npmjs.org/quick-lru/-/quick-lru-4.0.1.tgz#5b8878f113a58217848c6482026c73e1ba57727f" + integrity sha512-ARhCpm70fzdcvNQfPoy49IaanKkTlRWF2JMzqhcJbhSFRZv7nPTvZJdcY7301IPmvW+/p0RgIWnQDLJxifsQ7g== + +rc-config-loader@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/rc-config-loader/-/rc-config-loader-4.0.0.tgz#144cf31961c9f8ebcf252bd9c263fd40d62bd387" + integrity sha512-//LRTblJEcqbmmro1GCmZ39qZXD+JqzuD8Y5/IZU3Dhp3A1Yr0Xn68ks8MQ6qKfKvYCWDveUmRDKDA40c+sCXw== + dependencies: + debug "^4.1.1" + js-yaml "^4.0.0" + json5 "^2.1.2" + require-from-string "^2.0.2" + +rc@^1.2.8: + version "1.2.8" + resolved "https://registry.yarnpkg.com/rc/-/rc-1.2.8.tgz#cd924bf5200a075b83c188cd6b9e211b7fc0d3ed" + integrity sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw== + dependencies: + deep-extend "^0.6.0" + ini "~1.3.0" + minimist "^1.2.0" + strip-json-comments "~2.0.1" + +react-is@^17.0.1: + version "17.0.2" + resolved "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz#e691d4a8e9c789365655539ab372762b0efb54f0" + integrity sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w== + +read-package-json-fast@^2.0.3: + version "2.0.3" + resolved "https://registry.yarnpkg.com/read-package-json-fast/-/read-package-json-fast-2.0.3.tgz#323ca529630da82cb34b36cc0b996693c98c2b83" + integrity sha512-W/BKtbL+dUjTuRL2vziuYhp76s5HZ9qQhd/dKfWIZveD0O40453QNyZhC0e63lqZrAQ4jiOapVoeJ7JrszenQQ== + dependencies: + json-parse-even-better-errors "^2.3.0" + npm-normalize-package-bin "^1.0.1" + +read-package-json@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/read-package-json/-/read-package-json-5.0.0.tgz#d62602755547e152a3923c220238d9a7f0b60745" + integrity sha512-1cjk2MV5ONDMn34uxSID3X8NY7VKsXfJnjbcVdFMvHEnJOBzU6MJ7/3yg6QFVZDq5/1yFNrKBUK9kGnonyGP2Q== + dependencies: + glob "^7.2.0" + json-parse-even-better-errors "^2.3.1" + normalize-package-data "^4.0.0" + npm-normalize-package-bin "^1.0.1" + +read-pkg-up@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-3.0.0.tgz#3ed496685dba0f8fe118d0691dc51f4a1ff96f07" + integrity sha1-PtSWaF26D4/hGNBpHcUfSh/5bwc= + dependencies: + find-up "^2.0.0" + read-pkg "^3.0.0" + +read-pkg-up@^7.0.1: + version "7.0.1" + resolved "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-7.0.1.tgz#f3a6135758459733ae2b95638056e1854e7ef507" + integrity sha512-zK0TB7Xd6JpCLmlLmufqykGE+/TlOePD6qKClNW7hHDKFh/J7/7gCWGR7joEQEW1bKq3a3yUZSObOoWLFQ4ohg== + dependencies: + find-up "^4.1.0" + read-pkg "^5.2.0" + type-fest "^0.8.1" + +read-pkg@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/read-pkg/-/read-pkg-3.0.0.tgz#9cbc686978fee65d16c00e2b19c237fcf6e38389" + integrity sha1-nLxoaXj+5l0WwA4rGcI3/Pbjg4k= + dependencies: + load-json-file "^4.0.0" + normalize-package-data "^2.3.2" + path-type "^3.0.0" + +read-pkg@^5.2.0: + version "5.2.0" + resolved "https://registry.npmjs.org/read-pkg/-/read-pkg-5.2.0.tgz#7bf295438ca5a33e56cd30e053b34ee7250c93cc" + integrity sha512-Ug69mNOpfvKDAc2Q8DRpMjjzdtrnv9HcSMX+4VsZxD1aZ6ZzrIE7rlzXBtWTyhULSMKg076AW6WR5iZpD0JiOg== + dependencies: + "@types/normalize-package-data" "^2.4.0" + normalize-package-data "^2.5.0" + parse-json "^5.0.0" + type-fest "^0.6.0" + +readable-stream@3, readable-stream@^3.0.0, readable-stream@^3.0.2, readable-stream@^3.6.0: + version "3.6.0" + resolved "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.0.tgz#337bbda3adc0706bd3e024426a286d4b4b2c9198" + integrity sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA== + dependencies: + inherits "^2.0.3" + string_decoder "^1.1.1" + util-deprecate "^1.0.1" + +readable-stream@~2.3.6: + version "2.3.7" + resolved "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.7.tgz#1eca1cf711aef814c04f62252a36a62f6cb23b57" + integrity sha512-Ebho8K4jIbHAxnuxi7o42OrZgF/ZTNcsZj6nRKyUmkhLFq8CHItp/fy6hQZuZmP/n3yZ9VBUbp4zz/mX8hmYPw== + dependencies: + core-util-is "~1.0.0" + inherits "~2.0.3" + isarray "~1.0.0" + process-nextick-args "~2.0.0" + safe-buffer "~5.1.1" + string_decoder "~1.1.1" + util-deprecate "~1.0.1" + +rechoir@^0.6.2: + version "0.6.2" + resolved "https://registry.yarnpkg.com/rechoir/-/rechoir-0.6.2.tgz#85204b54dba82d5742e28c96756ef43af50e3384" + integrity sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q= + dependencies: + resolve "^1.1.6" + +redent@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/redent/-/redent-3.0.0.tgz#e557b7998316bb53c9f1f56fa626352c6963059f" + integrity sha512-6tDA8g98We0zd0GvVeMT9arEOnTw9qM03L9cJXaCjrip1OO764RDBLBfrB4cwzNGDj5OA5ioymC9GkizgWJDUg== + dependencies: + indent-string "^4.0.0" + strip-indent "^3.0.0" + +regexp.prototype.flags@^1.3.0: + version "1.4.1" + resolved "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.4.1.tgz#b3f4c0059af9e47eca9f3f660e51d81307e72307" + integrity sha512-pMR7hBVUUGI7PMA37m2ofIdQCsomVnas+Jn5UPGAHQ+/LlwKm/aTLJHdasmHRzlfeZwHiAOaRSo2rbBDm3nNUQ== + dependencies: + call-bind "^1.0.2" + define-properties "^1.1.3" + +regexpp@^3.2.0: + version "3.2.0" + resolved "https://registry.npmjs.org/regexpp/-/regexpp-3.2.0.tgz#0425a2768d8f23bad70ca4b90461fa2f1213e1b2" + integrity sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg== + +registry-auth-token@^4.0.0: + version "4.2.1" + resolved "https://registry.yarnpkg.com/registry-auth-token/-/registry-auth-token-4.2.1.tgz#6d7b4006441918972ccd5fedcd41dc322c79b250" + integrity sha512-6gkSb4U6aWJB4SF2ZvLb76yCBjcvufXBqvvEx1HbmKPkutswjW1xNVRY0+daljIYRbogN7O0etYSlbiaEQyMyw== + dependencies: + rc "^1.2.8" + +registry-url@^5.0.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/registry-url/-/registry-url-5.1.0.tgz#e98334b50d5434b81136b44ec638d9c2009c5009" + integrity sha512-8acYXXTI0AkQv6RAOjE3vOaIXZkT9wo4LOFbBKYQEEnnMNBpKqdUrI6S4NT0KPIo/WVvJ5tE/X5LF/TQUf0ekw== + dependencies: + rc "^1.2.8" + +remote-git-tags@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/remote-git-tags/-/remote-git-tags-3.0.0.tgz#424f8ec2cdea00bb5af1784a49190f25e16983c3" + integrity sha512-C9hAO4eoEsX+OXA4rla66pXZQ+TLQ8T9dttgQj18yuKlPMTVkIkdYXvlMC55IuUsIkV6DpmQYi10JKFLaU+l7w== + +require-directory@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/require-directory/-/require-directory-2.1.1.tgz#8c64ad5fd30dab1c976e2344ffe7f792a6a6df42" + integrity sha1-jGStX9MNqxyXbiNE/+f3kqam30I= + +require-from-string@^2.0.2: + version "2.0.2" + resolved "https://registry.yarnpkg.com/require-from-string/-/require-from-string-2.0.2.tgz#89a7fdd938261267318eafe14f9c32e598c36909" + integrity sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw== + +resolve-cwd@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/resolve-cwd/-/resolve-cwd-3.0.0.tgz#0f0075f1bb2544766cf73ba6a6e2adfebcb13f2d" + integrity sha512-OrZaX2Mb+rJCpH/6CpSqt9xFVpN++x01XnN2ie9g6P5/3xelLAkXWVADpdz1IHD/KFfEXyE6V0U01OQ3UO2rEg== + dependencies: + resolve-from "^5.0.0" + +resolve-from@^4.0.0: + version "4.0.0" + resolved "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz#4abcd852ad32dd7baabfe9b40e00a36db5f392e6" + integrity sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g== + +resolve-from@^5.0.0: + version "5.0.0" + resolved "https://registry.npmjs.org/resolve-from/-/resolve-from-5.0.0.tgz#c35225843df8f776df21c57557bc087e9dfdfc69" + integrity sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw== + +resolve.exports@^1.1.0: + version "1.1.0" + resolved "https://registry.npmjs.org/resolve.exports/-/resolve.exports-1.1.0.tgz#5ce842b94b05146c0e03076985d1d0e7e48c90c9" + integrity sha512-J1l+Zxxp4XK3LUDZ9m60LRJF/mAe4z6a4xyabPHk7pvK5t35dACV32iIjJDFeWZFfZlO29w6SZ67knR0tHzJtQ== + +resolve@^1.1.6, resolve@^1.10.0, resolve@^1.20.0, resolve@^1.22.0: + version "1.22.0" + resolved "https://registry.npmjs.org/resolve/-/resolve-1.22.0.tgz#5e0b8c67c15df57a89bdbabe603a002f21731198" + integrity sha512-Hhtrw0nLeSrFQ7phPp4OOcVjLPIeMnRlr5mcnVuMe7M/7eBn98A3hmFRLoFo3DLZkivSYwhRUJTyPyWAk56WLw== + dependencies: + is-core-module "^2.8.1" + path-parse "^1.0.7" + supports-preserve-symlinks-flag "^1.0.0" + +responselike@^1.0.2: + version "1.0.2" + resolved "https://registry.yarnpkg.com/responselike/-/responselike-1.0.2.tgz#918720ef3b631c5642be068f15ade5a46f4ba1e7" + integrity sha1-kYcg7ztjHFZCvgaPFa3lpG9Loec= + dependencies: + lowercase-keys "^1.0.0" + +retry@^0.12.0: + version "0.12.0" + resolved "https://registry.yarnpkg.com/retry/-/retry-0.12.0.tgz#1b42a6266a21f07421d1b0b54b7dc167b01c013b" + integrity sha1-G0KmJmoh8HQh0bC1S33BZ7AcATs= + +reusify@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.0.4.tgz#90da382b1e126efc02146e90845a88db12925d76" + integrity sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw== + +rfdc@^1.3.0: + version "1.3.0" + resolved "https://registry.npmjs.org/rfdc/-/rfdc-1.3.0.tgz#d0b7c441ab2720d05dc4cf26e01c89631d9da08b" + integrity sha512-V2hovdzFbOi77/WajaSMXk2OLm+xNIeQdMMuB7icj7bk6zi2F8GGAxigcnDFpJHbNyNcgyJDiP+8nOrY5cZGrA== + +rimraf@^3.0.0, rimraf@^3.0.2: + version "3.0.2" + resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a" + integrity sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA== + dependencies: + glob "^7.1.3" + +run-parallel@^1.1.9: + version "1.2.0" + resolved "https://registry.yarnpkg.com/run-parallel/-/run-parallel-1.2.0.tgz#66d1368da7bdf921eb9d95bd1a9229e7f21a43ee" + integrity sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA== + dependencies: + queue-microtask "^1.2.2" + +safe-buffer@~5.1.0, safe-buffer@~5.1.1: + version "5.1.2" + resolved "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d" + integrity sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g== + +safe-buffer@~5.2.0: + version "5.2.1" + resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6" + integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ== + +"safer-buffer@>= 2.1.2 < 3", "safer-buffer@>= 2.1.2 < 3.0.0": + version "2.1.2" + resolved "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz#44fa161b0187b9549dd84bb91802f9bd8385cd6a" + integrity sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg== + +saxes@^5.0.1: + version "5.0.1" + resolved "https://registry.npmjs.org/saxes/-/saxes-5.0.1.tgz#eebab953fa3b7608dbe94e5dadb15c888fa6696d" + integrity sha512-5LBh1Tls8c9xgGjw3QrMwETmTMVk0oFgvrFSvWx62llR2hcEInrKNZ2GZCCuuy2lvWrdl5jhbpeqc5hRYKFOcw== + dependencies: + xmlchars "^2.2.0" + +semver-diff@^3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/semver-diff/-/semver-diff-3.1.1.tgz#05f77ce59f325e00e2706afd67bb506ddb1ca32b" + integrity sha512-GX0Ix/CJcHyB8c4ykpHGIAvLyOwOobtM/8d+TQkAd81/bEjgPHrfba41Vpesr7jX/t8Uh+R3EX9eAS5be+jQYg== + dependencies: + semver "^6.3.0" + +semver-intersect@^1.4.0: + version "1.4.0" + resolved "https://registry.npmjs.org/semver-intersect/-/semver-intersect-1.4.0.tgz#bdd9c06bedcdd2fedb8cd352c3c43ee8c61321f3" + integrity sha512-d8fvGg5ycKAq0+I6nfWeCx6ffaWJCsBYU0H2Rq56+/zFePYfT8mXkB3tWBSjR5BerkHNZ5eTPIk1/LBYas35xQ== + dependencies: + semver "^5.0.0" + +semver-utils@^1.1.4: + version "1.1.4" + resolved "https://registry.yarnpkg.com/semver-utils/-/semver-utils-1.1.4.tgz#cf0405e669a57488913909fc1c3f29bf2a4871e2" + integrity sha512-EjnoLE5OGmDAVV/8YDoN5KiajNadjzIp9BAHOhYeQHt7j0UWxjmgsx4YD48wp4Ue1Qogq38F1GNUJNqF1kKKxA== + +"semver@2 || 3 || 4 || 5", semver@^5.0.0: + version "5.7.1" + resolved "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz#a954f931aeba508d307bbf069eff0c01c96116f7" + integrity sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ== + +semver@7.x, semver@^7.1.1, semver@^7.3.2, semver@^7.3.4, semver@^7.3.5: + version "7.3.5" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.5.tgz#0b621c879348d8998e4b0e4be94b3f12e6018ef7" + integrity sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ== + dependencies: + lru-cache "^6.0.0" + +semver@^6.0.0, semver@^6.2.0, semver@^6.3.0: + version "6.3.0" + resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d" + integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw== + +set-blocking@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/set-blocking/-/set-blocking-2.0.0.tgz#045f9782d011ae9a6803ddd382b24392b3d890f7" + integrity sha1-BF+XgtARrppoA93TgrJDkrPYkPc= + +shebang-command@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz#ccd0af4f8835fbdc265b82461aaf0c36663f34ea" + integrity sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA== + dependencies: + shebang-regex "^3.0.0" + +shebang-regex@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172" + integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== + +shelljs@^0.8.5: + version "0.8.5" + resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.8.5.tgz#de055408d8361bed66c669d2f000538ced8ee20c" + integrity sha512-TiwcRcrkhHvbrZbnRcFYMLl30Dfov3HKqzp5tO5b4pt6G/SezKcYhmDg15zXVBswHmctSAQKznqNW2LO5tTDow== + dependencies: + glob "^7.0.0" + interpret "^1.0.0" + rechoir "^0.6.2" + +shx@^0.3.4: + version "0.3.4" + resolved "https://registry.yarnpkg.com/shx/-/shx-0.3.4.tgz#74289230b4b663979167f94e1935901406e40f02" + integrity sha512-N6A9MLVqjxZYcVn8hLmtneQWIJtp8IKzMP4eMnx+nqkvXoqinUPCbUFLp2UcWTEIUONhlk0ewxr/jaVGlc+J+g== + dependencies: + minimist "^1.2.3" + shelljs "^0.8.5" + +side-channel@^1.0.3, side-channel@^1.0.4: + version "1.0.4" + resolved "https://registry.npmjs.org/side-channel/-/side-channel-1.0.4.tgz#efce5c8fdc104ee751b25c58d4290011fa5ea2cf" + integrity sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw== + dependencies: + call-bind "^1.0.0" + get-intrinsic "^1.0.2" + object-inspect "^1.9.0" + +signal-exit@^3.0.2, signal-exit@^3.0.3, signal-exit@^3.0.7: + version "3.0.7" + resolved "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz#a9a1767f8af84155114eaabd73f99273c8f59ad9" + integrity sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ== + +sisteransi@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/sisteransi/-/sisteransi-1.0.5.tgz#134d681297756437cc05ca01370d3a7a571075ed" + integrity sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg== + +slash@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/slash/-/slash-3.0.0.tgz#6539be870c165adbd5240220dbe361f1bc4d4634" + integrity sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q== + +smart-buffer@^4.2.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/smart-buffer/-/smart-buffer-4.2.0.tgz#6e1d71fa4f18c05f7d0ff216dd16a481d0e8d9ae" + integrity sha512-94hK0Hh8rPqQl2xXc3HsaBoOXKV20MToPkcXvwbISWLEs+64sBq5kFgn2kJDHb1Pry9yrP0dxrCI9RRci7RXKg== + +socks-proxy-agent@^6.1.1: + version "6.1.1" + resolved "https://registry.yarnpkg.com/socks-proxy-agent/-/socks-proxy-agent-6.1.1.tgz#e664e8f1aaf4e1fb3df945f09e3d94f911137f87" + integrity sha512-t8J0kG3csjA4g6FTbsMOWws+7R7vuRC8aQ/wy3/1OWmsgwA68zs/+cExQ0koSitUDXqhufF/YJr9wtNMZHw5Ew== + dependencies: + agent-base "^6.0.2" + debug "^4.3.1" + socks "^2.6.1" + +socks@^2.6.1: + version "2.6.2" + resolved "https://registry.yarnpkg.com/socks/-/socks-2.6.2.tgz#ec042d7960073d40d94268ff3bb727dc685f111a" + integrity sha512-zDZhHhZRY9PxRruRMR7kMhnf3I8hDs4S3f9RecfnGxvcBHQcKcIH/oUcEWffsfl1XxdYlA7nnlGbbTvPz9D8gA== + dependencies: + ip "^1.1.5" + smart-buffer "^4.2.0" + +sort-json@^2.0.1: + version "2.0.1" + resolved "https://registry.npmjs.org/sort-json/-/sort-json-2.0.1.tgz#7338783bef807185dc37d5b02e3afd905d537cfb" + integrity sha512-s8cs2bcsQCzo/P2T/uoU6Js4dS/jnX8+4xunziNoq9qmSpZNCrRIAIvp4avsz0ST18HycV4z/7myJ7jsHWB2XQ== + dependencies: + detect-indent "^5.0.0" + detect-newline "^2.1.0" + minimist "^1.2.0" + +source-map-support@^0.5.21, source-map-support@^0.5.6: + version "0.5.21" + resolved "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz#04fe7c7f9e1ed2d662233c28cb2b35b9f63f6e4f" + integrity sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w== + dependencies: + buffer-from "^1.0.0" + source-map "^0.6.0" + +source-map@^0.5.0: + version "0.5.7" + resolved "https://registry.npmjs.org/source-map/-/source-map-0.5.7.tgz#8a039d2d1021d22d1ea14c80d8ea468ba2ef3fcc" + integrity sha1-igOdLRAh0i0eoUyA2OpGi6LvP8w= + +source-map@^0.6.0, source-map@^0.6.1, source-map@~0.6.1: + version "0.6.1" + resolved "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263" + integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g== + +source-map@^0.7.3: + version "0.7.3" + resolved "https://registry.npmjs.org/source-map/-/source-map-0.7.3.tgz#5302f8169031735226544092e64981f751750383" + integrity sha512-CkCj6giN3S+n9qrYiBTX5gystlENnRW5jZeNLHpe6aue+SrHcG5VYwujhW9s4dY31mEGsxBDrHR6oI69fTXsaQ== + +spawn-please@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/spawn-please/-/spawn-please-1.0.0.tgz#51cf5831ba2bf418aa3ec2102d40b75cfd48b6f2" + integrity sha512-Kz33ip6NRNKuyTRo3aDWyWxeGeM0ORDO552Fs6E1nj4pLWPkl37SrRtTnq+MEopVaqgmaO6bAvVS+v64BJ5M/A== + +spdx-correct@^3.0.0: + version "3.1.1" + resolved "https://registry.yarnpkg.com/spdx-correct/-/spdx-correct-3.1.1.tgz#dece81ac9c1e6713e5f7d1b6f17d468fa53d89a9" + integrity sha512-cOYcUWwhCuHCXi49RhFRCyJEK3iPj1Ziz9DpViV3tbZOwXD49QzIN3MpOLJNxh2qwq2lJJZaKMVw9qNi4jTC0w== + dependencies: + spdx-expression-parse "^3.0.0" + spdx-license-ids "^3.0.0" + +spdx-exceptions@^2.1.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/spdx-exceptions/-/spdx-exceptions-2.3.0.tgz#3f28ce1a77a00372683eade4a433183527a2163d" + integrity sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A== + +spdx-expression-parse@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz#cf70f50482eefdc98e3ce0a6833e4a53ceeba679" + integrity sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q== + dependencies: + spdx-exceptions "^2.1.0" + spdx-license-ids "^3.0.0" + +spdx-license-ids@^3.0.0: + version "3.0.11" + resolved "https://registry.yarnpkg.com/spdx-license-ids/-/spdx-license-ids-3.0.11.tgz#50c0d8c40a14ec1bf449bae69a0ea4685a9d9f95" + integrity sha512-Ctl2BrFiM0X3MANYgj3CkygxhRmr9mi6xhejbdO960nF6EDJApTYpn0BQnDKlnNBULKiCN1n3w9EBkHK8ZWg+g== + +spdx-license-list@^6.4.0: + version "6.4.0" + resolved "https://registry.npmjs.org/spdx-license-list/-/spdx-license-list-6.4.0.tgz#9850c3699c1d35745285607d064d2a5145049d12" + integrity sha512-4BxgJ1IZxTJuX1YxMGu2cRYK46Bk9zJNTK2/R0wNZR0cm+6SVl26/uG7FQmQtxoJQX1uZ0EpTi2L7zvMLboaBA== + +split2@^3.0.0: + version "3.2.2" + resolved "https://registry.npmjs.org/split2/-/split2-3.2.2.tgz#bf2cf2a37d838312c249c89206fd7a17dd12365f" + integrity sha512-9NThjpgZnifTkJpzTZ7Eue85S49QwpNhZTq6GRJwObb6jnLFNGB7Qm73V5HewTROPyxD0C29xqmaI68bQtV+hg== + dependencies: + readable-stream "^3.0.0" + +split@^1.0.0: + version "1.0.1" + resolved "https://registry.npmjs.org/split/-/split-1.0.1.tgz#605bd9be303aa59fb35f9229fbea0ddec9ea07d9" + integrity sha512-mTyOoPbrivtXnwnIxZRFYRrPNtEFKlpB2fvjSnCQUiAA6qAZzqwna5envK4uk6OIeP17CsdF3rSBGYVBsU0Tkg== + dependencies: + through "2" + +sprintf-js@~1.0.2: + version "1.0.3" + resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c" + integrity sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw= + +ssri@^8.0.1: + version "8.0.1" + resolved "https://registry.yarnpkg.com/ssri/-/ssri-8.0.1.tgz#638e4e439e2ffbd2cd289776d5ca457c4f51a2af" + integrity sha512-97qShzy1AiyxvPNIkLWoGua7xoQzzPjQ0HAH4B0rWKo7SZ6USuPcrUiAFrws0UH8RrbWmgq3LMTObhPIHbbBeQ== + dependencies: + minipass "^3.1.1" + +stack-utils@^2.0.3: + version "2.0.5" + resolved "https://registry.npmjs.org/stack-utils/-/stack-utils-2.0.5.tgz#d25265fca995154659dbbfba3b49254778d2fdd5" + integrity sha512-xrQcmYhOsn/1kX+Vraq+7j4oE2j/6BFscZ0etmYg81xuM8Gq0022Pxb8+IqgOFUIaxHs0KaSb7T1+OegiNrNFA== + dependencies: + escape-string-regexp "^2.0.0" + +standard-version@^9: + version "9.3.2" + resolved "https://registry.npmjs.org/standard-version/-/standard-version-9.3.2.tgz#28db8c1be66fd2d736f28f7c5de7619e64cd6dab" + integrity sha512-u1rfKP4o4ew7Yjbfycv80aNMN2feTiqseAhUhrrx2XtdQGmu7gucpziXe68Z4YfHVqlxVEzo4aUA0Iu3VQOTgQ== + dependencies: + chalk "^2.4.2" + conventional-changelog "3.1.24" + conventional-changelog-config-spec "2.1.0" + conventional-changelog-conventionalcommits "4.6.1" + conventional-recommended-bump "6.1.0" + detect-indent "^6.0.0" + detect-newline "^3.1.0" + dotgitignore "^2.1.0" + figures "^3.1.0" + find-up "^5.0.0" + fs-access "^1.0.1" + git-semver-tags "^4.0.0" + semver "^7.1.1" + stringify-package "^1.0.1" + yargs "^16.0.0" + +streamroller@^3.0.6: + version "3.0.6" + resolved "https://registry.npmjs.org/streamroller/-/streamroller-3.0.6.tgz#52823415800ded79a49aa3f7712f50a422b97493" + integrity sha512-Qz32plKq/MZywYyhEatxyYc8vs994Gz0Hu2MSYXXLD233UyPeIeRBZARIIGwFer4Mdb8r3Y2UqKkgyDghM6QCg== + dependencies: + date-format "^4.0.6" + debug "^4.3.4" + fs-extra "^10.0.1" + +string-length@^4.0.1: + version "4.0.2" + resolved "https://registry.npmjs.org/string-length/-/string-length-4.0.2.tgz#a8a8dc7bd5c1a82b9b3c8b87e125f66871b6e57a" + integrity sha512-+l6rNN5fYHNhZZy41RXsYptCjA2Igmq4EG7kZAYFQI1E1VTXarr6ZPXBg6eq7Y6eK4FEhY6AJlyuFIb/v/S0VQ== + dependencies: + char-regex "^1.0.2" + strip-ansi "^6.0.0" + +"string-width@^1.0.2 || 2 || 3 || 4", string-width@^4.0.0, string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.2, string-width@^4.2.3: + version "4.2.3" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" + integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== + dependencies: + emoji-regex "^8.0.0" + is-fullwidth-code-point "^3.0.0" + strip-ansi "^6.0.1" + +string.prototype.repeat@^0.2.0: + version "0.2.0" + resolved "https://registry.npmjs.org/string.prototype.repeat/-/string.prototype.repeat-0.2.0.tgz#aba36de08dcee6a5a337d49b2ea1da1b28fc0ecf" + integrity sha1-q6Nt4I3O5qWjN9SbLqHaGyj8Ds8= + +string.prototype.trimend@^1.0.4: + version "1.0.4" + resolved "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.4.tgz#e75ae90c2942c63504686c18b287b4a0b1a45f80" + integrity sha512-y9xCjw1P23Awk8EvTpcyL2NIr1j7wJ39f+k6lvRnSMz+mz9CGz9NYPelDk42kOz6+ql8xjfK8oYzy3jAP5QU5A== + dependencies: + call-bind "^1.0.2" + define-properties "^1.1.3" + +string.prototype.trimstart@^1.0.4: + version "1.0.4" + resolved "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.4.tgz#b36399af4ab2999b4c9c648bd7a3fb2bb26feeed" + integrity sha512-jh6e984OBfvxS50tdY2nRZnoC5/mLFKOREQfw8t5yytkoUsJRNxvI/E39qu1sD0OtWI3OC0XgKSmcWwziwYuZw== + dependencies: + call-bind "^1.0.2" + define-properties "^1.1.3" + +string_decoder@^1.1.1: + version "1.3.0" + resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.3.0.tgz#42f114594a46cf1a8e30b0a84f56c78c3edac21e" + integrity sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA== + dependencies: + safe-buffer "~5.2.0" + +string_decoder@~1.1.1: + version "1.1.1" + resolved "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz#9cf1611ba62685d7030ae9e4ba34149c3af03fc8" + integrity sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg== + dependencies: + safe-buffer "~5.1.0" + +stringify-package@^1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/stringify-package/-/stringify-package-1.0.1.tgz#e5aa3643e7f74d0f28628b72f3dad5cecfc3ba85" + integrity sha512-sa4DUQsYciMP1xhKWGuFM04fB0LG/9DlluZoSVywUMRNvzid6XucHK0/90xGxRoHrAaROrcHK1aPKaijCtSrhg== + +strip-ansi@^6.0.0, strip-ansi@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" + integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== + dependencies: + ansi-regex "^5.0.1" + +strip-bom@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz#2334c18e9c759f7bdd56fdef7e9ae3d588e68ed3" + integrity sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM= + +strip-bom@^4.0.0: + version "4.0.0" + resolved "https://registry.npmjs.org/strip-bom/-/strip-bom-4.0.0.tgz#9c3505c1db45bcedca3d9cf7a16f5c5aa3901878" + integrity sha512-3xurFv5tEgii33Zi8Jtp55wEIILR9eh34FAW00PZf+JnSsTmV/ioewSgQl97JHvgjoRGwPShsWm+IdrxB35d0w== + +strip-final-newline@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz#89b852fb2fcbe936f6f4b3187afb0a12c1ab58ad" + integrity sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA== + +strip-indent@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/strip-indent/-/strip-indent-3.0.0.tgz#c32e1cee940b6b3432c771bc2c54bcce73cd3001" + integrity sha512-laJTa3Jb+VQpaC6DseHhF7dXVqHTfJPCRDaEbid/drOhgitgYku/letMUqOXFoWV0zIIUbjpdH2t+tYj4bQMRQ== + dependencies: + min-indent "^1.0.0" + +strip-json-comments@^3.1.0, strip-json-comments@^3.1.1: + version "3.1.1" + resolved "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz#31f1281b3832630434831c310c01cccda8cbe006" + integrity sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig== + +strip-json-comments@~2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/strip-json-comments/-/strip-json-comments-2.0.1.tgz#3c531942e908c2697c0ec344858c286c7ca0a60a" + integrity sha1-PFMZQukIwml8DsNEhYwobHygpgo= + +supports-color@^5.3.0: + version "5.5.0" + resolved "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz#e2e69a44ac8772f78a1ec0b35b689df6530efc8f" + integrity sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow== + dependencies: + has-flag "^3.0.0" + +supports-color@^7.0.0, supports-color@^7.1.0: + version "7.2.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-7.2.0.tgz#1b7dcdcb32b8138801b3e478ba6a51caa89648da" + integrity sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw== + dependencies: + has-flag "^4.0.0" + +supports-color@^8.0.0: + version "8.1.1" + resolved "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz#cd6fc17e28500cff56c1b86c0a7fd4a54a73005c" + integrity sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q== + dependencies: + has-flag "^4.0.0" + +supports-hyperlinks@^2.0.0: + version "2.2.0" + resolved "https://registry.npmjs.org/supports-hyperlinks/-/supports-hyperlinks-2.2.0.tgz#4f77b42488765891774b70c79babd87f9bd594bb" + integrity sha512-6sXEzV5+I5j8Bmq9/vUphGRM/RJNT9SCURJLjwfOg51heRtguGWDzcaBlgAzKhQa0EVNpPEKzQuBwZ8S8WaCeQ== + dependencies: + has-flag "^4.0.0" + supports-color "^7.0.0" + +supports-preserve-symlinks-flag@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz#6eda4bd344a3c94aea376d4cc31bc77311039e09" + integrity sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w== + +symbol-tree@^3.2.4: + version "3.2.4" + resolved "https://registry.npmjs.org/symbol-tree/-/symbol-tree-3.2.4.tgz#430637d248ba77e078883951fb9aa0eed7c63fa2" + integrity sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw== + +tar@^6.1.11, tar@^6.1.2: + version "6.1.11" + resolved "https://registry.yarnpkg.com/tar/-/tar-6.1.11.tgz#6760a38f003afa1b2ffd0ffe9e9abbd0eab3d621" + integrity sha512-an/KZQzQUkZCkuoAA64hM92X0Urb6VpRhAFllDzz44U2mcD5scmT3zBc4VgVpkugF580+DQn8eAFSyoQt0tznA== + dependencies: + chownr "^2.0.0" + fs-minipass "^2.0.0" + minipass "^3.0.0" + minizlib "^2.1.1" + mkdirp "^1.0.3" + yallist "^4.0.0" + +terminal-link@^2.0.0: + version "2.1.1" + resolved "https://registry.npmjs.org/terminal-link/-/terminal-link-2.1.1.tgz#14a64a27ab3c0df933ea546fba55f2d078edc994" + integrity sha512-un0FmiRUQNr5PJqy9kP7c40F5BOfpGlYTrxonDChEZB7pzZxRNp/bt+ymiy9/npwXya9KH99nJ/GXFIiUkYGFQ== + dependencies: + ansi-escapes "^4.2.1" + supports-hyperlinks "^2.0.0" + +test-exclude@^6.0.0: + version "6.0.0" + resolved "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz#04a8698661d805ea6fa293b6cb9e63ac044ef15e" + integrity sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w== + dependencies: + "@istanbuljs/schema" "^0.1.2" + glob "^7.1.4" + minimatch "^3.0.4" + +text-extensions@^1.0.0: + version "1.9.0" + resolved "https://registry.npmjs.org/text-extensions/-/text-extensions-1.9.0.tgz#1853e45fee39c945ce6f6c36b2d659b5aabc2a26" + integrity sha512-wiBrwC1EhBelW12Zy26JeOUkQ5mRu+5o8rpsJk5+2t+Y5vE7e842qtZDQ2g1NpX/29HdyFeJ4nSIhI47ENSxlQ== + +text-table@^0.2.0: + version "0.2.0" + resolved "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz#7f5ee823ae805207c00af2df4a84ec3fcfa570b4" + integrity sha1-f17oI66AUgfACvLfSoTsP8+lcLQ= + +throat@^6.0.1: + version "6.0.1" + resolved "https://registry.npmjs.org/throat/-/throat-6.0.1.tgz#d514fedad95740c12c2d7fc70ea863eb51ade375" + integrity sha512-8hmiGIJMDlwjg7dlJ4yKGLK8EsYqKgPWbG3b4wjJddKNwc7N7Dpn08Df4szr/sZdMVeOstrdYSsqzX6BYbcB+w== + +through2@^2.0.0: + version "2.0.5" + resolved "https://registry.npmjs.org/through2/-/through2-2.0.5.tgz#01c1e39eb31d07cb7d03a96a70823260b23132cd" + integrity sha512-/mrRod8xqpA+IHSLyGCQ2s8SPHiCDEeQJSep1jqLYeEUClOFG2Qsh+4FU6G9VeqpZnGW/Su8LQGc4YKni5rYSQ== + dependencies: + readable-stream "~2.3.6" + xtend "~4.0.1" + +through2@^4.0.0: + version "4.0.2" + resolved "https://registry.npmjs.org/through2/-/through2-4.0.2.tgz#a7ce3ac2a7a8b0b966c80e7c49f0484c3b239764" + integrity sha512-iOqSav00cVxEEICeD7TjLB1sueEL+81Wpzp2bY17uZjZN0pWZPuo4suZ/61VujxmqSGFfgOcNuTZ85QJwNZQpw== + dependencies: + readable-stream "3" + +through@2, "through@>=2.2.7 <3": + version "2.3.8" + resolved "https://registry.npmjs.org/through/-/through-2.3.8.tgz#0dd4c9ffaabc357960b1b724115d7e0e86a2e1f5" + integrity sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU= + +tmpl@1.0.5: + version "1.0.5" + resolved "https://registry.npmjs.org/tmpl/-/tmpl-1.0.5.tgz#8683e0b902bb9c20c4f726e3c0b69f36518c07cc" + integrity sha512-3f0uOEAQwIqGuWW2MVzYg8fV/QNnc/IpuJNG837rLuczAaLVHslWHZQj4IGiEl5Hs3kkbhwL9Ab7Hrsmuj+Smw== + +to-fast-properties@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/to-fast-properties/-/to-fast-properties-2.0.0.tgz#dc5e698cbd079265bc73e0377681a4e4e83f616e" + integrity sha1-3F5pjL0HkmW8c+A3doGk5Og/YW4= + +to-readable-stream@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/to-readable-stream/-/to-readable-stream-1.0.0.tgz#ce0aa0c2f3df6adf852efb404a783e77c0475771" + integrity sha512-Iq25XBt6zD5npPhlLVXGFN3/gyR2/qODcKNNyTMd4vbm39HUaOiAM4PMq0eMVC/Tkxz+Zjdsc55g9yyz+Yq00Q== + +to-regex-range@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" + integrity sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== + dependencies: + is-number "^7.0.0" + +tough-cookie@^4.0.0: + version "4.0.0" + resolved "https://registry.npmjs.org/tough-cookie/-/tough-cookie-4.0.0.tgz#d822234eeca882f991f0f908824ad2622ddbece4" + integrity sha512-tHdtEpQCMrc1YLrMaqXXcj6AxhYi/xgit6mZu1+EDWUn+qhUf8wMQoFIy9NXuq23zAwtcB0t/MjACGR18pcRbg== + dependencies: + psl "^1.1.33" + punycode "^2.1.1" + universalify "^0.1.2" + +tr46@^2.1.0: + version "2.1.0" + resolved "https://registry.npmjs.org/tr46/-/tr46-2.1.0.tgz#fa87aa81ca5d5941da8cbf1f9b749dc969a4e240" + integrity sha512-15Ih7phfcdP5YxqiB+iDtLoaTz4Nd35+IiAv0kQ5FNKHzXgdWqPoTIqEDDJmXceQt4JZk6lVPT8lnDlPpGDppw== + dependencies: + punycode "^2.1.1" + +trim-newlines@^3.0.0: + version "3.0.1" + resolved "https://registry.npmjs.org/trim-newlines/-/trim-newlines-3.0.1.tgz#260a5d962d8b752425b32f3a7db0dcacd176c144" + integrity sha512-c1PTsA3tYrIsLGkJkzHF+w9F2EyxfXGo4UyJc4pFL++FMjnq0HJS69T3M7d//gKrFKwy429bouPescbjecU+Zw== + +ts-jest@^27.1.4: + version "27.1.4" + resolved "https://registry.npmjs.org/ts-jest/-/ts-jest-27.1.4.tgz#84d42cf0f4e7157a52e7c64b1492c46330943e00" + integrity sha512-qjkZlVPWVctAezwsOD1OPzbZ+k7zA5z3oxII4dGdZo5ggX/PL7kvwTM0pXTr10fAtbiVpJaL3bWd502zAhpgSQ== + dependencies: + bs-logger "0.x" + fast-json-stable-stringify "2.x" + jest-util "^27.0.0" + json5 "2.x" + lodash.memoize "4.x" + make-error "1.x" + semver "7.x" + yargs-parser "20.x" + +tsconfig-paths@^3.12.0, tsconfig-paths@^3.14.1: + version "3.14.1" + resolved "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.14.1.tgz#ba0734599e8ea36c862798e920bcf163277b137a" + integrity sha512-fxDhWnFSLt3VuTwtvJt5fpwxBHg5AdKWMsgcPOOIilyjymcYVZoCQF8fvFRezCNfblEXmi+PcM1eYHeOAgXCOQ== + dependencies: + "@types/json5" "^0.0.29" + json5 "^1.0.1" + minimist "^1.2.6" + strip-bom "^3.0.0" + +tslib@^1.8.1: + version "1.14.1" + resolved "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz#cf2d38bdc34a134bcaf1091c41f6619e2f672d00" + integrity sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg== + +tsutils@^3.21.0: + version "3.21.0" + resolved "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz#b48717d394cea6c1e096983eed58e9d61715b623" + integrity sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA== + dependencies: + tslib "^1.8.1" + +type-check@^0.4.0, type-check@~0.4.0: + version "0.4.0" + resolved "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz#07b8203bfa7056c0657050e3ccd2c37730bab8f1" + integrity sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew== + dependencies: + prelude-ls "^1.2.1" + +type-check@~0.3.2: + version "0.3.2" + resolved "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz#5884cab512cf1d355e3fb784f30804b2b520db72" + integrity sha1-WITKtRLPHTVeP7eE8wgEsrUg23I= + dependencies: + prelude-ls "~1.1.2" + +type-detect@4.0.8: + version "4.0.8" + resolved "https://registry.npmjs.org/type-detect/-/type-detect-4.0.8.tgz#7646fb5f18871cfbb7749e69bd39a6388eb7450c" + integrity sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g== + +type-fest@^0.18.0: + version "0.18.1" + resolved "https://registry.npmjs.org/type-fest/-/type-fest-0.18.1.tgz#db4bc151a4a2cf4eebf9add5db75508db6cc841f" + integrity sha512-OIAYXk8+ISY+qTOwkHtKqzAuxchoMiD9Udx+FSGQDuiRR+PJKJHc2NJAXlbhkGwTt/4/nKZxELY1w3ReWOL8mw== + +type-fest@^0.20.2: + version "0.20.2" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.20.2.tgz#1bf207f4b28f91583666cb5fbd327887301cd5f4" + integrity sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ== + +type-fest@^0.21.3: + version "0.21.3" + resolved "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz#d260a24b0198436e133fa26a524a6d65fa3b2e37" + integrity sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w== + +type-fest@^0.6.0: + version "0.6.0" + resolved "https://registry.npmjs.org/type-fest/-/type-fest-0.6.0.tgz#8d2a2370d3df886eb5c90ada1c5bf6188acf838b" + integrity sha512-q+MB8nYR1KDLrgr4G5yemftpMC7/QLqVndBmEEdqzmNj5dcFOO4Oo8qlwZE3ULT3+Zim1F8Kq4cBnikNhlCMlg== + +type-fest@^0.8.1: + version "0.8.1" + resolved "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz#09e249ebde851d3b1e48d27c105444667f17b83d" + integrity sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA== + +typedarray-to-buffer@^3.1.5: + version "3.1.5" + resolved "https://registry.yarnpkg.com/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz#a97ee7a9ff42691b9f783ff1bc5112fe3fca9080" + integrity sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q== + dependencies: + is-typedarray "^1.0.0" + +typedarray@^0.0.6: + version "0.0.6" + resolved "https://registry.npmjs.org/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777" + integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c= + +typescript@^4.6.3: + version "4.6.3" + resolved "https://registry.npmjs.org/typescript/-/typescript-4.6.3.tgz#eefeafa6afdd31d725584c67a0eaba80f6fc6c6c" + integrity sha512-yNIatDa5iaofVozS/uQJEl3JRWLKKGJKh6Yaiv0GLGSuhpFJe7P3SbHZ8/yjAHRQwKRoA6YZqlfjXWmVzoVSMw== + +typescript@~3.9.10: + version "3.9.10" + resolved "https://registry.npmjs.org/typescript/-/typescript-3.9.10.tgz#70f3910ac7a51ed6bef79da7800690b19bf778b8" + integrity sha512-w6fIxVE/H1PkLKcCPsFqKE7Kv7QUwhU8qQY2MueZXWx5cPZdwFupLgKK3vntcK98BtNHZtAF4LA/yl2a7k8R6Q== + +uglify-js@^3.1.4: + version "3.15.3" + resolved "https://registry.npmjs.org/uglify-js/-/uglify-js-3.15.3.tgz#9aa82ca22419ba4c0137642ba0df800cb06e0471" + integrity sha512-6iCVm2omGJbsu3JWac+p6kUiOpg3wFO2f8lIXjfEb8RrmLjzog1wTPMmwKB7swfzzqxj9YM+sGUM++u1qN4qJg== + +unbox-primitive@^1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.0.1.tgz#085e215625ec3162574dc8859abee78a59b14471" + integrity sha512-tZU/3NqK3dA5gpE1KtyiJUrEB0lxnGkMFHptJ7q6ewdZ8s12QrODwNbhIJStmJkd1QDXa1NRA8aF2A1zk/Ypyw== + dependencies: + function-bind "^1.1.1" + has-bigints "^1.0.1" + has-symbols "^1.0.2" + which-boxed-primitive "^1.0.2" + +unique-filename@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/unique-filename/-/unique-filename-1.1.1.tgz#1d69769369ada0583103a1e6ae87681b56573230" + integrity sha512-Vmp0jIp2ln35UTXuryvjzkjGdRyf9b2lTXuSYUiPmzRcl3FDtYqAwOnTJkAngD9SWhnoJzDbTKwaOrZ+STtxNQ== + dependencies: + unique-slug "^2.0.0" + +unique-slug@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/unique-slug/-/unique-slug-2.0.2.tgz#baabce91083fc64e945b0f3ad613e264f7cd4e6c" + integrity sha512-zoWr9ObaxALD3DOPfjPSqxt4fnZiWblxHIgeWqW8x7UqDzEtHEQLzji2cuJYQFCU6KmoJikOYAZlrTHHebjx2w== + dependencies: + imurmurhash "^0.1.4" + +unique-string@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/unique-string/-/unique-string-2.0.0.tgz#39c6451f81afb2749de2b233e3f7c5e8843bd89d" + integrity sha512-uNaeirEPvpZWSgzwsPGtU2zVSTrn/8L5q/IexZmH0eH6SA73CmAA5U4GwORTxQAZs95TAXLNqeLoPPNO5gZfWg== + dependencies: + crypto-random-string "^2.0.0" + +universalify@^0.1.2: + version "0.1.2" + resolved "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz#b646f69be3942dabcecc9d6639c80dc105efaa66" + integrity sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg== + +universalify@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/universalify/-/universalify-2.0.0.tgz#75a4984efedc4b08975c5aeb73f530d02df25717" + integrity sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ== + +update-notifier@^5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/update-notifier/-/update-notifier-5.1.0.tgz#4ab0d7c7f36a231dd7316cf7729313f0214d9ad9" + integrity sha512-ItnICHbeMh9GqUy31hFPrD1kcuZ3rpxDZbf4KUDavXwS0bW5m7SLbDQpGX3UYr072cbrF5hFUs3r5tUsPwjfHw== + dependencies: + boxen "^5.0.0" + chalk "^4.1.0" + configstore "^5.0.1" + has-yarn "^2.1.0" + import-lazy "^2.1.0" + is-ci "^2.0.0" + is-installed-globally "^0.4.0" + is-npm "^5.0.0" + is-yarn-global "^0.3.0" + latest-version "^5.1.0" + pupa "^2.1.1" + semver "^7.3.4" + semver-diff "^3.1.1" + xdg-basedir "^4.0.0" + +uri-js@^4.2.2: + version "4.4.1" + resolved "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz#9b1a52595225859e55f669d928f88c6c57f2a77e" + integrity sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg== + dependencies: + punycode "^2.1.0" + +url-parse-lax@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/url-parse-lax/-/url-parse-lax-3.0.0.tgz#16b5cafc07dbe3676c1b1999177823d6503acb0c" + integrity sha1-FrXK/Afb42dsGxmZF3gj1lA6yww= + dependencies: + prepend-http "^2.0.0" + +util-deprecate@^1.0.1, util-deprecate@~1.0.1: + version "1.0.2" + resolved "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf" + integrity sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8= + +uuid@^8.3.2: + version "8.3.2" + resolved "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz#80d5b5ced271bb9af6c445f21a1a04c606cefbe2" + integrity sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg== + +v8-compile-cache@^2.0.3: + version "2.3.0" + resolved "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz#2de19618c66dc247dcfb6f99338035d8245a2cee" + integrity sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA== + +v8-to-istanbul@^8.1.0: + version "8.1.1" + resolved "https://registry.npmjs.org/v8-to-istanbul/-/v8-to-istanbul-8.1.1.tgz#77b752fd3975e31bbcef938f85e9bd1c7a8d60ed" + integrity sha512-FGtKtv3xIpR6BYhvgH8MI/y78oT7d8Au3ww4QIxymrCtZEh5b8gCw2siywE+puhEmuWKDtmfrvF5UlB298ut3w== + dependencies: + "@types/istanbul-lib-coverage" "^2.0.1" + convert-source-map "^1.6.0" + source-map "^0.7.3" + +validate-npm-package-license@^3.0.1, validate-npm-package-license@^3.0.4: + version "3.0.4" + resolved "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz#fc91f6b9c7ba15c857f4cb2c5defeec39d4f410a" + integrity sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew== + dependencies: + spdx-correct "^3.0.0" + spdx-expression-parse "^3.0.0" + +validate-npm-package-name@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/validate-npm-package-name/-/validate-npm-package-name-3.0.0.tgz#5fa912d81eb7d0c74afc140de7317f0ca7df437e" + integrity sha1-X6kS2B630MdK/BQN5zF/DKffQ34= + dependencies: + builtins "^1.0.3" + +w3c-hr-time@^1.0.2: + version "1.0.2" + resolved "https://registry.npmjs.org/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz#0a89cdf5cc15822df9c360543676963e0cc308cd" + integrity sha512-z8P5DvDNjKDoFIHK7q8r8lackT6l+jo/Ye3HOle7l9nICP9lf1Ci25fy9vHd0JOWewkIFzXIEig3TdKT7JQ5fQ== + dependencies: + browser-process-hrtime "^1.0.0" + +w3c-xmlserializer@^2.0.0: + version "2.0.0" + resolved "https://registry.npmjs.org/w3c-xmlserializer/-/w3c-xmlserializer-2.0.0.tgz#3e7104a05b75146cc60f564380b7f683acf1020a" + integrity sha512-4tzD0mF8iSiMiNs30BiLO3EpfGLZUT2MSX/G+o7ZywDzliWQ3OPtTZ0PTC3B3ca1UAf4cJMHB+2Bf56EriJuRA== + dependencies: + xml-name-validator "^3.0.0" + +walker@^1.0.7: + version "1.0.8" + resolved "https://registry.npmjs.org/walker/-/walker-1.0.8.tgz#bd498db477afe573dc04185f011d3ab8a8d7653f" + integrity sha512-ts/8E8l5b7kY0vlWLewOkDXMmPdLcVV4GmOQLyxuSswIJsweeFZtAsMF7k1Nszz+TYBQrlYRmzOnr398y1JemQ== + dependencies: + makeerror "1.0.12" + +webidl-conversions@^5.0.0: + version "5.0.0" + resolved "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-5.0.0.tgz#ae59c8a00b121543a2acc65c0434f57b0fc11aff" + integrity sha512-VlZwKPCkYKxQgeSbH5EyngOmRp7Ww7I9rQLERETtf5ofd9pGeswWiOtogpEO850jziPRarreGxn5QIiTqpb2wA== + +webidl-conversions@^6.1.0: + version "6.1.0" + resolved "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-6.1.0.tgz#9111b4d7ea80acd40f5270d666621afa78b69514" + integrity sha512-qBIvFLGiBpLjfwmYAaHPXsn+ho5xZnGvyGvsarywGNc8VyQJUMHJ8OBKGGrPER0okBeMDaan4mNBlgBROxuI8w== + +whatwg-encoding@^1.0.5: + version "1.0.5" + resolved "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-1.0.5.tgz#5abacf777c32166a51d085d6b4f3e7d27113ddb0" + integrity sha512-b5lim54JOPN9HtzvK9HFXvBma/rnfFeqsic0hSpjtDbVxR3dJKLc+KB4V6GgiGOvl7CY/KNh8rxSo9DKQrnUEw== + dependencies: + iconv-lite "0.4.24" + +whatwg-mimetype@^2.3.0: + version "2.3.0" + resolved "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-2.3.0.tgz#3d4b1e0312d2079879f826aff18dbeeca5960fbf" + integrity sha512-M4yMwr6mAnQz76TbJm914+gPpB/nCwvZbJU28cUD6dR004SAxDLOOSUaB1JDRqLtaOV/vi0IC5lEAGFgrjGv/g== + +whatwg-url@^8.0.0, whatwg-url@^8.5.0: + version "8.7.0" + resolved "https://registry.npmjs.org/whatwg-url/-/whatwg-url-8.7.0.tgz#656a78e510ff8f3937bc0bcbe9f5c0ac35941b77" + integrity sha512-gAojqb/m9Q8a5IV96E3fHJM70AzCkgt4uXYX2O7EmuyOnLrViCQlsEBmF9UQIu3/aeAIp2U17rtbpZWNntQqdg== + dependencies: + lodash "^4.7.0" + tr46 "^2.1.0" + webidl-conversions "^6.1.0" + +which-boxed-primitive@^1.0.1, which-boxed-primitive@^1.0.2: + version "1.0.2" + resolved "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.0.2.tgz#13757bc89b209b049fe5d86430e21cf40a89a8e6" + integrity sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg== + dependencies: + is-bigint "^1.0.1" + is-boolean-object "^1.1.0" + is-number-object "^1.0.4" + is-string "^1.0.5" + is-symbol "^1.0.3" + +which-collection@^1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/which-collection/-/which-collection-1.0.1.tgz#70eab71ebbbd2aefaf32f917082fc62cdcb70906" + integrity sha512-W8xeTUwaln8i3K/cY1nGXzdnVZlidBcagyNFtBdD5kxnb4TvGKR7FfSIS3mYpwWS1QUCutfKz8IY8RjftB0+1A== + dependencies: + is-map "^2.0.1" + is-set "^2.0.1" + is-weakmap "^2.0.1" + is-weakset "^2.0.1" + +which-typed-array@^1.1.2: + version "1.1.7" + resolved "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.7.tgz#2761799b9a22d4b8660b3c1b40abaa7739691793" + integrity sha512-vjxaB4nfDqwKI0ws7wZpxIlde1XrLX5uB0ZjpfshgmapJMD7jJWhZI+yToJTqaFByF0eNBcYxbjmCzoRP7CfEw== + dependencies: + available-typed-arrays "^1.0.5" + call-bind "^1.0.2" + es-abstract "^1.18.5" + foreach "^2.0.5" + has-tostringtag "^1.0.0" + is-typed-array "^1.1.7" + +which@^2.0.1, which@^2.0.2: + version "2.0.2" + resolved "https://registry.npmjs.org/which/-/which-2.0.2.tgz#7c6a8dd0a636a0327e10b59c9286eee93f3f51b1" + integrity sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA== + dependencies: + isexe "^2.0.0" + +wide-align@^1.1.5: + version "1.1.5" + resolved "https://registry.yarnpkg.com/wide-align/-/wide-align-1.1.5.tgz#df1d4c206854369ecf3c9a4898f1b23fbd9d15d3" + integrity sha512-eDMORYaPNZ4sQIuuYPDHdQvf4gyCF9rEEV/yPxGfwPkRodwEgiMUUXTx/dex+Me0wxx53S+NgUHaP7y3MGlDmg== + dependencies: + string-width "^1.0.2 || 2 || 3 || 4" + +widest-line@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/widest-line/-/widest-line-3.1.0.tgz#8292333bbf66cb45ff0de1603b136b7ae1496eca" + integrity sha512-NsmoXalsWVDMGupxZ5R08ka9flZjjiLvHVAWYOKtiKM8ujtZWr9cRffak+uSE48+Ob8ObalXpwyeUiyDD6QFgg== + dependencies: + string-width "^4.0.0" + +word-wrap@^1.2.3, word-wrap@~1.2.3: + version "1.2.3" + resolved "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.3.tgz#610636f6b1f703891bd34771ccb17fb93b47079c" + integrity sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ== + +wordwrap@^1.0.0: + version "1.0.0" + resolved "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz#27584810891456a4171c8d0226441ade90cbcaeb" + integrity sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus= + +workerpool@^6.2.0: + version "6.2.0" + resolved "https://registry.npmjs.org/workerpool/-/workerpool-6.2.0.tgz#827d93c9ba23ee2019c3ffaff5c27fccea289e8b" + integrity sha512-Rsk5qQHJ9eowMH28Jwhe8HEbmdYDX4lwoMWshiCXugjtHqMD9ZbiqSDLxcsfdqsETPzVUtX5s1Z5kStiIM6l4A== + +wrap-ansi@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" + integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== + dependencies: + ansi-styles "^4.0.0" + string-width "^4.1.0" + strip-ansi "^6.0.0" + +wrappy@1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" + integrity sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8= + +write-file-atomic@^3.0.0: + version "3.0.3" + resolved "https://registry.yarnpkg.com/write-file-atomic/-/write-file-atomic-3.0.3.tgz#56bd5c5a5c70481cd19c571bd39ab965a5de56e8" + integrity sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q== + dependencies: + imurmurhash "^0.1.4" + is-typedarray "^1.0.0" + signal-exit "^3.0.2" + typedarray-to-buffer "^3.1.5" + +ws@^7.4.6: + version "7.5.7" + resolved "https://registry.npmjs.org/ws/-/ws-7.5.7.tgz#9e0ac77ee50af70d58326ecff7e85eb3fa375e67" + integrity sha512-KMvVuFzpKBuiIXW3E4u3mySRO2/mCHSyZDJQM5NQ9Q9KHWHWh0NHgfbRMLLrceUK5qAL4ytALJbpRMjixFZh8A== + +xdg-basedir@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/xdg-basedir/-/xdg-basedir-4.0.0.tgz#4bc8d9984403696225ef83a1573cbbcb4e79db13" + integrity sha512-PSNhEJDejZYV7h50BohL09Er9VaIefr2LMAf3OEmpCkjOi34eYyQYAXUTjEQtZJTKcF0E2UKTh+osDLsgNim9Q== + +xml-name-validator@^3.0.0: + version "3.0.0" + resolved "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-3.0.0.tgz#6ae73e06de4d8c6e47f9fb181f78d648ad457c6a" + integrity sha512-A5CUptxDsvxKJEU3yO6DuWBSJz/qizqzJKOMIfUJHETbBw/sFaDxgd6fxm1ewUaM0jZ444Fc5vC5ROYurg/4Pw== + +xml@^1.0.1: + version "1.0.1" + resolved "https://registry.npmjs.org/xml/-/xml-1.0.1.tgz#78ba72020029c5bc87b8a81a3cfcd74b4a2fc1e5" + integrity sha1-eLpyAgApxbyHuKgaPPzXS0ovweU= + +xmlbuilder2@^2.4.1: + version "2.4.1" + resolved "https://registry.yarnpkg.com/xmlbuilder2/-/xmlbuilder2-2.4.1.tgz#899c783a833188c5a5aa6f3c5428a3963f3e479d" + integrity sha512-vliUplZsk5vJnhxXN/mRcij/AE24NObTUm/Zo4vkLusgayO6s3Et5zLEA14XZnY1c3hX5o1ToR0m0BJOPy0UvQ== + dependencies: + "@oozcitak/dom" "1.15.8" + "@oozcitak/infra" "1.0.8" + "@oozcitak/util" "8.3.8" + "@types/node" "*" + js-yaml "3.14.0" + +xmlbuilder@^15.1.1: + version "15.1.1" + resolved "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-15.1.1.tgz#9dcdce49eea66d8d10b42cae94a79c3c8d0c2ec5" + integrity sha512-yMqGBqtXyeN1e3TGYvgNgDVZ3j84W4cwkOXQswghol6APgZWaff9lnbvN7MHYJOiXsvGPXtjTYJEiC9J2wv9Eg== + +xmlchars@^2.2.0: + version "2.2.0" + resolved "https://registry.npmjs.org/xmlchars/-/xmlchars-2.2.0.tgz#060fe1bcb7f9c76fe2a17db86a9bc3ab894210cb" + integrity sha512-JZnDKK8B0RCDw84FNdDAIpZK+JuJw+s7Lz8nksI7SIuU3UXJJslUthsi+uWBUYOwPFwW7W7PRLRfUKpxjtjFCw== + +xtend@~4.0.1: + version "4.0.2" + resolved "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz#bb72779f5fa465186b1f438f674fa347fdb5db54" + integrity sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ== + +y18n@^5.0.5: + version "5.0.8" + resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.8.tgz#7f4934d0f7ca8c56f95314939ddcd2dd91ce1d55" + integrity sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA== + +yallist@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72" + integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A== + +yaml@2.0.0-7: + version "2.0.0-7" + resolved "https://registry.npmjs.org/yaml/-/yaml-2.0.0-7.tgz#9799d9d85dfc8f01e4cc425e18e09215364beef1" + integrity sha512-RbI2Tm3hl9AoHY4wWyWvGvJfFIbHOzuzaxum6ez1A0vve+uXgNor03Wys4t+2sgjJSVSe+B2xerd1/dnvqHlOA== + +yaml@^1.10.2: + version "1.10.2" + resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.2.tgz#2301c5ffbf12b467de8da2333a459e29e7920e4b" + integrity sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg== + +yaml@next: + version "2.0.0-11" + resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.0.0-11.tgz#269af42637a41ec1ebf2abb546a28949545f0cbb" + integrity sha512-5kGSQrzDyjCk0BLuFfjkoUE9vYcoyrwZIZ+GnpOSM9vhkvPjItYiWJ1jpRSo0aU4QmsoNrFwDT4O7XS2UGcBQg== + +yargs-parser@20.x, yargs-parser@^20.2.2, yargs-parser@^20.2.3: + version "20.2.9" + resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-20.2.9.tgz#2eb7dc3b0289718fc295f362753845c41a0c94ee" + integrity sha512-y11nGElTIV+CT3Zv9t7VKl+Q3hTQoT9a1Qzezhhl6Rp21gJ/IVTW7Z3y9EWXhuUBC2Shnf+DX0antecpAwSP8w== + +yargs@^16.0.0, yargs@^16.2.0: + version "16.2.0" + resolved "https://registry.yarnpkg.com/yargs/-/yargs-16.2.0.tgz#1c82bf0f6b6a66eafce7ef30e376f49a12477f66" + integrity sha512-D1mvvtDG0L5ft/jGWkLpG1+m0eQxOfaBvTNELraWj22wSVUMWxZUvYgJYcKh6jGGIkJFhH4IZPQhR4TKpc8mBw== + dependencies: + cliui "^7.0.2" + escalade "^3.1.1" + get-caller-file "^2.0.5" + require-directory "^2.1.1" + string-width "^4.2.0" + y18n "^5.0.5" + yargs-parser "^20.2.2" + +yocto-queue@^0.1.0: + version "0.1.0" + resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-0.1.0.tgz#0294eb3dee05028d31ee1a5fa2c556a6aaf10a1b" + integrity sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==