nomadSecretBackend.typescript.md

nomadSecretBackend Submodule

Constructs

NomadSecretBackend

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

Initializers

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

new nomadSecretBackend.NomadSecretBackend(scope: Construct, id: string, config?: NomadSecretBackendConfig)

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

• Type: NomadSecretBackendConfig

---

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".
resetAddress	No description.
resetBackend	No description.
resetCaCert	No description.
resetClientCert	No description.
resetClientKey	No description.
resetDefaultLeaseTtlSeconds	No description.
resetDescription	No description.
resetDisableRemount	No description.
resetId	No description.
resetLocal	No description.
resetMaxLeaseTtlSeconds	No description.
resetMaxTokenNameLength	No description.
resetMaxTtl	No description.
resetNamespace	No description.
resetToken	No description.
resetTtl	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".

---

resetAddress

public resetAddress(): void

resetBackend

public resetBackend(): void

resetCaCert

public resetCaCert(): void

resetClientCert

public resetClientCert(): void

resetClientKey

public resetClientKey(): void

resetDefaultLeaseTtlSeconds

public resetDefaultLeaseTtlSeconds(): void

resetDescription

public resetDescription(): void

resetDisableRemount

public resetDisableRemount(): void

resetId

public resetId(): void

resetLocal

public resetLocal(): void

resetMaxLeaseTtlSeconds

public resetMaxLeaseTtlSeconds(): void

resetMaxTokenNameLength

public resetMaxTokenNameLength(): void

resetMaxTtl

public resetMaxTtl(): void

resetNamespace

public resetNamespace(): void

resetToken

public resetToken(): void

resetTtl

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

---

isConstruct

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

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

nomadSecretBackend.NomadSecretBackend.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

nomadSecretBackend.NomadSecretBackend.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

nomadSecretBackend.NomadSecretBackend.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing NomadSecretBackend that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/nomad_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 NomadSecretBackend 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.
addressInput	string	No description.
backendInput	string	No description.
caCertInput	string	No description.
clientCertInput	string	No description.
clientKeyInput	string	No description.
defaultLeaseTtlSecondsInput	number	No description.
descriptionInput	string	No description.
disableRemountInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
localInput	boolean | cdktf.IResolvable	No description.
maxLeaseTtlSecondsInput	number	No description.
maxTokenNameLengthInput	number	No description.
maxTtlInput	number	No description.
namespaceInput	string	No description.
tokenInput	string	No description.
ttlInput	number	No description.
address	string	No description.
backend	string	No description.
caCert	string	No description.
clientCert	string	No description.
clientKey	string	No description.
defaultLeaseTtlSeconds	number	No description.
description	string	No description.
disableRemount	boolean | cdktf.IResolvable	No description.
id	string	No description.
local	boolean | cdktf.IResolvable	No description.
maxLeaseTtlSeconds	number	No description.
maxTokenNameLength	number	No description.
maxTtl	number	No description.
namespace	string	No description.
token	string	No description.
ttl	number	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[]

---

addressInput^Optional

public readonly addressInput: string;

• Type: string

---

backendInput^Optional

public readonly backendInput: string;

• Type: string

---

caCertInput^Optional

public readonly caCertInput: string;

• Type: string

---

clientCertInput^Optional

public readonly clientCertInput: string;

• Type: string

---

clientKeyInput^Optional

public readonly clientKeyInput: string;

• Type: string

---

defaultLeaseTtlSecondsInput^Optional

public readonly defaultLeaseTtlSecondsInput: 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

---

localInput^Optional

public readonly localInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

maxLeaseTtlSecondsInput^Optional

public readonly maxLeaseTtlSecondsInput: number;

• Type: number

---

maxTokenNameLengthInput^Optional

public readonly maxTokenNameLengthInput: number;

• Type: number

---

maxTtlInput^Optional

public readonly maxTtlInput: number;

• Type: number

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

tokenInput^Optional

public readonly tokenInput: string;

• Type: string

---

ttlInput^Optional

public readonly ttlInput: number;

• Type: number

---

address^Required

public readonly address: string;

• Type: string

---

backend^Required

public readonly backend: string;

• Type: string

---

caCert^Required

public readonly caCert: string;

• Type: string

---

clientCert^Required

public readonly clientCert: string;

• Type: string

---

clientKey^Required

public readonly clientKey: string;

• Type: string

---

defaultLeaseTtlSeconds^Required

public readonly defaultLeaseTtlSeconds: 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

