Skip to content

Latest commit

 

History

History
1629 lines (1023 loc) · 73.8 KB

provider.java.md

File metadata and controls

1629 lines (1023 loc) · 73.8 KB

provider Submodule

Constructs

KubernetesProvider

Represents a {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs kubernetes}.

Initializers 

import com.hashicorp.cdktf.providers.kubernetes.provider.KubernetesProvider;

KubernetesProvider.Builder.create(Construct scope, java.lang.String id)
//  .alias(java.lang.String)
//  .clientCertificate(java.lang.String)
//  .clientKey(java.lang.String)
//  .clusterCaCertificate(java.lang.String)
//  .configContext(java.lang.String)
//  .configContextAuthInfo(java.lang.String)
//  .configContextCluster(java.lang.String)
//  .configPath(java.lang.String)
//  .configPaths(java.util.List<java.lang.String>)
//  .exec(IResolvable)
//  .exec(java.util.List<KubernetesProviderExec>)
//  .experiments(IResolvable)
//  .experiments(java.util.List<KubernetesProviderExperiments>)
//  .host(java.lang.String)
//  .ignoreAnnotations(java.util.List<java.lang.String>)
//  .ignoreLabels(java.util.List<java.lang.String>)
//  .insecure(java.lang.Boolean)
//  .insecure(IResolvable)
//  .password(java.lang.String)
//  .proxyUrl(java.lang.String)
//  .tlsServerName(java.lang.String)
//  .token(java.lang.String)
//  .username(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
alias java.lang.String Alias name.
clientCertificate java.lang.String PEM-encoded client certificate for TLS authentication.
clientKey java.lang.String PEM-encoded client certificate key for TLS authentication.
clusterCaCertificate java.lang.String PEM-encoded root certificates bundle for TLS authentication.
configContext java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#config_context KubernetesProvider#config_context}.
configContextAuthInfo java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#config_context_auth_info KubernetesProvider#config_context_auth_info}.
configContextCluster java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#config_context_cluster KubernetesProvider#config_context_cluster}.
configPath java.lang.String Path to the kube config file. Can be set with KUBE_CONFIG_PATH.
configPaths java.util.List<java.lang.String> A list of paths to kube config files. Can be set with KUBE_CONFIG_PATHS environment variable.
exec com.hashicorp.cdktf.IResolvable OR java.util.List<KubernetesProviderExec> exec block.
experiments com.hashicorp.cdktf.IResolvable OR java.util.List<KubernetesProviderExperiments> experiments block.
host java.lang.String The hostname (in form of URI) of Kubernetes master.
ignoreAnnotations java.util.List<java.lang.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 java.util.List<java.lang.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 java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether server should be accessed without verifying the TLS certificate.
password java.lang.String The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint.
proxyUrl java.lang.String URL to the proxy to be used for all API requests.
tlsServerName java.lang.String Server name passed to the server for SNI and is used in the client to check server certificates against.
token java.lang.String Token to authenticate an service account.
username java.lang.String The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

aliasOptional
  • Type: java.lang.String

Alias name.

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

clientCertificateOptional
  • Type: java.lang.String

PEM-encoded client certificate for TLS authentication.

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

clientKeyOptional
  • Type: java.lang.String

PEM-encoded client certificate key for TLS authentication.

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

clusterCaCertificateOptional
  • Type: java.lang.String

PEM-encoded root certificates bundle for TLS authentication.

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

configContextOptional
  • Type: java.lang.String

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

configContextAuthInfoOptional
  • Type: java.lang.String

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

configContextClusterOptional
  • Type: java.lang.String

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

configPathOptional
  • Type: java.lang.String

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

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

configPathsOptional
  • Type: java.util.List<java.lang.String>

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

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

execOptional

exec block.

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

experimentsOptional

experiments block.

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

hostOptional
  • Type: java.lang.String

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

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

ignoreAnnotationsOptional
  • Type: java.util.List<java.lang.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://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#ignore_annotations KubernetesProvider#ignore_annotations}

