Skip to content

Latest commit

 

History

History
3868 lines (2428 loc) · 168 KB

provider.java.md

File metadata and controls

3868 lines (2428 loc) · 168 KB
Raw

provider Submodule

Constructs

VaultProvider

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

Initializers 

import com.hashicorp.cdktf.providers.vault.provider.VaultProvider;

VaultProvider.Builder.create(Construct scope, java.lang.String id)
    .address(java.lang.String)
//  .addAddressToEnv(java.lang.String)
//  .alias(java.lang.String)
//  .authLogin(VaultProviderAuthLogin)
//  .authLoginAws(VaultProviderAuthLoginAws)
//  .authLoginAzure(VaultProviderAuthLoginAzure)
//  .authLoginCert(VaultProviderAuthLoginCert)
//  .authLoginGcp(VaultProviderAuthLoginGcp)
//  .authLoginJwt(VaultProviderAuthLoginJwt)
//  .authLoginKerberos(VaultProviderAuthLoginKerberos)
//  .authLoginOci(VaultProviderAuthLoginOci)
//  .authLoginOidc(VaultProviderAuthLoginOidc)
//  .authLoginRadius(VaultProviderAuthLoginRadius)
//  .authLoginTokenFile(VaultProviderAuthLoginTokenFile)
//  .authLoginUserpass(VaultProviderAuthLoginUserpass)
//  .caCertDir(java.lang.String)
//  .caCertFile(java.lang.String)
//  .clientAuth(VaultProviderClientAuth)
//  .headers(IResolvable)
//  .headers(java.util.List<VaultProviderHeaders>)
//  .maxLeaseTtlSeconds(java.lang.Number)
//  .maxRetries(java.lang.Number)
//  .maxRetriesCcc(java.lang.Number)
//  .namespace(java.lang.String)
//  .setNamespaceFromToken(java.lang.Boolean)
//  .setNamespaceFromToken(IResolvable)
//  .skipChildToken(java.lang.Boolean)
//  .skipChildToken(IResolvable)
//  .skipGetVaultVersion(java.lang.Boolean)
//  .skipGetVaultVersion(IResolvable)
//  .skipTlsVerify(java.lang.Boolean)
//  .skipTlsVerify(IResolvable)
//  .tlsServerName(java.lang.String)
//  .token(java.lang.String)
//  .tokenName(java.lang.String)
//  .vaultVersionOverride(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.
address java.lang.String URL of the root of the target Vault server.
addAddressToEnv java.lang.String If true, adds the value of the address argument to the Terraform process environment.
alias java.lang.String Alias name.
authLogin VaultProviderAuthLogin auth_login block.
authLoginAws VaultProviderAuthLoginAws auth_login_aws block.
authLoginAzure VaultProviderAuthLoginAzure auth_login_azure block.
authLoginCert VaultProviderAuthLoginCert auth_login_cert block.
authLoginGcp VaultProviderAuthLoginGcp auth_login_gcp block.
authLoginJwt VaultProviderAuthLoginJwt auth_login_jwt block.
authLoginKerberos VaultProviderAuthLoginKerberos auth_login_kerberos block.
authLoginOci VaultProviderAuthLoginOci auth_login_oci block.
authLoginOidc VaultProviderAuthLoginOidc auth_login_oidc block.
authLoginRadius VaultProviderAuthLoginRadius auth_login_radius block.
authLoginTokenFile VaultProviderAuthLoginTokenFile auth_login_token_file block.
authLoginUserpass VaultProviderAuthLoginUserpass auth_login_userpass block.
caCertDir java.lang.String Path to directory containing CA certificate files to validate the server's certificate.
caCertFile java.lang.String Path to a CA certificate file to validate the server's certificate.
clientAuth VaultProviderClientAuth client_auth block.
headers com.hashicorp.cdktf.IResolvable OR java.util.List<VaultProviderHeaders> headers block.
maxLeaseTtlSeconds java.lang.Number Maximum TTL for secret leases requested by this provider.
maxRetries java.lang.Number Maximum number of retries when a 5xx error code is encountered.
maxRetriesCcc java.lang.Number Maximum number of retries for Client Controlled Consistency related operations.
namespace java.lang.String The namespace to use. Available only for Vault Enterprise.
setNamespaceFromToken java.lang.Boolean OR com.hashicorp.cdktf.IResolvable In the case where the Vault token is for a specific namespace and the provider namespace is not configured, use the token namespace as the root namespace for all resources.
skipChildToken java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Set this to true to prevent the creation of ephemeral child token used by this provider.
skipGetVaultVersion java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Skip the dynamic fetching of the Vault server version.
skipTlsVerify java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Set this to true only if the target Vault server is an insecure development instance.
tlsServerName java.lang.String Name to use as the SNI host when connecting via TLS.
token java.lang.String Token to use to authenticate to Vault.
tokenName java.lang.String Token name to use for creating the Vault child token.
vaultVersionOverride java.lang.String Override the Vault server version, which is normally determined dynamically from the target Vault server.
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

addressRequired
  • Type: java.lang.String

URL of the root of the target Vault server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#address VaultProvider#address}

addAddressToEnvOptional
  • Type: java.lang.String

If true, adds the value of the address argument to the Terraform process environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#add_address_to_env VaultProvider#add_address_to_env}

aliasOptional
  • Type: java.lang.String

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#alias VaultProvider#alias}

authLoginOptional

auth_login block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login VaultProvider#auth_login}

authLoginAwsOptional

auth_login_aws block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_aws VaultProvider#auth_login_aws}

authLoginAzureOptional

auth_login_azure block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_azure VaultProvider#auth_login_azure}

authLoginCertOptional

auth_login_cert block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_cert VaultProvider#auth_login_cert}

authLoginGcpOptional

auth_login_gcp block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_gcp VaultProvider#auth_login_gcp}

authLoginJwtOptional

auth_login_jwt block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_jwt VaultProvider#auth_login_jwt}

authLoginKerberosOptional

auth_login_kerberos block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_kerberos VaultProvider#auth_login_kerberos}

authLoginOciOptional

auth_login_oci block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_oci VaultProvider#auth_login_oci}

authLoginOidcOptional

auth_login_oidc block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_oidc VaultProvider#auth_login_oidc}

authLoginRadiusOptional

auth_login_radius block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_radius VaultProvider#auth_login_radius}

authLoginTokenFileOptional

auth_login_token_file block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_token_file VaultProvider#auth_login_token_file}

authLoginUserpassOptional

auth_login_userpass block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_userpass VaultProvider#auth_login_userpass}

caCertDirOptional
  • Type: java.lang.String

Path to directory containing CA certificate files to validate the server's certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#ca_cert_dir VaultProvider#ca_cert_dir}

caCertFileOptional
  • Type: java.lang.String

Path to a CA certificate file to validate the server's certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#ca_cert_file VaultProvider#ca_cert_file}

clientAuthOptional

client_auth block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#client_auth VaultProvider#client_auth}

headersOptional

headers block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#headers VaultProvider#headers}

maxLeaseTtlSecondsOptional
  • Type: java.lang.Number

Maximum TTL for secret leases requested by this provider.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#max_lease_ttl_seconds VaultProvider#max_lease_ttl_seconds}

maxRetriesOptional
  • Type: java.lang.Number

