consulSecretBackendRole.typescript.md

consulSecretBackendRole Submodule

Constructs

ConsulSecretBackendRole

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

Initializers

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

new consulSecretBackendRole.ConsulSecretBackendRole(scope: Construct, id: string, config: ConsulSecretBackendRoleConfig)

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

---

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.
resetConsulNamespace	No description.
resetConsulPolicies	No description.
resetConsulRoles	No description.
resetId	No description.
resetLocal	No description.
resetMaxTtl	No description.
resetNamespace	No description.
resetNodeIdentities	No description.
resetPartition	No description.
resetPolicies	No description.
resetServiceIdentities	No description.
resetTtl	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

resetConsulNamespace

public resetConsulNamespace(): void

resetConsulPolicies

public resetConsulPolicies(): void

resetConsulRoles

public resetConsulRoles(): void

resetId

public resetId(): void

resetLocal

public resetLocal(): void

resetMaxTtl

public resetMaxTtl(): void

resetNamespace

public resetNamespace(): void

resetNodeIdentities

public resetNodeIdentities(): void

resetPartition

public resetPartition(): void

resetPolicies

public resetPolicies(): void

resetServiceIdentities

public resetServiceIdentities(): void

resetTtl

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

---

isConstruct

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

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

consulSecretBackendRole.ConsulSecretBackendRole.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

consulSecretBackendRole.ConsulSecretBackendRole.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

consulSecretBackendRole.ConsulSecretBackendRole.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing ConsulSecretBackendRole that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/consul_secret_backend_role#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the ConsulSecretBackendRole to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
backendInput	string	No description.
consulNamespaceInput	string	No description.
consulPoliciesInput	string[]	No description.
consulRolesInput	string[]	No description.
idInput	string	No description.
localInput	boolean | cdktf.IResolvable	No description.
maxTtlInput	number	No description.
nameInput	string	No description.
namespaceInput	string	No description.
nodeIdentitiesInput	string[]	No description.
partitionInput	string	No description.
policiesInput	string[]	No description.
serviceIdentitiesInput	string[]	No description.
ttlInput	number	No description.
backend	string	No description.
consulNamespace	string	No description.
consulPolicies	string[]	No description.
consulRoles	string[]	No description.
id	string	No description.
local	boolean | cdktf.IResolvable	No description.
maxTtl	number	No description.
name	string	No description.
namespace	string	No description.
nodeIdentities	string[]	No description.
partition	string	No description.
policies	string[]	No description.
serviceIdentities	string[]	No description.
ttl	number	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

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

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

backendInput^Optional

public readonly backendInput: string;

• Type: string

---

consulNamespaceInput^Optional

public readonly consulNamespaceInput: string;

• Type: string

---

consulPoliciesInput^Optional

public readonly consulPoliciesInput: string[];

• Type: string[]

---

consulRolesInput^Optional

public readonly consulRolesInput: string[];

• Type: string[]

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

localInput^Optional

public readonly localInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

maxTtlInput^Optional

public readonly maxTtlInput: number;

• Type: number

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

nodeIdentitiesInput^Optional

public readonly nodeIdentitiesInput: string[];

• Type: string[]

---

partitionInput^Optional

public readonly partitionInput: string;

• Type: string

---

policiesInput^Optional

public readonly policiesInput: string[];

• Type: string[]

---

serviceIdentitiesInput^Optional

public readonly serviceIdentitiesInput: string[];

• Type: string[]

---

ttlInput^Optional

public readonly ttlInput: number;

• Type: number

---

backend^Required

public readonly backend: string;

• Type: string

---

consulNamespace^Required

public readonly consulNamespace: string;

• Type: string

---

consulPolicies^Required

public readonly consulPolicies: string[];

• Type: string[]

---

consulRoles^Required

public readonly consulRoles: string[];

• Type: string[]

---

id^Required

public readonly id: string;

• Type: string

---

local^Required

public readonly local: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

maxTtl^Required

public readonly maxTtl: number;

• Type: number

---

name^Required

public readonly name: string;

• Type: string

---

namespace^Required

public readonly namespace: string;

• Type: string

---

nodeIdentities^Required

public readonly nodeIdentities: string[];

• Type: string[]

---

partition^Required

public readonly partition: string;

• Type: string

---

policies^Required

public readonly policies: string[];

• Type: string[]

---

serviceIdentities^Required

