Skip to content

Latest commit

 

History

History
1455 lines (910 loc) · 60.4 KB

provider.java.md

File metadata and controls

1455 lines (910 loc) · 60.4 KB

provider Submodule

Constructs

HelmProvider

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

Initializers

import com.hashicorp.cdktf.providers.helm.provider.HelmProvider;

HelmProvider.Builder.create(Construct scope, java.lang.String id)
//  .alias(java.lang.String)
//  .burstLimit(java.lang.Number)
//  .debug(java.lang.Boolean)
//  .debug(IResolvable)
//  .experiments(HelmProviderExperiments)
//  .helmDriver(java.lang.String)
//  .kubernetes(HelmProviderKubernetes)
//  .pluginsPath(java.lang.String)
//  .registry(IResolvable)
//  .registry(java.util.List<HelmProviderRegistry>)
//  .registryConfigPath(java.lang.String)
//  .repositoryCache(java.lang.String)
//  .repositoryConfigPath(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.
burstLimit java.lang.Number Helm burst limit. Increase this if you have a cluster with many CRDs.
debug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Debug indicates whether or not Helm is running in Debug mode.
experiments HelmProviderExperiments experiments block.
helmDriver java.lang.String The backend storage driver. Values are: configmap, secret, memory, sql.
kubernetes HelmProviderKubernetes kubernetes block.
pluginsPath java.lang.String The path to the helm plugins directory.
registry com.hashicorp.cdktf.IResolvable OR java.util.List<HelmProviderRegistry> registry block.
registryConfigPath java.lang.String The path to the registry config file.
repositoryCache java.lang.String The path to the file containing cached repository indexes.
repositoryConfigPath java.lang.String The path to the file containing repository names and URLs.

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/helm/2.16.1/docs#alias HelmProvider#alias}


burstLimitOptional
  • Type: java.lang.Number

Helm burst limit. Increase this if you have a cluster with many CRDs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#burst_limit HelmProvider#burst_limit}


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

Debug indicates whether or not Helm is running in Debug mode.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#debug HelmProvider#debug}


experimentsOptional

experiments block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#experiments HelmProvider#experiments}


helmDriverOptional
  • Type: java.lang.String

The backend storage driver. Values are: configmap, secret, memory, sql.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#helm_driver HelmProvider#helm_driver}


kubernetesOptional

kubernetes block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#kubernetes HelmProvider#kubernetes}


pluginsPathOptional
  • Type: java.lang.String

The path to the helm plugins directory.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#plugins_path HelmProvider#plugins_path}


registryOptional

registry block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#registry HelmProvider#registry}


registryConfigPathOptional
  • Type: java.lang.String

The path to the registry config file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#registry_config_path HelmProvider#registry_config_path}


repositoryCacheOptional
  • Type: java.lang.String

The path to the file containing cached repository indexes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#repository_cache HelmProvider#repository_cache}


repositoryConfigPathOptional
  • Type: java.lang.String

The path to the file containing repository names and URLs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#repository_config_path HelmProvider#repository_config_path}


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.
resetBurstLimit No description.
resetDebug No description.
resetExperiments No description.
resetHelmDriver No description.
resetKubernetes No description.
resetPluginsPath No description.
resetRegistry No description.
resetRegistryConfigPath No description.
resetRepositoryCache No description.
resetRepositoryConfigPath 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()
resetBurstLimit
public void resetBurstLimit()
resetDebug
public void resetDebug()
resetExperiments
public void resetExperiments()
resetHelmDriver
public void resetHelmDriver()
resetKubernetes
public void resetKubernetes()
resetPluginsPath
public void resetPluginsPath()
resetRegistry
public void resetRegistry()
resetRegistryConfigPath
public void resetRegistryConfigPath()
resetRepositoryCache
public void resetRepositoryCache()
resetRepositoryConfigPath
public void resetRepositoryConfigPath()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformProvider No description.
generateConfigForImport Generates CDKTF code for importing a HelmProvider resource upon running "cdktf plan ".

isConstruct
import com.hashicorp.cdktf.providers.helm.provider.HelmProvider;

HelmProvider.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.helm.provider.HelmProvider;

HelmProvider.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object

isTerraformProvider
import com.hashicorp.cdktf.providers.helm.provider.HelmProvider;

