Skip to content

Latest commit

 

History

History
1323 lines (830 loc) · 50.6 KB

provider.csharp.md

File metadata and controls

1323 lines (830 loc) · 50.6 KB

provider Submodule

Constructs

HelmProvider

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

Initializers 

using HashiCorp.Cdktf.Providers.Helm;

new HelmProvider(Construct Scope, string Id, HelmProviderConfig Config = null);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config HelmProviderConfig No description.
ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

ConfigOptional

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 
private string ToString()

Returns a string representation of this construct.

AddOverride 
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string
ValueRequired
  • Type: object
OverrideLogicalId 
private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
private void ResetOverrideLogicalId()

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

ToHclTerraform 
private object ToHclTerraform()
ToMetadata 
private object ToMetadata()
ToTerraform 
private object ToTerraform()

Adds this resource to the terraform JSON output.

ResetAlias 
private void ResetAlias()
ResetBurstLimit 
private void ResetBurstLimit()
ResetDebug 
private void ResetDebug()
ResetExperiments 
private void ResetExperiments()
ResetHelmDriver 
private void ResetHelmDriver()
ResetKubernetes 
private void ResetKubernetes()
ResetPluginsPath 
private void ResetPluginsPath()
ResetRegistry 
private void ResetRegistry()
ResetRegistryConfigPath 
private void ResetRegistryConfigPath()
ResetRepositoryCache 
private void ResetRepositoryCache()
ResetRepositoryConfigPath 
private 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 
using HashiCorp.Cdktf.Providers.Helm;

