`googleDiscoveryEngineSchema` Submodule

Constructs

GoogleDiscoveryEngineSchema

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_discovery_engine_schema google_discovery_engine_schema}.

Initializers

import { googleDiscoveryEngineSchema } from '@cdktf/provider-google-beta'

new googleDiscoveryEngineSchema.GoogleDiscoveryEngineSchema(scope: Construct, id: string, config: GoogleDiscoveryEngineSchemaConfig)

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

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".
`putTimeouts`	No description.
`resetId`	No description.
`resetJsonSchema`	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".

`putTimeouts`

public putTimeouts(value: GoogleDiscoveryEngineSchemaTimeouts): void

`value`^Required

Type: GoogleDiscoveryEngineSchemaTimeouts

`resetId`

public resetId(): void

`resetJsonSchema`

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

`isConstruct`

import { googleDiscoveryEngineSchema } from '@cdktf/provider-google-beta'

googleDiscoveryEngineSchema.GoogleDiscoveryEngineSchema.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 { googleDiscoveryEngineSchema } from '@cdktf/provider-google-beta'

googleDiscoveryEngineSchema.GoogleDiscoveryEngineSchema.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { googleDiscoveryEngineSchema } from '@cdktf/provider-google-beta'

googleDiscoveryEngineSchema.GoogleDiscoveryEngineSchema.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { googleDiscoveryEngineSchema } from '@cdktf/provider-google-beta'

googleDiscoveryEngineSchema.GoogleDiscoveryEngineSchema.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`importFromId`^Required

Type: string

The id of the existing GoogleDiscoveryEngineSchema that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_discovery_engine_schema#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 GoogleDiscoveryEngineSchema 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.
`name`	`string`	No description.
`timeouts`	`GoogleDiscoveryEngineSchemaTimeoutsOutputReference`	No description.
`dataStoreIdInput`	`string`	No description.
`idInput`	`string`	No description.
`jsonSchemaInput`	`string`	No description.
`locationInput`	`string`	No description.
`projectInput`	`string`	No description.
`schemaIdInput`	`string`	No description.
`timeoutsInput`	`cdktf.IResolvable \| GoogleDiscoveryEngineSchemaTimeouts`	No description.
`dataStoreId`	`string`	No description.
`id`	`string`	No description.
`jsonSchema`	`string`	No description.
`location`	`string`	No description.
`project`	`string`	No description.
`schemaId`	`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[]

`name`^Required

public readonly name: string;

Type: string

`timeouts`^Required

public readonly timeouts: GoogleDiscoveryEngineSchemaTimeoutsOutputReference;

Type: GoogleDiscoveryEngineSchemaTimeoutsOutputReference

`dataStoreIdInput`^Optional

public readonly dataStoreIdInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`jsonSchemaInput`^Optional

public readonly jsonSchemaInput: string;

Type: string

`locationInput`^Optional

public readonly locationInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`schemaIdInput`^Optional

public readonly schemaIdInput: string;

Type: string

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | GoogleDiscoveryEngineSchemaTimeouts;

Type: cdktf.IResolvable | GoogleDiscoveryEngineSchemaTimeouts

`dataStoreId`^Required

public readonly dataStoreId: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`jsonSchema`^Required

public readonly jsonSchema: string;

Type: string

`location`^Required

public readonly location: string;

Type: string

`project`^Required

public readonly project: string;

Type: string

`schemaId`^Required

public readonly schemaId: string;

Type: string

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

GoogleDiscoveryEngineSchemaConfig

Initializer

import { googleDiscoveryEngineSchema } from '@cdktf/provider-google-beta'

const googleDiscoveryEngineSchemaConfig: googleDiscoveryEngineSchema.GoogleDiscoveryEngineSchemaConfig = { ... }

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.
`dataStoreId`	`string`	The unique id of the data store.
`location`	`string`	The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
`schemaId`	`string`	The unique id of the schema.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_discovery_engine_schema#id GoogleDiscoveryEngineSchema#id}.
`jsonSchema`	`string`	The JSON representation of the schema.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_discovery_engine_schema#project GoogleDiscoveryEngineSchema#project}.
`timeouts`	`GoogleDiscoveryEngineSchemaTimeouts`	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[]

`dataStoreId`^Required

public readonly dataStoreId: string;

Type: string

The unique id of the data store.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_discovery_engine_schema#data_store_id GoogleDiscoveryEngineSchema#data_store_id}

`location`^Required

public readonly location: string;

Type: string

The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_discovery_engine_schema#location GoogleDiscoveryEngineSchema#location}

`schemaId`^Required

public readonly schemaId: string;

Type: string

The unique id of the schema.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_discovery_engine_schema#schema_id GoogleDiscoveryEngineSchema#schema_id}

`id`^Optional

public readonly id: string;

Type: string

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

`jsonSchema`^Optional

public readonly jsonSchema: string;

Type: string

The JSON representation of the schema.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_discovery_engine_schema#json_schema GoogleDiscoveryEngineSchema#json_schema}

`project`^Optional

public readonly project: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_discovery_engine_schema#project GoogleDiscoveryEngineSchema#project}.

`timeouts`^Optional

public readonly timeouts: GoogleDiscoveryEngineSchemaTimeouts;

Type: GoogleDiscoveryEngineSchemaTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_discovery_engine_schema#timeouts GoogleDiscoveryEngineSchema#timeouts}

GoogleDiscoveryEngineSchemaTimeouts

Initializer

import { googleDiscoveryEngineSchema } from '@cdktf/provider-google-beta'

const googleDiscoveryEngineSchemaTimeouts: googleDiscoveryEngineSchema.GoogleDiscoveryEngineSchemaTimeouts = { ... }

Properties

Name	Type	Description
`create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_discovery_engine_schema#create GoogleDiscoveryEngineSchema#create}.
`delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_discovery_engine_schema#delete GoogleDiscoveryEngineSchema#delete}.

`create`^Optional

public readonly create: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_discovery_engine_schema#create GoogleDiscoveryEngineSchema#create}.

`delete`^Optional

public readonly delete: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.17.0/docs/resources/google_discovery_engine_schema#delete GoogleDiscoveryEngineSchema#delete}.

Classes

GoogleDiscoveryEngineSchemaTimeoutsOutputReference

Initializers

import { googleDiscoveryEngineSchema } from '@cdktf/provider-google-beta'

new googleDiscoveryEngineSchema.GoogleDiscoveryEngineSchemaTimeoutsOutputReference(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.

`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

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.
`create`	`string`	No description.
`delete`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleDiscoveryEngineSchemaTimeouts`	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

`create`^Required

public readonly create: string;

Type: string

`delete`^Required

public readonly delete: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleDiscoveryEngineSchemaTimeouts;

Type: cdktf.IResolvable | GoogleDiscoveryEngineSchemaTimeouts

Files

googleDiscoveryEngineSchema.typescript.md

Latest commit

History

googleDiscoveryEngineSchema.typescript.md

File metadata and controls

googleDiscoveryEngineSchema Submodule

Constructs