HelmProvider.isTerraformProvider(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import com.hashicorp.cdktf.providers.helm.provider.HelmProvider;

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

Generates CDKTF code for importing a HelmProvider 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 HelmProvider to import.


importFromIdRequired
  • Type: java.lang.String

The id of the existing HelmProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.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 HelmProvider 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.
burstLimitInput java.lang.Number No description.
debugInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
experimentsInput HelmProviderExperiments No description.
helmDriverInput java.lang.String No description.
kubernetesInput HelmProviderKubernetes No description.
pluginsPathInput java.lang.String No description.
registryConfigPathInput java.lang.String No description.
registryInput com.hashicorp.cdktf.IResolvable OR java.util.List<HelmProviderRegistry> No description.
repositoryCacheInput java.lang.String No description.
repositoryConfigPathInput java.lang.String No description.
burstLimit java.lang.Number No description.
debug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
experiments HelmProviderExperiments No description.
helmDriver java.lang.String No description.
kubernetes HelmProviderKubernetes No description.
pluginsPath java.lang.String No description.
registry com.hashicorp.cdktf.IResolvable OR java.util.List<HelmProviderRegistry> No description.
registryConfigPath java.lang.String No description.
repositoryCache java.lang.String No description.
repositoryConfigPath 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

burstLimitInputOptional
public java.lang.Number getBurstLimitInput();
  • Type: java.lang.Number

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

experimentsInputOptional
public HelmProviderExperiments getExperimentsInput();

helmDriverInputOptional
public java.lang.String getHelmDriverInput();
  • Type: java.lang.String

kubernetesInputOptional
public HelmProviderKubernetes getKubernetesInput();

pluginsPathInputOptional
public java.lang.String getPluginsPathInput();
  • Type: java.lang.String

registryConfigPathInputOptional
public java.lang.String getRegistryConfigPathInput();
  • Type: java.lang.String

registryInputOptional
public java.lang.Object getRegistryInput();

repositoryCacheInputOptional
public java.lang.String getRepositoryCacheInput();
  • Type: java.lang.String

repositoryConfigPathInputOptional
public java.lang.String getRepositoryConfigPathInput();
  • Type: java.lang.String

burstLimitOptional
public java.lang.Number getBurstLimit();
  • Type: java.lang.Number

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

experimentsOptional
public HelmProviderExperiments getExperiments();

helmDriverOptional
public java.lang.String getHelmDriver();
  • Type: java.lang.String

kubernetesOptional
public HelmProviderKubernetes getKubernetes();

pluginsPathOptional
public java.lang.String getPluginsPath();
  • Type: java.lang.String

registryOptional
public java.lang.Object getRegistry();

registryConfigPathOptional
public java.lang.String getRegistryConfigPath();
  • Type: java.lang.String

repositoryCacheOptional
public java.lang.String getRepositoryCache();
  • Type: java.lang.String

repositoryConfigPathOptional
public java.lang.String getRepositoryConfigPath();
  • 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

HelmProviderConfig

Initializer

import com.hashicorp.cdktf.providers.helm.provider.HelmProviderConfig;

HelmProviderConfig.builder()
//  .alias(java.lang.String)
//  .burstLimit(java.lang.Number)
//  .debug(java.lang.Boolean)
//  .debug(IResolvable)
//  .experiments(HelmProviderExperiments)
//  .helmDriver(java.lang.String)
//  .kubernetes(HelmProviderKubernetes)
//  .pluginsPath(java.lang.String)
//  .registry(IResolvable)
//  .registry(java.util.List<HelmProviderRegistry>)
//  .registryConfigPath(java.lang.String)
//  .repositoryCache(java.lang.String)
//  .repositoryConfigPath(java.lang.String)
    .build();

Properties

Name Type Description
alias java.lang.String Alias name.
burstLimit java.lang.Number Helm burst limit. Increase this if you have a cluster with many CRDs.
debug java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Debug indicates whether or not Helm is running in Debug mode.
experiments HelmProviderExperiments experiments block.
helmDriver java.lang.String The backend storage driver. Values are: configmap, secret, memory, sql.
kubernetes HelmProviderKubernetes kubernetes block.
pluginsPath java.lang.String The path to the helm plugins directory.
registry com.hashicorp.cdktf.IResolvable OR java.util.List<HelmProviderRegistry> registry block.
registryConfigPath java.lang.String The path to the registry config file.
repositoryCache java.lang.String The path to the file containing cached repository indexes.
repositoryConfigPath java.lang.String The path to the file containing repository names and URLs.

aliasOptional
public java.lang.String getAlias();
  • Type: java.lang.String

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#alias HelmProvider#alias}


burstLimitOptional
public java.lang.Number getBurstLimit();
  • Type: java.lang.Number

Helm burst limit. Increase this if you have a cluster with many CRDs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#burst_limit HelmProvider#burst_limit}


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

Debug indicates whether or not Helm is running in Debug mode.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#debug HelmProvider#debug}


experimentsOptional
public HelmProviderExperiments getExperiments();

experiments block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#experiments HelmProvider#experiments}


helmDriverOptional
public java.lang.String getHelmDriver();
  • Type: java.lang.String

The backend storage driver. Values are: configmap, secret, memory, sql.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#helm_driver HelmProvider#helm_driver}


kubernetesOptional
public HelmProviderKubernetes getKubernetes();

kubernetes block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#kubernetes HelmProvider#kubernetes}


pluginsPathOptional
public java.lang.String getPluginsPath();
  • Type: java.lang.String

The path to the helm plugins directory.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#plugins_path HelmProvider#plugins_path}


registryOptional
public java.lang.Object getRegistry();

registry block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#registry HelmProvider#registry}


registryConfigPathOptional
public java.lang.String getRegistryConfigPath();
  • Type: java.lang.String

The path to the registry config file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#registry_config_path HelmProvider#registry_config_path}


repositoryCacheOptional
public java.lang.String getRepositoryCache();
  • Type: java.lang.String

The path to the file containing cached repository indexes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#repository_cache HelmProvider#repository_cache}


repositoryConfigPathOptional
public java.lang.String getRepositoryConfigPath();
  • Type: java.lang.String

The path to the file containing repository names and URLs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#repository_config_path HelmProvider#repository_config_path}


HelmProviderExperiments

Initializer

import com.hashicorp.cdktf.providers.helm.provider.HelmProviderExperiments;

HelmProviderExperiments.builder()
//  .manifest(java.lang.Boolean)
//  .manifest(IResolvable)
    .build();

Properties

Name Type Description
manifest java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enable full diff by storing the rendered manifest in the state.

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

Enable full diff by storing the rendered manifest in the state.

This has similar limitations as when using helm install --dry-run. See https://helm.sh/docs/chart_best_practices/custom_resource_definitions/#install-a-crd-declaration-before-using-the-resource

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#manifest HelmProvider#manifest}


HelmProviderKubernetes

Initializer

import com.hashicorp.cdktf.providers.helm.provider.HelmProviderKubernetes;

HelmProviderKubernetes.builder()
//  .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(HelmProviderKubernetesExec)
//  .host(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
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/helm/2.16.1/docs#config_context HelmProvider#config_context}.
configContextAuthInfo java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#config_context_auth_info HelmProvider#config_context_auth_info}.
configContextCluster java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#config_context_cluster HelmProvider#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 HelmProviderKubernetesExec exec block.
host java.lang.String The hostname (in form of URI) of Kubernetes master.
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.

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/helm/2.16.1/docs#client_certificate HelmProvider#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/helm/2.16.1/docs#client_key HelmProvider#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/helm/2.16.1/docs#cluster_ca_certificate HelmProvider#cluster_ca_certificate}


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#config_context HelmProvider#config_context}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#config_context_auth_info HelmProvider#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/helm/2.16.1/docs#config_context_cluster HelmProvider#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/helm/2.16.1/docs#config_path HelmProvider#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/helm/2.16.1/docs#config_paths HelmProvider#config_paths}


execOptional
public HelmProviderKubernetesExec getExec();

exec block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#exec HelmProvider#exec}


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/helm/2.16.1/docs#host HelmProvider#host}


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/helm/2.16.1/docs#insecure HelmProvider#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/helm/2.16.1/docs#password HelmProvider#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/helm/2.16.1/docs#proxy_url HelmProvider#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/helm/2.16.1/docs#tls_server_name HelmProvider#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/helm/2.16.1/docs#token HelmProvider#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/helm/2.16.1/docs#username HelmProvider#username}


HelmProviderKubernetesExec

Initializer

import com.hashicorp.cdktf.providers.helm.provider.HelmProviderKubernetesExec;

HelmProviderKubernetesExec.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/helm/2.16.1/docs#api_version HelmProvider#api_version}.
command java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#command HelmProvider#command}.
args java.util.List<java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#args HelmProvider#args}.
env java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#env HelmProvider#env}.

apiVersionRequired
public java.lang.String getApiVersion();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#api_version HelmProvider#api_version}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#command HelmProvider#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/helm/2.16.1/docs#args HelmProvider#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/helm/2.16.1/docs#env HelmProvider#env}.


HelmProviderRegistry

Initializer

import com.hashicorp.cdktf.providers.helm.provider.HelmProviderRegistry;

HelmProviderRegistry.builder()
    .password(java.lang.String)
    .url(java.lang.String)
    .username(java.lang.String)
    .build();

Properties

Name Type Description
password java.lang.String The password to use for the OCI HTTP basic authentication when accessing the Kubernetes master endpoint.
url java.lang.String OCI URL in form of oci://host:port or oci://host.
username java.lang.String The username to use for the OCI HTTP basic authentication when accessing the Kubernetes master endpoint.

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#password HelmProvider#password}


urlRequired
public java.lang.String getUrl();
  • Type: java.lang.String

OCI URL in form of oci://host:port or oci://host.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#url HelmProvider#url}


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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.16.1/docs#username HelmProvider#username}