Skip to content

Latest commit

 

History

History
2893 lines (1823 loc) · 138 KB

ldapSecretBackend.java.md

File metadata and controls

2893 lines (1823 loc) · 138 KB
Raw

ldapSecretBackend Submodule

Constructs

LdapSecretBackend

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend vault_ldap_secret_backend}.

Initializers 

import com.hashicorp.cdktf.providers.vault.ldap_secret_backend.LdapSecretBackend;

LdapSecretBackend.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .binddn(java.lang.String)
    .bindpass(java.lang.String)
//  .allowedManagedKeys(java.util.List<java.lang.String>)
//  .allowedResponseHeaders(java.util.List<java.lang.String>)
//  .auditNonHmacRequestKeys(java.util.List<java.lang.String>)
//  .auditNonHmacResponseKeys(java.util.List<java.lang.String>)
//  .certificate(java.lang.String)
//  .clientTlsCert(java.lang.String)
//  .clientTlsKey(java.lang.String)
//  .connectionTimeout(java.lang.Number)
//  .defaultLeaseTtlSeconds(java.lang.Number)
//  .delegatedAuthAccessors(java.util.List<java.lang.String>)
//  .description(java.lang.String)
//  .disableRemount(java.lang.Boolean)
//  .disableRemount(IResolvable)
//  .externalEntropyAccess(java.lang.Boolean)
//  .externalEntropyAccess(IResolvable)
//  .id(java.lang.String)
//  .identityTokenKey(java.lang.String)
//  .insecureTls(java.lang.Boolean)
//  .insecureTls(IResolvable)
//  .listingVisibility(java.lang.String)
//  .local(java.lang.Boolean)
//  .local(IResolvable)
//  .maxLeaseTtlSeconds(java.lang.Number)
//  .namespace(java.lang.String)
//  .options(java.util.Map<java.lang.String, java.lang.String>)
//  .passthroughRequestHeaders(java.util.List<java.lang.String>)
//  .passwordPolicy(java.lang.String)
//  .path(java.lang.String)
//  .pluginVersion(java.lang.String)
//  .requestTimeout(java.lang.Number)
//  .schema(java.lang.String)
//  .sealWrap(java.lang.Boolean)
//  .sealWrap(IResolvable)
//  .skipStaticRoleImportRotation(java.lang.Boolean)
//  .skipStaticRoleImportRotation(IResolvable)
//  .starttls(java.lang.Boolean)
//  .starttls(IResolvable)
//  .upndomain(java.lang.String)
//  .url(java.lang.String)
//  .userattr(java.lang.String)
//  .userdn(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
binddn java.lang.String Distinguished name of object to bind when performing user and group search.
bindpass java.lang.String LDAP password for searching for the user DN.
allowedManagedKeys java.util.List<java.lang.String> List of managed key registry entry names that the mount in question is allowed to access.
allowedResponseHeaders java.util.List<java.lang.String> List of headers to allow and pass from the request to the plugin.
auditNonHmacRequestKeys java.util.List<java.lang.String> Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
auditNonHmacResponseKeys java.util.List<java.lang.String> Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
certificate java.lang.String CA certificate to use when verifying LDAP server certificate, must be x509 PEM encoded.
clientTlsCert java.lang.String Client certificate to provide to the LDAP server, must be x509 PEM encoded.
clientTlsKey java.lang.String Client certificate key to provide to the LDAP server, must be x509 PEM encoded.
connectionTimeout java.lang.Number Timeout, in seconds, when attempting to connect to the LDAP server before trying the next URL in the configuration.
defaultLeaseTtlSeconds java.lang.Number Default lease duration for tokens and secrets in seconds.
delegatedAuthAccessors java.util.List<java.lang.String> List of headers to allow and pass from the request to the plugin.
description java.lang.String Human-friendly description of the mount.
disableRemount java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If set, opts out of mount migration on path updates.
externalEntropyAccess java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enable the secrets engine to access Vault's external entropy source.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#id LdapSecretBackend#id}.
identityTokenKey java.lang.String The key to use for signing plugin workload identity tokens.
insecureTls java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Skip LDAP server SSL Certificate verification - insecure and not recommended for production use.
listingVisibility java.lang.String Specifies whether to show this mount in the UI-specific listing endpoint.
local java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Local mount flag that can be explicitly set to true to enforce local mount in HA environment.
maxLeaseTtlSeconds java.lang.Number Maximum possible lease duration for tokens and secrets in seconds.
namespace java.lang.String Target namespace. (requires Enterprise).
options java.util.Map<java.lang.String, java.lang.String> Specifies mount type specific options that are passed to the backend.
passthroughRequestHeaders java.util.List<java.lang.String> List of headers to allow and pass from the request to the plugin.
passwordPolicy java.lang.String Name of the password policy to use to generate passwords.
path java.lang.String The path where the LDAP secrets backend is mounted.
pluginVersion java.lang.String Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'.
requestTimeout java.lang.Number Timeout, in seconds, for the connection when making requests against the server before returning back an error.
schema java.lang.String The LDAP schema to use when storing entry passwords. Valid schemas include openldap, ad, and racf.
sealWrap java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability.
skipStaticRoleImportRotation java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Skip rotation of static role secrets on import.
starttls java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Issue a StartTLS command after establishing unencrypted connection.
upndomain java.lang.String Enables userPrincipalDomain login with [username]@UPNDomain.
url java.lang.String LDAP URL to connect to (default: ldap://127.0.0.1). Multiple URLs can be specified by concatenating them with commas; they will be tried in-order.
userattr java.lang.String Attribute used for users (default: cn).
userdn java.lang.String LDAP domain to use for users (eg: ou=People,dc=example,dc=org).
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
binddnRequired
  • Type: java.lang.String

Distinguished name of object to bind when performing user and group search.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#binddn LdapSecretBackend#binddn}

bindpassRequired
  • Type: java.lang.String

LDAP password for searching for the user DN.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#bindpass LdapSecretBackend#bindpass}

allowedManagedKeysOptional
  • Type: java.util.List<java.lang.String>

List of managed key registry entry names that the mount in question is allowed to access.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#allowed_managed_keys LdapSecretBackend#allowed_managed_keys}

allowedResponseHeadersOptional
  • Type: java.util.List<java.lang.String>

List of headers to allow and pass from the request to the plugin.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#allowed_response_headers LdapSecretBackend#allowed_response_headers}

auditNonHmacRequestKeysOptional
  • Type: java.util.List<java.lang.String>

Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#audit_non_hmac_request_keys LdapSecretBackend#audit_non_hmac_request_keys}

auditNonHmacResponseKeysOptional
  • Type: java.util.List<java.lang.String>

Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#audit_non_hmac_response_keys LdapSecretBackend#audit_non_hmac_response_keys}

certificateOptional
  • Type: java.lang.String

CA certificate to use when verifying LDAP server certificate, must be x509 PEM encoded.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#certificate LdapSecretBackend#certificate}

clientTlsCertOptional
  • Type: java.lang.String

Client certificate to provide to the LDAP server, must be x509 PEM encoded.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#client_tls_cert LdapSecretBackend#client_tls_cert}

clientTlsKeyOptional
  • Type: java.lang.String

Client certificate key to provide to the LDAP server, must be x509 PEM encoded.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#client_tls_key LdapSecretBackend#client_tls_key}

connectionTimeoutOptional
  • Type: java.lang.Number

Timeout, in seconds, when attempting to connect to the LDAP server before trying the next URL in the configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#connection_timeout LdapSecretBackend#connection_timeout}

defaultLeaseTtlSecondsOptional
  • Type: java.lang.Number

Default lease duration for tokens and secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#default_lease_ttl_seconds LdapSecretBackend#default_lease_ttl_seconds}

delegatedAuthAccessorsOptional
  • Type: java.util.List<java.lang.String>

List of headers to allow and pass from the request to the plugin.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#delegated_auth_accessors LdapSecretBackend#delegated_auth_accessors}

descriptionOptional
  • Type: java.lang.String

Human-friendly description of the mount.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#description LdapSecretBackend#description}

disableRemountOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.4.0/docs/resources/ldap_secret_backend#disable_remount LdapSecretBackend#disable_remount}

externalEntropyAccessOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Enable the secrets engine to access Vault's external entropy source.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#external_entropy_access LdapSecretBackend#external_entropy_access}

idOptional
  • Type: java.lang.String

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

identityTokenKeyOptional
  • Type: java.lang.String

The key to use for signing plugin workload identity tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#identity_token_key LdapSecretBackend#identity_token_key}

insecureTlsOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Skip LDAP server SSL Certificate verification - insecure and not recommended for production use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#insecure_tls LdapSecretBackend#insecure_tls}

listingVisibilityOptional
  • Type: java.lang.String

Specifies whether to show this mount in the UI-specific listing endpoint.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#listing_visibility LdapSecretBackend#listing_visibility}

localOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Local mount flag that can be explicitly set to true to enforce local mount in HA environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#local LdapSecretBackend#local}

maxLeaseTtlSecondsOptional
  • Type: java.lang.Number

Maximum possible lease duration for tokens and secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#max_lease_ttl_seconds LdapSecretBackend#max_lease_ttl_seconds}

namespaceOptional
  • Type: java.lang.String

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#namespace LdapSecretBackend#namespace}

optionsOptional
  • Type: java.util.Map<java.lang.String, java.lang.String>

Specifies mount type specific options that are passed to the backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#options LdapSecretBackend#options}

passthroughRequestHeadersOptional
  • Type: java.util.List<java.lang.String>

List of headers to allow and pass from the request to the plugin.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#passthrough_request_headers LdapSecretBackend#passthrough_request_headers}

passwordPolicyOptional
  • Type: java.lang.String

Name of the password policy to use to generate passwords.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#password_policy LdapSecretBackend#password_policy}

pathOptional
  • Type: java.lang.String

The path where the LDAP secrets backend is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#path LdapSecretBackend#path}

pluginVersionOptional
  • Type: java.lang.String

Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#plugin_version LdapSecretBackend#plugin_version}

requestTimeoutOptional
  • Type: java.lang.Number

Timeout, in seconds, for the connection when making requests against the server before returning back an error.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#request_timeout LdapSecretBackend#request_timeout}

schemaOptional
  • Type: java.lang.String

The LDAP schema to use when storing entry passwords. Valid schemas include openldap, ad, and racf.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#schema LdapSecretBackend#schema}

sealWrapOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#seal_wrap LdapSecretBackend#seal_wrap}

skipStaticRoleImportRotationOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Skip rotation of static role secrets on import.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#skip_static_role_import_rotation LdapSecretBackend#skip_static_role_import_rotation}

starttlsOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Issue a StartTLS command after establishing unencrypted connection.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#starttls LdapSecretBackend#starttls}

upndomainOptional
  • Type: java.lang.String

Enables userPrincipalDomain login with [username]@UPNDomain.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#upndomain LdapSecretBackend#upndomain}

urlOptional
  • Type: java.lang.String

LDAP URL to connect to (default: ldap://127.0.0.1). Multiple URLs can be specified by concatenating them with commas; they will be tried in-order.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#url LdapSecretBackend#url}

userattrOptional
  • Type: java.lang.String

Attribute used for users (default: cn).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#userattr LdapSecretBackend#userattr}

userdnOptional
  • Type: java.lang.String

LDAP domain to use for users (eg: ou=People,dc=example,dc=org).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#userdn LdapSecretBackend#userdn}

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".
resetAllowedManagedKeys No description.
resetAllowedResponseHeaders No description.
resetAuditNonHmacRequestKeys No description.
resetAuditNonHmacResponseKeys No description.
resetCertificate No description.
resetClientTlsCert No description.
resetClientTlsKey No description.
resetConnectionTimeout No description.
resetDefaultLeaseTtlSeconds No description.
resetDelegatedAuthAccessors No description.
resetDescription No description.
resetDisableRemount No description.
resetExternalEntropyAccess No description.
resetId No description.
resetIdentityTokenKey No description.
resetInsecureTls No description.
resetListingVisibility No description.
resetLocal No description.
resetMaxLeaseTtlSeconds No description.
resetNamespace No description.
resetOptions No description.
resetPassthroughRequestHeaders No description.
resetPasswordPolicy No description.
resetPath No description.
resetPluginVersion No description.
resetRequestTimeout No description.
resetSchema No description.
resetSealWrap No description.
resetSkipStaticRoleImportRotation No description.
resetStarttls No description.
resetUpndomain No description.
resetUrl No description.
resetUserattr No description.
resetUserdn No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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.

idRequired
  • Type: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

resetAllowedManagedKeys 
public void resetAllowedManagedKeys()
resetAllowedResponseHeaders 
public void resetAllowedResponseHeaders()
resetAuditNonHmacRequestKeys 
public void resetAuditNonHmacRequestKeys()
resetAuditNonHmacResponseKeys 
public void resetAuditNonHmacResponseKeys()
resetCertificate 
public void resetCertificate()
resetClientTlsCert 
public void resetClientTlsCert()
resetClientTlsKey 
public void resetClientTlsKey()
resetConnectionTimeout 
public void resetConnectionTimeout()
resetDefaultLeaseTtlSeconds 
public void resetDefaultLeaseTtlSeconds()
resetDelegatedAuthAccessors 
public void resetDelegatedAuthAccessors()
resetDescription 
public void resetDescription()
resetDisableRemount 
public void resetDisableRemount()
resetExternalEntropyAccess 
public void resetExternalEntropyAccess()
resetId 
public void resetId()
resetIdentityTokenKey 
public void resetIdentityTokenKey()
resetInsecureTls 
public void resetInsecureTls()
resetListingVisibility 
public void resetListingVisibility()
resetLocal 
public void resetLocal()
resetMaxLeaseTtlSeconds 
public void resetMaxLeaseTtlSeconds()
resetNamespace 
public void resetNamespace()
resetOptions 
public void resetOptions()
resetPassthroughRequestHeaders 
public void resetPassthroughRequestHeaders()
resetPasswordPolicy 
public void resetPasswordPolicy()
resetPath 
public void resetPath()
resetPluginVersion 
public void resetPluginVersion()
resetRequestTimeout 
public void resetRequestTimeout()
resetSchema 
public void resetSchema()
resetSealWrap 
public void resetSealWrap()
resetSkipStaticRoleImportRotation 
public void resetSkipStaticRoleImportRotation()
resetStarttls 
public void resetStarttls()
resetUpndomain 
public void resetUpndomain()
resetUrl 
public void resetUrl()
resetUserattr 
public void resetUserattr()
resetUserdn 
public void resetUserdn()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a LdapSecretBackend resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.vault.ldap_secret_backend.LdapSecretBackend;

LdapSecretBackend.isConstruct(java.lang.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: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.vault.ldap_secret_backend.LdapSecretBackend;

LdapSecretBackend.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.vault.ldap_secret_backend.LdapSecretBackend;

LdapSecretBackend.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.vault.ldap_secret_backend.LdapSecretBackend;

LdapSecretBackend.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),LdapSecretBackend.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing LdapSecretBackend that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
accessor java.lang.String No description.
allowedManagedKeysInput java.util.List<java.lang.String> No description.
allowedResponseHeadersInput java.util.List<java.lang.String> No description.
auditNonHmacRequestKeysInput java.util.List<java.lang.String> No description.
auditNonHmacResponseKeysInput java.util.List<java.lang.String> No description.
binddnInput java.lang.String No description.
bindpassInput java.lang.String No description.
certificateInput java.lang.String No description.
clientTlsCertInput java.lang.String No description.
clientTlsKeyInput java.lang.String No description.
connectionTimeoutInput java.lang.Number No description.
defaultLeaseTtlSecondsInput java.lang.Number No description.
delegatedAuthAccessorsInput java.util.List<java.lang.String> No description.
descriptionInput java.lang.String No description.
disableRemountInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
externalEntropyAccessInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
identityTokenKeyInput java.lang.String No description.
idInput java.lang.String No description.
insecureTlsInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
listingVisibilityInput java.lang.String No description.
localInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
maxLeaseTtlSecondsInput java.lang.Number No description.
namespaceInput java.lang.String No description.
optionsInput java.util.Map<java.lang.String, java.lang.String> No description.
passthroughRequestHeadersInput java.util.List<java.lang.String> No description.
passwordPolicyInput java.lang.String No description.
pathInput java.lang.String No description.
pluginVersionInput java.lang.String No description.
requestTimeoutInput java.lang.Number No description.
schemaInput java.lang.String No description.
sealWrapInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
skipStaticRoleImportRotationInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
starttlsInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
upndomainInput java.lang.String No description.
urlInput java.lang.String No description.
userattrInput java.lang.String No description.
userdnInput java.lang.String No description.
allowedManagedKeys java.util.List<java.lang.String> No description.
allowedResponseHeaders java.util.List<java.lang.String> No description.
auditNonHmacRequestKeys java.util.List<java.lang.String> No description.
auditNonHmacResponseKeys java.util.List<java.lang.String> No description.
binddn java.lang.String No description.
bindpass java.lang.String No description.
certificate java.lang.String No description.
clientTlsCert java.lang.String No description.
clientTlsKey java.lang.String No description.
connectionTimeout java.lang.Number No description.
defaultLeaseTtlSeconds java.lang.Number No description.
delegatedAuthAccessors java.util.List<java.lang.String> No description.
description java.lang.String No description.
disableRemount java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
externalEntropyAccess java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
identityTokenKey java.lang.String No description.
insecureTls java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
listingVisibility java.lang.String No description.
local java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
maxLeaseTtlSeconds java.lang.Number No description.
namespace java.lang.String No description.
options java.util.Map<java.lang.String, java.lang.String> No description.
passthroughRequestHeaders java.util.List<java.lang.String> No description.
passwordPolicy java.lang.String No description.
path java.lang.String No description.
pluginVersion java.lang.String No description.
requestTimeout java.lang.Number No description.
schema java.lang.String No description.
sealWrap java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
skipStaticRoleImportRotation java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
starttls java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
upndomain java.lang.String No description.
url java.lang.String No description.
userattr java.lang.String No description.
userdn java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
accessorRequired 
public java.lang.String getAccessor();
  • Type: java.lang.String
allowedManagedKeysInputOptional 
public java.util.List<java.lang.String> getAllowedManagedKeysInput();
  • Type: java.util.List<java.lang.String>
allowedResponseHeadersInputOptional 
public java.util.List<java.lang.String> getAllowedResponseHeadersInput();
  • Type: java.util.List<java.lang.String>
auditNonHmacRequestKeysInputOptional 
public java.util.List<java.lang.String> getAuditNonHmacRequestKeysInput();
  • Type: java.util.List<java.lang.String>
auditNonHmacResponseKeysInputOptional 
public java.util.List<java.lang.String> getAuditNonHmacResponseKeysInput();
  • Type: java.util.List<java.lang.String>
binddnInputOptional 
public java.lang.String getBinddnInput();
  • Type: java.lang.String
bindpassInputOptional 
public java.lang.String getBindpassInput();
  • Type: java.lang.String
certificateInputOptional 
public java.lang.String getCertificateInput();
  • Type: java.lang.String
clientTlsCertInputOptional 
public java.lang.String getClientTlsCertInput();
  • Type: java.lang.String
clientTlsKeyInputOptional 
public java.lang.String getClientTlsKeyInput();
  • Type: java.lang.String
connectionTimeoutInputOptional 
public java.lang.Number getConnectionTimeoutInput();
  • Type: java.lang.Number
defaultLeaseTtlSecondsInputOptional 
public java.lang.Number getDefaultLeaseTtlSecondsInput();
  • Type: java.lang.Number
delegatedAuthAccessorsInputOptional 
public java.util.List<java.lang.String> getDelegatedAuthAccessorsInput();
  • Type: java.util.List<java.lang.String>
descriptionInputOptional 
public java.lang.String getDescriptionInput();
  • Type: java.lang.String
disableRemountInputOptional 
public java.lang.Object getDisableRemountInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
externalEntropyAccessInputOptional 
public java.lang.Object getExternalEntropyAccessInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
identityTokenKeyInputOptional 
public java.lang.String getIdentityTokenKeyInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
insecureTlsInputOptional 
public java.lang.Object getInsecureTlsInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
listingVisibilityInputOptional 
public java.lang.String getListingVisibilityInput();
  • Type: java.lang.String
localInputOptional 
public java.lang.Object getLocalInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
maxLeaseTtlSecondsInputOptional 
public java.lang.Number getMaxLeaseTtlSecondsInput();
  • Type: java.lang.Number
namespaceInputOptional 
public java.lang.String getNamespaceInput();
  • Type: java.lang.String
optionsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getOptionsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
passthroughRequestHeadersInputOptional 
public java.util.List<java.lang.String> getPassthroughRequestHeadersInput();
  • Type: java.util.List<java.lang.String>
passwordPolicyInputOptional 
public java.lang.String getPasswordPolicyInput();
  • Type: java.lang.String
pathInputOptional 
public java.lang.String getPathInput();
  • Type: java.lang.String
pluginVersionInputOptional 
public java.lang.String getPluginVersionInput();
  • Type: java.lang.String
requestTimeoutInputOptional 
public java.lang.Number getRequestTimeoutInput();
  • Type: java.lang.Number
schemaInputOptional 
public java.lang.String getSchemaInput();
  • Type: java.lang.String
sealWrapInputOptional 
public java.lang.Object getSealWrapInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
skipStaticRoleImportRotationInputOptional 
public java.lang.Object getSkipStaticRoleImportRotationInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
starttlsInputOptional 
public java.lang.Object getStarttlsInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
upndomainInputOptional 
public java.lang.String getUpndomainInput();
  • Type: java.lang.String
urlInputOptional 
public java.lang.String getUrlInput();
  • Type: java.lang.String
userattrInputOptional 
public java.lang.String getUserattrInput();
  • Type: java.lang.String
userdnInputOptional 
public java.lang.String getUserdnInput();
  • Type: java.lang.String
allowedManagedKeysRequired 
public java.util.List<java.lang.String> getAllowedManagedKeys();
  • Type: java.util.List<java.lang.String>
allowedResponseHeadersRequired 
public java.util.List<java.lang.String> getAllowedResponseHeaders();
  • Type: java.util.List<java.lang.String>
auditNonHmacRequestKeysRequired 
public java.util.List<java.lang.String> getAuditNonHmacRequestKeys();
  • Type: java.util.List<java.lang.String>
auditNonHmacResponseKeysRequired 
public java.util.List<java.lang.String> getAuditNonHmacResponseKeys();
  • Type: java.util.List<java.lang.String>
binddnRequired 
public java.lang.String getBinddn();
  • Type: java.lang.String
bindpassRequired 
public java.lang.String getBindpass();
  • Type: java.lang.String
certificateRequired 
public java.lang.String getCertificate();
  • Type: java.lang.String
clientTlsCertRequired 
public java.lang.String getClientTlsCert();
  • Type: java.lang.String
clientTlsKeyRequired 
public java.lang.String getClientTlsKey();
  • Type: java.lang.String
connectionTimeoutRequired 
public java.lang.Number getConnectionTimeout();
  • Type: java.lang.Number
defaultLeaseTtlSecondsRequired 
public java.lang.Number getDefaultLeaseTtlSeconds();
  • Type: java.lang.Number
delegatedAuthAccessorsRequired 
public java.util.List<java.lang.String> getDelegatedAuthAccessors();
  • Type: java.util.List<java.lang.String>
descriptionRequired 
public java.lang.String getDescription();
  • Type: java.lang.String
disableRemountRequired 
public java.lang.Object getDisableRemount();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
externalEntropyAccessRequired 
public java.lang.Object getExternalEntropyAccess();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
identityTokenKeyRequired 
public java.lang.String getIdentityTokenKey();
  • Type: java.lang.String
insecureTlsRequired 
public java.lang.Object getInsecureTls();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
listingVisibilityRequired 
public java.lang.String getListingVisibility();
  • Type: java.lang.String
localRequired 
public java.lang.Object getLocal();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
maxLeaseTtlSecondsRequired 
public java.lang.Number getMaxLeaseTtlSeconds();
  • Type: java.lang.Number
namespaceRequired 
public java.lang.String getNamespace();
  • Type: java.lang.String
optionsRequired 
public java.util.Map<java.lang.String, java.lang.String> getOptions();
  • Type: java.util.Map<java.lang.String, java.lang.String>
passthroughRequestHeadersRequired 
public java.util.List<java.lang.String> getPassthroughRequestHeaders();
  • Type: java.util.List<java.lang.String>
passwordPolicyRequired 
public java.lang.String getPasswordPolicy();
  • Type: java.lang.String
pathRequired 
public java.lang.String getPath();
  • Type: java.lang.String
pluginVersionRequired 
public java.lang.String getPluginVersion();
  • Type: java.lang.String
requestTimeoutRequired 
public java.lang.Number getRequestTimeout();
  • Type: java.lang.Number
schemaRequired 
public java.lang.String getSchema();
  • Type: java.lang.String
sealWrapRequired 
public java.lang.Object getSealWrap();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
skipStaticRoleImportRotationRequired 
public java.lang.Object getSkipStaticRoleImportRotation();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
starttlsRequired 
public java.lang.Object getStarttls();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
upndomainRequired 
public java.lang.String getUpndomain();
  • Type: java.lang.String
urlRequired 
public java.lang.String getUrl();
  • Type: java.lang.String
userattrRequired 
public java.lang.String getUserattr();
  • Type: java.lang.String
userdnRequired 
public java.lang.String getUserdn();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

LdapSecretBackendConfig

Initializer 

import com.hashicorp.cdktf.providers.vault.ldap_secret_backend.LdapSecretBackendConfig;

LdapSecretBackendConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .binddn(java.lang.String)
    .bindpass(java.lang.String)
//  .allowedManagedKeys(java.util.List<java.lang.String>)
//  .allowedResponseHeaders(java.util.List<java.lang.String>)
//  .auditNonHmacRequestKeys(java.util.List<java.lang.String>)
//  .auditNonHmacResponseKeys(java.util.List<java.lang.String>)
//  .certificate(java.lang.String)
//  .clientTlsCert(java.lang.String)
//  .clientTlsKey(java.lang.String)
//  .connectionTimeout(java.lang.Number)
//  .defaultLeaseTtlSeconds(java.lang.Number)
//  .delegatedAuthAccessors(java.util.List<java.lang.String>)
//  .description(java.lang.String)
//  .disableRemount(java.lang.Boolean)
//  .disableRemount(IResolvable)
//  .externalEntropyAccess(java.lang.Boolean)
//  .externalEntropyAccess(IResolvable)
//  .id(java.lang.String)
//  .identityTokenKey(java.lang.String)
//  .insecureTls(java.lang.Boolean)
//  .insecureTls(IResolvable)
//  .listingVisibility(java.lang.String)
//  .local(java.lang.Boolean)
//  .local(IResolvable)
//  .maxLeaseTtlSeconds(java.lang.Number)
//  .namespace(java.lang.String)
//  .options(java.util.Map<java.lang.String, java.lang.String>)
//  .passthroughRequestHeaders(java.util.List<java.lang.String>)
//  .passwordPolicy(java.lang.String)
//  .path(java.lang.String)
//  .pluginVersion(java.lang.String)
//  .requestTimeout(java.lang.Number)
//  .schema(java.lang.String)
//  .sealWrap(java.lang.Boolean)
//  .sealWrap(IResolvable)
//  .skipStaticRoleImportRotation(java.lang.Boolean)
//  .skipStaticRoleImportRotation(IResolvable)
//  .starttls(java.lang.Boolean)
//  .starttls(IResolvable)
//  .upndomain(java.lang.String)
//  .url(java.lang.String)
//  .userattr(java.lang.String)
//  .userdn(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
binddn java.lang.String Distinguished name of object to bind when performing user and group search.
bindpass java.lang.String LDAP password for searching for the user DN.
allowedManagedKeys java.util.List<java.lang.String> List of managed key registry entry names that the mount in question is allowed to access.
allowedResponseHeaders java.util.List<java.lang.String> List of headers to allow and pass from the request to the plugin.
auditNonHmacRequestKeys java.util.List<java.lang.String> Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
auditNonHmacResponseKeys java.util.List<java.lang.String> Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
certificate java.lang.String CA certificate to use when verifying LDAP server certificate, must be x509 PEM encoded.
clientTlsCert java.lang.String Client certificate to provide to the LDAP server, must be x509 PEM encoded.
clientTlsKey java.lang.String Client certificate key to provide to the LDAP server, must be x509 PEM encoded.
connectionTimeout java.lang.Number Timeout, in seconds, when attempting to connect to the LDAP server before trying the next URL in the configuration.
defaultLeaseTtlSeconds java.lang.Number Default lease duration for tokens and secrets in seconds.
delegatedAuthAccessors java.util.List<java.lang.String> List of headers to allow and pass from the request to the plugin.
description java.lang.String Human-friendly description of the mount.
disableRemount java.lang.Boolean OR com.hashicorp.cdktf.IResolvable If set, opts out of mount migration on path updates.
externalEntropyAccess java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enable the secrets engine to access Vault's external entropy source.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#id LdapSecretBackend#id}.
identityTokenKey java.lang.String The key to use for signing plugin workload identity tokens.
insecureTls java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Skip LDAP server SSL Certificate verification - insecure and not recommended for production use.
listingVisibility java.lang.String Specifies whether to show this mount in the UI-specific listing endpoint.
local java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Local mount flag that can be explicitly set to true to enforce local mount in HA environment.
maxLeaseTtlSeconds java.lang.Number Maximum possible lease duration for tokens and secrets in seconds.
namespace java.lang.String Target namespace. (requires Enterprise).
options java.util.Map<java.lang.String, java.lang.String> Specifies mount type specific options that are passed to the backend.
passthroughRequestHeaders java.util.List<java.lang.String> List of headers to allow and pass from the request to the plugin.
passwordPolicy java.lang.String Name of the password policy to use to generate passwords.
path java.lang.String The path where the LDAP secrets backend is mounted.
pluginVersion java.lang.String Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'.
requestTimeout java.lang.Number Timeout, in seconds, for the connection when making requests against the server before returning back an error.
schema java.lang.String The LDAP schema to use when storing entry passwords. Valid schemas include openldap, ad, and racf.
sealWrap java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability.
skipStaticRoleImportRotation java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Skip rotation of static role secrets on import.
starttls java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Issue a StartTLS command after establishing unencrypted connection.
upndomain java.lang.String Enables userPrincipalDomain login with [username]@UPNDomain.
url java.lang.String LDAP URL to connect to (default: ldap://127.0.0.1). Multiple URLs can be specified by concatenating them with commas; they will be tried in-order.
userattr java.lang.String Attribute used for users (default: cn).
userdn java.lang.String LDAP domain to use for users (eg: ou=People,dc=example,dc=org).
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
binddnRequired 
public java.lang.String getBinddn();
  • Type: java.lang.String

Distinguished name of object to bind when performing user and group search.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#binddn LdapSecretBackend#binddn}

bindpassRequired 
public java.lang.String getBindpass();
  • Type: java.lang.String

LDAP password for searching for the user DN.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#bindpass LdapSecretBackend#bindpass}

allowedManagedKeysOptional 
public java.util.List<java.lang.String> getAllowedManagedKeys();
  • Type: java.util.List<java.lang.String>

List of managed key registry entry names that the mount in question is allowed to access.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#allowed_managed_keys LdapSecretBackend#allowed_managed_keys}

allowedResponseHeadersOptional 
public java.util.List<java.lang.String> getAllowedResponseHeaders();
  • Type: java.util.List<java.lang.String>

List of headers to allow and pass from the request to the plugin.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#allowed_response_headers LdapSecretBackend#allowed_response_headers}

auditNonHmacRequestKeysOptional 
public java.util.List<java.lang.String> getAuditNonHmacRequestKeys();
  • Type: java.util.List<java.lang.String>

Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#audit_non_hmac_request_keys LdapSecretBackend#audit_non_hmac_request_keys}

auditNonHmacResponseKeysOptional 
public java.util.List<java.lang.String> getAuditNonHmacResponseKeys();
  • Type: java.util.List<java.lang.String>

Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#audit_non_hmac_response_keys LdapSecretBackend#audit_non_hmac_response_keys}

certificateOptional 
public java.lang.String getCertificate();
  • Type: java.lang.String

CA certificate to use when verifying LDAP server certificate, must be x509 PEM encoded.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#certificate LdapSecretBackend#certificate}

clientTlsCertOptional 
public java.lang.String getClientTlsCert();
  • Type: java.lang.String

Client certificate to provide to the LDAP server, must be x509 PEM encoded.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#client_tls_cert LdapSecretBackend#client_tls_cert}

clientTlsKeyOptional 
public java.lang.String getClientTlsKey();
  • Type: java.lang.String

Client certificate key to provide to the LDAP server, must be x509 PEM encoded.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#client_tls_key LdapSecretBackend#client_tls_key}

connectionTimeoutOptional 
public java.lang.Number getConnectionTimeout();
  • Type: java.lang.Number

Timeout, in seconds, when attempting to connect to the LDAP server before trying the next URL in the configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#connection_timeout LdapSecretBackend#connection_timeout}

defaultLeaseTtlSecondsOptional 
public java.lang.Number getDefaultLeaseTtlSeconds();
  • Type: java.lang.Number

Default lease duration for tokens and secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#default_lease_ttl_seconds LdapSecretBackend#default_lease_ttl_seconds}

delegatedAuthAccessorsOptional 
public java.util.List<java.lang.String> getDelegatedAuthAccessors();
  • Type: java.util.List<java.lang.String>

List of headers to allow and pass from the request to the plugin.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#delegated_auth_accessors LdapSecretBackend#delegated_auth_accessors}

descriptionOptional 
public java.lang.String getDescription();
  • Type: java.lang.String

Human-friendly description of the mount.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#description LdapSecretBackend#description}

disableRemountOptional 
public java.lang.Object getDisableRemount();
  • Type: java.lang.Boolean OR com.hashicorp.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.4.0/docs/resources/ldap_secret_backend#disable_remount LdapSecretBackend#disable_remount}

externalEntropyAccessOptional 
public java.lang.Object getExternalEntropyAccess();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Enable the secrets engine to access Vault's external entropy source.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#external_entropy_access LdapSecretBackend#external_entropy_access}

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

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

identityTokenKeyOptional 
public java.lang.String getIdentityTokenKey();
  • Type: java.lang.String

The key to use for signing plugin workload identity tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#identity_token_key LdapSecretBackend#identity_token_key}

insecureTlsOptional 
public java.lang.Object getInsecureTls();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Skip LDAP server SSL Certificate verification - insecure and not recommended for production use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#insecure_tls LdapSecretBackend#insecure_tls}

listingVisibilityOptional 
public java.lang.String getListingVisibility();
  • Type: java.lang.String

Specifies whether to show this mount in the UI-specific listing endpoint.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#listing_visibility LdapSecretBackend#listing_visibility}

localOptional 
public java.lang.Object getLocal();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Local mount flag that can be explicitly set to true to enforce local mount in HA environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#local LdapSecretBackend#local}

maxLeaseTtlSecondsOptional 
public java.lang.Number getMaxLeaseTtlSeconds();
  • Type: java.lang.Number

Maximum possible lease duration for tokens and secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#max_lease_ttl_seconds LdapSecretBackend#max_lease_ttl_seconds}

namespaceOptional 
public java.lang.String getNamespace();
  • Type: java.lang.String

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#namespace LdapSecretBackend#namespace}

optionsOptional 
public java.util.Map<java.lang.String, java.lang.String> getOptions();
  • Type: java.util.Map<java.lang.String, java.lang.String>

Specifies mount type specific options that are passed to the backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#options LdapSecretBackend#options}

passthroughRequestHeadersOptional 
public java.util.List<java.lang.String> getPassthroughRequestHeaders();
  • Type: java.util.List<java.lang.String>

List of headers to allow and pass from the request to the plugin.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#passthrough_request_headers LdapSecretBackend#passthrough_request_headers}

passwordPolicyOptional 
public java.lang.String getPasswordPolicy();
  • Type: java.lang.String

Name of the password policy to use to generate passwords.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#password_policy LdapSecretBackend#password_policy}

pathOptional 
public java.lang.String getPath();
  • Type: java.lang.String

The path where the LDAP secrets backend is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#path LdapSecretBackend#path}

pluginVersionOptional 
public java.lang.String getPluginVersion();
  • Type: java.lang.String

Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#plugin_version LdapSecretBackend#plugin_version}

requestTimeoutOptional 
public java.lang.Number getRequestTimeout();
  • Type: java.lang.Number

Timeout, in seconds, for the connection when making requests against the server before returning back an error.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#request_timeout LdapSecretBackend#request_timeout}

schemaOptional 
public java.lang.String getSchema();
  • Type: java.lang.String

The LDAP schema to use when storing entry passwords. Valid schemas include openldap, ad, and racf.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#schema LdapSecretBackend#schema}

sealWrapOptional 
public java.lang.Object getSealWrap();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#seal_wrap LdapSecretBackend#seal_wrap}

skipStaticRoleImportRotationOptional 
public java.lang.Object getSkipStaticRoleImportRotation();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Skip rotation of static role secrets on import.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#skip_static_role_import_rotation LdapSecretBackend#skip_static_role_import_rotation}

starttlsOptional 
public java.lang.Object getStarttls();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Issue a StartTLS command after establishing unencrypted connection.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#starttls LdapSecretBackend#starttls}

upndomainOptional 
public java.lang.String getUpndomain();
  • Type: java.lang.String

Enables userPrincipalDomain login with [username]@UPNDomain.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#upndomain LdapSecretBackend#upndomain}

urlOptional 
public java.lang.String getUrl();
  • Type: java.lang.String

LDAP URL to connect to (default: ldap://127.0.0.1). Multiple URLs can be specified by concatenating them with commas; they will be tried in-order.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#url LdapSecretBackend#url}

userattrOptional 
public java.lang.String getUserattr();
  • Type: java.lang.String

Attribute used for users (default: cn).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#userattr LdapSecretBackend#userattr}

userdnOptional 
public java.lang.String getUserdn();
  • Type: java.lang.String

LDAP domain to use for users (eg: ou=People,dc=example,dc=org).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.4.0/docs/resources/ldap_secret_backend#userdn LdapSecretBackend#userdn}