vertexAiIndexEndpoint.typescript.md

vertexAiIndexEndpoint Submodule

Constructs

VertexAiIndexEndpoint

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint google_vertex_ai_index_endpoint}.

Initializers

import { vertexAiIndexEndpoint } from '@cdktf/provider-google'

new vertexAiIndexEndpoint.VertexAiIndexEndpoint(scope: Construct, id: string, config: VertexAiIndexEndpointConfig)

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

---

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".
putPrivateServiceConnectConfig	No description.
putTimeouts	No description.
resetDescription	No description.
resetId	No description.
resetLabels	No description.
resetNetwork	No description.
resetPrivateServiceConnectConfig	No description.
resetProject	No description.
resetPublicEndpointEnabled	No description.
resetRegion	No description.
resetTimeouts	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".

---

putPrivateServiceConnectConfig

public putPrivateServiceConnectConfig(value: VertexAiIndexEndpointPrivateServiceConnectConfig): void

value^Required

• Type: VertexAiIndexEndpointPrivateServiceConnectConfig

---

putTimeouts

public putTimeouts(value: VertexAiIndexEndpointTimeouts): void

value^Required

• Type: VertexAiIndexEndpointTimeouts

---

resetDescription

public resetDescription(): void

resetId

public resetId(): void

resetLabels

public resetLabels(): void

resetNetwork

public resetNetwork(): void

resetPrivateServiceConnectConfig

public resetPrivateServiceConnectConfig(): void

resetProject

public resetProject(): void

resetPublicEndpointEnabled

public resetPublicEndpointEnabled(): void

resetRegion

public resetRegion(): void

resetTimeouts

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

---

isConstruct

import { vertexAiIndexEndpoint } from '@cdktf/provider-google'

vertexAiIndexEndpoint.VertexAiIndexEndpoint.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 { vertexAiIndexEndpoint } from '@cdktf/provider-google'

vertexAiIndexEndpoint.VertexAiIndexEndpoint.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { vertexAiIndexEndpoint } from '@cdktf/provider-google'

vertexAiIndexEndpoint.VertexAiIndexEndpoint.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { vertexAiIndexEndpoint } from '@cdktf/provider-google'

vertexAiIndexEndpoint.VertexAiIndexEndpoint.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing VertexAiIndexEndpoint that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#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 VertexAiIndexEndpoint 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.
createTime	string	No description.
effectiveLabels	cdktf.StringMap	No description.
etag	string	No description.
name	string	No description.
privateServiceConnectConfig	VertexAiIndexEndpointPrivateServiceConnectConfigOutputReference	No description.
publicEndpointDomainName	string	No description.
terraformLabels	cdktf.StringMap	No description.
timeouts	VertexAiIndexEndpointTimeoutsOutputReference	No description.
updateTime	string	No description.
descriptionInput	string	No description.
displayNameInput	string	No description.
idInput	string	No description.
labelsInput	{[ key: string ]: string}	No description.
networkInput	string	No description.
privateServiceConnectConfigInput	VertexAiIndexEndpointPrivateServiceConnectConfig	No description.
projectInput	string	No description.
publicEndpointEnabledInput	boolean | cdktf.IResolvable	No description.
regionInput	string	No description.
timeoutsInput	cdktf.IResolvable | VertexAiIndexEndpointTimeouts	No description.
description	string	No description.
displayName	string	No description.
id	string	No description.
labels	{[ key: string ]: string}	No description.
network	string	No description.
project	string	No description.
publicEndpointEnabled	boolean | cdktf.IResolvable	No description.
region	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[]

---

createTime^Required

public readonly createTime: string;

• Type: string

---

effectiveLabels^Required

public readonly effectiveLabels: StringMap;

• Type: cdktf.StringMap

---

etag^Required

public readonly etag: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

privateServiceConnectConfig^Required

public readonly privateServiceConnectConfig: VertexAiIndexEndpointPrivateServiceConnectConfigOutputReference;

• Type: VertexAiIndexEndpointPrivateServiceConnectConfigOutputReference

---

publicEndpointDomainName^Required

public readonly publicEndpointDomainName: string;

• Type: string

---

terraformLabels^Required

public readonly terraformLabels: StringMap;

• Type: cdktf.StringMap

---