public readonly serviceIdentities: string[];

• Type: string[]

---

ttl^Required

public readonly ttl: number;

• Type: number

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ConsulSecretBackendRoleConfig

Initializer

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

const consulSecretBackendRoleConfig: consulSecretBackendRole.ConsulSecretBackendRoleConfig = { ... }

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.
name	string	The name of an existing role against which to create this Consul credential.
backend	string	The path of the Consul Secret Backend the role belongs to.
consulNamespace	string	The Consul namespace that the token will be created in. Applicable for Vault 1.10+ and Consul 1.7+.
consulPolicies	string[]	List of Consul policies to associate with this role.
consulRoles	string[]	Set of Consul roles to attach to the token. Applicable for Vault 1.10+ with Consul 1.5+.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/consul_secret_backend_role#id ConsulSecretBackendRole#id}.
local	boolean | cdktf.IResolvable	Indicates that the token should not be replicated globally and instead be local to the current datacenter.
maxTtl	number	Maximum TTL for leases associated with this role, in seconds.
namespace	string	Target namespace. (requires Enterprise).
nodeIdentities	string[]	Set of Consul node identities to attach to the token. Applicable for Vault 1.11+ with Consul 1.8+.
partition	string	The Consul admin partition that the token will be created in. Applicable for Vault 1.10+ and Consul 1.11+.
policies	string[]	List of Consul policies to associate with this role.
serviceIdentities	string[]	Set of Consul service identities to attach to the token. Applicable for Vault 1.11+ with Consul 1.5+.
ttl	number	Specifies the TTL for this role.

---

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

---

name^Required

public readonly name: string;

• Type: string

The name of an existing role against which to create this Consul credential.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/consul_secret_backend_role#name ConsulSecretBackendRole#name}

---

backend^Optional

public readonly backend: string;

• Type: string

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

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

---

consulNamespace^Optional

public readonly consulNamespace: string;

• Type: string

The Consul namespace that the token will be created in. Applicable for Vault 1.10+ and Consul 1.7+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/consul_secret_backend_role#consul_namespace ConsulSecretBackendRole#consul_namespace}

---

consulPolicies^Optional

public readonly consulPolicies: string[];

• Type: string[]

List of Consul policies to associate with this role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/consul_secret_backend_role#consul_policies ConsulSecretBackendRole#consul_policies}

---

consulRoles^Optional

public readonly consulRoles: string[];

• Type: string[]

Set of Consul roles to attach to the token. Applicable for Vault 1.10+ with Consul 1.5+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/consul_secret_backend_role#consul_roles ConsulSecretBackendRole#consul_roles}

---

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/consul_secret_backend_role#id ConsulSecretBackendRole#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.

---

local^Optional

public readonly local: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Indicates that the token should not be replicated globally and instead be local to the current datacenter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/consul_secret_backend_role#local ConsulSecretBackendRole#local}

---

maxTtl^Optional

public readonly maxTtl: number;

• Type: number

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/consul_secret_backend_role#max_ttl ConsulSecretBackendRole#max_ttl}

---

namespace^Optional

public readonly namespace: string;

• Type: string

Target namespace. (requires Enterprise).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/consul_secret_backend_role#namespace ConsulSecretBackendRole#namespace}

---

nodeIdentities^Optional

public readonly nodeIdentities: string[];

• Type: string[]

Set of Consul node identities to attach to the token. Applicable for Vault 1.11+ with Consul 1.8+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/consul_secret_backend_role#node_identities ConsulSecretBackendRole#node_identities}

---

partition^Optional

public readonly partition: string;

• Type: string

The Consul admin partition that the token will be created in. Applicable for Vault 1.10+ and Consul 1.11+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/consul_secret_backend_role#partition ConsulSecretBackendRole#partition}

---

policies^Optional

public readonly policies: string[];

• Type: string[]

List of Consul policies to associate with this role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/consul_secret_backend_role#policies ConsulSecretBackendRole#policies}

---

serviceIdentities^Optional

public readonly serviceIdentities: string[];

• Type: string[]

Set of Consul service identities to attach to the token. Applicable for Vault 1.11+ with Consul 1.5+.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.6.0/docs/resources/consul_secret_backend_role#service_identities ConsulSecretBackendRole#service_identities}

---

ttl^Optional

public readonly ttl: number;

• Type: number

Specifies the TTL for this role.

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

---