---

local^Required

public readonly local: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

maxLeaseTtlSeconds^Required

public readonly maxLeaseTtlSeconds: number;

• Type: number

---

maxTokenNameLength^Required

public readonly maxTokenNameLength: number;

• Type: number

---

maxTtl^Required

public readonly maxTtl: number;

• Type: number

---

namespace^Required

public readonly namespace: string;

• Type: string

---

token^Required

public readonly token: string;

• Type: string

---

ttl^Required

public readonly ttl: number;

• Type: number

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

NomadSecretBackendConfig

Initializer

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

const nomadSecretBackendConfig: nomadSecretBackend.NomadSecretBackendConfig = { ... }

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.
address	string	Specifies the address of the Nomad instance, provided as "protocol://host:port" like "http://127.0.0.1:4646".
backend	string	The mount path for the Nomad backend.
caCert	string	CA certificate to use when verifying Nomad server certificate, must be x509 PEM encoded.
clientCert	string	Client certificate used for Nomad's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
clientKey	string	Client key used for Nomad's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
defaultLeaseTtlSeconds	number	Default lease duration for secrets 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/nomad_secret_backend#id NomadSecretBackend#id}.
local	boolean | cdktf.IResolvable	Mark the secrets engine as local-only.
maxLeaseTtlSeconds	number	Maximum possible lease duration for secrets in seconds.
maxTokenNameLength	number	Specifies the maximum length to use for the name of the Nomad token generated with Generate Credential.
maxTtl	number	Maximum possible lease duration for secrets in seconds.
namespace	string	Target namespace. (requires Enterprise).
token	string	Specifies the Nomad Management token to use.
ttl	number	Maximum possible lease duration for secrets in seconds.

---

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

---

address^Optional

public readonly address: string;

• Type: string

Specifies the address of the Nomad instance, provided as "protocol://host:port" like "http://127.0.0.1:4646".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/nomad_secret_backend#address NomadSecretBackend#address}

---

backend^Optional

public readonly backend: string;

• Type: string

The mount path for the Nomad backend.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/nomad_secret_backend#backend NomadSecretBackend#backend}

---

caCert^Optional

public readonly caCert: string;

• Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/nomad_secret_backend#ca_cert NomadSecretBackend#ca_cert}

---

clientCert^Optional

public readonly clientCert: string;

• Type: string

Client certificate used for Nomad's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/nomad_secret_backend#client_cert NomadSecretBackend#client_cert}

---

clientKey^Optional

public readonly clientKey: string;

• Type: string

Client key used for Nomad's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/nomad_secret_backend#client_key NomadSecretBackend#client_key}

---

defaultLeaseTtlSeconds^Optional

public readonly defaultLeaseTtlSeconds: number;

• Type: number

Default lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/nomad_secret_backend#default_lease_ttl_seconds NomadSecretBackend#default_lease_ttl_seconds}

---

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/nomad_secret_backend#description NomadSecretBackend#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/nomad_secret_backend#disable_remount NomadSecretBackend#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/nomad_secret_backend#id NomadSecretBackend#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.

---

local^Optional

public readonly local: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Mark the secrets engine as local-only.

Local engines are not replicated or removed by replication. Tolerance duration to use when checking the last rotation time.

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

---

maxLeaseTtlSeconds^Optional

public readonly maxLeaseTtlSeconds: number;

• Type: number

Maximum possible lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/nomad_secret_backend#max_lease_ttl_seconds NomadSecretBackend#max_lease_ttl_seconds}

---

maxTokenNameLength^Optional

public readonly maxTokenNameLength: number;

• Type: number

Specifies the maximum length to use for the name of the Nomad token generated with Generate Credential.

If omitted, 0 is used and ignored, defaulting to the max value allowed by the Nomad version.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/nomad_secret_backend#max_token_name_length NomadSecretBackend#max_token_name_length}

---

maxTtl^Optional

public readonly maxTtl: number;

• Type: number

Maximum possible lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/nomad_secret_backend#max_ttl NomadSecretBackend#max_ttl}

---

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/nomad_secret_backend#namespace NomadSecretBackend#namespace}

---

token^Optional

public readonly token: string;

• Type: string

Specifies the Nomad Management token to use.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/nomad_secret_backend#token NomadSecretBackend#token}

---

ttl^Optional

public readonly ttl: number;

• Type: number

Maximum possible lease duration for secrets in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/nomad_secret_backend#ttl NomadSecretBackend#ttl}

---