timeouts^Required

public readonly timeouts: VertexAiIndexEndpointTimeoutsOutputReference;

• Type: VertexAiIndexEndpointTimeoutsOutputReference

---

updateTime^Required

public readonly updateTime: string;

• Type: string

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

displayNameInput^Optional

public readonly displayNameInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

labelsInput^Optional

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

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

---

networkInput^Optional

public readonly networkInput: string;

• Type: string

---

privateServiceConnectConfigInput^Optional

public readonly privateServiceConnectConfigInput: VertexAiIndexEndpointPrivateServiceConnectConfig;

• Type: VertexAiIndexEndpointPrivateServiceConnectConfig

---

projectInput^Optional

public readonly projectInput: string;

• Type: string

---

publicEndpointEnabledInput^Optional

public readonly publicEndpointEnabledInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

regionInput^Optional

public readonly regionInput: string;

• Type: string

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | VertexAiIndexEndpointTimeouts;

• Type: cdktf.IResolvable | VertexAiIndexEndpointTimeouts

---

description^Required

public readonly description: string;

• Type: string

---

displayName^Required

public readonly displayName: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

labels^Required

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

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

---

network^Required

public readonly network: string;

• Type: string

---

project^Required

public readonly project: string;

• Type: string

---

publicEndpointEnabled^Required

public readonly publicEndpointEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

region^Required

public readonly region: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

VertexAiIndexEndpointConfig

Initializer

import { vertexAiIndexEndpoint } from '@cdktf/provider-google'

const vertexAiIndexEndpointConfig: vertexAiIndexEndpoint.VertexAiIndexEndpointConfig = { ... }

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 Index.
description	string	The description of the Index.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#id VertexAiIndexEndpoint#id}.
labels	{[ key: string ]: string}	The labels with user-defined metadata to organize your Indexes.
network	string	The full name of the Google Compute Engine network to which the index endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network. Format: 'projects/{project}/global/networks/{network}'. Where '{project}' is a project number, as in '12345', and '{network}' is network name.
privateServiceConnectConfig	VertexAiIndexEndpointPrivateServiceConnectConfig	private_service_connect_config block.
project	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#project VertexAiIndexEndpoint#project}.
publicEndpointEnabled	boolean | cdktf.IResolvable	If true, the deployed index will be accessible through public endpoint.
region	string	The region of the index endpoint. eg us-central1.
timeouts	VertexAiIndexEndpointTimeouts	timeouts block.

---

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^Required

public readonly displayName: string;

• Type: string

The display name of the Index.

The name can be up to 128 characters long and can consist of any UTF-8 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#display_name VertexAiIndexEndpoint#display_name}

---

description^Optional

public readonly description: string;

• Type: string

The description of the Index.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#description VertexAiIndexEndpoint#description}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#id VertexAiIndexEndpoint#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.

---

labels^Optional

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

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

The labels with user-defined metadata to organize your Indexes.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#labels VertexAiIndexEndpoint#labels}

---

network^Optional

public readonly network: string;

• Type: string

The full name of the Google Compute Engine network to which the index endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network. Format: 'projects/{project}/global/networks/{network}'. Where '{project}' is a project number, as in '12345', and '{network}' is network name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#network VertexAiIndexEndpoint#network}

---

privateServiceConnectConfig^Optional

public readonly privateServiceConnectConfig: VertexAiIndexEndpointPrivateServiceConnectConfig;

• Type: VertexAiIndexEndpointPrivateServiceConnectConfig

private_service_connect_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#private_service_connect_config VertexAiIndexEndpoint#private_service_connect_config}

---

project^Optional

public readonly project: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#project VertexAiIndexEndpoint#project}.

---

publicEndpointEnabled^Optional

public readonly publicEndpointEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

If true, the deployed index will be accessible through public endpoint.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#public_endpoint_enabled VertexAiIndexEndpoint#public_endpoint_enabled}

---

region^Optional

public readonly region: string;

• Type: string

The region of the index endpoint. eg us-central1.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#region VertexAiIndexEndpoint#region}

---

timeouts^Optional

public readonly timeouts: VertexAiIndexEndpointTimeouts;

• Type: VertexAiIndexEndpointTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#timeouts VertexAiIndexEndpoint#timeouts}