ignoreLabelsOptional
  • Type: java.util.List<java.lang.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://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#ignore_labels KubernetesProvider#ignore_labels}

insecureOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether server should be accessed without verifying the TLS certificate.

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

passwordOptional
  • Type: java.lang.String

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

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

proxyUrlOptional
  • Type: java.lang.String

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

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

tlsServerNameOptional
  • Type: java.lang.String

Server name passed to the server for SNI and is used in the client to check server certificates against.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#tls_server_name KubernetesProvider#tls_server_name}

tokenOptional
  • Type: java.lang.String

Token to authenticate an service account.

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

usernameOptional
  • Type: java.lang.String

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

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

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
resetAlias No description.
resetClientCertificate No description.
resetClientKey No description.
resetClusterCaCertificate No description.
resetConfigContext No description.
resetConfigContextAuthInfo No description.
resetConfigContextCluster No description.
resetConfigPath No description.
resetConfigPaths No description.
resetExec No description.
resetExperiments No description.
resetHost No description.
resetIgnoreAnnotations No description.
resetIgnoreLabels No description.
resetInsecure No description.
resetPassword No description.
resetProxyUrl No description.
resetTlsServerName No description.
resetToken No description.
resetUsername No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

resetAlias 
public void resetAlias()
resetClientCertificate 
public void resetClientCertificate()
resetClientKey 
public void resetClientKey()
resetClusterCaCertificate 
public void resetClusterCaCertificate()
resetConfigContext 
public void resetConfigContext()
resetConfigContextAuthInfo 
public void resetConfigContextAuthInfo()
resetConfigContextCluster 
public void resetConfigContextCluster()
resetConfigPath 
public void resetConfigPath()
resetConfigPaths 
public void resetConfigPaths()
resetExec 
public void resetExec()
resetExperiments 
public void resetExperiments()
resetHost 
public void resetHost()
resetIgnoreAnnotations 
public void resetIgnoreAnnotations()
resetIgnoreLabels 
public void resetIgnoreLabels()
resetInsecure 
public void resetInsecure()
resetPassword 
public void resetPassword()
resetProxyUrl 
public void resetProxyUrl()
resetTlsServerName 
public void resetTlsServerName()
resetToken 
public void resetToken()
resetUsername 
public void resetUsername()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformProvider No description.
generateConfigForImport Generates CDKTF code for importing a KubernetesProvider resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.kubernetes.provider.KubernetesProvider;

KubernetesProvider.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.kubernetes.provider.KubernetesProvider;

KubernetesProvider.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformProvider 
import com.hashicorp.cdktf.providers.kubernetes.provider.KubernetesProvider;

KubernetesProvider.isTerraformProvider(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.kubernetes.provider.KubernetesProvider;

KubernetesProvider.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),KubernetesProvider.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTF code for importing a KubernetesProvider resource upon running "cdktf plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the KubernetesProvider to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing KubernetesProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the KubernetesProvider to import is found.

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
metaAttributes java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
terraformProviderSource java.lang.String No description.
alias java.lang.String No description.
aliasInput java.lang.String No description.
clientCertificateInput java.lang.String No description.
clientKeyInput java.lang.String No description.
clusterCaCertificateInput java.lang.String No description.
configContextAuthInfoInput java.lang.String No description.
configContextClusterInput java.lang.String No description.
configContextInput java.lang.String No description.
configPathInput java.lang.String No description.
configPathsInput java.util.List<java.lang.String> No description.
execInput com.hashicorp.cdktf.IResolvable OR java.util.List<KubernetesProviderExec> No description.
experimentsInput com.hashicorp.cdktf.IResolvable OR java.util.List<KubernetesProviderExperiments> No description.
hostInput java.lang.String No description.
ignoreAnnotationsInput java.util.List<java.lang.String> No description.
ignoreLabelsInput java.util.List<java.lang.String> No description.
insecureInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
passwordInput java.lang.String No description.
proxyUrlInput java.lang.String No description.
tlsServerNameInput java.lang.String No description.
tokenInput java.lang.String No description.
usernameInput java.lang.String No description.
clientCertificate java.lang.String No description.
clientKey java.lang.String No description.
clusterCaCertificate java.lang.String No description.
configContext java.lang.String No description.
configContextAuthInfo java.lang.String No description.
configContextCluster java.lang.String No description.
configPath java.lang.String No description.
configPaths java.util.List<java.lang.String> No description.
exec com.hashicorp.cdktf.IResolvable OR java.util.List<KubernetesProviderExec> No description.
experiments com.hashicorp.cdktf.IResolvable OR java.util.List<KubernetesProviderExperiments> No description.
host java.lang.String No description.
ignoreAnnotations java.util.List<java.lang.String> No description.
ignoreLabels java.util.List<java.lang.String> No description.
insecure java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
password java.lang.String No description.
proxyUrl java.lang.String No description.
tlsServerName java.lang.String No description.
token java.lang.String No description.
username java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
metaAttributesRequired 
public java.util.Map<java.lang.String, java.lang.Object> getMetaAttributes();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
terraformProviderSourceOptional 
public java.lang.String getTerraformProviderSource();
  • Type: java.lang.String
aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String
aliasInputOptional 
public java.lang.String getAliasInput();
  • Type: java.lang.String
clientCertificateInputOptional 
public java.lang.String getClientCertificateInput();
  • Type: java.lang.String
clientKeyInputOptional 
public java.lang.String getClientKeyInput();
  • Type: java.lang.String
clusterCaCertificateInputOptional 
public java.lang.String getClusterCaCertificateInput();
  • Type: java.lang.String
configContextAuthInfoInputOptional 
public java.lang.String getConfigContextAuthInfoInput();
  • Type: java.lang.String
configContextClusterInputOptional 
public java.lang.String getConfigContextClusterInput();
  • Type: java.lang.String
configContextInputOptional 
public java.lang.String getConfigContextInput();
  • Type: java.lang.String
configPathInputOptional 
public java.lang.String getConfigPathInput();
  • Type: java.lang.String
configPathsInputOptional 
public java.util.List<java.lang.String> getConfigPathsInput();
  • Type: java.util.List<java.lang.String>
execInputOptional 
public java.lang.Object getExecInput();
experimentsInputOptional 
public java.lang.Object getExperimentsInput();
hostInputOptional 
public java.lang.String getHostInput();
  • Type: java.lang.String
ignoreAnnotationsInputOptional 
public java.util.List<java.lang.String> getIgnoreAnnotationsInput();
  • Type: java.util.List<java.lang.String>
ignoreLabelsInputOptional 
public java.util.List<java.lang.String> getIgnoreLabelsInput();
  • Type: java.util.List<java.lang.String>
insecureInputOptional 
public java.lang.Object getInsecureInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
passwordInputOptional 
public java.lang.String getPasswordInput();
  • Type: java.lang.String
proxyUrlInputOptional 
public java.lang.String getProxyUrlInput();
  • Type: java.lang.String
tlsServerNameInputOptional 
public java.lang.String getTlsServerNameInput();
  • Type: java.lang.String
tokenInputOptional 
public java.lang.String getTokenInput();
  • Type: java.lang.String
usernameInputOptional 
public java.lang.String getUsernameInput();
  • Type: java.lang.String
clientCertificateOptional 
public java.lang.String getClientCertificate();
  • Type: java.lang.String
clientKeyOptional 
public java.lang.String getClientKey();
  • Type: java.lang.String
clusterCaCertificateOptional 
public java.lang.String getClusterCaCertificate();
  • Type: java.lang.String
configContextOptional 
public java.lang.String getConfigContext();
  • Type: java.lang.String
configContextAuthInfoOptional 
public java.lang.String getConfigContextAuthInfo();
  • Type: java.lang.String
configContextClusterOptional 
public java.lang.String getConfigContextCluster();
  • Type: java.lang.String
