dataVaultKubernetesAuthBackendConfig.typescript.md

dataVaultKubernetesAuthBackendConfig Submodule

Constructs

DataVaultKubernetesAuthBackendConfig

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/kubernetes_auth_backend_config vault_kubernetes_auth_backend_config}.

Initializers

import { dataVaultKubernetesAuthBackendConfig } from '@cdktf/provider-vault'

new dataVaultKubernetesAuthBackendConfig.DataVaultKubernetesAuthBackendConfig(scope: Construct, id: string, config?: DataVaultKubernetesAuthBackendConfigConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	DataVaultKubernetesAuthBackendConfigConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Optional

• Type: DataVaultKubernetesAuthBackendConfigConfig

---

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	Adds this resource to the terraform JSON output.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resetBackend	No description.
resetDisableIssValidation	No description.
resetDisableLocalCaJwt	No description.
resetId	No description.
resetIssuer	No description.
resetKubernetesCaCert	No description.
resetKubernetesHost	No description.
resetNamespace	No description.
resetPemKeys	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toHclTerraform

public toHclTerraform(): any

Adds this resource to the terraform JSON output.

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

resetBackend

public resetBackend(): void

resetDisableIssValidation

public resetDisableIssValidation(): void

resetDisableLocalCaJwt

public resetDisableLocalCaJwt(): void

resetId

public resetId(): void

resetIssuer

public resetIssuer(): void

resetKubernetesCaCert

public resetKubernetesCaCert(): void

resetKubernetesHost

public resetKubernetesHost(): void

resetNamespace

public resetNamespace(): void

resetPemKeys

public resetPemKeys(): void

Static Functions

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

---

isConstruct

import { dataVaultKubernetesAuthBackendConfig } from '@cdktf/provider-vault'

dataVaultKubernetesAuthBackendConfig.DataVaultKubernetesAuthBackendConfig.isConstruct(x: 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.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { dataVaultKubernetesAuthBackendConfig } from '@cdktf/provider-vault'

dataVaultKubernetesAuthBackendConfig.DataVaultKubernetesAuthBackendConfig.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

import { dataVaultKubernetesAuthBackendConfig } from '@cdktf/provider-vault'

dataVaultKubernetesAuthBackendConfig.DataVaultKubernetesAuthBackendConfig.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { dataVaultKubernetesAuthBackendConfig } from '@cdktf/provider-vault'

dataVaultKubernetesAuthBackendConfig.DataVaultKubernetesAuthBackendConfig.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing DataVaultKubernetesAuthBackendConfig that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/kubernetes_auth_backend_config#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
backendInput	string	No description.
disableIssValidationInput	boolean | cdktf.IResolvable	No description.
disableLocalCaJwtInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
issuerInput	string	No description.
kubernetesCaCertInput	string	No description.
kubernetesHostInput	string	No description.
namespaceInput	string	No description.
pemKeysInput	string[]	No description.
backend	string	No description.
disableIssValidation	boolean | cdktf.IResolvable	No description.
disableLocalCaJwt	boolean | cdktf.IResolvable	No description.
id	string	No description.
issuer	string	No description.
kubernetesCaCert	string	No description.
kubernetesHost	string	No description.
namespace	string	No description.
pemKeys	string[]	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

backendInput^Optional

public readonly backendInput: string;

• Type: string

---

disableIssValidationInput^Optional

public readonly disableIssValidationInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

disableLocalCaJwtInput^Optional

public readonly disableLocalCaJwtInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

issuerInput^Optional

public readonly issuerInput: string;

• Type: string

---

kubernetesCaCertInput^Optional

public readonly kubernetesCaCertInput: string;

• Type: string

---

kubernetesHostInput^Optional

public readonly kubernetesHostInput: string;

• Type: string

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

pemKeysInput^Optional

public readonly pemKeysInput: string[];

• Type: string[]

---

backend^Required

public readonly backend: string;

• Type: string

---

disableIssValidation^Required

public readonly disableIssValidation: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

disableLocalCaJwt^Required

public readonly disableLocalCaJwt: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

issuer^Required

public readonly issuer: string;

• Type: string

---

kubernetesCaCert^Required

public readonly kubernetesCaCert: string;

• Type: string

---

kubernetesHost^Required

public readonly kubernetesHost: string;

• Type: string

---

namespace^Required

public readonly namespace: string;

• Type: string

---

pemKeys^Required

public readonly pemKeys: string[];

• Type: string[]

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataVaultKubernetesAuthBackendConfigConfig

Initializer

import { dataVaultKubernetesAuthBackendConfig } from '@cdktf/provider-vault'

const dataVaultKubernetesAuthBackendConfigConfig: dataVaultKubernetesAuthBackendConfig.DataVaultKubernetesAuthBackendConfigConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
backend	string	Unique name of the kubernetes backend to configure.
disableIssValidation	boolean | cdktf.IResolvable	Optional disable JWT issuer validation. Allows to skip ISS validation.
disableLocalCaJwt	boolean | cdktf.IResolvable	Optional disable defaulting to the local CA cert and service account JWT when running in a Kubernetes pod.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/kubernetes_auth_backend_config#id DataVaultKubernetesAuthBackendConfig#id}.
issuer	string	Optional JWT issuer. If no issuer is specified, kubernetes.io/serviceaccount will be used as the default issuer.
kubernetesCaCert	string	PEM encoded CA cert for use by the TLS client used to talk with the Kubernetes API.
kubernetesHost	string	Host must be a host string, a host:port pair, or a URL to the base of the Kubernetes API server.
namespace	string	Target namespace. (requires Enterprise).
pemKeys	string[]	Optional list of PEM-formatted public keys or certificates used to verify the signatures of Kubernetes service account JWTs.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

backend^Optional

public readonly backend: string;

• Type: string

Unique name of the kubernetes backend to configure.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/kubernetes_auth_backend_config#backend DataVaultKubernetesAuthBackendConfig#backend}

---

disableIssValidation^Optional

public readonly disableIssValidation: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Optional disable JWT issuer validation. Allows to skip ISS validation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/kubernetes_auth_backend_config#disable_iss_validation DataVaultKubernetesAuthBackendConfig#disable_iss_validation}

---

disableLocalCaJwt^Optional

public readonly disableLocalCaJwt: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Optional disable defaulting to the local CA cert and service account JWT when running in a Kubernetes pod.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/kubernetes_auth_backend_config#disable_local_ca_jwt DataVaultKubernetesAuthBackendConfig#disable_local_ca_jwt}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/kubernetes_auth_backend_config#id DataVaultKubernetesAuthBackendConfig#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

issuer^Optional

public readonly issuer: string;

• Type: string

Optional JWT issuer. If no issuer is specified, kubernetes.io/serviceaccount will be used as the default issuer.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/kubernetes_auth_backend_config#issuer DataVaultKubernetesAuthBackendConfig#issuer}

---

kubernetesCaCert^Optional

public readonly kubernetesCaCert: string;

• Type: string

PEM encoded CA cert for use by the TLS client used to talk with the Kubernetes API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/kubernetes_auth_backend_config#kubernetes_ca_cert DataVaultKubernetesAuthBackendConfig#kubernetes_ca_cert}

---

kubernetesHost^Optional

public readonly kubernetesHost: string;

• Type: string

Host must be a host string, a host:port pair, or a URL to the base of the Kubernetes API server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/kubernetes_auth_backend_config#kubernetes_host DataVaultKubernetesAuthBackendConfig#kubernetes_host}

---

namespace^Optional

public readonly namespace: string;

• Type: string

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/kubernetes_auth_backend_config#namespace DataVaultKubernetesAuthBackendConfig#namespace}

---

pemKeys^Optional

public readonly pemKeys: string[];

• Type: string[]

Optional list of PEM-formatted public keys or certificates used to verify the signatures of Kubernetes service account JWTs.

If a certificate is given, its public key will be extracted. Not every installation of Kubernetes exposes these keys.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/kubernetes_auth_backend_config#pem_keys DataVaultKubernetesAuthBackendConfig#pem_keys}

---