kmipSecretBackend.typescript.md

kmipSecretBackend Submodule

Constructs

KmipSecretBackend

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

Initializers

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

new kmipSecretBackend.KmipSecretBackend(scope: Construct, id: string, config: KmipSecretBackendConfig)

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

---

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".
resetDefaultTlsClientKeyBits	No description.
resetDefaultTlsClientKeyType	No description.
resetDefaultTlsClientTtl	No description.
resetDescription	No description.
resetDisableRemount	No description.
resetId	No description.
resetListenAddrs	No description.
resetNamespace	No description.
resetServerHostnames	No description.
resetServerIps	No description.
resetTlsCaKeyBits	No description.
resetTlsCaKeyType	No description.
resetTlsMinVersion	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".

---

resetDefaultTlsClientKeyBits

public resetDefaultTlsClientKeyBits(): void

resetDefaultTlsClientKeyType

public resetDefaultTlsClientKeyType(): void

resetDefaultTlsClientTtl

public resetDefaultTlsClientTtl(): void

resetDescription

public resetDescription(): void

resetDisableRemount

public resetDisableRemount(): void

resetId

public resetId(): void

resetListenAddrs

public resetListenAddrs(): void

resetNamespace

public resetNamespace(): void

resetServerHostnames

public resetServerHostnames(): void

resetServerIps

public resetServerIps(): void

resetTlsCaKeyBits

public resetTlsCaKeyBits(): void

resetTlsCaKeyType

public resetTlsCaKeyType(): void

resetTlsMinVersion

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

---

isConstruct

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

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

kmipSecretBackend.KmipSecretBackend.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

kmipSecretBackend.KmipSecretBackend.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

kmipSecretBackend.KmipSecretBackend.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing KmipSecretBackend that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/kmip_secret_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 KmipSecretBackend 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.
defaultTlsClientKeyBitsInput	number	No description.
defaultTlsClientKeyTypeInput	string	No description.
defaultTlsClientTtlInput	number	No description.
descriptionInput	string	No description.
disableRemountInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
listenAddrsInput	string[]	No description.
namespaceInput	string	No description.
pathInput	string	No description.
serverHostnamesInput	string[]	No description.
serverIpsInput	string[]	No description.
tlsCaKeyBitsInput	number	No description.
tlsCaKeyTypeInput	string	No description.
tlsMinVersionInput	string	No description.
defaultTlsClientKeyBits	number	No description.
defaultTlsClientKeyType	string	No description.
defaultTlsClientTtl	number	No description.
description	string	No description.
disableRemount	boolean | cdktf.IResolvable	No description.
id	string	No description.
listenAddrs	string[]	No description.
namespace	string	No description.
path	string	No description.
serverHostnames	string[]	No description.
serverIps	string[]	No description.
tlsCaKeyBits	number	No description.
tlsCaKeyType	string	No description.
tlsMinVersion	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[]

---

defaultTlsClientKeyBitsInput^Optional

public readonly defaultTlsClientKeyBitsInput: number;

• Type: number

---

defaultTlsClientKeyTypeInput^Optional

public readonly defaultTlsClientKeyTypeInput: string;

• Type: string

---

defaultTlsClientTtlInput^Optional

public readonly defaultTlsClientTtlInput: number;

• Type: number

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

disableRemountInput^Optional

public readonly disableRemountInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

listenAddrsInput^Optional

public readonly listenAddrsInput: string[];

• Type: string[]

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

pathInput^Optional

public readonly pathInput: string;

• Type: string

---

serverHostnamesInput^Optional

public readonly serverHostnamesInput: string[];

• Type: string[]

---

serverIpsInput^Optional

public readonly serverIpsInput: string[];

• Type: string[]

---

tlsCaKeyBitsInput^Optional

public readonly tlsCaKeyBitsInput: number;

• Type: number

---

tlsCaKeyTypeInput^Optional

public readonly tlsCaKeyTypeInput: string;

• Type: string

---

tlsMinVersionInput^Optional

public readonly tlsMinVersionInput: string;

• Type: string

---

defaultTlsClientKeyBits^Required

public readonly defaultTlsClientKeyBits: number;

• Type: number

---

defaultTlsClientKeyType^Required

public readonly defaultTlsClientKeyType: string;

• Type: string

---

defaultTlsClientTtl^Required