configPathOptional 
public java.lang.String getConfigPath();
  • Type: java.lang.String
configPathsOptional 
public java.util.List<java.lang.String> getConfigPaths();
  • Type: java.util.List<java.lang.String>
execOptional 
public java.lang.Object getExec();
experimentsOptional 
public java.lang.Object getExperiments();
hostOptional 
public java.lang.String getHost();
  • Type: java.lang.String
ignoreAnnotationsOptional 
public java.util.List<java.lang.String> getIgnoreAnnotations();
  • Type: java.util.List<java.lang.String>
ignoreLabelsOptional 
public java.util.List<java.lang.String> getIgnoreLabels();
  • Type: java.util.List<java.lang.String>
insecureOptional 
public java.lang.Object getInsecure();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
passwordOptional 
public java.lang.String getPassword();
  • Type: java.lang.String
proxyUrlOptional 
public java.lang.String getProxyUrl();
  • Type: java.lang.String
tlsServerNameOptional 
public java.lang.String getTlsServerName();
  • Type: java.lang.String
tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String
usernameOptional 
public java.lang.String getUsername();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

KubernetesProviderConfig

Initializer 

import com.hashicorp.cdktf.providers.kubernetes.provider.KubernetesProviderConfig;

KubernetesProviderConfig.builder()
//  .alias(java.lang.String)
//  .clientCertificate(java.lang.String)
//  .clientKey(java.lang.String)
//  .clusterCaCertificate(java.lang.String)
//  .configContext(java.lang.String)
//  .configContextAuthInfo(java.lang.String)
//  .configContextCluster(java.lang.String)
//  .configPath(java.lang.String)
//  .configPaths(java.util.List<java.lang.String>)
//  .exec(IResolvable)
//  .exec(java.util.List<KubernetesProviderExec>)
//  .experiments(IResolvable)
//  .experiments(java.util.List<KubernetesProviderExperiments>)
//  .host(java.lang.String)
//  .ignoreAnnotations(java.util.List<java.lang.String>)
//  .ignoreLabels(java.util.List<java.lang.String>)
//  .insecure(java.lang.Boolean)
//  .insecure(IResolvable)
//  .password(java.lang.String)
//  .proxyUrl(java.lang.String)
//  .tlsServerName(java.lang.String)
//  .token(java.lang.String)
//  .username(java.lang.String)
    .build();

Properties

Name Type Description
alias java.lang.String Alias name.
clientCertificate java.lang.String PEM-encoded client certificate for TLS authentication.
clientKey java.lang.String PEM-encoded client certificate key for TLS authentication.
clusterCaCertificate java.lang.String PEM-encoded root certificates bundle for TLS authentication.
configContext java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#config_context KubernetesProvider#config_context}.
configContextAuthInfo java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#config_context_auth_info KubernetesProvider#config_context_auth_info}.
configContextCluster java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#config_context_cluster KubernetesProvider#config_context_cluster}.
configPath java.lang.String Path to the kube config file. Can be set with KUBE_CONFIG_PATH.
configPaths java.util.List<java.lang.String> A list of paths to kube config files. Can be set with KUBE_CONFIG_PATHS environment variable.
exec com.hashicorp.cdktf.IResolvable OR java.util.List<KubernetesProviderExec> exec block.
experiments com.hashicorp.cdktf.IResolvable OR java.util.List<KubernetesProviderExperiments> experiments block.
host java.lang.String The hostname (in form of URI) of Kubernetes master.
ignoreAnnotations java.util.List<java.lang.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 java.util.List<java.lang.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 java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether server should be accessed without verifying the TLS certificate.
password java.lang.String The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint.
proxyUrl java.lang.String URL to the proxy to be used for all API requests.
tlsServerName java.lang.String Server name passed to the server for SNI and is used in the client to check server certificates against.
token java.lang.String Token to authenticate an service account.
username java.lang.String The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint.
aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String

Alias name.

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

