authBackend.typescript.md

authBackend Submodule

Constructs

AuthBackend

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend vault_auth_backend}.

Initializers

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

new authBackend.AuthBackend(scope: Construct, id: string, config: AuthBackendConfig)

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

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: AuthBackendConfig

---

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".
putTune	No description.
resetDescription	No description.
resetDisableRemount	No description.
resetId	No description.
resetIdentityTokenKey	No description.
resetLocal	No description.
resetNamespace	No description.
resetPath	No description.
resetTune	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

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

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

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

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

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

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

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

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

id^Required

• Type: string

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

---

moveTo

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

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

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

---

index^Optional

• Type: string | number

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

---

moveToId

public moveToId(id: string): void

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

id^Required

• Type: string

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

---

putTune

public putTune(value: IResolvable | AuthBackendTune[]): void

value^Required

• Type: cdktf.IResolvable | AuthBackendTune[]

---

resetDescription

public resetDescription(): void

resetDisableRemount

public resetDisableRemount(): void

resetId

public resetId(): void

resetIdentityTokenKey

public resetIdentityTokenKey(): void

resetLocal

public resetLocal(): void

resetNamespace

public resetNamespace(): void

resetPath

public resetPath(): void

resetTune

public resetTune(): void

Static Functions

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

---

isConstruct

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

authBackend.AuthBackend.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

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

authBackend.AuthBackend.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

authBackend.AuthBackend.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

authBackend.AuthBackend.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing AuthBackend that should be imported.

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

---

provider^Optional

• Type: cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
accessor	string	No description.
tune	AuthBackendTuneList	No description.
descriptionInput	string	No description.
disableRemountInput	boolean | cdktf.IResolvable	No description.
identityTokenKeyInput	string	No description.
idInput	string	No description.
localInput	boolean | cdktf.IResolvable	No description.
namespaceInput	string	No description.
pathInput	string	No description.
tuneInput	cdktf.IResolvable | AuthBackendTune[]	No description.
typeInput	string	No description.
description	string	No description.
disableRemount	boolean | cdktf.IResolvable	No description.
id	string	No description.
identityTokenKey	string	No description.
local	boolean | cdktf.IResolvable	No description.
namespace	string	No description.
path	string	No description.
type	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

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

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

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

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

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

---

accessor^Required

public readonly accessor: string;

• Type: string

---

tune^Required

public readonly tune: AuthBackendTuneList;

• Type: AuthBackendTuneList

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

disableRemountInput^Optional

public readonly disableRemountInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

identityTokenKeyInput^Optional

public readonly identityTokenKeyInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

localInput^Optional

public readonly localInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

pathInput^Optional

public readonly pathInput: string;

• Type: string

---

tuneInput^Optional

public readonly tuneInput: IResolvable | AuthBackendTune[];

• Type: cdktf.IResolvable | AuthBackendTune[]

---

typeInput^Optional

public readonly typeInput: string;

• Type: string

---

description^Required

public readonly description: string;

• Type: string

---

disableRemount^Required

public readonly disableRemount: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

identityTokenKey^Required

public readonly identityTokenKey: string;

• Type: string

---

local^Required

public readonly local: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

namespace^Required

public readonly namespace: string;

• Type: string

---

path^Required

public readonly path: string;

• Type: string

---

type^Required

public readonly type: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

AuthBackendConfig

Initializer

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

