approleAuthBackendRoleSecretId.typescript.md

approleAuthBackendRoleSecretId Submodule

Constructs

ApproleAuthBackendRoleSecretId

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

Initializers

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

new approleAuthBackendRoleSecretId.ApproleAuthBackendRoleSecretId(scope: Construct, id: string, config: ApproleAuthBackendRoleSecretIdConfig)

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

---

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".
resetBackend	No description.
resetCidrList	No description.
resetId	No description.
resetMetadata	No description.
resetNamespace	No description.
resetNumUses	No description.
resetSecretId	No description.
resetTtl	No description.
resetWithWrappedAccessor	No description.
resetWrappingTtl	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".

---

resetBackend

public resetBackend(): void

resetCidrList

public resetCidrList(): void

resetId

public resetId(): void

resetMetadata

public resetMetadata(): void

resetNamespace

public resetNamespace(): void

resetNumUses

public resetNumUses(): void

resetSecretId

public resetSecretId(): void

resetTtl

public resetTtl(): void

resetWithWrappedAccessor

public resetWithWrappedAccessor(): void

resetWrappingTtl

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

---

isConstruct

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

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

approleAuthBackendRoleSecretId.ApproleAuthBackendRoleSecretId.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

approleAuthBackendRoleSecretId.ApproleAuthBackendRoleSecretId.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

approleAuthBackendRoleSecretId.ApproleAuthBackendRoleSecretId.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing ApproleAuthBackendRoleSecretId that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/approle_auth_backend_role_secret_id#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 ApproleAuthBackendRoleSecretId 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.
accessor	string	No description.
wrappingAccessor	string	No description.
wrappingToken	string	No description.
backendInput	string	No description.
cidrListInput	string[]	No description.
idInput	string	No description.
metadataInput	string	No description.
namespaceInput	string	No description.
numUsesInput	number	No description.
roleNameInput	string	No description.
secretIdInput	string	No description.
ttlInput	number	No description.
withWrappedAccessorInput	boolean | cdktf.IResolvable	No description.
wrappingTtlInput	string	No description.
backend	string	No description.
cidrList	string[]	No description.
id	string	No description.
metadata	string	No description.
namespace	string	No description.
numUses	number	No description.
roleName	string	No description.
secretId	string	No description.
ttl	number	No description.
withWrappedAccessor	boolean | cdktf.IResolvable	No description.
wrappingTtl	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[]

---

accessor^Required

public readonly accessor: string;

• Type: string

---

wrappingAccessor^Required

public readonly wrappingAccessor: string;

• Type: string

---

wrappingToken^Required

public readonly wrappingToken: string;

• Type: string

---

backendInput^Optional

public readonly backendInput: string;

• Type: string

---

cidrListInput^Optional

public readonly cidrListInput: string[];

• Type: string[]

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

metadataInput^Optional

public readonly metadataInput: string;

• Type: string

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

numUsesInput^Optional

public readonly numUsesInput: number;

• Type: number

---

roleNameInput^Optional

public readonly roleNameInput: string;

• Type: string

---

secretIdInput^Optional

public readonly secretIdInput: string;

• Type: string

---

ttlInput^Optional

public readonly ttlInput: number;

• Type: number

---

withWrappedAccessorInput^Optional

public readonly withWrappedAccessorInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

wrappingTtlInput^Optional

public readonly wrappingTtlInput: string;

• Type: string

---

backend^Required

public readonly backend: string;

• Type: string

---

cidrList^Required

public readonly cidrList: string[];

• Type: string[]

---

id^Required

public readonly id: string;

• Type: string

---

metadata^Required

public readonly metadata: string;

• Type: string

---

namespace^Required

public readonly namespace: string;

• Type: string

---

numUses^Required

public readonly numUses: number;

• Type: number

---

roleName^Required

public readonly roleName: string;

• Type: string

---

secretId^Required

public readonly secretId: string;

• Type: string

---

ttl^Required

public readonly ttl: number;

• Type: number

---

withWrappedAccessor^Required

public readonly withWrappedAccessor: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

wrappingTtl^Required

public readonly wrappingTtl: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ApproleAuthBackendRoleSecretIdConfig

Initializer

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

const approleAuthBackendRoleSecretIdConfig: approleAuthBackendRoleSecretId.ApproleAuthBackendRoleSecretIdConfig = { ... }

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.
roleName	string	Name of the role.
backend	string	Unique name of the auth backend to configure.
cidrList	string[]	List of CIDR blocks that can log in using the SecretID.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/approle_auth_backend_role_secret_id#id ApproleAuthBackendRoleSecretId#id}.
metadata	string	JSON-encoded secret data to write.
namespace	string	Target namespace. (requires Enterprise).
numUses	number	The number of uses for the secret-id.
secretId	string	The SecretID to be managed. If not specified, Vault auto-generates one.
ttl	number	The TTL duration of the SecretID.
withWrappedAccessor	boolean | cdktf.IResolvable	Use the wrapped secret-id accessor as the id of this resource.
wrappingTtl	string	The TTL duration of the wrapped SecretID.

---

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

---

roleName^Required

public readonly roleName: string;

• Type: string

Name of the role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/approle_auth_backend_role_secret_id#role_name ApproleAuthBackendRoleSecretId#role_name}

---

backend^Optional

public readonly backend: string;

• Type: string

Unique name of the auth backend to configure.

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

---

cidrList^Optional

public readonly cidrList: string[];

• Type: string[]

List of CIDR blocks that can log in using the SecretID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/approle_auth_backend_role_secret_id#cidr_list ApproleAuthBackendRoleSecretId#cidr_list}

---

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/approle_auth_backend_role_secret_id#id ApproleAuthBackendRoleSecretId#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.

---

metadata^Optional

public readonly metadata: string;

• Type: string

JSON-encoded secret data to write.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/approle_auth_backend_role_secret_id#metadata ApproleAuthBackendRoleSecretId#metadata}

---

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/approle_auth_backend_role_secret_id#namespace ApproleAuthBackendRoleSecretId#namespace}

---

numUses^Optional

public readonly numUses: number;

• Type: number

The number of uses for the secret-id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/approle_auth_backend_role_secret_id#num_uses ApproleAuthBackendRoleSecretId#num_uses}

---

secretId^Optional

public readonly secretId: string;

• Type: string

The SecretID to be managed. If not specified, Vault auto-generates one.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/approle_auth_backend_role_secret_id#secret_id ApproleAuthBackendRoleSecretId#secret_id}

---

ttl^Optional

public readonly ttl: number;

• Type: number

The TTL duration of the SecretID.

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

---

withWrappedAccessor^Optional

public readonly withWrappedAccessor: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Use the wrapped secret-id accessor as the id of this resource.

If false, a fresh secret-id will be regenerated whenever the wrapping token is expired or invalidated through unwrapping.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/approle_auth_backend_role_secret_id#with_wrapped_accessor ApproleAuthBackendRoleSecretId#with_wrapped_accessor}

---

wrappingTtl^Optional

public readonly wrappingTtl: string;

• Type: string

The TTL duration of the wrapped SecretID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/approle_auth_backend_role_secret_id#wrapping_ttl ApproleAuthBackendRoleSecretId#wrapping_ttl}

---