Skip to content

Latest commit

 

History

History
1390 lines (880 loc) · 54.9 KB

provider.csharp.md

File metadata and controls

1390 lines (880 loc) · 54.9 KB
Raw

provider Submodule

Constructs

KubernetesProvider

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

Initializers 

using HashiCorp.Cdktf.Providers.Kubernetes;

new KubernetesProvider(Construct Scope, string Id, KubernetesProviderConfig Config = null);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config KubernetesProviderConfig 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.
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 
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()
ResetClientCertificate 
private void ResetClientCertificate()
ResetClientKey 
private void ResetClientKey()
ResetClusterCaCertificate 
private void ResetClusterCaCertificate()
ResetConfigContext 
private void ResetConfigContext()
ResetConfigContextAuthInfo 
private void ResetConfigContextAuthInfo()
ResetConfigContextCluster 
private void ResetConfigContextCluster()
ResetConfigPath 
private void ResetConfigPath()
ResetConfigPaths 
private void ResetConfigPaths()
ResetExec 
private void ResetExec()
ResetExperiments 
private void ResetExperiments()
ResetHost 
private void ResetHost()
ResetIgnoreAnnotations 
private void ResetIgnoreAnnotations()
ResetIgnoreLabels 
private void ResetIgnoreLabels()
ResetInsecure 
private void ResetInsecure()
ResetPassword 
private void ResetPassword()
ResetProxyUrl 
private void ResetProxyUrl()
ResetTlsServerName 
private void ResetTlsServerName()
ResetToken 
private void ResetToken()
ResetUsername 
private 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 
using HashiCorp.Cdktf.Providers.Kubernetes;

KubernetesProvider.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.Kubernetes;

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

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

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

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

ImportFromIdRequired
  • Type: string

The id of the existing KubernetesProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.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 KubernetesProvider 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.
ClientCertificateInput string No description.
ClientKeyInput string No description.
ClusterCaCertificateInput string No description.
ConfigContextAuthInfoInput string No description.
ConfigContextClusterInput string No description.
ConfigContextInput string No description.
ConfigPathInput string No description.
ConfigPathsInput string[] No description.
ExecInput object No description.
ExperimentsInput object No description.
HostInput string No description.
IgnoreAnnotationsInput string[] No description.
IgnoreLabelsInput string[] No description.
InsecureInput object No description.
PasswordInput string No description.
ProxyUrlInput string No description.
TlsServerNameInput string No description.
TokenInput string No description.
UsernameInput string No description.
ClientCertificate string No description.
ClientKey string No description.
ClusterCaCertificate string No description.
ConfigContext string No description.
ConfigContextAuthInfo string No description.
ConfigContextCluster string No description.
ConfigPath string No description.
ConfigPaths string[] No description.
Exec object No description.
Experiments object No description.
Host string No description.
IgnoreAnnotations string[] No description.
IgnoreLabels string[] No description.
Insecure object No description.
Password string No description.
ProxyUrl string No description.
TlsServerName string No description.
Token string No description.
Username 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
ClientCertificateInputOptional 
public string ClientCertificateInput { get; }
  • Type: string
ClientKeyInputOptional 
public string ClientKeyInput { get; }
  • Type: string
ClusterCaCertificateInputOptional 
public string ClusterCaCertificateInput { get; }
  • Type: string
ConfigContextAuthInfoInputOptional 
public string ConfigContextAuthInfoInput { get; }
  • Type: string
ConfigContextClusterInputOptional 
public string ConfigContextClusterInput { get; }
  • Type: string
ConfigContextInputOptional 
public string ConfigContextInput { get; }
  • Type: string
ConfigPathInputOptional 
public string ConfigPathInput { get; }
  • Type: string
ConfigPathsInputOptional 
public string[] ConfigPathsInput { get; }
  • Type: string[]
ExecInputOptional 
public object ExecInput { get; }
  • Type: object
ExperimentsInputOptional 
public object ExperimentsInput { get; }
  • Type: object
HostInputOptional 
public string HostInput { get; }
  • Type: string
IgnoreAnnotationsInputOptional 
public string[] IgnoreAnnotationsInput { get; }
  • Type: string[]
IgnoreLabelsInputOptional 
public string[] IgnoreLabelsInput { get; }
  • Type: string[]
InsecureInputOptional 
public object InsecureInput { get; }
  • Type: object
PasswordInputOptional 
public string PasswordInput { get; }
  • Type: string
ProxyUrlInputOptional 
public string ProxyUrlInput { get; }
  • Type: string
TlsServerNameInputOptional 
public string TlsServerNameInput { get; }
  • Type: string
TokenInputOptional 
public string TokenInput { get; }
  • Type: string
UsernameInputOptional 
public string UsernameInput { get; }
  • Type: string
ClientCertificateOptional 
public string ClientCertificate { get; }
  • Type: string
ClientKeyOptional 
public string ClientKey { get; }
  • Type: string
ClusterCaCertificateOptional 
public string ClusterCaCertificate { get; }
  • Type: string
ConfigContextOptional 
public string ConfigContext { get; }
  • Type: string
ConfigContextAuthInfoOptional 
public string ConfigContextAuthInfo { get; }
  • Type: string
ConfigContextClusterOptional 
public string ConfigContextCluster { get; }
  • Type: string