const authBackendConfig: authBackend.AuthBackendConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
type	string	Name of the auth backend.
description	string	The description of the auth backend.
disableRemount	boolean | cdktf.IResolvable	If set, opts out of mount migration on path updates.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#id AuthBackend#id}.
identityTokenKey	string	The key to use for signing identity tokens.
local	boolean | cdktf.IResolvable	Specifies if the auth method is local only.
namespace	string	Target namespace. (requires Enterprise).
path	string	path to mount the backend. This defaults to the type.
tune	cdktf.IResolvable | AuthBackendTune[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#tune AuthBackend#tune}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

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

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

---

type^Required

public readonly type: string;

• Type: string

Name of the auth backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#type AuthBackend#type}

---

description^Optional

public readonly description: string;

• Type: string

The description of the auth backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#description AuthBackend#description}

---

disableRemount^Optional

public readonly disableRemount: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#disable_remount AuthBackend#disable_remount}

---

id^Optional

public readonly id: string;

• Type: string

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

---

identityTokenKey^Optional

public readonly identityTokenKey: string;

• Type: string

The key to use for signing identity tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#identity_token_key AuthBackend#identity_token_key}

---

local^Optional

public readonly local: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Specifies if the auth method is local only.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#local AuthBackend#local}

---

namespace^Optional

public readonly namespace: string;

• Type: string

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#namespace AuthBackend#namespace}

---

path^Optional

public readonly path: string;

• Type: string

path to mount the backend. This defaults to the type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#path AuthBackend#path}

---

tune^Optional

public readonly tune: IResolvable | AuthBackendTune[];

• Type: cdktf.IResolvable | AuthBackendTune[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#tune AuthBackend#tune}.

---

AuthBackendTune

Initializer

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

const authBackendTune: authBackend.AuthBackendTune = { ... }

Properties

Name	Type	Description
allowedResponseHeaders	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#allowed_response_headers AuthBackend#allowed_response_headers}.
auditNonHmacRequestKeys	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#audit_non_hmac_request_keys AuthBackend#audit_non_hmac_request_keys}.
auditNonHmacResponseKeys	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#audit_non_hmac_response_keys AuthBackend#audit_non_hmac_response_keys}.
defaultLeaseTtl	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#default_lease_ttl AuthBackend#default_lease_ttl}.
listingVisibility	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#listing_visibility AuthBackend#listing_visibility}.
maxLeaseTtl	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#max_lease_ttl AuthBackend#max_lease_ttl}.
passthroughRequestHeaders	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#passthrough_request_headers AuthBackend#passthrough_request_headers}.
tokenType	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#token_type AuthBackend#token_type}.

---

allowedResponseHeaders^Optional

public readonly allowedResponseHeaders: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#allowed_response_headers AuthBackend#allowed_response_headers}.

---

auditNonHmacRequestKeys^Optional

public readonly auditNonHmacRequestKeys: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#audit_non_hmac_request_keys AuthBackend#audit_non_hmac_request_keys}.

---

auditNonHmacResponseKeys^Optional

public readonly auditNonHmacResponseKeys: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#audit_non_hmac_response_keys AuthBackend#audit_non_hmac_response_keys}.

---

defaultLeaseTtl^Optional

public readonly defaultLeaseTtl: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#default_lease_ttl AuthBackend#default_lease_ttl}.

---

listingVisibility^Optional

public readonly listingVisibility: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#listing_visibility AuthBackend#listing_visibility}.

---

maxLeaseTtl^Optional

public readonly maxLeaseTtl: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#max_lease_ttl AuthBackend#max_lease_ttl}.

---

passthroughRequestHeaders^Optional

public readonly passthroughRequestHeaders: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#passthrough_request_headers AuthBackend#passthrough_request_headers}.

---

tokenType^Optional

public readonly tokenType: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/auth_backend#token_type AuthBackend#token_type}.

---

Classes

AuthBackendTuneList

Initializers

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

new authBackend.AuthBackendTuneList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
wrapsSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
allWithMapKey	Creating an iterator for this complex list.
computeFqn	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
get	No description.

---

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): AuthBackendTuneOutputReference

index^Required

• Type: number

the index of the item to return.

---

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
internalValue	cdktf.IResolvable | AuthBackendTune[]	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | AuthBackendTune[];

• Type: cdktf.IResolvable | AuthBackendTune[]

---

AuthBackendTuneOutputReference

Initializers

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

new authBackend.AuthBackendTuneOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
complexObjectIndex	number	the index of this item in the list.
complexObjectIsFromSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetAllowedResponseHeaders	No description.
resetAuditNonHmacRequestKeys	No description.
resetAuditNonHmacResponseKeys	No description.
resetDefaultLeaseTtl	No description.
resetListingVisibility	No description.
resetMaxLeaseTtl	No description.
resetPassthroughRequestHeaders	No description.
resetTokenType	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetAllowedResponseHeaders

public resetAllowedResponseHeaders(): void

resetAuditNonHmacRequestKeys

public resetAuditNonHmacRequestKeys(): void

resetAuditNonHmacResponseKeys

public resetAuditNonHmacResponseKeys(): void

resetDefaultLeaseTtl

public resetDefaultLeaseTtl(): void

resetListingVisibility

public resetListingVisibility(): void

resetMaxLeaseTtl

public resetMaxLeaseTtl(): void

resetPassthroughRequestHeaders

public resetPassthroughRequestHeaders(): void

resetTokenType

public resetTokenType(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
allowedResponseHeadersInput	string[]	No description.
auditNonHmacRequestKeysInput	string[]	No description.
auditNonHmacResponseKeysInput	string[]	No description.
defaultLeaseTtlInput	string	No description.
listingVisibilityInput	string	No description.
maxLeaseTtlInput	string	No description.
passthroughRequestHeadersInput	string[]	No description.
tokenTypeInput	string	No description.
allowedResponseHeaders	string[]	No description.
auditNonHmacRequestKeys	string[]	No description.
auditNonHmacResponseKeys	string[]	No description.
defaultLeaseTtl	string	No description.
listingVisibility	string	No description.
maxLeaseTtl	string	No description.
passthroughRequestHeaders	string[]	No description.
tokenType	string	No description.
internalValue	cdktf.IResolvable | AuthBackendTune	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

allowedResponseHeadersInput^Optional

public readonly allowedResponseHeadersInput: string[];

• Type: string[]

---

auditNonHmacRequestKeysInput^Optional

public readonly auditNonHmacRequestKeysInput: string[];

• Type: string[]

---

auditNonHmacResponseKeysInput^Optional

public readonly auditNonHmacResponseKeysInput: string[];

• Type: string[]

---

defaultLeaseTtlInput^Optional

public readonly defaultLeaseTtlInput: string;

• Type: string

---

listingVisibilityInput^Optional

public readonly listingVisibilityInput: string;

• Type: string

---

maxLeaseTtlInput^Optional

public readonly maxLeaseTtlInput: string;

• Type: string

---

passthroughRequestHeadersInput^Optional

public readonly passthroughRequestHeadersInput: string[];

• Type: string[]

---

tokenTypeInput^Optional

public readonly tokenTypeInput: string;

• Type: string

---

allowedResponseHeaders^Required

public readonly allowedResponseHeaders: string[];

• Type: string[]

---

auditNonHmacRequestKeys^Required

public readonly auditNonHmacRequestKeys: string[];

• Type: string[]

---

auditNonHmacResponseKeys^Required

public readonly auditNonHmacResponseKeys: string[];

• Type: string[]

---

defaultLeaseTtl^Required

public readonly defaultLeaseTtl: string;

• Type: string

---

listingVisibility^Required

public readonly listingVisibility: string;

• Type: string

---

maxLeaseTtl^Required

public readonly maxLeaseTtl: string;

• Type: string

---

passthroughRequestHeaders^Required

public readonly passthroughRequestHeaders: string[];

• Type: string[]

---

tokenType^Required

public readonly tokenType: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | AuthBackendTune;

• Type: cdktf.IResolvable | AuthBackendTune

---