public readonly defaultTlsClientTtl: number;

• Type: number

---

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

---

listenAddrs^Required

public readonly listenAddrs: string[];

• Type: string[]

---

namespace^Required

public readonly namespace: string;

• Type: string

---

path^Required

public readonly path: string;

• Type: string

---

serverHostnames^Required

public readonly serverHostnames: string[];

• Type: string[]

---

serverIps^Required

public readonly serverIps: string[];

• Type: string[]

---

tlsCaKeyBits^Required

public readonly tlsCaKeyBits: number;

• Type: number

---

tlsCaKeyType^Required

public readonly tlsCaKeyType: string;

• Type: string

---

tlsMinVersion^Required

public readonly tlsMinVersion: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

KmipSecretBackendConfig

Initializer

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

const kmipSecretBackendConfig: kmipSecretBackend.KmipSecretBackendConfig = { ... }

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.
path	string	Path where KMIP secret backend will be mounted.
defaultTlsClientKeyBits	number	Client certificate key bits, valid values depend on key type.
defaultTlsClientKeyType	string	Client certificate key type, rsa or ec.
defaultTlsClientTtl	number	Client certificate TTL in seconds.
description	string	Human-friendly description of the mount for the 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/kmip_secret_backend#id KmipSecretBackend#id}.
listenAddrs	string[]	Addresses the KMIP server should listen on (host:port).
namespace	string	Target namespace. (requires Enterprise).
serverHostnames	string[]	Hostnames to include in the server's TLS certificate as SAN DNS names.
serverIps	string[]	IPs to include in the server's TLS certificate as SAN IP addresses.
tlsCaKeyBits	number	CA key bits, valid values depend on key type.
tlsCaKeyType	string	CA key type, rsa or ec.
tlsMinVersion	string	Minimum TLS version to accept.

---

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

---

path^Required

public readonly path: string;

• Type: string

Path where KMIP secret backend will be mounted.

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

---

defaultTlsClientKeyBits^Optional

public readonly defaultTlsClientKeyBits: number;

• Type: number

Client certificate key bits, valid values depend on key type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/kmip_secret_backend#default_tls_client_key_bits KmipSecretBackend#default_tls_client_key_bits}

---

defaultTlsClientKeyType^Optional

public readonly defaultTlsClientKeyType: string;

• Type: string

Client certificate key type, rsa or ec.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/kmip_secret_backend#default_tls_client_key_type KmipSecretBackend#default_tls_client_key_type}

---

defaultTlsClientTtl^Optional

public readonly defaultTlsClientTtl: number;

• Type: number

Client certificate TTL in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/kmip_secret_backend#default_tls_client_ttl KmipSecretBackend#default_tls_client_ttl}

---

description^Optional

public readonly description: string;

• Type: string

Human-friendly description of the mount for the backend.

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

---

listenAddrs^Optional

public readonly listenAddrs: string[];

• Type: string[]

Addresses the KMIP server should listen on (host:port).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/kmip_secret_backend#listen_addrs KmipSecretBackend#listen_addrs}

---

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/kmip_secret_backend#namespace KmipSecretBackend#namespace}

---

serverHostnames^Optional

public readonly serverHostnames: string[];

• Type: string[]

Hostnames to include in the server's TLS certificate as SAN DNS names.

The first will be used as the common name (CN)

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/kmip_secret_backend#server_hostnames KmipSecretBackend#server_hostnames}

---

serverIps^Optional

public readonly serverIps: string[];

• Type: string[]

IPs to include in the server's TLS certificate as SAN IP addresses.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/kmip_secret_backend#server_ips KmipSecretBackend#server_ips}

---

tlsCaKeyBits^Optional

public readonly tlsCaKeyBits: number;

• Type: number

CA key bits, valid values depend on key type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/kmip_secret_backend#tls_ca_key_bits KmipSecretBackend#tls_ca_key_bits}

---

tlsCaKeyType^Optional

public readonly tlsCaKeyType: string;

• Type: string

CA key type, rsa or ec.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/kmip_secret_backend#tls_ca_key_type KmipSecretBackend#tls_ca_key_type}

---

tlsMinVersion^Optional

public readonly tlsMinVersion: string;

• Type: string

Minimum TLS version to accept.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/kmip_secret_backend#tls_min_version KmipSecretBackend#tls_min_version}

---