Maximum number of retries when a 5xx error code is encountered.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#max_retries VaultProvider#max_retries}

maxRetriesCccOptional
  • Type: java.lang.Number

Maximum number of retries for Client Controlled Consistency related operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#max_retries_ccc VaultProvider#max_retries_ccc}

namespaceOptional
  • Type: java.lang.String

The namespace to use. Available only for Vault Enterprise.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#namespace VaultProvider#namespace}

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

In the case where the Vault token is for a specific namespace and the provider namespace is not configured, use the token namespace as the root namespace for all resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#set_namespace_from_token VaultProvider#set_namespace_from_token}

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

Set this to true to prevent the creation of ephemeral child token used by this provider.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#skip_child_token VaultProvider#skip_child_token}

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

Skip the dynamic fetching of the Vault server version.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#skip_get_vault_version VaultProvider#skip_get_vault_version}

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

Set this to true only if the target Vault server is an insecure development instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#skip_tls_verify VaultProvider#skip_tls_verify}

tlsServerNameOptional
  • Type: java.lang.String

Name to use as the SNI host when connecting via TLS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#tls_server_name VaultProvider#tls_server_name}

tokenOptional
  • Type: java.lang.String

Token to use to authenticate to Vault.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#token VaultProvider#token}

tokenNameOptional
  • Type: java.lang.String

Token name to use for creating the Vault child token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#token_name VaultProvider#token_name}

vaultVersionOverrideOptional
  • Type: java.lang.String

Override the Vault server version, which is normally determined dynamically from the target Vault server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#vault_version_override VaultProvider#vault_version_override}

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.
resetAddAddressToEnv No description.
resetAlias No description.
resetAuthLogin No description.
resetAuthLoginAws No description.
resetAuthLoginAzure No description.
resetAuthLoginCert No description.
resetAuthLoginGcp No description.
resetAuthLoginJwt No description.
resetAuthLoginKerberos No description.
resetAuthLoginOci No description.
resetAuthLoginOidc No description.
resetAuthLoginRadius No description.
resetAuthLoginTokenFile No description.
resetAuthLoginUserpass No description.
resetCaCertDir No description.
resetCaCertFile No description.
resetClientAuth No description.
resetHeaders No description.
resetMaxLeaseTtlSeconds No description.
resetMaxRetries No description.
resetMaxRetriesCcc No description.
resetNamespace No description.
resetSetNamespaceFromToken No description.
resetSkipChildToken No description.
resetSkipGetVaultVersion No description.
resetSkipTlsVerify No description.
resetTlsServerName No description.
resetToken No description.
resetTokenName No description.
resetVaultVersionOverride 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.

resetAddAddressToEnv 
public void resetAddAddressToEnv()
resetAlias 
public void resetAlias()
resetAuthLogin 
public void resetAuthLogin()
resetAuthLoginAws 
public void resetAuthLoginAws()
resetAuthLoginAzure 
public void resetAuthLoginAzure()
resetAuthLoginCert 
public void resetAuthLoginCert()
resetAuthLoginGcp 
public void resetAuthLoginGcp()
resetAuthLoginJwt 
public void resetAuthLoginJwt()
resetAuthLoginKerberos 
public void resetAuthLoginKerberos()
resetAuthLoginOci 
public void resetAuthLoginOci()
resetAuthLoginOidc 
public void resetAuthLoginOidc()
resetAuthLoginRadius 
public void resetAuthLoginRadius()
resetAuthLoginTokenFile 
public void resetAuthLoginTokenFile()
resetAuthLoginUserpass 
public void resetAuthLoginUserpass()
resetCaCertDir 
public void resetCaCertDir()
resetCaCertFile 
public void resetCaCertFile()
resetClientAuth 
public void resetClientAuth()
resetHeaders 
public void resetHeaders()
resetMaxLeaseTtlSeconds 
public void resetMaxLeaseTtlSeconds()
resetMaxRetries 
public void resetMaxRetries()
resetMaxRetriesCcc 
public void resetMaxRetriesCcc()
resetNamespace 
public void resetNamespace()
resetSetNamespaceFromToken 
public void resetSetNamespaceFromToken()
resetSkipChildToken 
public void resetSkipChildToken()
resetSkipGetVaultVersion 
public void resetSkipGetVaultVersion()
resetSkipTlsVerify 
public void resetSkipTlsVerify()
resetTlsServerName 
public void resetTlsServerName()
resetToken 
public void resetToken()
resetTokenName 
public void resetTokenName()
resetVaultVersionOverride 
public void resetVaultVersionOverride()

Static Functions

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

VaultProvider.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.provider.VaultProvider;

VaultProvider.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformProvider 
import com.hashicorp.cdktf.providers.vault.provider.VaultProvider;

