Skip to content

Latest commit

 

History

History
1467 lines (922 loc) · 57.5 KB

provider.python.md

File metadata and controls

1467 lines (922 loc) · 57.5 KB

provider Submodule

Constructs

HelmProvider

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

Initializers 

from cdktf_cdktf_provider_helm import provider

provider.HelmProvider(
  scope: Construct,
  id: str,
  alias: str = None,
  burst_limit: typing.Union[int, float] = None,
  debug: typing.Union[bool, IResolvable] = None,
  experiments: HelmProviderExperiments = None,
  helm_driver: str = None,
  kubernetes: HelmProviderKubernetes = None,
  plugins_path: str = None,
  registry: typing.Union[IResolvable, typing.List[HelmProviderRegistry]] = None,
  registry_config_path: str = None,
  repository_cache: str = None,
  repository_config_path: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
alias str Alias name.
burst_limit typing.Union[int, float] Helm burst limit. Increase this if you have a cluster with many CRDs.
debug typing.Union[bool, cdktf.IResolvable] Debug indicates whether or not Helm is running in Debug mode.
experiments HelmProviderExperiments experiments block.
helm_driver str The backend storage driver. Values are: configmap, secret, memory, sql.
kubernetes HelmProviderKubernetes kubernetes block.
plugins_path str The path to the helm plugins directory.
registry typing.Union[cdktf.IResolvable, typing.List[HelmProviderRegistry]] registry block.
registry_config_path str The path to the registry config file.
repository_cache str The path to the file containing cached repository indexes.
repository_config_path str The path to the file containing repository names and URLs.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

aliasOptional
  • Type: str

Alias name.

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

burst_limitOptional
  • Type: typing.Union[int, float]

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.17.0/docs#burst_limit HelmProvider#burst_limit}

debugOptional
  • Type: typing.Union[bool, 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.17.0/docs#debug HelmProvider#debug}

experimentsOptional

experiments block.

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

helm_driverOptional
  • Type: str

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

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

kubernetesOptional

kubernetes block.

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

plugins_pathOptional
  • Type: str

The path to the helm plugins directory.

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

registryOptional

registry block.

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

registry_config_pathOptional
  • Type: str

The path to the registry config file.

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

repository_cacheOptional
  • Type: str

The path to the file containing cached repository indexes.

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

repository_config_pathOptional
  • Type: str

The path to the file containing repository names and URLs.

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

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
reset_alias No description.
reset_burst_limit No description.
reset_debug No description.
reset_experiments No description.
reset_helm_driver No description.
reset_kubernetes No description.
reset_plugins_path No description.
reset_registry No description.
reset_registry_config_path No description.
reset_repository_cache No description.
reset_repository_config_path No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

reset_alias 
def reset_alias() -> None
reset_burst_limit 
def reset_burst_limit() -> None
reset_debug 
def reset_debug() -> None
reset_experiments 
def reset_experiments() -> None
reset_helm_driver 
def reset_helm_driver() -> None
reset_kubernetes 
def reset_kubernetes() -> None
reset_plugins_path 
def reset_plugins_path() -> None
reset_registry 
def reset_registry() -> None
reset_registry_config_path 
def reset_registry_config_path() -> None
reset_repository_cache 
def reset_repository_cache() -> None
reset_repository_config_path 
def reset_repository_config_path() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_provider No description.
generate_config_for_import Generates CDKTF code for importing a HelmProvider resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_helm import provider

provider.HelmProvider.is_construct(
  x: typing.Any
)

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: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_helm import provider

provider.HelmProvider.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_provider 
from cdktf_cdktf_provider_helm import provider

provider.HelmProvider.is_terraform_provider(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_helm import provider

provider.HelmProvider.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

The id of the existing HelmProvider that should be imported.

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

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
meta_attributes typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
terraform_provider_source str No description.
alias str No description.
alias_input str No description.
burst_limit_input typing.Union[int, float] No description.
debug_input typing.Union[bool, cdktf.IResolvable] No description.
experiments_input HelmProviderExperiments No description.
helm_driver_input str No description.
kubernetes_input HelmProviderKubernetes No description.
plugins_path_input str No description.
registry_config_path_input str No description.
registry_input typing.Union[cdktf.IResolvable, typing.List[HelmProviderRegistry]] No description.
repository_cache_input str No description.
repository_config_path_input str No description.
burst_limit typing.Union[int, float] No description.
debug typing.Union[bool, cdktf.IResolvable] No description.
experiments HelmProviderExperiments No description.
helm_driver str No description.
kubernetes HelmProviderKubernetes No description.
plugins_path str No description.
registry typing.Union[cdktf.IResolvable, typing.List[HelmProviderRegistry]] No description.
registry_config_path str No description.
repository_cache str No description.
repository_config_path str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
meta_attributesRequired 
meta_attributes: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
terraform_provider_sourceOptional 
terraform_provider_source: str
  • Type: str
aliasOptional 
alias: str
  • Type: str
alias_inputOptional 
alias_input: str
  • Type: str
burst_limit_inputOptional 
burst_limit_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
debug_inputOptional 
debug_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
experiments_inputOptional 
experiments_input: HelmProviderExperiments
helm_driver_inputOptional 
helm_driver_input: str
  • Type: str
kubernetes_inputOptional 
kubernetes_input: HelmProviderKubernetes
plugins_path_inputOptional 
plugins_path_input: str
  • Type: str
registry_config_path_inputOptional 
registry_config_path_input: str
  • Type: str
registry_inputOptional 
registry_input: typing.Union[IResolvable, typing.List[HelmProviderRegistry]]
repository_cache_inputOptional 
repository_cache_input: str
  • Type: str
repository_config_path_inputOptional 
repository_config_path_input: str
  • Type: str
burst_limitOptional 
burst_limit: typing.Union[int, float]
  • Type: typing.Union[int, float]
debugOptional 
debug: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
experimentsOptional 
experiments: HelmProviderExperiments
helm_driverOptional 
helm_driver: str
  • Type: str
kubernetesOptional 
kubernetes: HelmProviderKubernetes
plugins_pathOptional 
plugins_path: str
  • Type: str
registryOptional 
registry: typing.Union[IResolvable, typing.List[HelmProviderRegistry]]
registry_config_pathOptional 
registry_config_path: str
  • Type: str
repository_cacheOptional 
repository_cache: str
  • Type: str
repository_config_pathOptional 
repository_config_path: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

HelmProviderConfig

Initializer 

from cdktf_cdktf_provider_helm import provider

provider.HelmProviderConfig(
  alias: str = None,
  burst_limit: typing.Union[int, float] = None,
  debug: typing.Union[bool, IResolvable] = None,
  experiments: HelmProviderExperiments = None,
  helm_driver: str = None,
  kubernetes: HelmProviderKubernetes = None,
  plugins_path: str = None,
  registry: typing.Union[IResolvable, typing.List[HelmProviderRegistry]] = None,
  registry_config_path: str = None,
  repository_cache: str = None,
  repository_config_path: str = None
)

Properties

Name Type Description
alias str Alias name.
burst_limit typing.Union[int, float] Helm burst limit. Increase this if you have a cluster with many CRDs.
debug typing.Union[bool, cdktf.IResolvable] Debug indicates whether or not Helm is running in Debug mode.
experiments HelmProviderExperiments experiments block.
helm_driver str The backend storage driver. Values are: configmap, secret, memory, sql.
kubernetes HelmProviderKubernetes kubernetes block.
plugins_path str The path to the helm plugins directory.
registry typing.Union[cdktf.IResolvable, typing.List[HelmProviderRegistry]] registry block.
registry_config_path str The path to the registry config file.
repository_cache str The path to the file containing cached repository indexes.
repository_config_path str The path to the file containing repository names and URLs.
aliasOptional 
alias: str
  • Type: str

Alias name.

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

burst_limitOptional 
burst_limit: typing.Union[int, float]
  • Type: typing.Union[int, float]

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.17.0/docs#burst_limit HelmProvider#burst_limit}

debugOptional 
debug: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.17.0/docs#debug HelmProvider#debug}

experimentsOptional 
experiments: HelmProviderExperiments

experiments block.

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

helm_driverOptional 
helm_driver: str
  • Type: str

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

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

kubernetesOptional 
kubernetes: HelmProviderKubernetes

kubernetes block.

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

plugins_pathOptional 
plugins_path: str
  • Type: str

The path to the helm plugins directory.

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

registryOptional 
registry: typing.Union[IResolvable, typing.List[HelmProviderRegistry]]

registry block.

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

registry_config_pathOptional 
registry_config_path: str
  • Type: str

The path to the registry config file.

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

repository_cacheOptional 
repository_cache: str
  • Type: str

The path to the file containing cached repository indexes.

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

repository_config_pathOptional 
repository_config_path: str
  • Type: str

The path to the file containing repository names and URLs.

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

HelmProviderExperiments

Initializer 

from cdktf_cdktf_provider_helm import provider

provider.HelmProviderExperiments(
  manifest: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
manifest typing.Union[bool, cdktf.IResolvable] Enable full diff by storing the rendered manifest in the state.
manifestOptional 
manifest: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.17.0/docs#manifest HelmProvider#manifest}

HelmProviderKubernetes

Initializer 

from cdktf_cdktf_provider_helm import provider

provider.HelmProviderKubernetes(
  client_certificate: str = None,
  client_key: str = None,
  cluster_ca_certificate: str = None,
  config_context: str = None,
  config_context_auth_info: str = None,
  config_context_cluster: str = None,
  config_path: str = None,
  config_paths: typing.List[str] = None,
  exec: HelmProviderKubernetesExec = None,
  host: str = None,
  insecure: typing.Union[bool, IResolvable] = None,
  password: str = None,
  proxy_url: str = None,
  tls_server_name: str = None,
  token: str = None,
  username: str = None
)

Properties

Name Type Description
client_certificate str PEM-encoded client certificate for TLS authentication.
client_key str PEM-encoded client certificate key for TLS authentication.
cluster_ca_certificate str PEM-encoded root certificates bundle for TLS authentication.
config_context str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.17.0/docs#config_context HelmProvider#config_context}.
config_context_auth_info str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.17.0/docs#config_context_auth_info HelmProvider#config_context_auth_info}.
config_context_cluster str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.17.0/docs#config_context_cluster HelmProvider#config_context_cluster}.
config_path str Path to the kube config file. Can be set with KUBE_CONFIG_PATH.
config_paths typing.List[str] A list of paths to kube config files. Can be set with KUBE_CONFIG_PATHS environment variable.
exec HelmProviderKubernetesExec exec block.
host str The hostname (in form of URI) of Kubernetes master.
insecure typing.Union[bool, cdktf.IResolvable] Whether server should be accessed without verifying the TLS certificate.
password str The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint.
proxy_url str URL to the proxy to be used for all API requests.
tls_server_name str Server name passed to the server for SNI and is used in the client to check server certificates against.
token str Token to authenticate an service account.
username str The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint.
client_certificateOptional 
client_certificate: str
  • Type: str

PEM-encoded client certificate for TLS authentication.

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

client_keyOptional 
client_key: str
  • Type: str

PEM-encoded client certificate key for TLS authentication.

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

cluster_ca_certificateOptional 
cluster_ca_certificate: str
  • Type: str

PEM-encoded root certificates bundle for TLS authentication.

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

config_contextOptional 
config_context: str
  • Type: str

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

config_context_auth_infoOptional 
config_context_auth_info: str
  • Type: str

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

config_context_clusterOptional 
config_context_cluster: str
  • Type: str

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

config_pathOptional 
config_path: str
  • Type: str

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.17.0/docs#config_path HelmProvider#config_path}

config_pathsOptional 
config_paths: typing.List[str]
  • Type: typing.List[str]

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.17.0/docs#config_paths HelmProvider#config_paths}

execOptional 
exec: HelmProviderKubernetesExec

exec block.

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

hostOptional 
host: str
  • Type: str

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

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

insecureOptional 
insecure: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.17.0/docs#insecure HelmProvider#insecure}

passwordOptional 
password: str
  • Type: str

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.17.0/docs#password HelmProvider#password}

proxy_urlOptional 
proxy_url: str
  • Type: str

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

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

tls_server_nameOptional 
tls_server_name: str
  • Type: str

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.17.0/docs#tls_server_name HelmProvider#tls_server_name}

tokenOptional 
token: str
  • Type: str

Token to authenticate an service account.

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

usernameOptional 
username: str
  • Type: str

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.17.0/docs#username HelmProvider#username}

HelmProviderKubernetesExec

Initializer 

from cdktf_cdktf_provider_helm import provider

provider.HelmProviderKubernetesExec(
  api_version: str,
  command: str,
  args: typing.List[str] = None,
  env: typing.Mapping[str] = None
)

Properties

Name Type Description
api_version str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.17.0/docs#api_version HelmProvider#api_version}.
command str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.17.0/docs#command HelmProvider#command}.
args typing.List[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.17.0/docs#args HelmProvider#args}.
env typing.Mapping[str] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.17.0/docs#env HelmProvider#env}.
api_versionRequired 
api_version: str
  • Type: str

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

commandRequired 
command: str
  • Type: str

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

argsOptional 
args: typing.List[str]
  • Type: typing.List[str]

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

envOptional 
env: typing.Mapping[str]
  • Type: typing.Mapping[str]

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

HelmProviderRegistry

Initializer 

from cdktf_cdktf_provider_helm import provider

provider.HelmProviderRegistry(
  password: str,
  url: str,
  username: str
)

Properties

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

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.17.0/docs#password HelmProvider#password}

urlRequired 
url: str
  • Type: str

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

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

usernameRequired 
username: str
  • Type: str

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.17.0/docs#username HelmProvider#username}