rabbitmqSecretBackend.typescript.md

rabbitmqSecretBackend Submodule

Constructs

RabbitmqSecretBackend

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

Initializers

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

new rabbitmqSecretBackend.RabbitmqSecretBackend(scope: Construct, id: string, config: RabbitmqSecretBackendConfig)

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

---

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".
resetDefaultLeaseTtlSeconds	No description.
resetDescription	No description.
resetDisableRemount	No description.
resetId	No description.
resetMaxLeaseTtlSeconds	No description.
resetNamespace	No description.
resetPasswordPolicy	No description.
resetPath	No description.
resetUsernameTemplate	No description.
resetVerifyConnection	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".

---

resetDefaultLeaseTtlSeconds

public resetDefaultLeaseTtlSeconds(): void

resetDescription

public resetDescription(): void

resetDisableRemount

public resetDisableRemount(): void

resetId

public resetId(): void

resetMaxLeaseTtlSeconds

public resetMaxLeaseTtlSeconds(): void

resetNamespace

public resetNamespace(): void

resetPasswordPolicy

public resetPasswordPolicy(): void

resetPath

public resetPath(): void

resetUsernameTemplate

public resetUsernameTemplate(): void

resetVerifyConnection

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

---

isConstruct

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

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

rabbitmqSecretBackend.RabbitmqSecretBackend.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

rabbitmqSecretBackend.RabbitmqSecretBackend.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

rabbitmqSecretBackend.RabbitmqSecretBackend.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing RabbitmqSecretBackend that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/rabbitmq_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 RabbitmqSecretBackend 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.
connectionUriInput	string	No description.
defaultLeaseTtlSecondsInput	number	No description.
descriptionInput	string	No description.
disableRemountInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
maxLeaseTtlSecondsInput	number	No description.
namespaceInput	string	No description.
passwordInput	string	No description.
passwordPolicyInput	string	No description.
pathInput	string	No description.
usernameInput	string	No description.
usernameTemplateInput	string	No description.
verifyConnectionInput	boolean | cdktf.IResolvable	No description.
connectionUri	string	No description.
defaultLeaseTtlSeconds	number	No description.
description	string	No description.
disableRemount	boolean | cdktf.IResolvable	No description.
id	string	No description.
maxLeaseTtlSeconds	number	No description.
namespace	string	No description.
password	string	No description.
passwordPolicy	string	No description.
path	string	No description.
username	string	No description.
usernameTemplate	string	No description.
verifyConnection	boolean | cdktf.IResolvable	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[]

---

connectionUriInput^Optional

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

---

maxLeaseTtlSecondsInput^Optional

public readonly maxLeaseTtlSecondsInput: number;

• Type: number

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

passwordInput^Optional

public readonly passwordInput: string;

• Type: string

---

passwordPolicyInput^Optional

public readonly passwordPolicyInput: string;

• Type: string

---

pathInput^Optional

public readonly pathInput: string;

• Type: string

---

usernameInput^Optional

public readonly usernameInput: string;

• Type: string

---

usernameTemplateInput^Optional

public readonly usernameTemplateInput: string;

• Type: string

---

verifyConnectionInput^Optional

public readonly verifyConnectionInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

connectionUri^Required

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

---

maxLeaseTtlSeconds^Required

public readonly maxLeaseTtlSeconds: number;

• Type: number

---

namespace^Required

public readonly namespace: string;

• Type: string

---

password^Required

public readonly password: string;

• Type: string

---

passwordPolicy^Required

public readonly passwordPolicy: string;

• Type: string

---

path^Required

public readonly path: string;

• Type: string

---

username^Required

public readonly username: string;

• Type: string

---

usernameTemplate^Required

public readonly usernameTemplate: string;

• Type: string

---

verifyConnection^Required

public readonly verifyConnection: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

RabbitmqSecretBackendConfig

Initializer

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

const rabbitmqSecretBackendConfig: rabbitmqSecretBackend.RabbitmqSecretBackendConfig = { ... }

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.
connectionUri	string	Specifies the RabbitMQ connection URI.
password	string	Specifies the RabbitMQ management administrator password.
username	string	Specifies the RabbitMQ management administrator username.
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.2.0/docs/resources/rabbitmq_secret_backend#id RabbitmqSecretBackend#id}.
maxLeaseTtlSeconds	number	Maximum possible lease duration for secrets in seconds.
namespace	string	Target namespace. (requires Enterprise).
passwordPolicy	string	Specifies a password policy to use when creating dynamic credentials. Defaults to generating an alphanumeric password if not set.
path	string	The path of the RabbitMQ Secret Backend where the connection should be configured.
usernameTemplate	string	Template describing how dynamic usernames are generated.
verifyConnection	boolean | cdktf.IResolvable	Specifies whether to verify connection URI, username, and password.

---

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

---

connectionUri^Required

public readonly connectionUri: string;

• Type: string

Specifies the RabbitMQ connection URI.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/rabbitmq_secret_backend#connection_uri RabbitmqSecretBackend#connection_uri}

---

password^Required

public readonly password: string;

• Type: string

Specifies the RabbitMQ management administrator password.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/rabbitmq_secret_backend#password RabbitmqSecretBackend#password}

---

username^Required

public readonly username: string;

• Type: string

Specifies the RabbitMQ management administrator username.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/rabbitmq_secret_backend#username RabbitmqSecretBackend#username}

---

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.2.0/docs/resources/rabbitmq_secret_backend#default_lease_ttl_seconds RabbitmqSecretBackend#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.2.0/docs/resources/rabbitmq_secret_backend#description RabbitmqSecretBackend#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.2.0/docs/resources/rabbitmq_secret_backend#disable_remount RabbitmqSecretBackend#disable_remount}

---

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/rabbitmq_secret_backend#id RabbitmqSecretBackend#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.

---

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.2.0/docs/resources/rabbitmq_secret_backend#max_lease_ttl_seconds RabbitmqSecretBackend#max_lease_ttl_seconds}

---

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/rabbitmq_secret_backend#namespace RabbitmqSecretBackend#namespace}

---

passwordPolicy^Optional

public readonly passwordPolicy: string;

• Type: string

Specifies a password policy to use when creating dynamic credentials. Defaults to generating an alphanumeric password if not set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/rabbitmq_secret_backend#password_policy RabbitmqSecretBackend#password_policy}

---

path^Optional

public readonly path: string;

• Type: string

The path of the RabbitMQ Secret Backend where the connection should be configured.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/rabbitmq_secret_backend#path RabbitmqSecretBackend#path}

---

usernameTemplate^Optional

public readonly usernameTemplate: string;

• Type: string

Template describing how dynamic usernames are generated.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/rabbitmq_secret_backend#username_template RabbitmqSecretBackend#username_template}

---

verifyConnection^Optional

public readonly verifyConnection: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Specifies whether to verify connection URI, username, and password.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/rabbitmq_secret_backend#verify_connection RabbitmqSecretBackend#verify_connection}

---