credentialLibraryVault.typescript.md

credentialLibraryVault Submodule

Constructs

CredentialLibraryVault

Represents a {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/credential_library_vault boundary_credential_library_vault}.

Initializers

import { credentialLibraryVault } from '@cdktf/provider-boundary'

new credentialLibraryVault.CredentialLibraryVault(scope: Construct, id: string, config: CredentialLibraryVaultConfig)

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

---

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".
resetCredentialMappingOverrides	No description.
resetCredentialType	No description.
resetDescription	No description.
resetHttpMethod	No description.
resetHttpRequestBody	No description.
resetName	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".

---

resetCredentialMappingOverrides

public resetCredentialMappingOverrides(): void

resetCredentialType

public resetCredentialType(): void

resetDescription

public resetDescription(): void

resetHttpMethod

public resetHttpMethod(): void

resetHttpRequestBody

public resetHttpRequestBody(): void

resetName

public resetName(): 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 CredentialLibraryVault resource upon running "cdktf plan ".

---

isConstruct

import { credentialLibraryVault } from '@cdktf/provider-boundary'

credentialLibraryVault.CredentialLibraryVault.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 { credentialLibraryVault } from '@cdktf/provider-boundary'

credentialLibraryVault.CredentialLibraryVault.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { credentialLibraryVault } from '@cdktf/provider-boundary'

credentialLibraryVault.CredentialLibraryVault.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { credentialLibraryVault } from '@cdktf/provider-boundary'

credentialLibraryVault.CredentialLibraryVault.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing CredentialLibraryVault that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/credential_library_vault#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 CredentialLibraryVault 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.
id	string	No description.
credentialMappingOverridesInput	{[ key: string ]: string}	No description.
credentialStoreIdInput	string	No description.
credentialTypeInput	string	No description.
descriptionInput	string	No description.
httpMethodInput	string	No description.
httpRequestBodyInput	string	No description.
nameInput	string	No description.
pathInput	string	No description.
credentialMappingOverrides	{[ key: string ]: string}	No description.
credentialStoreId	string	No description.
credentialType	string	No description.
description	string	No description.
httpMethod	string	No description.
httpRequestBody	string	No description.
name	string	No description.
path	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[]

---

id^Required

public readonly id: string;

• Type: string

---

credentialMappingOverridesInput^Optional

public readonly credentialMappingOverridesInput: {[ key: string ]: string};

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

---

credentialStoreIdInput^Optional

public readonly credentialStoreIdInput: string;

• Type: string

---

credentialTypeInput^Optional

public readonly credentialTypeInput: string;

• Type: string

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

httpMethodInput^Optional

public readonly httpMethodInput: string;

• Type: string

---

httpRequestBodyInput^Optional

public readonly httpRequestBodyInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

pathInput^Optional

public readonly pathInput: string;

• Type: string

---

credentialMappingOverrides^Required

public readonly credentialMappingOverrides: {[ key: string ]: string};

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

---

credentialStoreId^Required

public readonly credentialStoreId: string;

• Type: string

---

credentialType^Required

public readonly credentialType: string;

• Type: string

---

description^Required

public readonly description: string;

• Type: string

---

httpMethod^Required

public readonly httpMethod: string;

• Type: string

---

httpRequestBody^Required

public readonly httpRequestBody: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

path^Required

public readonly path: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

CredentialLibraryVaultConfig

Initializer

import { credentialLibraryVault } from '@cdktf/provider-boundary'

const credentialLibraryVaultConfig: credentialLibraryVault.CredentialLibraryVaultConfig = { ... }

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.
credentialStoreId	string	The ID of the credential store that this library belongs to.
path	string	The path in Vault to request credentials from.
credentialMappingOverrides	{[ key: string ]: string}	The credential mapping override.
credentialType	string	The type of credential the library generates. Cannot be updated on an existing resource.
description	string	The Vault credential library description.
httpMethod	string	The HTTP method the library uses when requesting credentials from Vault. Defaults to 'GET'.
httpRequestBody	string	The body of the HTTP request the library sends to Vault when requesting credentials.
name	string	The Vault credential library name. Defaults to the resource name.

---

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

---

credentialStoreId^Required

public readonly credentialStoreId: string;

• Type: string

The ID of the credential store that this library belongs to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/credential_library_vault#credential_store_id CredentialLibraryVault#credential_store_id}

---

path^Required

public readonly path: string;

• Type: string

The path in Vault to request credentials from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/credential_library_vault#path CredentialLibraryVault#path}

---

credentialMappingOverrides^Optional

public readonly credentialMappingOverrides: {[ key: string ]: string};

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

The credential mapping override.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/credential_library_vault#credential_mapping_overrides CredentialLibraryVault#credential_mapping_overrides}

---

credentialType^Optional

public readonly credentialType: string;

• Type: string

The type of credential the library generates. Cannot be updated on an existing resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/credential_library_vault#credential_type CredentialLibraryVault#credential_type}

---

description^Optional

public readonly description: string;

• Type: string

The Vault credential library description.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/credential_library_vault#description CredentialLibraryVault#description}

---

httpMethod^Optional

public readonly httpMethod: string;

• Type: string

The HTTP method the library uses when requesting credentials from Vault. Defaults to 'GET'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/credential_library_vault#http_method CredentialLibraryVault#http_method}

---

httpRequestBody^Optional

public readonly httpRequestBody: string;

• Type: string

The body of the HTTP request the library sends to Vault when requesting credentials.

Only valid if http_method is set to POST.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/credential_library_vault#http_request_body CredentialLibraryVault#http_request_body}

---

name^Optional

public readonly name: string;

• Type: string

The Vault credential library name. Defaults to the resource name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/boundary/1.1.15/docs/resources/credential_library_vault#name CredentialLibraryVault#name}

---