`ldapAuthBackend` Submodule

Constructs

LdapAuthBackend

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend vault_ldap_auth_backend}.

Initializers

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

new ldapAuthBackend.LdapAuthBackend(scope: Construct, id: string, config: LdapAuthBackendConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`LdapAuthBackendConfig`	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`^Required

Type: LdapAuthBackendConfig

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.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`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.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`resetBinddn`	No description.
`resetBindpass`	No description.
`resetCaseSensitiveNames`	No description.
`resetCertificate`	No description.
`resetClientTlsCert`	No description.
`resetClientTlsKey`	No description.
`resetDenyNullBind`	No description.
`resetDescription`	No description.
`resetDisableRemount`	No description.
`resetDiscoverdn`	No description.
`resetGroupattr`	No description.
`resetGroupdn`	No description.
`resetGroupfilter`	No description.
`resetId`	No description.
`resetInsecureTls`	No description.
`resetLocal`	No description.
`resetMaxPageSize`	No description.
`resetNamespace`	No description.
`resetPath`	No description.
`resetStarttls`	No description.
`resetTlsMaxVersion`	No description.
`resetTlsMinVersion`	No description.
`resetTokenBoundCidrs`	No description.
`resetTokenExplicitMaxTtl`	No description.
`resetTokenMaxTtl`	No description.
`resetTokenNoDefaultPolicy`	No description.
`resetTokenNumUses`	No description.
`resetTokenPeriod`	No description.
`resetTokenPolicies`	No description.
`resetTokenTtl`	No description.
`resetTokenType`	No description.
`resetUpndomain`	No description.
`resetUserattr`	No description.
`resetUserdn`	No description.
`resetUserfilter`	No description.
`resetUsernameAsAlias`	No description.
`resetUseTokenGroups`	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

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`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

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`moveToId`

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`resetBinddn`

public resetBinddn(): void

`resetBindpass`

public resetBindpass(): void

`resetCaseSensitiveNames`

public resetCaseSensitiveNames(): void

`resetCertificate`

public resetCertificate(): void

`resetClientTlsCert`

public resetClientTlsCert(): void

`resetClientTlsKey`

public resetClientTlsKey(): void

`resetDenyNullBind`

public resetDenyNullBind(): void

`resetDescription`

public resetDescription(): void

`resetDisableRemount`

public resetDisableRemount(): void

`resetDiscoverdn`

public resetDiscoverdn(): void

`resetGroupattr`

public resetGroupattr(): void

`resetGroupdn`

public resetGroupdn(): void

`resetGroupfilter`

public resetGroupfilter(): void

`resetId`

public resetId(): void

`resetInsecureTls`

public resetInsecureTls(): void

`resetLocal`

public resetLocal(): void

`resetMaxPageSize`

public resetMaxPageSize(): void

`resetNamespace`

public resetNamespace(): void

`resetPath`

public resetPath(): void

`resetStarttls`

public resetStarttls(): void

`resetTlsMaxVersion`

public resetTlsMaxVersion(): void

`resetTlsMinVersion`

public resetTlsMinVersion(): void

`resetTokenBoundCidrs`

public resetTokenBoundCidrs(): void

`resetTokenExplicitMaxTtl`

public resetTokenExplicitMaxTtl(): void

`resetTokenMaxTtl`

public resetTokenMaxTtl(): void

`resetTokenNoDefaultPolicy`

public resetTokenNoDefaultPolicy(): void

`resetTokenNumUses`

public resetTokenNumUses(): void

`resetTokenPeriod`

public resetTokenPeriod(): void

`resetTokenPolicies`

public resetTokenPolicies(): void

`resetTokenTtl`

public resetTokenTtl(): void

`resetTokenType`

public resetTokenType(): void

`resetUpndomain`

public resetUpndomain(): void

`resetUserattr`

public resetUserattr(): void

`resetUserdn`

public resetUserdn(): void

`resetUserfilter`

public resetUserfilter(): void

`resetUsernameAsAlias`

public resetUsernameAsAlias(): void

`resetUseTokenGroups`

public resetUseTokenGroups(): void

Static Functions

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

`isConstruct`

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

ldapAuthBackend.LdapAuthBackend.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 { ldapAuthBackend } from '@cdktf/provider-vault'

ldapAuthBackend.LdapAuthBackend.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

ldapAuthBackend.LdapAuthBackend.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

ldapAuthBackend.LdapAuthBackend.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`importFromId`^Required

Type: string

The id of the existing LdapAuthBackend that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#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 LdapAuthBackend 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.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	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.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`accessor`	`string`	No description.
`binddnInput`	`string`	No description.
`bindpassInput`	`string`	No description.
`caseSensitiveNamesInput`	`boolean \| cdktf.IResolvable`	No description.
`certificateInput`	`string`	No description.
`clientTlsCertInput`	`string`	No description.
`clientTlsKeyInput`	`string`	No description.
`denyNullBindInput`	`boolean \| cdktf.IResolvable`	No description.
`descriptionInput`	`string`	No description.
`disableRemountInput`	`boolean \| cdktf.IResolvable`	No description.
`discoverdnInput`	`boolean \| cdktf.IResolvable`	No description.
`groupattrInput`	`string`	No description.
`groupdnInput`	`string`	No description.
`groupfilterInput`	`string`	No description.
`idInput`	`string`	No description.
`insecureTlsInput`	`boolean \| cdktf.IResolvable`	No description.
`localInput`	`boolean \| cdktf.IResolvable`	No description.
`maxPageSizeInput`	`number`	No description.
`namespaceInput`	`string`	No description.
`pathInput`	`string`	No description.
`starttlsInput`	`boolean \| cdktf.IResolvable`	No description.
`tlsMaxVersionInput`	`string`	No description.
`tlsMinVersionInput`	`string`	No description.
`tokenBoundCidrsInput`	`string[]`	No description.
`tokenExplicitMaxTtlInput`	`number`	No description.
`tokenMaxTtlInput`	`number`	No description.
`tokenNoDefaultPolicyInput`	`boolean \| cdktf.IResolvable`	No description.
`tokenNumUsesInput`	`number`	No description.
`tokenPeriodInput`	`number`	No description.
`tokenPoliciesInput`	`string[]`	No description.
`tokenTtlInput`	`number`	No description.
`tokenTypeInput`	`string`	No description.
`upndomainInput`	`string`	No description.
`urlInput`	`string`	No description.
`userattrInput`	`string`	No description.
`userdnInput`	`string`	No description.
`userfilterInput`	`string`	No description.
`usernameAsAliasInput`	`boolean \| cdktf.IResolvable`	No description.
`useTokenGroupsInput`	`boolean \| cdktf.IResolvable`	No description.
`binddn`	`string`	No description.
`bindpass`	`string`	No description.
`caseSensitiveNames`	`boolean \| cdktf.IResolvable`	No description.
`certificate`	`string`	No description.
`clientTlsCert`	`string`	No description.
`clientTlsKey`	`string`	No description.
`denyNullBind`	`boolean \| cdktf.IResolvable`	No description.
`description`	`string`	No description.
`disableRemount`	`boolean \| cdktf.IResolvable`	No description.
`discoverdn`	`boolean \| cdktf.IResolvable`	No description.
`groupattr`	`string`	No description.
`groupdn`	`string`	No description.
`groupfilter`	`string`	No description.
`id`	`string`	No description.
`insecureTls`	`boolean \| cdktf.IResolvable`	No description.
`local`	`boolean \| cdktf.IResolvable`	No description.
`maxPageSize`	`number`	No description.
`namespace`	`string`	No description.
`path`	`string`	No description.
`starttls`	`boolean \| cdktf.IResolvable`	No description.
`tlsMaxVersion`	`string`	No description.
`tlsMinVersion`	`string`	No description.
`tokenBoundCidrs`	`string[]`	No description.
`tokenExplicitMaxTtl`	`number`	No description.
`tokenMaxTtl`	`number`	No description.
`tokenNoDefaultPolicy`	`boolean \| cdktf.IResolvable`	No description.
`tokenNumUses`	`number`	No description.
`tokenPeriod`	`number`	No description.
`tokenPolicies`	`string[]`	No description.
`tokenTtl`	`number`	No description.
`tokenType`	`string`	No description.
`upndomain`	`string`	No description.
`url`	`string`	No description.
`userattr`	`string`	No description.
`userdn`	`string`	No description.
`userfilter`	`string`	No description.
`usernameAsAlias`	`boolean \| cdktf.IResolvable`	No description.
`useTokenGroups`	`boolean \| cdktf.IResolvable`	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

`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: 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

`provisioners`^Optional

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

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

`accessor`^Required

public readonly accessor: string;

Type: string

`binddnInput`^Optional

public readonly binddnInput: string;

Type: string

`bindpassInput`^Optional

public readonly bindpassInput: string;

Type: string

`caseSensitiveNamesInput`^Optional

public readonly caseSensitiveNamesInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`certificateInput`^Optional

public readonly certificateInput: string;

Type: string

`clientTlsCertInput`^Optional

public readonly clientTlsCertInput: string;

Type: string

`clientTlsKeyInput`^Optional

public readonly clientTlsKeyInput: string;

Type: string

`denyNullBindInput`^Optional

public readonly denyNullBindInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`disableRemountInput`^Optional

public readonly disableRemountInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`discoverdnInput`^Optional

public readonly discoverdnInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`groupattrInput`^Optional

public readonly groupattrInput: string;

Type: string

`groupdnInput`^Optional

public readonly groupdnInput: string;

Type: string

`groupfilterInput`^Optional

public readonly groupfilterInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`insecureTlsInput`^Optional

public readonly insecureTlsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`localInput`^Optional

public readonly localInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`maxPageSizeInput`^Optional

public readonly maxPageSizeInput: number;

Type: number

`namespaceInput`^Optional

public readonly namespaceInput: string;

Type: string

`pathInput`^Optional

public readonly pathInput: string;

Type: string

`starttlsInput`^Optional

public readonly starttlsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`tlsMaxVersionInput`^Optional

public readonly tlsMaxVersionInput: string;

Type: string

`tlsMinVersionInput`^Optional

public readonly tlsMinVersionInput: string;

Type: string

`tokenBoundCidrsInput`^Optional

public readonly tokenBoundCidrsInput: string[];

Type: string[]

`tokenExplicitMaxTtlInput`^Optional

public readonly tokenExplicitMaxTtlInput: number;

Type: number

`tokenMaxTtlInput`^Optional

public readonly tokenMaxTtlInput: number;

Type: number

`tokenNoDefaultPolicyInput`^Optional

public readonly tokenNoDefaultPolicyInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`tokenNumUsesInput`^Optional

public readonly tokenNumUsesInput: number;

Type: number

`tokenPeriodInput`^Optional

public readonly tokenPeriodInput: number;

Type: number

`tokenPoliciesInput`^Optional

public readonly tokenPoliciesInput: string[];

Type: string[]

`tokenTtlInput`^Optional

public readonly tokenTtlInput: number;

Type: number

`tokenTypeInput`^Optional

public readonly tokenTypeInput: string;

Type: string

`upndomainInput`^Optional

public readonly upndomainInput: string;

Type: string

`urlInput`^Optional

public readonly urlInput: string;

Type: string

`userattrInput`^Optional

public readonly userattrInput: string;

Type: string

`userdnInput`^Optional

public readonly userdnInput: string;

Type: string

`userfilterInput`^Optional

public readonly userfilterInput: string;

Type: string

`usernameAsAliasInput`^Optional

public readonly usernameAsAliasInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`useTokenGroupsInput`^Optional

public readonly useTokenGroupsInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`binddn`^Required

public readonly binddn: string;

Type: string

`bindpass`^Required

public readonly bindpass: string;

Type: string

`caseSensitiveNames`^Required

public readonly caseSensitiveNames: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`certificate`^Required

public readonly certificate: string;

Type: string

`clientTlsCert`^Required

public readonly clientTlsCert: string;

Type: string

`clientTlsKey`^Required

public readonly clientTlsKey: string;

Type: string

`denyNullBind`^Required

public readonly denyNullBind: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`description`^Required

public readonly description: string;

Type: string

`disableRemount`^Required

public readonly disableRemount: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`discoverdn`^Required

public readonly discoverdn: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`groupattr`^Required

public readonly groupattr: string;

Type: string

`groupdn`^Required

public readonly groupdn: string;

Type: string

`groupfilter`^Required

public readonly groupfilter: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`insecureTls`^Required

public readonly insecureTls: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`local`^Required

public readonly local: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`maxPageSize`^Required

public readonly maxPageSize: number;

Type: number

`namespace`^Required

public readonly namespace: string;

Type: string

`path`^Required

public readonly path: string;

Type: string

`starttls`^Required

public readonly starttls: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`tlsMaxVersion`^Required

public readonly tlsMaxVersion: string;

Type: string

`tlsMinVersion`^Required

public readonly tlsMinVersion: string;

Type: string

`tokenBoundCidrs`^Required

public readonly tokenBoundCidrs: string[];

Type: string[]

`tokenExplicitMaxTtl`^Required

public readonly tokenExplicitMaxTtl: number;

Type: number

`tokenMaxTtl`^Required

public readonly tokenMaxTtl: number;

Type: number

`tokenNoDefaultPolicy`^Required

public readonly tokenNoDefaultPolicy: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`tokenNumUses`^Required

public readonly tokenNumUses: number;

Type: number

`tokenPeriod`^Required

public readonly tokenPeriod: number;

Type: number

`tokenPolicies`^Required

public readonly tokenPolicies: string[];

Type: string[]

`tokenTtl`^Required

public readonly tokenTtl: number;

Type: number

`tokenType`^Required

public readonly tokenType: string;

Type: string

`upndomain`^Required

public readonly upndomain: string;

Type: string

`url`^Required

public readonly url: string;

Type: string

`userattr`^Required

public readonly userattr: string;

Type: string

`userdn`^Required

public readonly userdn: string;

Type: string

`userfilter`^Required

public readonly userfilter: string;

Type: string

`usernameAsAlias`^Required

public readonly usernameAsAlias: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`useTokenGroups`^Required

public readonly useTokenGroups: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

LdapAuthBackendConfig

Initializer

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

const ldapAuthBackendConfig: ldapAuthBackend.LdapAuthBackendConfig = { ... }

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.
`url`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#url LdapAuthBackend#url}.
`binddn`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#binddn LdapAuthBackend#binddn}.
`bindpass`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#bindpass LdapAuthBackend#bindpass}.
`caseSensitiveNames`	`boolean \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#case_sensitive_names LdapAuthBackend#case_sensitive_names}.
`certificate`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#certificate LdapAuthBackend#certificate}.
`clientTlsCert`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#client_tls_cert LdapAuthBackend#client_tls_cert}.
`clientTlsKey`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#client_tls_key LdapAuthBackend#client_tls_key}.
`denyNullBind`	`boolean \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#deny_null_bind LdapAuthBackend#deny_null_bind}.
`description`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#description LdapAuthBackend#description}.
`disableRemount`	`boolean \| cdktf.IResolvable`	If set, opts out of mount migration on path updates.
`discoverdn`	`boolean \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#discoverdn LdapAuthBackend#discoverdn}.
`groupattr`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#groupattr LdapAuthBackend#groupattr}.
`groupdn`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#groupdn LdapAuthBackend#groupdn}.
`groupfilter`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#groupfilter LdapAuthBackend#groupfilter}.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#id LdapAuthBackend#id}.
`insecureTls`	`boolean \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#insecure_tls LdapAuthBackend#insecure_tls}.
`local`	`boolean \| cdktf.IResolvable`	Specifies if the auth method is local only.
`maxPageSize`	`number`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#max_page_size LdapAuthBackend#max_page_size}.
`namespace`	`string`	Target namespace. (requires Enterprise).
`path`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#path LdapAuthBackend#path}.
`starttls`	`boolean \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#starttls LdapAuthBackend#starttls}.
`tlsMaxVersion`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#tls_max_version LdapAuthBackend#tls_max_version}.
`tlsMinVersion`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#tls_min_version LdapAuthBackend#tls_min_version}.
`tokenBoundCidrs`	`string[]`	Specifies the blocks of IP addresses which are allowed to use the generated token.
`tokenExplicitMaxTtl`	`number`	Generated Token's Explicit Maximum TTL in seconds.
`tokenMaxTtl`	`number`	The maximum lifetime of the generated token.
`tokenNoDefaultPolicy`	`boolean \| cdktf.IResolvable`	If true, the 'default' policy will not automatically be added to generated tokens.
`tokenNumUses`	`number`	The maximum number of times a token may be used, a value of zero means unlimited.
`tokenPeriod`	`number`	Generated Token's Period.
`tokenPolicies`	`string[]`	Generated Token's Policies.
`tokenTtl`	`number`	The initial ttl of the token to generate in seconds.
`tokenType`	`string`	The type of token to generate, service or batch.
`upndomain`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#upndomain LdapAuthBackend#upndomain}.
`userattr`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#userattr LdapAuthBackend#userattr}.
`userdn`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#userdn LdapAuthBackend#userdn}.
`userfilter`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#userfilter LdapAuthBackend#userfilter}.
`usernameAsAlias`	`boolean \| cdktf.IResolvable`	Force the auth method to use the username passed by the user as the alias name.
`useTokenGroups`	`boolean \| cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#use_token_groups LdapAuthBackend#use_token_groups}.

`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[]

`url`^Required

public readonly url: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#url LdapAuthBackend#url}.

`binddn`^Optional

public readonly binddn: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#binddn LdapAuthBackend#binddn}.

`bindpass`^Optional

public readonly bindpass: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#bindpass LdapAuthBackend#bindpass}.

`caseSensitiveNames`^Optional

public readonly caseSensitiveNames: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#case_sensitive_names LdapAuthBackend#case_sensitive_names}.

`certificate`^Optional

public readonly certificate: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#certificate LdapAuthBackend#certificate}.

`clientTlsCert`^Optional

public readonly clientTlsCert: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#client_tls_cert LdapAuthBackend#client_tls_cert}.

`clientTlsKey`^Optional

public readonly clientTlsKey: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#client_tls_key LdapAuthBackend#client_tls_key}.

`denyNullBind`^Optional

public readonly denyNullBind: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#deny_null_bind LdapAuthBackend#deny_null_bind}.

`description`^Optional

public readonly description: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#description LdapAuthBackend#description}.

`disableRemount`^Optional

public readonly disableRemount: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

If set, opts out of mount migration on path updates.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#disable_remount LdapAuthBackend#disable_remount}

`discoverdn`^Optional

public readonly discoverdn: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#discoverdn LdapAuthBackend#discoverdn}.

`groupattr`^Optional

public readonly groupattr: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#groupattr LdapAuthBackend#groupattr}.

`groupdn`^Optional

public readonly groupdn: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#groupdn LdapAuthBackend#groupdn}.

`groupfilter`^Optional

public readonly groupfilter: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#groupfilter LdapAuthBackend#groupfilter}.

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#id LdapAuthBackend#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.

`insecureTls`^Optional

public readonly insecureTls: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#insecure_tls LdapAuthBackend#insecure_tls}.

`local`^Optional

public readonly local: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Specifies if the auth method is local only.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#local LdapAuthBackend#local}

`maxPageSize`^Optional

public readonly maxPageSize: number;

Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#max_page_size LdapAuthBackend#max_page_size}.

`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/resources/ldap_auth_backend#namespace LdapAuthBackend#namespace}

`path`^Optional

public readonly path: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#path LdapAuthBackend#path}.

`starttls`^Optional

public readonly starttls: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#starttls LdapAuthBackend#starttls}.

`tlsMaxVersion`^Optional

public readonly tlsMaxVersion: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#tls_max_version LdapAuthBackend#tls_max_version}.

`tlsMinVersion`^Optional

public readonly tlsMinVersion: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#tls_min_version LdapAuthBackend#tls_min_version}.

`tokenBoundCidrs`^Optional

public readonly tokenBoundCidrs: string[];

Type: string[]

Specifies the blocks of IP addresses which are allowed to use the generated token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#token_bound_cidrs LdapAuthBackend#token_bound_cidrs}

`tokenExplicitMaxTtl`^Optional

public readonly tokenExplicitMaxTtl: number;

Type: number

Generated Token's Explicit Maximum TTL in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#token_explicit_max_ttl LdapAuthBackend#token_explicit_max_ttl}

`tokenMaxTtl`^Optional

public readonly tokenMaxTtl: number;

Type: number

The maximum lifetime of the generated token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#token_max_ttl LdapAuthBackend#token_max_ttl}

`tokenNoDefaultPolicy`^Optional

public readonly tokenNoDefaultPolicy: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

If true, the 'default' policy will not automatically be added to generated tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#token_no_default_policy LdapAuthBackend#token_no_default_policy}

`tokenNumUses`^Optional

public readonly tokenNumUses: number;

Type: number

The maximum number of times a token may be used, a value of zero means unlimited.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#token_num_uses LdapAuthBackend#token_num_uses}

`tokenPeriod`^Optional

public readonly tokenPeriod: number;

Type: number

Generated Token's Period.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#token_period LdapAuthBackend#token_period}

`tokenPolicies`^Optional

public readonly tokenPolicies: string[];

Type: string[]

Generated Token's Policies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#token_policies LdapAuthBackend#token_policies}

`tokenTtl`^Optional

public readonly tokenTtl: number;

Type: number

The initial ttl of the token to generate in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#token_ttl LdapAuthBackend#token_ttl}

`tokenType`^Optional

public readonly tokenType: string;

Type: string

The type of token to generate, service or batch.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#token_type LdapAuthBackend#token_type}

`upndomain`^Optional

public readonly upndomain: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#upndomain LdapAuthBackend#upndomain}.

`userattr`^Optional

public readonly userattr: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#userattr LdapAuthBackend#userattr}.

`userdn`^Optional

public readonly userdn: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#userdn LdapAuthBackend#userdn}.

`userfilter`^Optional

public readonly userfilter: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#userfilter LdapAuthBackend#userfilter}.

`usernameAsAlias`^Optional

public readonly usernameAsAlias: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Force the auth method to use the username passed by the user as the alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#username_as_alias LdapAuthBackend#username_as_alias}

`useTokenGroups`^Optional

public readonly useTokenGroups: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/ldap_auth_backend#use_token_groups LdapAuthBackend#use_token_groups}.

Files

ldapAuthBackend.typescript.md

Latest commit

History

ldapAuthBackend.typescript.md

File metadata and controls

ldapAuthBackend Submodule

Constructs