`discoveryEngineSearchEngine` Submodule

Constructs

DiscoveryEngineSearchEngine

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine google_discovery_engine_search_engine}.

Initializers

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

new discoveryEngineSearchEngine.DiscoveryEngineSearchEngine(scope: Construct, id: string, config: DiscoveryEngineSearchEngineConfig)

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

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".
`putCommonConfig`	No description.
`putSearchEngineConfig`	No description.
`putTimeouts`	No description.
`resetCommonConfig`	No description.
`resetId`	No description.
`resetIndustryVertical`	No description.
`resetProject`	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".

`putCommonConfig`

public putCommonConfig(value: DiscoveryEngineSearchEngineCommonConfig): void

`value`^Required

Type: DiscoveryEngineSearchEngineCommonConfig

`putSearchEngineConfig`

public putSearchEngineConfig(value: DiscoveryEngineSearchEngineSearchEngineConfig): void

`value`^Required

Type: DiscoveryEngineSearchEngineSearchEngineConfig

`putTimeouts`

public putTimeouts(value: DiscoveryEngineSearchEngineTimeouts): void

`value`^Required

Type: DiscoveryEngineSearchEngineTimeouts

`resetCommonConfig`

public resetCommonConfig(): void

`resetId`

public resetId(): void

`resetIndustryVertical`

public resetIndustryVertical(): void

`resetProject`

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

`isConstruct`

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

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

discoveryEngineSearchEngine.DiscoveryEngineSearchEngine.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

discoveryEngineSearchEngine.DiscoveryEngineSearchEngine.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

discoveryEngineSearchEngine.DiscoveryEngineSearchEngine.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`importFromId`^Required

Type: string

