databaseSecretBackendRole.typescript.md

databaseSecretBackendRole Submodule

Constructs

DatabaseSecretBackendRole

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/database_secret_backend_role vault_database_secret_backend_role}.

Initializers

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

new databaseSecretBackendRole.DatabaseSecretBackendRole(scope: Construct, id: string, config: DatabaseSecretBackendRoleConfig)

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

---

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".
resetCredentialConfig	No description.
resetCredentialType	No description.
resetDefaultTtl	No description.
resetId	No description.
resetMaxTtl	No description.
resetNamespace	No description.
resetRenewStatements	No description.
resetRevocationStatements	No description.
resetRollbackStatements	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".

---

resetCredentialConfig

public resetCredentialConfig(): void

resetCredentialType

public resetCredentialType(): void

resetDefaultTtl

public resetDefaultTtl(): void

resetId

public resetId(): void

resetMaxTtl

public resetMaxTtl(): void

resetNamespace

public resetNamespace(): void

resetRenewStatements

public resetRenewStatements(): void

resetRevocationStatements

public resetRevocationStatements(): void

resetRollbackStatements

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

---

isConstruct

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

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

databaseSecretBackendRole.DatabaseSecretBackendRole.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

databaseSecretBackendRole.DatabaseSecretBackendRole.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

databaseSecretBackendRole.DatabaseSecretBackendRole.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing DatabaseSecretBackendRole that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/database_secret_backend_role#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 DatabaseSecretBackendRole 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.
backendInput	string	No description.
creationStatementsInput	string[]	No description.
credentialConfigInput	{[ key: string ]: string}	No description.
credentialTypeInput	string	No description.
dbNameInput	string	No description.
defaultTtlInput	number	No description.
idInput	string	No description.
maxTtlInput	number	No description.
nameInput	string	No description.
namespaceInput	string	No description.
renewStatementsInput	string[]	No description.
revocationStatementsInput	string[]	No description.
rollbackStatementsInput	string[]	No description.
backend	string	No description.
creationStatements	string[]	No description.
credentialConfig	{[ key: string ]: string}	No description.
credentialType	string	No description.
dbName	string	No description.
defaultTtl	number	No description.
id	string	No description.
maxTtl	number	No description.
name	string	No description.
namespace	string	No description.
renewStatements	string[]	No description.
revocationStatements	string[]	No description.
rollbackStatements	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[]

---

backendInput^Optional

public readonly backendInput: string;

• Type: string

---

creationStatementsInput^Optional

public readonly creationStatementsInput: string[];

• Type: string[]

---

credentialConfigInput^Optional

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

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

---

credentialTypeInput^Optional

public readonly credentialTypeInput: string;

• Type: string

---

dbNameInput^Optional

public readonly dbNameInput: string;

• Type: string

---

defaultTtlInput^Optional

public readonly defaultTtlInput: number;

• Type: number

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

maxTtlInput^Optional

public readonly maxTtlInput: number;

• Type: number

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

renewStatementsInput^Optional

public readonly renewStatementsInput: string[];

• Type: string[]

---

revocationStatementsInput^Optional

public readonly revocationStatementsInput: string[];

• Type: string[]

---

rollbackStatementsInput^Optional

public readonly rollbackStatementsInput: string[];

• Type: string[]

---

backend^Required

public readonly backend: string;

• Type: string

---

creationStatements^Required

public readonly creationStatements: string[];

• Type: string[]

---

credentialConfig^Required

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

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

---

credentialType^Required

public readonly credentialType: string;

• Type: string

---

dbName^Required

public readonly dbName: string;

• Type: string

---

defaultTtl^Required

public readonly defaultTtl: number;

• Type: number

---

id^Required

public readonly id: string;

• Type: string

---

maxTtl^Required

public readonly maxTtl: number;

• Type: number

---

name^Required

public readonly name: string;

• Type: string

---

namespace^Required

public readonly namespace: string;

• Type: string

---

renewStatements^Required

public readonly renewStatements: string[];

• Type: string[]

---

revocationStatements^Required

public readonly revocationStatements: string[];

• Type: string[]

---

rollbackStatements^Required

public readonly rollbackStatements: string[];

• Type: string[]

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DatabaseSecretBackendRoleConfig

Initializer

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

const databaseSecretBackendRoleConfig: databaseSecretBackendRole.DatabaseSecretBackendRoleConfig = { ... }

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.
backend	string	The path of the Database Secret Backend the role belongs to.
creationStatements	string[]	Database statements to execute to create and configure a user.
dbName	string	Database connection to use for this role.
name	string	Unique name for the role.
credentialConfig	{[ key: string ]: string}	Specifies the configuration for the given credential_type.
credentialType	string	Specifies the type of credential that will be generated for the role.
defaultTtl	number	Default TTL for leases associated with this role, in seconds.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/database_secret_backend_role#id DatabaseSecretBackendRole#id}.
maxTtl	number	Maximum TTL for leases associated with this role, in seconds.
namespace	string	Target namespace. (requires Enterprise).
renewStatements	string[]	Database statements to execute to renew a user.
revocationStatements	string[]	Database statements to execute to revoke a user.
rollbackStatements	string[]	Database statements to execute to rollback a create operation in the event of an error.

---

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

---

backend^Required

public readonly backend: string;

• Type: string

The path of the Database Secret Backend the role belongs to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/database_secret_backend_role#backend DatabaseSecretBackendRole#backend}

---

creationStatements^Required

public readonly creationStatements: string[];

• Type: string[]

Database statements to execute to create and configure a user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/database_secret_backend_role#creation_statements DatabaseSecretBackendRole#creation_statements}

---

dbName^Required

public readonly dbName: string;

• Type: string

Database connection to use for this role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/database_secret_backend_role#db_name DatabaseSecretBackendRole#db_name}

---

name^Required

public readonly name: string;

• Type: string

Unique name for the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/database_secret_backend_role#name DatabaseSecretBackendRole#name}

---

credentialConfig^Optional

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

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

Specifies the configuration for the given credential_type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/database_secret_backend_role#credential_config DatabaseSecretBackendRole#credential_config}

---

credentialType^Optional

public readonly credentialType: string;

• Type: string

Specifies the type of credential that will be generated for the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/database_secret_backend_role#credential_type DatabaseSecretBackendRole#credential_type}

---

defaultTtl^Optional

public readonly defaultTtl: number;

• Type: number

Default TTL for leases associated with this role, in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/database_secret_backend_role#default_ttl DatabaseSecretBackendRole#default_ttl}

---

id^Optional

public readonly id: string;

• Type: string

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

---

maxTtl^Optional

public readonly maxTtl: number;

• Type: number

Maximum TTL for leases associated with this role, in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/database_secret_backend_role#max_ttl DatabaseSecretBackendRole#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.2.0/docs/resources/database_secret_backend_role#namespace DatabaseSecretBackendRole#namespace}

---

renewStatements^Optional

public readonly renewStatements: string[];

• Type: string[]

Database statements to execute to renew a user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/database_secret_backend_role#renew_statements DatabaseSecretBackendRole#renew_statements}

---

revocationStatements^Optional

public readonly revocationStatements: string[];

• Type: string[]

Database statements to execute to revoke a user.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/database_secret_backend_role#revocation_statements DatabaseSecretBackendRole#revocation_statements}

---

rollbackStatements^Optional

public readonly rollbackStatements: string[];

• Type: string[]

Database statements to execute to rollback a create operation in the event of an error.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/database_secret_backend_role#rollback_statements DatabaseSecretBackendRole#rollback_statements}

---