clientCertificateOptional 
public java.lang.String getClientCertificate();
  • Type: java.lang.String

PEM-encoded client certificate for TLS authentication.

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

clientKeyOptional 
public java.lang.String getClientKey();
  • Type: java.lang.String

PEM-encoded client certificate key for TLS authentication.

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

clusterCaCertificateOptional 
public java.lang.String getClusterCaCertificate();
  • Type: java.lang.String

PEM-encoded root certificates bundle for TLS authentication.

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

configContextOptional 
public java.lang.String getConfigContext();
  • Type: java.lang.String

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

configContextAuthInfoOptional 
public java.lang.String getConfigContextAuthInfo();
  • Type: java.lang.String

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

configContextClusterOptional 
public java.lang.String getConfigContextCluster();
  • Type: java.lang.String

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

configPathOptional 
public java.lang.String getConfigPath();
  • Type: java.lang.String

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

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

configPathsOptional 
public java.util.List<java.lang.String> getConfigPaths();
  • Type: java.util.List<java.lang.String>

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

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

execOptional 
public java.lang.Object getExec();

exec block.

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

experimentsOptional 
public java.lang.Object getExperiments();

experiments block.

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

hostOptional 
public java.lang.String getHost();
  • Type: java.lang.String

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

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

ignoreAnnotationsOptional 
public java.util.List<java.lang.String> getIgnoreAnnotations();
  • Type: java.util.List<java.lang.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://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#ignore_annotations KubernetesProvider#ignore_annotations}

ignoreLabelsOptional 
public java.util.List<java.lang.String> getIgnoreLabels();
  • Type: java.util.List<java.lang.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://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#ignore_labels KubernetesProvider#ignore_labels}

insecureOptional 
public java.lang.Object getInsecure();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether server should be accessed without verifying the TLS certificate.

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

passwordOptional 
public java.lang.String getPassword();
  • Type: java.lang.String

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

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

proxyUrlOptional 
public java.lang.String getProxyUrl();
  • Type: java.lang.String

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

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

tlsServerNameOptional 
public java.lang.String getTlsServerName();
  • Type: java.lang.String

Server name passed to the server for SNI and is used in the client to check server certificates against.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#tls_server_name KubernetesProvider#tls_server_name}

tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String

Token to authenticate an service account.

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

usernameOptional 
public java.lang.String getUsername();
  • Type: java.lang.String

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

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

KubernetesProviderExec

Initializer 

import com.hashicorp.cdktf.providers.kubernetes.provider.KubernetesProviderExec;

KubernetesProviderExec.builder()
    .apiVersion(java.lang.String)
    .command(java.lang.String)
//  .args(java.util.List<java.lang.String>)
//  .env(java.util.Map<java.lang.String, java.lang.String>)
    .build();

Properties

Name Type Description
apiVersion java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#api_version KubernetesProvider#api_version}.
command java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#command KubernetesProvider#command}.
args java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#args KubernetesProvider#args}.
env java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#env KubernetesProvider#env}.
apiVersionRequired 
public java.lang.String getApiVersion();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#api_version KubernetesProvider#api_version}.

commandRequired 
public java.lang.String getCommand();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#command KubernetesProvider#command}.

argsOptional 
public java.util.List<java.lang.String> getArgs();
  • Type: java.util.List<java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#args KubernetesProvider#args}.

envOptional 
public java.util.Map<java.lang.String, java.lang.String> getEnv();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#env KubernetesProvider#env}.

KubernetesProviderExperiments

Initializer 

import com.hashicorp.cdktf.providers.kubernetes.provider.KubernetesProviderExperiments;

KubernetesProviderExperiments.builder()
//  .manifestResource(java.lang.Boolean)
//  .manifestResource(IResolvable)
    .build();

Properties

Name Type Description
manifestResource java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enable the kubernetes_manifest resource.
manifestResourceOptional 
public java.lang.Object getManifestResource();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Enable the kubernetes_manifest resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.35.1/docs#manifest_resource KubernetesProvider#manifest_resource}