---

VertexAiIndexEndpointPrivateServiceConnectConfig

Initializer

import { vertexAiIndexEndpoint } from '@cdktf/provider-google'

const vertexAiIndexEndpointPrivateServiceConnectConfig: vertexAiIndexEndpoint.VertexAiIndexEndpointPrivateServiceConnectConfig = { ... }

Properties

Name	Type	Description
enablePrivateServiceConnect	boolean | cdktf.IResolvable	If set to true, the IndexEndpoint is created without private service access.
projectAllowlist	string[]	A list of Projects from which the forwarding rule will target the service attachment.

---

enablePrivateServiceConnect^Required

public readonly enablePrivateServiceConnect: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

If set to true, the IndexEndpoint is created without private service access.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#enable_private_service_connect VertexAiIndexEndpoint#enable_private_service_connect}

---

projectAllowlist^Optional

public readonly projectAllowlist: string[];

• Type: string[]

A list of Projects from which the forwarding rule will target the service attachment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#project_allowlist VertexAiIndexEndpoint#project_allowlist}

---

VertexAiIndexEndpointTimeouts

Initializer

import { vertexAiIndexEndpoint } from '@cdktf/provider-google'

const vertexAiIndexEndpointTimeouts: vertexAiIndexEndpoint.VertexAiIndexEndpointTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#create VertexAiIndexEndpoint#create}.
delete	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#delete VertexAiIndexEndpoint#delete}.
update	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#update VertexAiIndexEndpoint#update}.

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#create VertexAiIndexEndpoint#create}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#delete VertexAiIndexEndpoint#delete}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/vertex_ai_index_endpoint#update VertexAiIndexEndpoint#update}.

---

Classes

VertexAiIndexEndpointPrivateServiceConnectConfigOutputReference

Initializers

import { vertexAiIndexEndpoint } from '@cdktf/provider-google'

new vertexAiIndexEndpoint.VertexAiIndexEndpointPrivateServiceConnectConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
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.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetProjectAllowlist	No description.

---

computeFqn

public computeFqn(): string

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(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetProjectAllowlist

public resetProjectAllowlist(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
enablePrivateServiceConnectInput	boolean | cdktf.IResolvable	No description.
projectAllowlistInput	string[]	No description.
enablePrivateServiceConnect	boolean | cdktf.IResolvable	No description.
projectAllowlist	string[]	No description.
internalValue	VertexAiIndexEndpointPrivateServiceConnectConfig	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

enablePrivateServiceConnectInput^Optional

public readonly enablePrivateServiceConnectInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

projectAllowlistInput^Optional

public readonly projectAllowlistInput: string[];

• Type: string[]

---

enablePrivateServiceConnect^Required

public readonly enablePrivateServiceConnect: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

projectAllowlist^Required

public readonly projectAllowlist: string[];

• Type: string[]

---

internalValue^Optional

public readonly internalValue: VertexAiIndexEndpointPrivateServiceConnectConfig;

• Type: VertexAiIndexEndpointPrivateServiceConnectConfig

---

VertexAiIndexEndpointTimeoutsOutputReference

Initializers

import { vertexAiIndexEndpoint } from '@cdktf/provider-google'

new vertexAiIndexEndpoint.VertexAiIndexEndpointTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
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.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetCreate	No description.
resetDelete	No description.
resetUpdate	No description.

---

computeFqn

public computeFqn(): string

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(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate

public resetCreate(): void

resetDelete

public resetDelete(): void

resetUpdate

public resetUpdate(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
createInput	string	No description.
deleteInput	string	No description.
updateInput	string	No description.
create	string	No description.
delete	string	No description.
update	string	No description.
internalValue	cdktf.IResolvable | VertexAiIndexEndpointTimeouts	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

createInput^Optional

public readonly createInput: string;

• Type: string

---

deleteInput^Optional

public readonly deleteInput: string;

• Type: string

---

updateInput^Optional

public readonly updateInput: string;

• Type: string

---

create^Required

public readonly create: string;

• Type: string

---

delete^Required

public readonly delete: string;

• Type: string

---

update^Required

public readonly update: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | VertexAiIndexEndpointTimeouts;

• Type: cdktf.IResolvable | VertexAiIndexEndpointTimeouts

---