HelmProvider.IsConstruct(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: object

Any object.

IsTerraformElement 
using HashiCorp.Cdktf.Providers.Helm;

HelmProvider.IsTerraformElement(object X);
XRequired
  • Type: object
IsTerraformProvider 
using HashiCorp.Cdktf.Providers.Helm;

HelmProvider.IsTerraformProvider(object X);
XRequired
  • Type: object
GenerateConfigForImport 
using HashiCorp.Cdktf.Providers.Helm;

HelmProvider.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.

ImportToIdRequired
  • Type: string

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

ImportFromIdRequired
  • Type: string

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: HashiCorp.Cdktf.TerraformProvider

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

Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
MetaAttributes System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
TerraformProviderSource string No description.
Alias string No description.
AliasInput string No description.
BurstLimitInput double No description.
DebugInput object No description.
ExperimentsInput HelmProviderExperiments No description.
HelmDriverInput string No description.
KubernetesInput HelmProviderKubernetes No description.
PluginsPathInput string No description.
RegistryConfigPathInput string No description.
RegistryInput object No description.
RepositoryCacheInput string No description.
RepositoryConfigPathInput string No description.
BurstLimit double No description.
Debug object No description.
Experiments HelmProviderExperiments No description.
HelmDriver string No description.
Kubernetes HelmProviderKubernetes No description.
PluginsPath string No description.
Registry object No description.
RegistryConfigPath string No description.
RepositoryCache string No description.
RepositoryConfigPath string No description.
NodeRequired 
public Node Node { get; }
  • Type: Constructs.Node

The tree node.

CdktfStackRequired 
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack
FqnRequired 
public string Fqn { get; }
  • Type: string
FriendlyUniqueIdRequired 
public string FriendlyUniqueId { get; }
  • Type: string
MetaAttributesRequired 
public System.Collections.Generic.IDictionary<string, object> MetaAttributes { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>
TerraformResourceTypeRequired 
public string TerraformResourceType { get; }
  • Type: string
TerraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
TerraformProviderSourceOptional 
public string TerraformProviderSource { get; }
  • Type: string
AliasOptional 
public string Alias { get; }
  • Type: string
AliasInputOptional 
public string AliasInput { get; }
  • Type: string
BurstLimitInputOptional 
public double BurstLimitInput { get; }
  • Type: double
DebugInputOptional 
public object DebugInput { get; }
  • Type: object
ExperimentsInputOptional 
public HelmProviderExperiments ExperimentsInput { get; }
HelmDriverInputOptional 
public string HelmDriverInput { get; }
  • Type: string
KubernetesInputOptional 
public HelmProviderKubernetes KubernetesInput { get; }
PluginsPathInputOptional 
public string PluginsPathInput { get; }
  • Type: string
RegistryConfigPathInputOptional 
public string RegistryConfigPathInput { get; }
  • Type: string
RegistryInputOptional 
public object RegistryInput { get; }
  • Type: object
RepositoryCacheInputOptional 
public string RepositoryCacheInput { get; }
  • Type: string
RepositoryConfigPathInputOptional 
public string RepositoryConfigPathInput { get; }
  • Type: string
BurstLimitOptional 
public double BurstLimit { get; }
  • Type: double
DebugOptional 
public object Debug { get; }
  • Type: object
ExperimentsOptional 
public HelmProviderExperiments Experiments { get; }
HelmDriverOptional 
public string HelmDriver { get; }
  • Type: string
KubernetesOptional 
public HelmProviderKubernetes Kubernetes { get; }
PluginsPathOptional 
public string PluginsPath { get; }
  • Type: string
RegistryOptional 
public object Registry { get; }
  • Type: object
RegistryConfigPathOptional 
public string RegistryConfigPath { get; }
  • Type: string
RepositoryCacheOptional 
public string RepositoryCache { get; }
  • Type: string
RepositoryConfigPathOptional 
public string RepositoryConfigPath { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.
TfResourceTypeRequired 
public string TfResourceType { get; }
  • Type: string

Structs

HelmProviderConfig

Initializer 

using HashiCorp.Cdktf.Providers.Helm;

new HelmProviderConfig {
    string Alias = null,
    double BurstLimit = null,
    object Debug = null,
    HelmProviderExperiments Experiments = null,
    string HelmDriver = null,
    HelmProviderKubernetes Kubernetes = null,
    string PluginsPath = null,
    object Registry = null,
    string RegistryConfigPath = null,
    string RepositoryCache = null,
    string RepositoryConfigPath = null
};

Properties

Name Type Description
Alias string Alias name.
BurstLimit double Helm burst limit. Increase this if you have a cluster with many CRDs.
Debug object Debug indicates whether or not Helm is running in Debug mode.
Experiments HelmProviderExperiments experiments block.
HelmDriver string The backend storage driver. Values are: configmap, secret, memory, sql.
Kubernetes HelmProviderKubernetes kubernetes block.
PluginsPath string The path to the helm plugins directory.
Registry object registry block.
RegistryConfigPath string The path to the registry config file.
RepositoryCache string The path to the file containing cached repository indexes.
RepositoryConfigPath string The path to the file containing repository names and URLs.
AliasOptional 
public string Alias { get; set; }
  • Type: string

Alias name.

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

BurstLimitOptional 
public double BurstLimit { get; set; }
  • Type: double

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 
public object Debug { get; set; }
  • Type: object

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 
public HelmProviderExperiments Experiments { get; set; }

experiments block.

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

HelmDriverOptional 
public string HelmDriver { get; set; }
  • Type: string

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 
public HelmProviderKubernetes Kubernetes { get; set; }

kubernetes block.

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

PluginsPathOptional 
public string PluginsPath { get; set; }
  • Type: string

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 
public object Registry { get; set; }
  • Type: object

registry block.

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

RegistryConfigPathOptional 
public string RegistryConfigPath { get; set; }
  • Type: string

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}

RepositoryCacheOptional 
public string RepositoryCache { get; set; }
  • Type: string

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}

RepositoryConfigPathOptional 
public string RepositoryConfigPath { get; set; }
  • Type: string

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 

using HashiCorp.Cdktf.Providers.Helm;

new HelmProviderExperiments {
    object Manifest = null
};

Properties

Name Type Description
Manifest object Enable full diff by storing the rendered manifest in the state.
ManifestOptional 
public object Manifest { get; set; }
  • Type: object

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 

using HashiCorp.Cdktf.Providers.Helm;

new HelmProviderKubernetes {
    string ClientCertificate = null,
    string ClientKey = null,
    string ClusterCaCertificate = null,
    string ConfigContext = null,
    string ConfigContextAuthInfo = null,
    string ConfigContextCluster = null,
    string ConfigPath = null,
    string[] ConfigPaths = null,
    HelmProviderKubernetesExec Exec = null,
    string Host = null,
    object Insecure = null,
    string Password = null,
    string ProxyUrl = null,
    string TlsServerName = null,
    string Token = null,
    string Username = null
};

Properties

Name Type Description
ClientCertificate string PEM-encoded client certificate for TLS authentication.
ClientKey string PEM-encoded client certificate key for TLS authentication.
ClusterCaCertificate string PEM-encoded root certificates bundle for TLS authentication.
ConfigContext string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.17.0/docs#config_context HelmProvider#config_context}.
ConfigContextAuthInfo string 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}.
ConfigContextCluster string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.17.0/docs#config_context_cluster HelmProvider#config_context_cluster}.
ConfigPath string Path to the kube config file. Can be set with KUBE_CONFIG_PATH.
ConfigPaths string[] A list of paths to kube config files. Can be set with KUBE_CONFIG_PATHS environment variable.
Exec HelmProviderKubernetesExec exec block.
Host string The hostname (in form of URI) of Kubernetes master.
Insecure object Whether server should be accessed without verifying the TLS certificate.
Password string The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint.
ProxyUrl string URL to the proxy to be used for all API requests.
TlsServerName string Server name passed to the server for SNI and is used in the client to check server certificates against.
Token string Token to authenticate an service account.
Username string The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint.
ClientCertificateOptional 
public string ClientCertificate { get; set; }
  • Type: string

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}