The id of the existing DiscoveryEngineSearchEngine that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#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 DiscoveryEngineSearchEngine 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.
`commonConfig`	`DiscoveryEngineSearchEngineCommonConfigOutputReference`	No description.
`createTime`	`string`	No description.
`name`	`string`	No description.
`searchEngineConfig`	`DiscoveryEngineSearchEngineSearchEngineConfigOutputReference`	No description.
`timeouts`	`DiscoveryEngineSearchEngineTimeoutsOutputReference`	No description.
`updateTime`	`string`	No description.
`collectionIdInput`	`string`	No description.
`commonConfigInput`	`DiscoveryEngineSearchEngineCommonConfig`	No description.
`dataStoreIdsInput`	`string[]`	No description.
`displayNameInput`	`string`	No description.
`engineIdInput`	`string`	No description.
`idInput`	`string`	No description.
`industryVerticalInput`	`string`	No description.
`locationInput`	`string`	No description.
`projectInput`	`string`	No description.
`searchEngineConfigInput`	`DiscoveryEngineSearchEngineSearchEngineConfig`	No description.
`timeoutsInput`	`cdktf.IResolvable \| DiscoveryEngineSearchEngineTimeouts`	No description.
`collectionId`	`string`	No description.
`dataStoreIds`	`string[]`	No description.
`displayName`	`string`	No description.
`engineId`	`string`	No description.
`id`	`string`	No description.
`industryVertical`	`string`	No description.
`location`	`string`	No description.
`project`	`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[]

`commonConfig`^Required

public readonly commonConfig: DiscoveryEngineSearchEngineCommonConfigOutputReference;

Type: DiscoveryEngineSearchEngineCommonConfigOutputReference

`createTime`^Required

public readonly createTime: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`searchEngineConfig`^Required

public readonly searchEngineConfig: DiscoveryEngineSearchEngineSearchEngineConfigOutputReference;

Type: DiscoveryEngineSearchEngineSearchEngineConfigOutputReference

`timeouts`^Required

public readonly timeouts: DiscoveryEngineSearchEngineTimeoutsOutputReference;

Type: DiscoveryEngineSearchEngineTimeoutsOutputReference

`updateTime`^Required

public readonly updateTime: string;

Type: string

`collectionIdInput`^Optional

public readonly collectionIdInput: string;

Type: string

`commonConfigInput`^Optional

public readonly commonConfigInput: DiscoveryEngineSearchEngineCommonConfig;

Type: DiscoveryEngineSearchEngineCommonConfig

`dataStoreIdsInput`^Optional

public readonly dataStoreIdsInput: string[];

Type: string[]

`displayNameInput`^Optional

public readonly displayNameInput: string;

Type: string

`engineIdInput`^Optional

public readonly engineIdInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`industryVerticalInput`^Optional

public readonly industryVerticalInput: string;

Type: string

`locationInput`^Optional

public readonly locationInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`searchEngineConfigInput`^Optional

public readonly searchEngineConfigInput: DiscoveryEngineSearchEngineSearchEngineConfig;

Type: DiscoveryEngineSearchEngineSearchEngineConfig

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | DiscoveryEngineSearchEngineTimeouts;

Type: cdktf.IResolvable | DiscoveryEngineSearchEngineTimeouts

`collectionId`^Required

public readonly collectionId: string;

Type: string

`dataStoreIds`^Required

public readonly dataStoreIds: string[];

Type: string[]

`displayName`^Required

public readonly displayName: string;

Type: string

`engineId`^Required

public readonly engineId: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`industryVertical`^Required

public readonly industryVertical: string;

Type: string

`location`^Required

public readonly location: string;

Type: string

`project`^Required

public readonly project: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

DiscoveryEngineSearchEngineCommonConfig

Initializer

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

const discoveryEngineSearchEngineCommonConfig: discoveryEngineSearchEngine.DiscoveryEngineSearchEngineCommonConfig = { ... }

Properties

Name	Type	Description
`companyName`	`string`	The name of the company, business or entity that is associated with the engine.

`companyName`^Optional

public readonly companyName: string;

Type: string

The name of the company, business or entity that is associated with the engine.

Setting this may help improve LLM related features.cd

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#company_name DiscoveryEngineSearchEngine#company_name}

DiscoveryEngineSearchEngineConfig

Initializer

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

const discoveryEngineSearchEngineConfig: discoveryEngineSearchEngine.DiscoveryEngineSearchEngineConfig = { ... }

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.
`collectionId`	`string`	The collection ID.
`dataStoreIds`	`string[]`	The data stores associated with this engine.
`displayName`	`string`	Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
`engineId`	`string`	Unique ID to use for Search Engine App.
`location`	`string`	Location.
`searchEngineConfig`	`DiscoveryEngineSearchEngineSearchEngineConfig`	search_engine_config block.
`commonConfig`	`DiscoveryEngineSearchEngineCommonConfig`	common_config block.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#id DiscoveryEngineSearchEngine#id}.
`industryVertical`	`string`	The industry vertical that the engine registers.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#project DiscoveryEngineSearchEngine#project}.
`timeouts`	`DiscoveryEngineSearchEngineTimeouts`	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[]

`collectionId`^Required

public readonly collectionId: string;

Type: string

The collection ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#collection_id DiscoveryEngineSearchEngine#collection_id}

`dataStoreIds`^Required

public readonly dataStoreIds: string[];

Type: string[]

The data stores associated with this engine.

For SOLUTION_TYPE_SEARCH type of engines, they can only associate with at most one data store.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#data_store_ids DiscoveryEngineSearchEngine#data_store_ids}

`displayName`^Required

public readonly displayName: string;

Type: string

Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#display_name DiscoveryEngineSearchEngine#display_name}

`engineId`^Required

public readonly engineId: string;

Type: string

Unique ID to use for Search Engine App.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#engine_id DiscoveryEngineSearchEngine#engine_id}

`location`^Required

public readonly location: string;

Type: string

Location.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#location DiscoveryEngineSearchEngine#location}

`searchEngineConfig`^Required

public readonly searchEngineConfig: DiscoveryEngineSearchEngineSearchEngineConfig;

Type: DiscoveryEngineSearchEngineSearchEngineConfig

search_engine_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#search_engine_config DiscoveryEngineSearchEngine#search_engine_config}

`commonConfig`^Optional

public readonly commonConfig: DiscoveryEngineSearchEngineCommonConfig;

Type: DiscoveryEngineSearchEngineCommonConfig

common_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#common_config DiscoveryEngineSearchEngine#common_config}

`id`^Optional

public readonly id: string;

Type: string

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

`industryVertical`^Optional

public readonly industryVertical: string;

Type: string

The industry vertical that the engine registers.

The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore liniked to the engine. Default value: "GENERIC" Possible values: ["GENERIC", "MEDIA", "HEALTHCARE_FHIR"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#industry_vertical DiscoveryEngineSearchEngine#industry_vertical}

`project`^Optional

public readonly project: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#project DiscoveryEngineSearchEngine#project}.

`timeouts`^Optional

public readonly timeouts: DiscoveryEngineSearchEngineTimeouts;

Type: DiscoveryEngineSearchEngineTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#timeouts DiscoveryEngineSearchEngine#timeouts}

DiscoveryEngineSearchEngineSearchEngineConfig

Initializer

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

const discoveryEngineSearchEngineSearchEngineConfig: discoveryEngineSearchEngine.DiscoveryEngineSearchEngineSearchEngineConfig = { ... }

Properties

Name	Type	Description
`searchAddOns`	`string[]`	The add-on that this search engine enables. Possible values: ["SEARCH_ADD_ON_LLM"].
`searchTier`	`string`	The search feature tier of this engine.

`searchAddOns`^Optional

public readonly searchAddOns: string[];

Type: string[]

The add-on that this search engine enables. Possible values: ["SEARCH_ADD_ON_LLM"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#search_add_ons DiscoveryEngineSearchEngine#search_add_ons}

`searchTier`^Optional

public readonly searchTier: string;

Type: string

The search feature tier of this engine.

Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. Default value: "SEARCH_TIER_STANDARD" Possible values: ["SEARCH_TIER_STANDARD", "SEARCH_TIER_ENTERPRISE"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#search_tier DiscoveryEngineSearchEngine#search_tier}

DiscoveryEngineSearchEngineTimeouts

Initializer

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

const discoveryEngineSearchEngineTimeouts: discoveryEngineSearchEngine.DiscoveryEngineSearchEngineTimeouts = { ... }

Properties

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

`create`^Optional

public readonly create: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#create DiscoveryEngineSearchEngine#create}.

`delete`^Optional

public readonly delete: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#delete DiscoveryEngineSearchEngine#delete}.

`update`^Optional

public readonly update: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/discovery_engine_search_engine#update DiscoveryEngineSearchEngine#update}.

Classes

DiscoveryEngineSearchEngineCommonConfigOutputReference

Initializers

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

new discoveryEngineSearchEngine.DiscoveryEngineSearchEngineCommonConfigOutputReference(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.
`resetCompanyName`	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.

`resetCompanyName`

public resetCompanyName(): 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.
`companyNameInput`	`string`	No description.
`companyName`	`string`	No description.
`internalValue`	`DiscoveryEngineSearchEngineCommonConfig`	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

`companyNameInput`^Optional

public readonly companyNameInput: string;

Type: string

`companyName`^Required

public readonly companyName: string;

Type: string

`internalValue`^Optional

public readonly internalValue: DiscoveryEngineSearchEngineCommonConfig;

Type: DiscoveryEngineSearchEngineCommonConfig

DiscoveryEngineSearchEngineSearchEngineConfigOutputReference

Initializers

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

new discoveryEngineSearchEngine.DiscoveryEngineSearchEngineSearchEngineConfigOutputReference(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.
`resetSearchAddOns`	No description.
`resetSearchTier`	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.

`resetSearchAddOns`

public resetSearchAddOns(): void

`resetSearchTier`

public resetSearchTier(): 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.
`searchAddOnsInput`	`string[]`	No description.
`searchTierInput`	`string`	No description.
`searchAddOns`	`string[]`	No description.
`searchTier`	`string`	No description.
`internalValue`	`DiscoveryEngineSearchEngineSearchEngineConfig`	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

`searchAddOnsInput`^Optional

public readonly searchAddOnsInput: string[];

Type: string[]

`searchTierInput`^Optional

public readonly searchTierInput: string;

Type: string

`searchAddOns`^Required

public readonly searchAddOns: string[];

Type: string[]

`searchTier`^Required

public readonly searchTier: string;

Type: string

`internalValue`^Optional

public readonly internalValue: DiscoveryEngineSearchEngineSearchEngineConfig;

Type: DiscoveryEngineSearchEngineSearchEngineConfig

DiscoveryEngineSearchEngineTimeoutsOutputReference

Initializers

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

new discoveryEngineSearchEngine.DiscoveryEngineSearchEngineTimeoutsOutputReference(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 \| DiscoveryEngineSearchEngineTimeouts`	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 | DiscoveryEngineSearchEngineTimeouts;

Type: cdktf.IResolvable | DiscoveryEngineSearchEngineTimeouts

Files

discoveryEngineSearchEngine.typescript.md

Latest commit

History

discoveryEngineSearchEngine.typescript.md

File metadata and controls

discoveryEngineSearchEngine Submodule

Constructs