token.typescript.md

token Submodule

Constructs

Token

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

Initializers

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

new token.Token(scope: Construct, id: string, config?: TokenConfig)

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

---

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".
resetDisplayName	No description.
resetExplicitMaxTtl	No description.
resetId	No description.
resetMetadata	No description.
resetNamespace	No description.
resetNoDefaultPolicy	No description.
resetNoParent	No description.
resetNumUses	No description.
resetPeriod	No description.
resetPolicies	No description.
resetRenewable	No description.
resetRenewIncrement	No description.
resetRenewMinLease	No description.
resetRoleName	No description.
resetTtl	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".

---

resetDisplayName

public resetDisplayName(): void

resetExplicitMaxTtl

public resetExplicitMaxTtl(): void

resetId

public resetId(): void

resetMetadata

public resetMetadata(): void

resetNamespace

public resetNamespace(): void

resetNoDefaultPolicy

public resetNoDefaultPolicy(): void

resetNoParent

public resetNoParent(): void

resetNumUses

public resetNumUses(): void

resetPeriod

public resetPeriod(): void

resetPolicies

public resetPolicies(): void

resetRenewable

public resetRenewable(): void

resetRenewIncrement

public resetRenewIncrement(): void

resetRenewMinLease

public resetRenewMinLease(): void

resetRoleName

public resetRoleName(): void

resetTtl

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

---

isConstruct

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

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

token.Token.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

token.Token.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

token.Token.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing Token that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#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 Token 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.
clientToken	string	No description.
leaseDuration	number	No description.
leaseStarted	string	No description.
wrappedToken	string	No description.
wrappingAccessor	string	No description.
displayNameInput	string	No description.
explicitMaxTtlInput	string	No description.
idInput	string	No description.
metadataInput	{[ key: string ]: string}	No description.
namespaceInput	string	No description.
noDefaultPolicyInput	boolean | cdktf.IResolvable	No description.
noParentInput	boolean | cdktf.IResolvable	No description.
numUsesInput	number	No description.
periodInput	string	No description.
policiesInput	string[]	No description.
renewableInput	boolean | cdktf.IResolvable	No description.
renewIncrementInput	number	No description.
renewMinLeaseInput	number	No description.
roleNameInput	string	No description.
ttlInput	string	No description.
wrappingTtlInput	string	No description.
displayName	string	No description.
explicitMaxTtl	string	No description.
id	string	No description.
metadata	{[ key: string ]: string}	No description.
namespace	string	No description.
noDefaultPolicy	boolean | cdktf.IResolvable	No description.
noParent	boolean | cdktf.IResolvable	No description.
numUses	number	No description.
period	string	No description.
policies	string[]	No description.
renewable	boolean | cdktf.IResolvable	No description.
renewIncrement	number	No description.
renewMinLease	number	No description.
roleName	string	No description.
ttl	string	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[]

---

clientToken^Required

public readonly clientToken: string;

• Type: string

---

leaseDuration^Required

public readonly leaseDuration: number;

• Type: number

---

leaseStarted^Required

public readonly leaseStarted: string;

• Type: string

---

wrappedToken^Required

public readonly wrappedToken: string;

• Type: string

---

wrappingAccessor^Required

public readonly wrappingAccessor: string;

• Type: string

---

displayNameInput^Optional

public readonly displayNameInput: string;

• Type: string

---

explicitMaxTtlInput^Optional

public readonly explicitMaxTtlInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

metadataInput^Optional

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

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

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

noDefaultPolicyInput^Optional

public readonly noDefaultPolicyInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

noParentInput^Optional

public readonly noParentInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

numUsesInput^Optional

public readonly numUsesInput: number;

• Type: number

---

periodInput^Optional

public readonly periodInput: string;

• Type: string

---

policiesInput^Optional

public readonly policiesInput: string[];

• Type: string[]

---

renewableInput^Optional

public readonly renewableInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

renewIncrementInput^Optional

public readonly renewIncrementInput: number;

• Type: number

---