ConfigPathOptional 
public string ConfigPath { get; }
  • Type: string
ConfigPathsOptional 
public string[] ConfigPaths { get; }
  • Type: string[]
ExecOptional 
public object Exec { get; }
  • Type: object
ExperimentsOptional 
public object Experiments { get; }
  • Type: object
HostOptional 
public string Host { get; }
  • Type: string
IgnoreAnnotationsOptional 
public string[] IgnoreAnnotations { get; }
  • Type: string[]
IgnoreLabelsOptional 
public string[] IgnoreLabels { get; }
  • Type: string[]
InsecureOptional 
public object Insecure { get; }
  • Type: object
PasswordOptional 
public string Password { get; }
  • Type: string
ProxyUrlOptional 
public string ProxyUrl { get; }
  • Type: string
TlsServerNameOptional 
public string TlsServerName { get; }
  • Type: string
TokenOptional 
public string Token { get; }
  • Type: string
UsernameOptional 
public string Username { get; }
  • Type: string

Constants

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

Structs

KubernetesProviderConfig

Initializer 

using HashiCorp.Cdktf.Providers.Kubernetes;

new KubernetesProviderConfig {
    string Alias = null,
    string ClientCertificate = null,
    string ClientKey = null,
    string ClusterCaCertificate = null,
    string ConfigContext = null,
    string ConfigContextAuthInfo = null,
    string ConfigContextCluster = null,
    string ConfigPath = null,
    string[] ConfigPaths = null,
    object Exec = null,
    object Experiments = null,
    string Host = null,
    string[] IgnoreAnnotations = null,
    string[] IgnoreLabels = null,
    object Insecure = null,
    string Password = null,
    string ProxyUrl = null,
    string TlsServerName = null,
    string Token = null,
    string Username = null
};

Properties

Name Type Description
Alias string Alias name.
ClientCertificate string PEM-encoded client certificate for TLS authentication.
ClientKey string PEM-encoded client certificate key for TLS authentication.
ClusterCaCertificate string PEM-encoded root certificates bundle for TLS authentication.
ConfigContext string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs#config_context KubernetesProvider#config_context}.
ConfigContextAuthInfo string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs#config_context_auth_info KubernetesProvider#config_context_auth_info}.
ConfigContextCluster string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs#config_context_cluster KubernetesProvider#config_context_cluster}.
ConfigPath string Path to the kube config file. Can be set with KUBE_CONFIG_PATH.
ConfigPaths string[] A list of paths to kube config files. Can be set with KUBE_CONFIG_PATHS environment variable.
Exec object exec block.
Experiments object experiments block.
Host string The hostname (in form of URI) of Kubernetes master.
IgnoreAnnotations string[] List of Kubernetes metadata annotations to ignore across all resources handled by this provider for situations where external systems are managing certain resource annotations.
IgnoreLabels string[] List of Kubernetes metadata labels to ignore across all resources handled by this provider for situations where external systems are managing certain resource labels.
Insecure 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.
AliasOptional 
public string Alias { get; set; }
  • Type: string

Alias name.

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

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/kubernetes/2.30.0/docs#client_certificate KubernetesProvider#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/kubernetes/2.30.0/docs#client_key KubernetesProvider#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/kubernetes/2.30.0/docs#cluster_ca_certificate KubernetesProvider#cluster_ca_certificate}

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

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

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

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

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

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

ExecOptional 
public object Exec { get; set; }
  • Type: object

exec block.

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

ExperimentsOptional 
public object Experiments { get; set; }
  • Type: object

experiments block.

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

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/kubernetes/2.30.0/docs#host KubernetesProvider#host}

IgnoreAnnotationsOptional 
public string[] IgnoreAnnotations { get; set; }
  • Type: string[]

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

Each item is a regular expression.

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

IgnoreLabelsOptional 
public string[] IgnoreLabels { get; set; }
  • Type: string[]

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

Each item is a regular expression.

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

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/kubernetes/2.30.0/docs#insecure KubernetesProvider#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/kubernetes/2.30.0/docs#password KubernetesProvider#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/kubernetes/2.30.0/docs#proxy_url KubernetesProvider#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/kubernetes/2.30.0/docs#tls_server_name KubernetesProvider#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/kubernetes/2.30.0/docs#token KubernetesProvider#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/kubernetes/2.30.0/docs#username KubernetesProvider#username}

KubernetesProviderExec

Initializer 

using HashiCorp.Cdktf.Providers.Kubernetes;

new KubernetesProviderExec {
    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/kubernetes/2.30.0/docs#api_version KubernetesProvider#api_version}.
Command string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs#command KubernetesProvider#command}.
Args string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs#args KubernetesProvider#args}.
Env System.Collections.Generic.IDictionary<string, string> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/kubernetes/2.30.0/docs#env KubernetesProvider#env}.
ApiVersionRequired 
public string ApiVersion { get; set; }
  • Type: string

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

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

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

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

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

KubernetesProviderExperiments

Initializer 

using HashiCorp.Cdktf.Providers.Kubernetes;

new KubernetesProviderExperiments {
    object ManifestResource = null
};

Properties

Name Type Description
ManifestResource object Enable the kubernetes_manifest resource.
ManifestResourceOptional 
public object ManifestResource { get; set; }
  • Type: object

Enable the kubernetes_manifest resource.

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