azureSecretBackend.typescript.md

azureSecretBackend Submodule

Constructs

AzureSecretBackend

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

Initializers

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

new azureSecretBackend.AzureSecretBackend(scope: Construct, id: string, config: AzureSecretBackendConfig)

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

---

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".
resetClientId	No description.
resetClientSecret	No description.
resetDescription	No description.
resetDisableRemount	No description.
resetEnvironment	No description.
resetId	No description.
resetIdentityTokenAudience	No description.
resetIdentityTokenKey	No description.
resetIdentityTokenTtl	No description.
resetNamespace	No description.
resetPath	No description.
resetUseMicrosoftGraphApi	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".

---

resetClientId

public resetClientId(): void

resetClientSecret

public resetClientSecret(): void

resetDescription

public resetDescription(): void

resetDisableRemount

public resetDisableRemount(): void

resetEnvironment

public resetEnvironment(): void

resetId

public resetId(): void

resetIdentityTokenAudience

public resetIdentityTokenAudience(): void

resetIdentityTokenKey

public resetIdentityTokenKey(): void

resetIdentityTokenTtl

public resetIdentityTokenTtl(): void

resetNamespace

public resetNamespace(): void

resetPath

public resetPath(): void

resetUseMicrosoftGraphApi

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

---

isConstruct

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

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

azureSecretBackend.AzureSecretBackend.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

azureSecretBackend.AzureSecretBackend.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

azureSecretBackend.AzureSecretBackend.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing AzureSecretBackend that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/azure_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 AzureSecretBackend 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.
clientIdInput	string	No description.
clientSecretInput	string	No description.
descriptionInput	string	No description.
disableRemountInput	boolean | cdktf.IResolvable	No description.
environmentInput	string	No description.
identityTokenAudienceInput	string	No description.
identityTokenKeyInput	string	No description.
identityTokenTtlInput	number	No description.
idInput	string	No description.
namespaceInput	string	No description.
pathInput	string	No description.
subscriptionIdInput	string	No description.
tenantIdInput	string	No description.
useMicrosoftGraphApiInput	boolean | cdktf.IResolvable	No description.
clientId	string	No description.
clientSecret	string	No description.
description	string	No description.
disableRemount	boolean | cdktf.IResolvable	No description.
environment	string	No description.
id	string	No description.
identityTokenAudience	string	No description.
identityTokenKey	string	No description.
identityTokenTtl	number	No description.
namespace	string	No description.
path	string	No description.
subscriptionId	string	No description.
tenantId	string	No description.
useMicrosoftGraphApi	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[]

---

clientIdInput^Optional

public readonly clientIdInput: string;

• Type: string

---

clientSecretInput^Optional

public readonly clientSecretInput: string;

• Type: string

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

disableRemountInput^Optional

public readonly disableRemountInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

environmentInput^Optional

public readonly environmentInput: string;

• Type: string

---

identityTokenAudienceInput^Optional

public readonly identityTokenAudienceInput: string;

• Type: string

---

identityTokenKeyInput^Optional

public readonly identityTokenKeyInput: string;

• Type: string

---

identityTokenTtlInput^Optional

public readonly identityTokenTtlInput: number;

• Type: number

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

pathInput^Optional

public readonly pathInput: string;

• Type: string

---

subscriptionIdInput^Optional

public readonly subscriptionIdInput: string;

• Type: string

---

tenantIdInput^Optional

public readonly tenantIdInput: string;

• Type: string

---

useMicrosoftGraphApiInput^Optional

public readonly useMicrosoftGraphApiInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

clientId^Required

public readonly clientId: string;

• Type: string

---

clientSecret^Required

public readonly clientSecret: string;

• Type: string

---

description^Required

public readonly description: string;

• Type: string

---

disableRemount^Required

public readonly disableRemount: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

environment^Required

public readonly environment: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

identityTokenAudience^Required

public readonly identityTokenAudience: string;

• Type: string

---

identityTokenKey^Required

public readonly identityTokenKey: string;

• Type: string

---

identityTokenTtl^Required

public readonly identityTokenTtl: number;

• Type: number

---

namespace^Required

public readonly namespace: string;

• Type: string

---

path^Required

public readonly path: string;

• Type: string

---

subscriptionId^Required

public readonly subscriptionId: string;

• Type: string

---

tenantId^Required

public readonly tenantId: string;

• Type: string

---

useMicrosoftGraphApi^Required

public readonly useMicrosoftGraphApi: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

AzureSecretBackendConfig

Initializer

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

const azureSecretBackendConfig: azureSecretBackend.AzureSecretBackendConfig = { ... }

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.
subscriptionId	string	The subscription id for the Azure Active Directory.
tenantId	string	The tenant id for the Azure Active Directory organization.
clientId	string	The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.
clientSecret	string	The client secret for credentials to query the Azure APIs.
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.
environment	string	The Azure cloud environment. Valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/azure_secret_backend#id AzureSecretBackend#id}.
identityTokenAudience	string	The audience claim value.
identityTokenKey	string	The key to use for signing identity tokens.
identityTokenTtl	number	The TTL of generated identity tokens in seconds.
namespace	string	Target namespace. (requires Enterprise).
path	string	Path to mount the backend at.
useMicrosoftGraphApi	boolean | cdktf.IResolvable	Use the Microsoft Graph API. Should be set to true on vault-1.10+.

---

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

---

subscriptionId^Required

public readonly subscriptionId: string;

• Type: string

The subscription id for the Azure Active Directory.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/azure_secret_backend#subscription_id AzureSecretBackend#subscription_id}

---

tenantId^Required

public readonly tenantId: string;

• Type: string

The tenant id for the Azure Active Directory organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/azure_secret_backend#tenant_id AzureSecretBackend#tenant_id}

---

clientId^Optional

public readonly clientId: string;

• Type: string

The client id for credentials to query the Azure APIs. Currently read permissions to query compute resources are required.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/azure_secret_backend#client_id AzureSecretBackend#client_id}

---

clientSecret^Optional

public readonly clientSecret: string;

• Type: string

The client secret for credentials to query the Azure APIs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/azure_secret_backend#client_secret AzureSecretBackend#client_secret}

---

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/azure_secret_backend#description AzureSecretBackend#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/azure_secret_backend#disable_remount AzureSecretBackend#disable_remount}

---

environment^Optional

public readonly environment: string;

• Type: string

The Azure cloud environment. Valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/azure_secret_backend#environment AzureSecretBackend#environment}

---

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/azure_secret_backend#id AzureSecretBackend#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.

---

identityTokenAudience^Optional

public readonly identityTokenAudience: string;

• Type: string

The audience claim value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/azure_secret_backend#identity_token_audience AzureSecretBackend#identity_token_audience}

---

identityTokenKey^Optional

public readonly identityTokenKey: string;

• Type: string

The key to use for signing identity tokens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/azure_secret_backend#identity_token_key AzureSecretBackend#identity_token_key}

---

identityTokenTtl^Optional

public readonly identityTokenTtl: number;

• Type: number

The TTL of generated identity tokens in seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/azure_secret_backend#identity_token_ttl AzureSecretBackend#identity_token_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/azure_secret_backend#namespace AzureSecretBackend#namespace}

---

path^Optional

public readonly path: string;

• Type: string

Path to mount the backend at.

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

---

useMicrosoftGraphApi^Optional

public readonly useMicrosoftGraphApi: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Use the Microsoft Graph API. Should be set to true on vault-1.10+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/azure_secret_backend#use_microsoft_graph_api AzureSecretBackend#use_microsoft_graph_api}

---