Skip to content

Latest commit

 

History

History
355 lines (209 loc) · 14.2 KB

API.md

File metadata and controls

355 lines (209 loc) · 14.2 KB
Raw

API Reference

Constructs

CDK8sProvider

Initializers 

import { CDK8sProvider } from 'cdktf-cdk8s'

new CDK8sProvider(scope: Construct, id: string, config: CDK8sProviderConfig)
Name Type Description
scope* constructs.Construct No description.
id* string No description.
config* cdktf-cdk8s.CDK8sProviderConfig No description.
scopeRequired
idRequired
  • Type: string
configRequired

Structs

CDK8sProviderConfig

Initializer 

import { CDK8sProviderConfig } from 'cdktf-cdk8s'

const cDK8sProviderConfig: CDK8sProviderConfig = { ... }

Properties

Name Type Description
alias string Alias name.
clientCertificate string PEM-encoded client certificate for TLS authentication.
clientKey string PEM-encoded client certificate key for TLS authentication.
clusterCaCertificate string PEM-encoded root certificates bundle for TLS authentication.
configContext string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#config_context KubernetesProvider#config_context}.
configContextAuthInfo string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#config_context_auth_info KubernetesProvider#config_context_auth_info}.
configContextCluster string Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#config_context_cluster KubernetesProvider#config_context_cluster}.
configPath string Path to the kube config file. Can be set with KUBE_CONFIG_PATH.
configPaths string[] A list of paths to kube config files. Can be set with KUBE_CONFIG_PATHS environment variable.
exec @cdktf/provider-kubernetes.KubernetesProviderExec exec block.
experiments @cdktf/provider-kubernetes.KubernetesProviderExperiments experiments block.
host string The hostname (in form of URI) of Kubernetes master.
ignoreAnnotations string[] List of Kubernetes metadata annotations to ignore across all resources handled by this provider for situations where external systems are managing certain resource annotations.
ignoreLabels string[] List of Kubernetes metadata labels to ignore across all resources handled by this provider for situations where external systems are managing certain resource labels.
insecure boolean | cdktf.IResolvable Whether server should be accessed without verifying the TLS certificate.
password string The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint.
proxyUrl string URL to the proxy to be used for all API requests.
token string Token to authenticate an service account.
username string The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint.
cdk8sApp* cdk8s.App No description.
aliasOptional 
public readonly alias: string;
  • Type: string

Alias name.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#alias KubernetesProvider#alias}

clientCertificateOptional 
public readonly clientCertificate: string;
  • Type: string

PEM-encoded client certificate for TLS authentication.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#client_certificate KubernetesProvider#client_certificate}

clientKeyOptional 
public readonly clientKey: string;
  • Type: string

PEM-encoded client certificate key for TLS authentication.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#client_key KubernetesProvider#client_key}

clusterCaCertificateOptional 
public readonly clusterCaCertificate: string;
  • Type: string

PEM-encoded root certificates bundle for TLS authentication.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#cluster_ca_certificate KubernetesProvider#cluster_ca_certificate}

configContextOptional 
public readonly configContext: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#config_context KubernetesProvider#config_context}.

configContextAuthInfoOptional 
public readonly configContextAuthInfo: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#config_context_auth_info KubernetesProvider#config_context_auth_info}.

configContextClusterOptional 
public readonly configContextCluster: string;
  • Type: string

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#config_context_cluster KubernetesProvider#config_context_cluster}.

configPathOptional 
public readonly configPath: string;
  • Type: string

Path to the kube config file. Can be set with KUBE_CONFIG_PATH.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#config_path KubernetesProvider#config_path}

configPathsOptional 
public readonly configPaths: string[];
  • Type: string[]

A list of paths to kube config files. Can be set with KUBE_CONFIG_PATHS environment variable.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#config_paths KubernetesProvider#config_paths}

execOptional 
public readonly exec: KubernetesProviderExec;

exec block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#exec KubernetesProvider#exec}

experimentsOptional 
public readonly experiments: KubernetesProviderExperiments;

experiments block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#experiments KubernetesProvider#experiments}

hostOptional 
public readonly host: string;
  • Type: string

The hostname (in form of URI) of Kubernetes master.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#host KubernetesProvider#host}

ignoreAnnotationsOptional 
public readonly ignoreAnnotations: string[];
  • Type: string[]

List of Kubernetes metadata annotations to ignore across all resources handled by this provider for situations where external systems are managing certain resource annotations.

Each item is a regular expression. Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#ignore_annotations KubernetesProvider#ignore_annotations}

ignoreLabelsOptional 
public readonly ignoreLabels: string[];
  • Type: string[]

List of Kubernetes metadata labels to ignore across all resources handled by this provider for situations where external systems are managing certain resource labels.

Each item is a regular expression. Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#ignore_labels KubernetesProvider#ignore_labels}

insecureOptional 
public readonly insecure: boolean | IResolvable;

Whether server should be accessed without verifying the TLS certificate.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#insecure KubernetesProvider#insecure}

passwordOptional 
public readonly password: string;
  • Type: string

The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#password KubernetesProvider#password}

proxyUrlOptional 
public readonly proxyUrl: string;
  • Type: string

URL to the proxy to be used for all API requests.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#proxy_url KubernetesProvider#proxy_url}

tokenOptional 
public readonly token: string;
  • Type: string

Token to authenticate an service account.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#token KubernetesProvider#token}

usernameOptional 
public readonly username: string;
  • Type: string

The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/kubernetes#username KubernetesProvider#username}

cdk8sAppRequired 
public readonly cdk8sApp: App;