ClientKeyOptional 
public string ClientKey { get; set; }
  • Type: string

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}

ClusterCaCertificateOptional 
public string ClusterCaCertificate { get; set; }
  • Type: string

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}

ConfigContextOptional 
public string ConfigContext { get; set; }
  • Type: string

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

ConfigContextAuthInfoOptional 
public string ConfigContextAuthInfo { get; set; }
  • Type: string

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}.

ConfigContextClusterOptional 
public string ConfigContextCluster { get; set; }
  • Type: string

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

ConfigPathOptional 
public string ConfigPath { get; set; }
  • Type: 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.17.0/docs#config_path HelmProvider#config_path}

ConfigPathsOptional 
public string[] ConfigPaths { get; set; }
  • Type: string[]

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

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

ExecOptional 
public HelmProviderKubernetesExec Exec { get; set; }

exec block.

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

HostOptional 
public string Host { get; set; }
  • Type: string

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 
public object Insecure { get; set; }
  • Type: object

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 
public string Password { get; set; }
  • Type: 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.17.0/docs#password HelmProvider#password}

ProxyUrlOptional 
public string ProxyUrl { get; set; }
  • Type: 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.17.0/docs#proxy_url HelmProvider#proxy_url}

TlsServerNameOptional 
public string TlsServerName { get; set; }
  • Type: 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.17.0/docs#tls_server_name HelmProvider#tls_server_name}

TokenOptional 
public string Token { get; set; }
  • Type: string

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 
public string Username { get; set; }
  • Type: 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.17.0/docs#username HelmProvider#username}

HelmProviderKubernetesExec

Initializer 

using HashiCorp.Cdktf.Providers.Helm;

new HelmProviderKubernetesExec {
    string ApiVersion,
    string Command,
    string[] Args = null,
    System.Collections.Generic.IDictionary<string, string> Env = null
};

Properties

Name Type Description
ApiVersion string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.17.0/docs#api_version HelmProvider#api_version}.
Command string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.17.0/docs#command HelmProvider#command}.
Args string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.17.0/docs#args HelmProvider#args}.
Env System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/helm/2.17.0/docs#env HelmProvider#env}.
ApiVersionRequired 
public string ApiVersion { get; set; }
  • Type: string

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

CommandRequired 
public string Command { get; set; }
  • Type: string

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

ArgsOptional 
public string[] Args { get; set; }
  • Type: string[]

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

EnvOptional 
public System.Collections.Generic.IDictionary<string, string> Env { get; set; }
  • Type: System.Collections.Generic.IDictionary<string, string>

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

HelmProviderRegistry

Initializer 

using HashiCorp.Cdktf.Providers.Helm;

new HelmProviderRegistry {
    string Password,
    string Url,
    string Username
};

Properties

Name Type Description
Password string The password to use for the OCI HTTP basic authentication when accessing the Kubernetes master endpoint.
Url string OCI URL in form of oci://host:port or oci://host.
Username string The username to use for the OCI HTTP basic authentication when accessing the Kubernetes master endpoint.
PasswordRequired 
public string Password { get; set; }
  • Type: 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.17.0/docs#password HelmProvider#password}

UrlRequired 
public string Url { get; set; }
  • Type: 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.17.0/docs#url HelmProvider#url}

UsernameRequired 
public string Username { get; set; }
  • Type: 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.17.0/docs#username HelmProvider#username}