renewMinLeaseInput^Optional

public readonly renewMinLeaseInput: number;

• Type: number

---

roleNameInput^Optional

public readonly roleNameInput: string;

• Type: string

---

ttlInput^Optional

public readonly ttlInput: string;

• Type: string

---

wrappingTtlInput^Optional

public readonly wrappingTtlInput: string;

• Type: string

---

displayName^Required

public readonly displayName: string;

• Type: string

---

explicitMaxTtl^Required

public readonly explicitMaxTtl: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

metadata^Required

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

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

---

namespace^Required

public readonly namespace: string;

• Type: string

---

noDefaultPolicy^Required

public readonly noDefaultPolicy: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

noParent^Required

public readonly noParent: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

numUses^Required

public readonly numUses: number;

• Type: number

---

period^Required

public readonly period: string;

• Type: string

---

policies^Required

public readonly policies: string[];

• Type: string[]

---

renewable^Required

public readonly renewable: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

renewIncrement^Required

public readonly renewIncrement: number;

• Type: number

---

renewMinLease^Required

public readonly renewMinLease: number;

• Type: number

---

roleName^Required

public readonly roleName: string;

• Type: string

---

ttl^Required

public readonly ttl: string;

• Type: string

---

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

TokenConfig

Initializer

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

const tokenConfig: token.TokenConfig = { ... }

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.
displayName	string	The display name of the token.
explicitMaxTtl	string	The explicit max TTL of the token.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#id Token#id}.
metadata	{[ key: string ]: string}	Metadata to be associated with the token.
namespace	string	Target namespace. (requires Enterprise).
noDefaultPolicy	boolean | cdktf.IResolvable	Flag to disable the default policy.
noParent	boolean | cdktf.IResolvable	Flag to create a token without parent.
numUses	number	The number of allowed uses of the token.
period	string	The period of the token.
policies	string[]	List of policies.
renewable	boolean | cdktf.IResolvable	Flag to allow the token to be renewed.
renewIncrement	number	The renew increment.
renewMinLease	number	The minimum lease to renew token.
roleName	string	The token role name.
ttl	string	The TTL period of the token.
wrappingTtl	string	The TTL period of the wrapped token.

---

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

---

displayName^Optional

public readonly displayName: string;

• Type: string

The display name of the token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#display_name Token#display_name}

---

explicitMaxTtl^Optional

public readonly explicitMaxTtl: string;

• Type: string

The explicit max TTL of the token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#explicit_max_ttl Token#explicit_max_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/token#id Token#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: {[ key: string ]: string};

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

Metadata to be associated with the token.

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

---

noDefaultPolicy^Optional

public readonly noDefaultPolicy: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Flag to disable the default policy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#no_default_policy Token#no_default_policy}

---

noParent^Optional

public readonly noParent: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Flag to create a token without parent.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#no_parent Token#no_parent}

---

numUses^Optional

public readonly numUses: number;

• Type: number

The number of allowed uses of the token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#num_uses Token#num_uses}

---

period^Optional

public readonly period: string;

• Type: string

The period of the token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#period Token#period}

---

policies^Optional

public readonly policies: string[];

• Type: string[]

List of policies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#policies Token#policies}

---

renewable^Optional

public readonly renewable: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Flag to allow the token to be renewed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#renewable Token#renewable}

---

renewIncrement^Optional

public readonly renewIncrement: number;

• Type: number

The renew increment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#renew_increment Token#renew_increment}

---

renewMinLease^Optional

public readonly renewMinLease: number;

• Type: number

The minimum lease to renew token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#renew_min_lease Token#renew_min_lease}

---

roleName^Optional

public readonly roleName: string;

• Type: string

The token role name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#role_name Token#role_name}

---

ttl^Optional

public readonly ttl: string;

• Type: string

The TTL period of the token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#ttl Token#ttl}

---

wrappingTtl^Optional

public readonly wrappingTtl: string;

• Type: string

The TTL period of the wrapped token.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/resources/token#wrapping_ttl Token#wrapping_ttl}

---