VaultProvider.isTerraformProvider(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.vault.provider.VaultProvider;

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

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing VaultProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#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 VaultProvider 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.
metaAttributes java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
terraformProviderSource java.lang.String No description.
alias java.lang.String No description.
addAddressToEnvInput java.lang.String No description.
addressInput java.lang.String No description.
aliasInput java.lang.String No description.
authLoginAwsInput VaultProviderAuthLoginAws No description.
authLoginAzureInput VaultProviderAuthLoginAzure No description.
authLoginCertInput VaultProviderAuthLoginCert No description.
authLoginGcpInput VaultProviderAuthLoginGcp No description.
authLoginInput VaultProviderAuthLogin No description.
authLoginJwtInput VaultProviderAuthLoginJwt No description.
authLoginKerberosInput VaultProviderAuthLoginKerberos No description.
authLoginOciInput VaultProviderAuthLoginOci No description.
authLoginOidcInput VaultProviderAuthLoginOidc No description.
authLoginRadiusInput VaultProviderAuthLoginRadius No description.
authLoginTokenFileInput VaultProviderAuthLoginTokenFile No description.
authLoginUserpassInput VaultProviderAuthLoginUserpass No description.
caCertDirInput java.lang.String No description.
caCertFileInput java.lang.String No description.
clientAuthInput VaultProviderClientAuth No description.
headersInput com.hashicorp.cdktf.IResolvable OR java.util.List<VaultProviderHeaders> No description.
maxLeaseTtlSecondsInput java.lang.Number No description.
maxRetriesCccInput java.lang.Number No description.
maxRetriesInput java.lang.Number No description.
namespaceInput java.lang.String No description.
setNamespaceFromTokenInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
skipChildTokenInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
skipGetVaultVersionInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
skipTlsVerifyInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tlsServerNameInput java.lang.String No description.
tokenInput java.lang.String No description.
tokenNameInput java.lang.String No description.
vaultVersionOverrideInput java.lang.String No description.
addAddressToEnv java.lang.String No description.
address java.lang.String No description.
authLogin VaultProviderAuthLogin No description.
authLoginAws VaultProviderAuthLoginAws No description.
authLoginAzure VaultProviderAuthLoginAzure No description.
authLoginCert VaultProviderAuthLoginCert No description.
authLoginGcp VaultProviderAuthLoginGcp No description.
authLoginJwt VaultProviderAuthLoginJwt No description.
authLoginKerberos VaultProviderAuthLoginKerberos No description.
authLoginOci VaultProviderAuthLoginOci No description.
authLoginOidc VaultProviderAuthLoginOidc No description.
authLoginRadius VaultProviderAuthLoginRadius No description.
authLoginTokenFile VaultProviderAuthLoginTokenFile No description.
authLoginUserpass VaultProviderAuthLoginUserpass No description.
caCertDir java.lang.String No description.
caCertFile java.lang.String No description.
clientAuth VaultProviderClientAuth No description.
headers com.hashicorp.cdktf.IResolvable OR java.util.List<VaultProviderHeaders> No description.
maxLeaseTtlSeconds java.lang.Number No description.
maxRetries java.lang.Number No description.
maxRetriesCcc java.lang.Number No description.
namespace java.lang.String No description.
setNamespaceFromToken java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
skipChildToken java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
skipGetVaultVersion java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
skipTlsVerify java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
tlsServerName java.lang.String No description.
token java.lang.String No description.
tokenName java.lang.String No description.
vaultVersionOverride 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
metaAttributesRequired 
public java.util.Map<java.lang.String, java.lang.Object> getMetaAttributes();
  • 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
terraformProviderSourceOptional 
public java.lang.String getTerraformProviderSource();
  • Type: java.lang.String
aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String
addAddressToEnvInputOptional 
public java.lang.String getAddAddressToEnvInput();
  • Type: java.lang.String
addressInputOptional 
public java.lang.String getAddressInput();
  • Type: java.lang.String
aliasInputOptional 
public java.lang.String getAliasInput();
  • Type: java.lang.String
authLoginAwsInputOptional 
public VaultProviderAuthLoginAws getAuthLoginAwsInput();
authLoginAzureInputOptional 
public VaultProviderAuthLoginAzure getAuthLoginAzureInput();
authLoginCertInputOptional 
public VaultProviderAuthLoginCert getAuthLoginCertInput();
authLoginGcpInputOptional 
public VaultProviderAuthLoginGcp getAuthLoginGcpInput();
authLoginInputOptional 
public VaultProviderAuthLogin getAuthLoginInput();
authLoginJwtInputOptional 
public VaultProviderAuthLoginJwt getAuthLoginJwtInput();
authLoginKerberosInputOptional 
public VaultProviderAuthLoginKerberos getAuthLoginKerberosInput();
authLoginOciInputOptional 
public VaultProviderAuthLoginOci getAuthLoginOciInput();
authLoginOidcInputOptional 
public VaultProviderAuthLoginOidc getAuthLoginOidcInput();
authLoginRadiusInputOptional 
public VaultProviderAuthLoginRadius getAuthLoginRadiusInput();
authLoginTokenFileInputOptional 
public VaultProviderAuthLoginTokenFile getAuthLoginTokenFileInput();
authLoginUserpassInputOptional 
public VaultProviderAuthLoginUserpass getAuthLoginUserpassInput();
caCertDirInputOptional 
public java.lang.String getCaCertDirInput();
  • Type: java.lang.String
caCertFileInputOptional 
public java.lang.String getCaCertFileInput();
  • Type: java.lang.String
clientAuthInputOptional 
public VaultProviderClientAuth getClientAuthInput();
headersInputOptional 
public java.lang.Object getHeadersInput();
maxLeaseTtlSecondsInputOptional 
public java.lang.Number getMaxLeaseTtlSecondsInput();
  • Type: java.lang.Number
maxRetriesCccInputOptional 
public java.lang.Number getMaxRetriesCccInput();
  • Type: java.lang.Number
maxRetriesInputOptional 
public java.lang.Number getMaxRetriesInput();
  • Type: java.lang.Number
namespaceInputOptional 
public java.lang.String getNamespaceInput();
  • Type: java.lang.String
setNamespaceFromTokenInputOptional 
public java.lang.Object getSetNamespaceFromTokenInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
skipChildTokenInputOptional 
public java.lang.Object getSkipChildTokenInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
skipGetVaultVersionInputOptional 
public java.lang.Object getSkipGetVaultVersionInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
skipTlsVerifyInputOptional 
public java.lang.Object getSkipTlsVerifyInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
tlsServerNameInputOptional 
public java.lang.String getTlsServerNameInput();
  • Type: java.lang.String
tokenInputOptional 
public java.lang.String getTokenInput();
  • Type: java.lang.String
tokenNameInputOptional 
public java.lang.String getTokenNameInput();
  • Type: java.lang.String
vaultVersionOverrideInputOptional 
public java.lang.String getVaultVersionOverrideInput();
  • Type: java.lang.String
addAddressToEnvOptional 
public java.lang.String getAddAddressToEnv();
  • Type: java.lang.String
addressOptional 
public java.lang.String getAddress();
  • Type: java.lang.String
authLoginOptional 
public VaultProviderAuthLogin getAuthLogin();
authLoginAwsOptional 
public VaultProviderAuthLoginAws getAuthLoginAws();
authLoginAzureOptional 
public VaultProviderAuthLoginAzure getAuthLoginAzure();
authLoginCertOptional 
public VaultProviderAuthLoginCert getAuthLoginCert();
authLoginGcpOptional 
public VaultProviderAuthLoginGcp getAuthLoginGcp();
authLoginJwtOptional 
public VaultProviderAuthLoginJwt getAuthLoginJwt();
authLoginKerberosOptional 
public VaultProviderAuthLoginKerberos getAuthLoginKerberos();
authLoginOciOptional 
public VaultProviderAuthLoginOci getAuthLoginOci();
authLoginOidcOptional 
public VaultProviderAuthLoginOidc getAuthLoginOidc();
authLoginRadiusOptional 
public VaultProviderAuthLoginRadius getAuthLoginRadius();
authLoginTokenFileOptional 
public VaultProviderAuthLoginTokenFile getAuthLoginTokenFile();
authLoginUserpassOptional 
public VaultProviderAuthLoginUserpass getAuthLoginUserpass();
caCertDirOptional 
public java.lang.String getCaCertDir();
  • Type: java.lang.String
caCertFileOptional 
public java.lang.String getCaCertFile();
  • Type: java.lang.String
clientAuthOptional 
public VaultProviderClientAuth getClientAuth();
headersOptional 
public java.lang.Object getHeaders();
maxLeaseTtlSecondsOptional 
public java.lang.Number getMaxLeaseTtlSeconds();
  • Type: java.lang.Number
maxRetriesOptional 
public java.lang.Number getMaxRetries();
  • Type: java.lang.Number
maxRetriesCccOptional 
public java.lang.Number getMaxRetriesCcc();
  • Type: java.lang.Number
namespaceOptional 
public java.lang.String getNamespace();
  • Type: java.lang.String
setNamespaceFromTokenOptional 
public java.lang.Object getSetNamespaceFromToken();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
skipChildTokenOptional 
public java.lang.Object getSkipChildToken();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
skipGetVaultVersionOptional 
public java.lang.Object getSkipGetVaultVersion();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
skipTlsVerifyOptional 
public java.lang.Object getSkipTlsVerify();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
tlsServerNameOptional 
public java.lang.String getTlsServerName();
  • Type: java.lang.String
tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String
tokenNameOptional 
public java.lang.String getTokenName();
  • Type: java.lang.String
vaultVersionOverrideOptional 
public java.lang.String getVaultVersionOverride();
  • 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

VaultProviderAuthLogin

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderAuthLogin;

VaultProviderAuthLogin.builder()
    .path(java.lang.String)
//  .method(java.lang.String)
//  .namespace(java.lang.String)
//  .parameters(java.util.Map<java.lang.String, java.lang.String>)
//  .useRootNamespace(java.lang.Boolean)
//  .useRootNamespace(IResolvable)
    .build();

Properties

Name Type Description
path java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#path VaultProvider#path}.
method java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#method VaultProvider#method}.
namespace java.lang.String The authentication engine's namespace. Conflicts with use_root_namespace.
parameters java.util.Map<java.lang.String, java.lang.String> Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#parameters VaultProvider#parameters}.
useRootNamespace java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Authenticate to the root Vault namespace. Conflicts with namespace.
pathRequired 
public java.lang.String getPath();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#path VaultProvider#path}.

methodOptional 
public java.lang.String getMethod();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#method VaultProvider#method}.

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

The authentication engine's namespace. Conflicts with use_root_namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#namespace VaultProvider#namespace}

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#parameters VaultProvider#parameters}.

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

Authenticate to the root Vault namespace. Conflicts with namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#use_root_namespace VaultProvider#use_root_namespace}

VaultProviderAuthLoginAws

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderAuthLoginAws;

VaultProviderAuthLoginAws.builder()
    .role(java.lang.String)
//  .awsAccessKeyId(java.lang.String)
//  .awsIamEndpoint(java.lang.String)
//  .awsProfile(java.lang.String)
//  .awsRegion(java.lang.String)
//  .awsRoleArn(java.lang.String)
//  .awsRoleSessionName(java.lang.String)
//  .awsSecretAccessKey(java.lang.String)
//  .awsSessionToken(java.lang.String)
//  .awsSharedCredentialsFile(java.lang.String)
//  .awsStsEndpoint(java.lang.String)
//  .awsWebIdentityTokenFile(java.lang.String)
//  .headerValue(java.lang.String)
//  .mount(java.lang.String)
//  .namespace(java.lang.String)
//  .useRootNamespace(java.lang.Boolean)
//  .useRootNamespace(IResolvable)
    .build();

Properties

Name Type Description
role java.lang.String The Vault role to use when logging into Vault.
awsAccessKeyId java.lang.String The AWS access key ID.
awsIamEndpoint java.lang.String The IAM endpoint URL.
awsProfile java.lang.String The name of the AWS profile.
awsRegion java.lang.String The AWS region.
awsRoleArn java.lang.String The ARN of the AWS Role to assume.Used during STS AssumeRole.
awsRoleSessionName java.lang.String Specifies the name to attach to the AWS role session. Used during STS AssumeRole.
awsSecretAccessKey java.lang.String The AWS secret access key.
awsSessionToken java.lang.String The AWS session token.
awsSharedCredentialsFile java.lang.String Path to the AWS shared credentials file.
awsStsEndpoint java.lang.String The STS endpoint URL.
awsWebIdentityTokenFile java.lang.String Path to the file containing an OAuth 2.0 access token or OpenID Connect ID token.
headerValue java.lang.String The Vault header value to include in the STS signing request.
mount java.lang.String The path where the authentication engine is mounted.
namespace java.lang.String The authentication engine's namespace. Conflicts with use_root_namespace.
useRootNamespace java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Authenticate to the root Vault namespace. Conflicts with namespace.
roleRequired 
public java.lang.String getRole();
  • Type: java.lang.String

The Vault role to use when logging into Vault.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#role VaultProvider#role}

awsAccessKeyIdOptional 
public java.lang.String getAwsAccessKeyId();
  • Type: java.lang.String

The AWS access key ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#aws_access_key_id VaultProvider#aws_access_key_id}

awsIamEndpointOptional 
public java.lang.String getAwsIamEndpoint();
  • Type: java.lang.String

The IAM endpoint URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#aws_iam_endpoint VaultProvider#aws_iam_endpoint}

awsProfileOptional 
public java.lang.String getAwsProfile();
  • Type: java.lang.String

The name of the AWS profile.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#aws_profile VaultProvider#aws_profile}

awsRegionOptional 
public java.lang.String getAwsRegion();
  • Type: java.lang.String

The AWS region.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#aws_region VaultProvider#aws_region}

awsRoleArnOptional 
public java.lang.String getAwsRoleArn();
  • Type: java.lang.String

The ARN of the AWS Role to assume.Used during STS AssumeRole.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#aws_role_arn VaultProvider#aws_role_arn}

awsRoleSessionNameOptional 
public java.lang.String getAwsRoleSessionName();
  • Type: java.lang.String

Specifies the name to attach to the AWS role session. Used during STS AssumeRole.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#aws_role_session_name VaultProvider#aws_role_session_name}

awsSecretAccessKeyOptional 
public java.lang.String getAwsSecretAccessKey();
  • Type: java.lang.String

The AWS secret access key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#aws_secret_access_key VaultProvider#aws_secret_access_key}

awsSessionTokenOptional 
public java.lang.String getAwsSessionToken();
  • Type: java.lang.String

The AWS session token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#aws_session_token VaultProvider#aws_session_token}

awsSharedCredentialsFileOptional 
public java.lang.String getAwsSharedCredentialsFile();
  • Type: java.lang.String

Path to the AWS shared credentials file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#aws_shared_credentials_file VaultProvider#aws_shared_credentials_file}

awsStsEndpointOptional 
public java.lang.String getAwsStsEndpoint();
  • Type: java.lang.String

The STS endpoint URL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#aws_sts_endpoint VaultProvider#aws_sts_endpoint}

awsWebIdentityTokenFileOptional 
public java.lang.String getAwsWebIdentityTokenFile();
  • Type: java.lang.String

Path to the file containing an OAuth 2.0 access token or OpenID Connect ID token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#aws_web_identity_token_file VaultProvider#aws_web_identity_token_file}

headerValueOptional 
public java.lang.String getHeaderValue();
  • Type: java.lang.String

The Vault header value to include in the STS signing request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#header_value VaultProvider#header_value}

mountOptional 
public java.lang.String getMount();
  • Type: java.lang.String

The path where the authentication engine is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#mount VaultProvider#mount}

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

The authentication engine's namespace. Conflicts with use_root_namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#namespace VaultProvider#namespace}

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

Authenticate to the root Vault namespace. Conflicts with namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#use_root_namespace VaultProvider#use_root_namespace}

VaultProviderAuthLoginAzure

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderAuthLoginAzure;

VaultProviderAuthLoginAzure.builder()
    .resourceGroupName(java.lang.String)
    .role(java.lang.String)
    .subscriptionId(java.lang.String)
//  .clientId(java.lang.String)
//  .jwt(java.lang.String)
//  .mount(java.lang.String)
//  .namespace(java.lang.String)
//  .scope(java.lang.String)
//  .tenantId(java.lang.String)
//  .useRootNamespace(java.lang.Boolean)
//  .useRootNamespace(IResolvable)
//  .vmName(java.lang.String)
//  .vmssName(java.lang.String)
    .build();

Properties

Name Type Description
resourceGroupName java.lang.String The resource group for the machine that generated the MSI token. This information can be obtained through instance metadata.
role java.lang.String Name of the login role.
subscriptionId java.lang.String The subscription ID for the machine that generated the MSI token. This information can be obtained through instance metadata.
clientId java.lang.String The identity's client ID.
jwt java.lang.String A signed JSON Web Token. If not specified on will be created automatically.
mount java.lang.String The path where the authentication engine is mounted.
namespace java.lang.String The authentication engine's namespace. Conflicts with use_root_namespace.
scope java.lang.String The scopes to include in the token request.
tenantId java.lang.String Provides the tenant ID to use in a multi-tenant authentication scenario.
useRootNamespace java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Authenticate to the root Vault namespace. Conflicts with namespace.
vmName java.lang.String The virtual machine name for the machine that generated the MSI token.
vmssName java.lang.String The virtual machine scale set name for the machine that generated the MSI token.
resourceGroupNameRequired 
public java.lang.String getResourceGroupName();
  • Type: java.lang.String

The resource group for the machine that generated the MSI token. This information can be obtained through instance metadata.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#resource_group_name VaultProvider#resource_group_name}

roleRequired 
public java.lang.String getRole();
  • Type: java.lang.String

Name of the login role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#role VaultProvider#role}

subscriptionIdRequired 
public java.lang.String getSubscriptionId();
  • Type: java.lang.String

The subscription ID for the machine that generated the MSI token. This information can be obtained through instance metadata.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#subscription_id VaultProvider#subscription_id}

clientIdOptional 
public java.lang.String getClientId();
  • Type: java.lang.String

The identity's client ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#client_id VaultProvider#client_id}

jwtOptional 
public java.lang.String getJwt();
  • Type: java.lang.String

A signed JSON Web Token. If not specified on will be created automatically.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#jwt VaultProvider#jwt}

mountOptional 
public java.lang.String getMount();
  • Type: java.lang.String

The path where the authentication engine is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#mount VaultProvider#mount}

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

The authentication engine's namespace. Conflicts with use_root_namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#namespace VaultProvider#namespace}

scopeOptional 
public java.lang.String getScope();
  • Type: java.lang.String

The scopes to include in the token request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#scope VaultProvider#scope}

tenantIdOptional 
public java.lang.String getTenantId();
  • Type: java.lang.String

Provides the tenant ID to use in a multi-tenant authentication scenario.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#tenant_id VaultProvider#tenant_id}

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

Authenticate to the root Vault namespace. Conflicts with namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#use_root_namespace VaultProvider#use_root_namespace}

vmNameOptional 
public java.lang.String getVmName();
  • Type: java.lang.String

The virtual machine name for the machine that generated the MSI token.

This information can be obtained through instance metadata.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#vm_name VaultProvider#vm_name}

vmssNameOptional 
public java.lang.String getVmssName();
  • Type: java.lang.String

The virtual machine scale set name for the machine that generated the MSI token.

This information can be obtained through instance metadata.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#vmss_name VaultProvider#vmss_name}

VaultProviderAuthLoginCert

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderAuthLoginCert;

VaultProviderAuthLoginCert.builder()
    .certFile(java.lang.String)
    .keyFile(java.lang.String)
//  .mount(java.lang.String)
//  .name(java.lang.String)
//  .namespace(java.lang.String)
//  .useRootNamespace(java.lang.Boolean)
//  .useRootNamespace(IResolvable)
    .build();

Properties

Name Type Description
certFile java.lang.String Path to a file containing the client certificate.
keyFile java.lang.String Path to a file containing the private key that the certificate was issued for.
mount java.lang.String The path where the authentication engine is mounted.
name java.lang.String Name of the certificate's role.
namespace java.lang.String The authentication engine's namespace. Conflicts with use_root_namespace.
useRootNamespace java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Authenticate to the root Vault namespace. Conflicts with namespace.
certFileRequired 
public java.lang.String getCertFile();
  • Type: java.lang.String

Path to a file containing the client certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#cert_file VaultProvider#cert_file}

keyFileRequired 
public java.lang.String getKeyFile();
  • Type: java.lang.String

Path to a file containing the private key that the certificate was issued for.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#key_file VaultProvider#key_file}

mountOptional 
public java.lang.String getMount();
  • Type: java.lang.String

The path where the authentication engine is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#mount VaultProvider#mount}

nameOptional 
public java.lang.String getName();
  • Type: java.lang.String

Name of the certificate's role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#name VaultProvider#name}

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

The authentication engine's namespace. Conflicts with use_root_namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#namespace VaultProvider#namespace}

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

Authenticate to the root Vault namespace. Conflicts with namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#use_root_namespace VaultProvider#use_root_namespace}

VaultProviderAuthLoginGcp

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderAuthLoginGcp;

VaultProviderAuthLoginGcp.builder()
    .role(java.lang.String)
//  .credentials(java.lang.String)
//  .jwt(java.lang.String)
//  .mount(java.lang.String)
//  .namespace(java.lang.String)
//  .serviceAccount(java.lang.String)
//  .useRootNamespace(java.lang.Boolean)
//  .useRootNamespace(IResolvable)
    .build();

Properties

Name Type Description
role java.lang.String Name of the login role.
credentials java.lang.String Path to the Google Cloud credentials file.
jwt java.lang.String A signed JSON Web Token.
mount java.lang.String The path where the authentication engine is mounted.
namespace java.lang.String The authentication engine's namespace. Conflicts with use_root_namespace.
serviceAccount java.lang.String IAM service account.
useRootNamespace java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Authenticate to the root Vault namespace. Conflicts with namespace.
roleRequired 
public java.lang.String getRole();
  • Type: java.lang.String

Name of the login role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#role VaultProvider#role}

credentialsOptional 
public java.lang.String getCredentials();
  • Type: java.lang.String

Path to the Google Cloud credentials file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#credentials VaultProvider#credentials}

jwtOptional 
public java.lang.String getJwt();
  • Type: java.lang.String

A signed JSON Web Token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#jwt VaultProvider#jwt}

mountOptional 
public java.lang.String getMount();
  • Type: java.lang.String

The path where the authentication engine is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#mount VaultProvider#mount}

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

The authentication engine's namespace. Conflicts with use_root_namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#namespace VaultProvider#namespace}

serviceAccountOptional 
public java.lang.String getServiceAccount();
  • Type: java.lang.String

IAM service account.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#service_account VaultProvider#service_account}

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

Authenticate to the root Vault namespace. Conflicts with namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#use_root_namespace VaultProvider#use_root_namespace}

VaultProviderAuthLoginJwt

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderAuthLoginJwt;

VaultProviderAuthLoginJwt.builder()
    .jwt(java.lang.String)
    .role(java.lang.String)
//  .mount(java.lang.String)
//  .namespace(java.lang.String)
//  .useRootNamespace(java.lang.Boolean)
//  .useRootNamespace(IResolvable)
    .build();

Properties

Name Type Description
jwt java.lang.String A signed JSON Web Token.
role java.lang.String Name of the login role.
mount java.lang.String The path where the authentication engine is mounted.
namespace java.lang.String The authentication engine's namespace. Conflicts with use_root_namespace.
useRootNamespace java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Authenticate to the root Vault namespace. Conflicts with namespace.
jwtRequired 
public java.lang.String getJwt();
  • Type: java.lang.String

A signed JSON Web Token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#jwt VaultProvider#jwt}

roleRequired 
public java.lang.String getRole();
  • Type: java.lang.String

Name of the login role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#role VaultProvider#role}

mountOptional 
public java.lang.String getMount();
  • Type: java.lang.String

The path where the authentication engine is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#mount VaultProvider#mount}

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

The authentication engine's namespace. Conflicts with use_root_namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#namespace VaultProvider#namespace}

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

Authenticate to the root Vault namespace. Conflicts with namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#use_root_namespace VaultProvider#use_root_namespace}

VaultProviderAuthLoginKerberos

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderAuthLoginKerberos;

VaultProviderAuthLoginKerberos.builder()
//  .disableFastNegotiation(java.lang.Boolean)
//  .disableFastNegotiation(IResolvable)
//  .keytabPath(java.lang.String)
//  .krb5ConfPath(java.lang.String)
//  .mount(java.lang.String)
//  .namespace(java.lang.String)
//  .realm(java.lang.String)
//  .removeInstanceName(java.lang.Boolean)
//  .removeInstanceName(IResolvable)
//  .service(java.lang.String)
//  .token(java.lang.String)
//  .username(java.lang.String)
//  .useRootNamespace(java.lang.Boolean)
//  .useRootNamespace(IResolvable)
    .build();

Properties

Name Type Description
disableFastNegotiation java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Disable the Kerberos FAST negotiation.
keytabPath java.lang.String The Kerberos keytab file containing the entry of the login entity.
krb5ConfPath java.lang.String A valid Kerberos configuration file e.g. /etc/krb5.conf.
mount java.lang.String The path where the authentication engine is mounted.
namespace java.lang.String The authentication engine's namespace. Conflicts with use_root_namespace.
realm java.lang.String The Kerberos server's authoritative authentication domain.
removeInstanceName java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Strip the host from the username found in the keytab.
service java.lang.String The service principle name.
token java.lang.String Simple and Protected GSSAPI Negotiation Mechanism (SPNEGO) token.
username java.lang.String The username to login into Kerberos with.
useRootNamespace java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Authenticate to the root Vault namespace. Conflicts with namespace.
disableFastNegotiationOptional 
public java.lang.Object getDisableFastNegotiation();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Disable the Kerberos FAST negotiation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#disable_fast_negotiation VaultProvider#disable_fast_negotiation}

keytabPathOptional 
public java.lang.String getKeytabPath();
  • Type: java.lang.String

The Kerberos keytab file containing the entry of the login entity.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#keytab_path VaultProvider#keytab_path}

krb5ConfPathOptional 
public java.lang.String getKrb5ConfPath();
  • Type: java.lang.String

A valid Kerberos configuration file e.g. /etc/krb5.conf.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#krb5conf_path VaultProvider#krb5conf_path}

mountOptional 
public java.lang.String getMount();
  • Type: java.lang.String

The path where the authentication engine is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#mount VaultProvider#mount}

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

The authentication engine's namespace. Conflicts with use_root_namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#namespace VaultProvider#namespace}

realmOptional 
public java.lang.String getRealm();
  • Type: java.lang.String

The Kerberos server's authoritative authentication domain.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#realm VaultProvider#realm}

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

Strip the host from the username found in the keytab.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#remove_instance_name VaultProvider#remove_instance_name}

serviceOptional 
public java.lang.String getService();
  • Type: java.lang.String

The service principle name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#service VaultProvider#service}

tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String

Simple and Protected GSSAPI Negotiation Mechanism (SPNEGO) token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#token VaultProvider#token}

usernameOptional 
public java.lang.String getUsername();
  • Type: java.lang.String

The username to login into Kerberos with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#username VaultProvider#username}

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

Authenticate to the root Vault namespace. Conflicts with namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#use_root_namespace VaultProvider#use_root_namespace}

VaultProviderAuthLoginOci

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderAuthLoginOci;

VaultProviderAuthLoginOci.builder()
    .authType(java.lang.String)
    .role(java.lang.String)
//  .mount(java.lang.String)
//  .namespace(java.lang.String)
//  .useRootNamespace(java.lang.Boolean)
//  .useRootNamespace(IResolvable)
    .build();

Properties

Name Type Description
authType java.lang.String Authentication type to use when getting OCI credentials.
role java.lang.String Name of the login role.
mount java.lang.String The path where the authentication engine is mounted.
namespace java.lang.String The authentication engine's namespace. Conflicts with use_root_namespace.
useRootNamespace java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Authenticate to the root Vault namespace. Conflicts with namespace.
authTypeRequired 
public java.lang.String getAuthType();
  • Type: java.lang.String

Authentication type to use when getting OCI credentials.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_type VaultProvider#auth_type}

roleRequired 
public java.lang.String getRole();
  • Type: java.lang.String

Name of the login role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#role VaultProvider#role}

mountOptional 
public java.lang.String getMount();
  • Type: java.lang.String

The path where the authentication engine is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#mount VaultProvider#mount}

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

The authentication engine's namespace. Conflicts with use_root_namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#namespace VaultProvider#namespace}

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

Authenticate to the root Vault namespace. Conflicts with namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#use_root_namespace VaultProvider#use_root_namespace}

VaultProviderAuthLoginOidc

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderAuthLoginOidc;

VaultProviderAuthLoginOidc.builder()
    .role(java.lang.String)
//  .callbackAddress(java.lang.String)
//  .callbackListenerAddress(java.lang.String)
//  .mount(java.lang.String)
//  .namespace(java.lang.String)
//  .useRootNamespace(java.lang.Boolean)
//  .useRootNamespace(IResolvable)
    .build();

Properties

Name Type Description
role java.lang.String Name of the login role.
callbackAddress java.lang.String The callback address. Must be a valid URI without the path.
callbackListenerAddress java.lang.String The callback listener's address. Must be a valid URI without the path.
mount java.lang.String The path where the authentication engine is mounted.
namespace java.lang.String The authentication engine's namespace. Conflicts with use_root_namespace.
useRootNamespace java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Authenticate to the root Vault namespace. Conflicts with namespace.
roleRequired 
public java.lang.String getRole();
  • Type: java.lang.String

Name of the login role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#role VaultProvider#role}

callbackAddressOptional 
public java.lang.String getCallbackAddress();
  • Type: java.lang.String

The callback address. Must be a valid URI without the path.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#callback_address VaultProvider#callback_address}

callbackListenerAddressOptional 
public java.lang.String getCallbackListenerAddress();
  • Type: java.lang.String

The callback listener's address. Must be a valid URI without the path.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#callback_listener_address VaultProvider#callback_listener_address}

mountOptional 
public java.lang.String getMount();
  • Type: java.lang.String

The path where the authentication engine is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#mount VaultProvider#mount}

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

The authentication engine's namespace. Conflicts with use_root_namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#namespace VaultProvider#namespace}

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

Authenticate to the root Vault namespace. Conflicts with namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#use_root_namespace VaultProvider#use_root_namespace}

VaultProviderAuthLoginRadius

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderAuthLoginRadius;

VaultProviderAuthLoginRadius.builder()
    .password(java.lang.String)
    .username(java.lang.String)
//  .mount(java.lang.String)
//  .namespace(java.lang.String)
//  .useRootNamespace(java.lang.Boolean)
//  .useRootNamespace(IResolvable)
    .build();

Properties

Name Type Description
password java.lang.String The Radius password for username.
username java.lang.String The Radius username.
mount java.lang.String The path where the authentication engine is mounted.
namespace java.lang.String The authentication engine's namespace. Conflicts with use_root_namespace.
useRootNamespace java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Authenticate to the root Vault namespace. Conflicts with namespace.
passwordRequired 
public java.lang.String getPassword();
  • Type: java.lang.String

The Radius password for username.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#password VaultProvider#password}

usernameRequired 
public java.lang.String getUsername();
  • Type: java.lang.String

The Radius username.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#username VaultProvider#username}

mountOptional 
public java.lang.String getMount();
  • Type: java.lang.String

The path where the authentication engine is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#mount VaultProvider#mount}

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

The authentication engine's namespace. Conflicts with use_root_namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#namespace VaultProvider#namespace}

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

Authenticate to the root Vault namespace. Conflicts with namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#use_root_namespace VaultProvider#use_root_namespace}

VaultProviderAuthLoginTokenFile

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderAuthLoginTokenFile;

VaultProviderAuthLoginTokenFile.builder()
    .filename(java.lang.String)
//  .namespace(java.lang.String)
//  .useRootNamespace(java.lang.Boolean)
//  .useRootNamespace(IResolvable)
    .build();

Properties

Name Type Description
filename java.lang.String The name of a file containing a single line that is a valid Vault token.
namespace java.lang.String The authentication engine's namespace. Conflicts with use_root_namespace.
useRootNamespace java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Authenticate to the root Vault namespace. Conflicts with namespace.
filenameRequired 
public java.lang.String getFilename();
  • Type: java.lang.String

The name of a file containing a single line that is a valid Vault token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#filename VaultProvider#filename}

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

The authentication engine's namespace. Conflicts with use_root_namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#namespace VaultProvider#namespace}

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

Authenticate to the root Vault namespace. Conflicts with namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#use_root_namespace VaultProvider#use_root_namespace}

VaultProviderAuthLoginUserpass

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderAuthLoginUserpass;

VaultProviderAuthLoginUserpass.builder()
    .username(java.lang.String)
//  .mount(java.lang.String)
//  .namespace(java.lang.String)
//  .password(java.lang.String)
//  .passwordFile(java.lang.String)
//  .useRootNamespace(java.lang.Boolean)
//  .useRootNamespace(IResolvable)
    .build();

Properties

Name Type Description
username java.lang.String Login with username.
mount java.lang.String The path where the authentication engine is mounted.
namespace java.lang.String The authentication engine's namespace. Conflicts with use_root_namespace.
password java.lang.String Login with password.
passwordFile java.lang.String Login with password from a file.
useRootNamespace java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Authenticate to the root Vault namespace. Conflicts with namespace.
usernameRequired 
public java.lang.String getUsername();
  • Type: java.lang.String

Login with username.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#username VaultProvider#username}

mountOptional 
public java.lang.String getMount();
  • Type: java.lang.String

The path where the authentication engine is mounted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#mount VaultProvider#mount}

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

The authentication engine's namespace. Conflicts with use_root_namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#namespace VaultProvider#namespace}

passwordOptional 
public java.lang.String getPassword();
  • Type: java.lang.String

Login with password.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#password VaultProvider#password}

passwordFileOptional 
public java.lang.String getPasswordFile();
  • Type: java.lang.String

Login with password from a file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#password_file VaultProvider#password_file}

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

Authenticate to the root Vault namespace. Conflicts with namespace.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#use_root_namespace VaultProvider#use_root_namespace}

VaultProviderClientAuth

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderClientAuth;

VaultProviderClientAuth.builder()
//  .certFile(java.lang.String)
//  .keyFile(java.lang.String)
    .build();

Properties

Name Type Description
certFile java.lang.String Path to a file containing the client certificate.
keyFile java.lang.String Path to a file containing the private key that the certificate was issued for.
certFileOptional 
public java.lang.String getCertFile();
  • Type: java.lang.String

Path to a file containing the client certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#cert_file VaultProvider#cert_file}

keyFileOptional 
public java.lang.String getKeyFile();
  • Type: java.lang.String

Path to a file containing the private key that the certificate was issued for.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#key_file VaultProvider#key_file}

VaultProviderConfig

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderConfig;

VaultProviderConfig.builder()
    .address(java.lang.String)
//  .addAddressToEnv(java.lang.String)
//  .alias(java.lang.String)
//  .authLogin(VaultProviderAuthLogin)
//  .authLoginAws(VaultProviderAuthLoginAws)
//  .authLoginAzure(VaultProviderAuthLoginAzure)
//  .authLoginCert(VaultProviderAuthLoginCert)
//  .authLoginGcp(VaultProviderAuthLoginGcp)
//  .authLoginJwt(VaultProviderAuthLoginJwt)
//  .authLoginKerberos(VaultProviderAuthLoginKerberos)
//  .authLoginOci(VaultProviderAuthLoginOci)
//  .authLoginOidc(VaultProviderAuthLoginOidc)
//  .authLoginRadius(VaultProviderAuthLoginRadius)
//  .authLoginTokenFile(VaultProviderAuthLoginTokenFile)
//  .authLoginUserpass(VaultProviderAuthLoginUserpass)
//  .caCertDir(java.lang.String)
//  .caCertFile(java.lang.String)
//  .clientAuth(VaultProviderClientAuth)
//  .headers(IResolvable)
//  .headers(java.util.List<VaultProviderHeaders>)
//  .maxLeaseTtlSeconds(java.lang.Number)
//  .maxRetries(java.lang.Number)
//  .maxRetriesCcc(java.lang.Number)
//  .namespace(java.lang.String)
//  .setNamespaceFromToken(java.lang.Boolean)
//  .setNamespaceFromToken(IResolvable)
//  .skipChildToken(java.lang.Boolean)
//  .skipChildToken(IResolvable)
//  .skipGetVaultVersion(java.lang.Boolean)
//  .skipGetVaultVersion(IResolvable)
//  .skipTlsVerify(java.lang.Boolean)
//  .skipTlsVerify(IResolvable)
//  .tlsServerName(java.lang.String)
//  .token(java.lang.String)
//  .tokenName(java.lang.String)
//  .vaultVersionOverride(java.lang.String)
    .build();

Properties

Name Type Description
address java.lang.String URL of the root of the target Vault server.
addAddressToEnv java.lang.String If true, adds the value of the address argument to the Terraform process environment.
alias java.lang.String Alias name.
authLogin VaultProviderAuthLogin auth_login block.
authLoginAws VaultProviderAuthLoginAws auth_login_aws block.
authLoginAzure VaultProviderAuthLoginAzure auth_login_azure block.
authLoginCert VaultProviderAuthLoginCert auth_login_cert block.
authLoginGcp VaultProviderAuthLoginGcp auth_login_gcp block.
authLoginJwt VaultProviderAuthLoginJwt auth_login_jwt block.
authLoginKerberos VaultProviderAuthLoginKerberos auth_login_kerberos block.
authLoginOci VaultProviderAuthLoginOci auth_login_oci block.
authLoginOidc VaultProviderAuthLoginOidc auth_login_oidc block.
authLoginRadius VaultProviderAuthLoginRadius auth_login_radius block.
authLoginTokenFile VaultProviderAuthLoginTokenFile auth_login_token_file block.
authLoginUserpass VaultProviderAuthLoginUserpass auth_login_userpass block.
caCertDir java.lang.String Path to directory containing CA certificate files to validate the server's certificate.
caCertFile java.lang.String Path to a CA certificate file to validate the server's certificate.
clientAuth VaultProviderClientAuth client_auth block.
headers com.hashicorp.cdktf.IResolvable OR java.util.List<VaultProviderHeaders> headers block.
maxLeaseTtlSeconds java.lang.Number Maximum TTL for secret leases requested by this provider.
maxRetries java.lang.Number Maximum number of retries when a 5xx error code is encountered.
maxRetriesCcc java.lang.Number Maximum number of retries for Client Controlled Consistency related operations.
namespace java.lang.String The namespace to use. Available only for Vault Enterprise.
setNamespaceFromToken java.lang.Boolean OR com.hashicorp.cdktf.IResolvable In the case where the Vault token is for a specific namespace and the provider namespace is not configured, use the token namespace as the root namespace for all resources.
skipChildToken java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Set this to true to prevent the creation of ephemeral child token used by this provider.
skipGetVaultVersion java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Skip the dynamic fetching of the Vault server version.
skipTlsVerify java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Set this to true only if the target Vault server is an insecure development instance.
tlsServerName java.lang.String Name to use as the SNI host when connecting via TLS.
token java.lang.String Token to use to authenticate to Vault.
tokenName java.lang.String Token name to use for creating the Vault child token.
vaultVersionOverride java.lang.String Override the Vault server version, which is normally determined dynamically from the target Vault server.
addressRequired 
public java.lang.String getAddress();
  • Type: java.lang.String

URL of the root of the target Vault server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#address VaultProvider#address}

addAddressToEnvOptional 
public java.lang.String getAddAddressToEnv();
  • Type: java.lang.String

If true, adds the value of the address argument to the Terraform process environment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#add_address_to_env VaultProvider#add_address_to_env}

aliasOptional 
public java.lang.String getAlias();
  • Type: java.lang.String

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#alias VaultProvider#alias}

authLoginOptional 
public VaultProviderAuthLogin getAuthLogin();

auth_login block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login VaultProvider#auth_login}

authLoginAwsOptional 
public VaultProviderAuthLoginAws getAuthLoginAws();

auth_login_aws block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_aws VaultProvider#auth_login_aws}

authLoginAzureOptional 
public VaultProviderAuthLoginAzure getAuthLoginAzure();

auth_login_azure block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_azure VaultProvider#auth_login_azure}

authLoginCertOptional 
public VaultProviderAuthLoginCert getAuthLoginCert();

auth_login_cert block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_cert VaultProvider#auth_login_cert}

authLoginGcpOptional 
public VaultProviderAuthLoginGcp getAuthLoginGcp();

auth_login_gcp block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_gcp VaultProvider#auth_login_gcp}

authLoginJwtOptional 
public VaultProviderAuthLoginJwt getAuthLoginJwt();

auth_login_jwt block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_jwt VaultProvider#auth_login_jwt}

authLoginKerberosOptional 
public VaultProviderAuthLoginKerberos getAuthLoginKerberos();

auth_login_kerberos block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_kerberos VaultProvider#auth_login_kerberos}

authLoginOciOptional 
public VaultProviderAuthLoginOci getAuthLoginOci();

auth_login_oci block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_oci VaultProvider#auth_login_oci}

authLoginOidcOptional 
public VaultProviderAuthLoginOidc getAuthLoginOidc();

auth_login_oidc block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_oidc VaultProvider#auth_login_oidc}

authLoginRadiusOptional 
public VaultProviderAuthLoginRadius getAuthLoginRadius();

auth_login_radius block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_radius VaultProvider#auth_login_radius}

authLoginTokenFileOptional 
public VaultProviderAuthLoginTokenFile getAuthLoginTokenFile();

auth_login_token_file block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_token_file VaultProvider#auth_login_token_file}

authLoginUserpassOptional 
public VaultProviderAuthLoginUserpass getAuthLoginUserpass();

auth_login_userpass block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#auth_login_userpass VaultProvider#auth_login_userpass}

caCertDirOptional 
public java.lang.String getCaCertDir();
  • Type: java.lang.String

Path to directory containing CA certificate files to validate the server's certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#ca_cert_dir VaultProvider#ca_cert_dir}

caCertFileOptional 
public java.lang.String getCaCertFile();
  • Type: java.lang.String

Path to a CA certificate file to validate the server's certificate.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#ca_cert_file VaultProvider#ca_cert_file}

clientAuthOptional 
public VaultProviderClientAuth getClientAuth();

client_auth block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#client_auth VaultProvider#client_auth}

headersOptional 
public java.lang.Object getHeaders();

headers block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#headers VaultProvider#headers}

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

Maximum TTL for secret leases requested by this provider.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#max_lease_ttl_seconds VaultProvider#max_lease_ttl_seconds}

maxRetriesOptional 
public java.lang.Number getMaxRetries();
  • Type: java.lang.Number

Maximum number of retries when a 5xx error code is encountered.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#max_retries VaultProvider#max_retries}

maxRetriesCccOptional 
public java.lang.Number getMaxRetriesCcc();
  • Type: java.lang.Number

Maximum number of retries for Client Controlled Consistency related operations.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#max_retries_ccc VaultProvider#max_retries_ccc}

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

The namespace to use. Available only for Vault Enterprise.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#namespace VaultProvider#namespace}

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

In the case where the Vault token is for a specific namespace and the provider namespace is not configured, use the token namespace as the root namespace for all resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#set_namespace_from_token VaultProvider#set_namespace_from_token}

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

Set this to true to prevent the creation of ephemeral child token used by this provider.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#skip_child_token VaultProvider#skip_child_token}

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

Skip the dynamic fetching of the Vault server version.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#skip_get_vault_version VaultProvider#skip_get_vault_version}

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

Set this to true only if the target Vault server is an insecure development instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#skip_tls_verify VaultProvider#skip_tls_verify}

tlsServerNameOptional 
public java.lang.String getTlsServerName();
  • Type: java.lang.String

Name to use as the SNI host when connecting via TLS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#tls_server_name VaultProvider#tls_server_name}

tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String

Token to use to authenticate to Vault.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#token VaultProvider#token}

tokenNameOptional 
public java.lang.String getTokenName();
  • Type: java.lang.String

Token name to use for creating the Vault child token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#token_name VaultProvider#token_name}

vaultVersionOverrideOptional 
public java.lang.String getVaultVersionOverride();
  • Type: java.lang.String

Override the Vault server version, which is normally determined dynamically from the target Vault server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#vault_version_override VaultProvider#vault_version_override}

VaultProviderHeaders

Initializer 

import com.hashicorp.cdktf.providers.vault.provider.VaultProviderHeaders;

VaultProviderHeaders.builder()
    .name(java.lang.String)
    .value(java.lang.String)
    .build();

Properties

Name Type Description
name java.lang.String The header name.
value java.lang.String The header value.
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

The header name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#name VaultProvider#name}

valueRequired 
public java.lang.String getValue();
  • Type: java.lang.String

The header value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.5.0/docs#value VaultProvider#value}