dataVaultIdentityGroup.typescript.md

dataVaultIdentityGroup Submodule

Constructs

DataVaultIdentityGroup

Represents a {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/identity_group vault_identity_group}.

Initializers

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

new dataVaultIdentityGroup.DataVaultIdentityGroup(scope: Construct, id: string, config?: DataVaultIdentityGroupConfig)

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

---

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	Adds this resource to the terraform JSON output.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
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.
interpolationForAttribute	No description.
resetAliasId	No description.
resetAliasMountAccessor	No description.
resetAliasName	No description.
resetGroupId	No description.
resetGroupName	No description.
resetId	No description.
resetNamespace	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

Adds this resource to the terraform JSON output.

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

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

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

resetAliasId

public resetAliasId(): void

resetAliasMountAccessor

public resetAliasMountAccessor(): void

resetAliasName

public resetAliasName(): void

resetGroupId

public resetGroupId(): void

resetGroupName

public resetGroupName(): void

resetId

public resetId(): void

resetNamespace

public resetNamespace(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformDataSource	No description.
generateConfigForImport	Generates CDKTF code for importing a DataVaultIdentityGroup resource upon running "cdktf plan ".

---

isConstruct

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

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

dataVaultIdentityGroup.DataVaultIdentityGroup.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

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

dataVaultIdentityGroup.DataVaultIdentityGroup.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

dataVaultIdentityGroup.DataVaultIdentityGroup.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing DataVaultIdentityGroup that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/identity_group#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 DataVaultIdentityGroup 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.
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.
aliasCanonicalId	string	No description.
aliasCreationTime	string	No description.
aliasLastUpdateTime	string	No description.
aliasMergedFromCanonicalIds	string[]	No description.
aliasMetadata	cdktf.StringMap	No description.
aliasMountPath	string	No description.
aliasMountType	string	No description.
creationTime	string	No description.
dataJson	string	No description.
lastUpdateTime	string	No description.
memberEntityIds	string[]	No description.
memberGroupIds	string[]	No description.
metadata	cdktf.StringMap	No description.
modifyIndex	number	No description.
namespaceId	string	No description.
parentGroupIds	string[]	No description.
policies	string[]	No description.
type	string	No description.
aliasIdInput	string	No description.
aliasMountAccessorInput	string	No description.
aliasNameInput	string	No description.
groupIdInput	string	No description.
groupNameInput	string	No description.
idInput	string	No description.
namespaceInput	string	No description.
aliasId	string	No description.
aliasMountAccessor	string	No description.
aliasName	string	No description.
groupId	string	No description.
groupName	string	No description.
id	string	No description.
namespace	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

---

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

---

aliasCanonicalId^Required

public readonly aliasCanonicalId: string;

• Type: string

---

aliasCreationTime^Required

public readonly aliasCreationTime: string;

• Type: string

---

aliasLastUpdateTime^Required

public readonly aliasLastUpdateTime: string;

• Type: string

---

aliasMergedFromCanonicalIds^Required

public readonly aliasMergedFromCanonicalIds: string[];

• Type: string[]

---

aliasMetadata^Required

public readonly aliasMetadata: StringMap;

• Type: cdktf.StringMap

---

aliasMountPath^Required

public readonly aliasMountPath: string;

• Type: string

---

aliasMountType^Required

public readonly aliasMountType: string;

• Type: string

---

creationTime^Required

public readonly creationTime: string;

• Type: string

---

dataJson^Required

public readonly dataJson: string;

• Type: string

---

lastUpdateTime^Required

public readonly lastUpdateTime: string;

• Type: string

---

memberEntityIds^Required

public readonly memberEntityIds: string[];

• Type: string[]

---

memberGroupIds^Required

public readonly memberGroupIds: string[];

• Type: string[]

---

metadata^Required

public readonly metadata: StringMap;

• Type: cdktf.StringMap

---

modifyIndex^Required

public readonly modifyIndex: number;

• Type: number

---

namespaceId^Required

public readonly namespaceId: string;

• Type: string

---

parentGroupIds^Required

public readonly parentGroupIds: string[];

• Type: string[]

---

policies^Required

public readonly policies: string[];

• Type: string[]

---

type^Required

public readonly type: string;

• Type: string

---

aliasIdInput^Optional

public readonly aliasIdInput: string;

• Type: string

---

aliasMountAccessorInput^Optional

public readonly aliasMountAccessorInput: string;

• Type: string

---

aliasNameInput^Optional

public readonly aliasNameInput: string;

• Type: string

---

groupIdInput^Optional

public readonly groupIdInput: string;

• Type: string

---

groupNameInput^Optional

public readonly groupNameInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

namespaceInput^Optional

public readonly namespaceInput: string;

• Type: string

---

aliasId^Required

public readonly aliasId: string;

• Type: string

---

aliasMountAccessor^Required

public readonly aliasMountAccessor: string;

• Type: string

---

aliasName^Required

public readonly aliasName: string;

• Type: string

---

groupId^Required

public readonly groupId: string;

• Type: string

---

groupName^Required

public readonly groupName: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

namespace^Required

public readonly namespace: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataVaultIdentityGroupConfig

Initializer

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

const dataVaultIdentityGroupConfig: dataVaultIdentityGroup.DataVaultIdentityGroupConfig = { ... }

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.
aliasId	string	ID of the alias.
aliasMountAccessor	string	Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with alias_name.
aliasName	string	Name of the alias. This should be supplied in conjunction with alias_mount_accessor.
groupId	string	ID of the group.
groupName	string	Name of the group.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/identity_group#id DataVaultIdentityGroup#id}.
namespace	string	Target namespace. (requires Enterprise).

---

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

---

aliasId^Optional

public readonly aliasId: string;

• Type: string

ID of the alias.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/identity_group#alias_id DataVaultIdentityGroup#alias_id}

---

aliasMountAccessor^Optional

public readonly aliasMountAccessor: string;

• Type: string

Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with alias_name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/identity_group#alias_mount_accessor DataVaultIdentityGroup#alias_mount_accessor}

---

aliasName^Optional

public readonly aliasName: string;

• Type: string

Name of the alias. This should be supplied in conjunction with alias_mount_accessor.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/identity_group#alias_name DataVaultIdentityGroup#alias_name}

---

groupId^Optional

public readonly groupId: string;

• Type: string

ID of the group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/identity_group#group_id DataVaultIdentityGroup#group_id}

---

groupName^Optional

public readonly groupName: string;

• Type: string

Name of the group.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/identity_group#group_name DataVaultIdentityGroup#group_name}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/vault/4.2.0/docs/data-sources/identity_group#id DataVaultIdentityGroup#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.

---

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/data-sources/identity_group#namespace DataVaultIdentityGroup#namespace}

---