`apihubApiHubInstance` Submodule

Constructs

ApihubApiHubInstance

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

Initializers

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

new apihubApiHubInstance.ApihubApiHubInstance(scope: Construct, id: string, config: ApihubApiHubInstanceConfig)

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

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".
`putConfig`	No description.
`putTimeouts`	No description.
`resetApiHubInstanceId`	No description.
`resetDescription`	No description.
`resetId`	No description.
`resetLabels`	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".

`putConfig`

public putConfig(value: ApihubApiHubInstanceConfigA): void

`value`^Required

Type: ApihubApiHubInstanceConfigA

`putTimeouts`

public putTimeouts(value: ApihubApiHubInstanceTimeouts): void

`value`^Required

Type: ApihubApiHubInstanceTimeouts

`resetApiHubInstanceId`

public resetApiHubInstanceId(): void

`resetDescription`

public resetDescription(): void

`resetId`

public resetId(): void

`resetLabels`

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

`isConstruct`

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

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

apihubApiHubInstance.ApihubApiHubInstance.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

apihubApiHubInstance.ApihubApiHubInstance.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

apihubApiHubInstance.ApihubApiHubInstance.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`importFromId`^Required

Type: string

The id of the existing ApihubApiHubInstance that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/apihub_api_hub_instance#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 ApihubApiHubInstance 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.
`config`	`ApihubApiHubInstanceConfigAOutputReference`	No description.
`createTime`	`string`	No description.
`effectiveLabels`	`cdktf.StringMap`	No description.
`name`	`string`	No description.
`state`	`string`	No description.
`stateMessage`	`string`	No description.
`terraformLabels`	`cdktf.StringMap`	No description.
`timeouts`	`ApihubApiHubInstanceTimeoutsOutputReference`	No description.
`updateTime`	`string`	No description.
`apiHubInstanceIdInput`	`string`	No description.
`configInput`	`ApihubApiHubInstanceConfigA`	No description.
`descriptionInput`	`string`	No description.
`idInput`	`string`	No description.
`labelsInput`	`{[ key: string ]: string}`	No description.
`locationInput`	`string`	No description.
`projectInput`	`string`	No description.
`timeoutsInput`	`cdktf.IResolvable \| ApihubApiHubInstanceTimeouts`	No description.
`apiHubInstanceId`	`string`	No description.
`description`	`string`	No description.
`id`	`string`	No description.
`labels`	`{[ key: string ]: 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[]

`config`^Required

public readonly config: ApihubApiHubInstanceConfigAOutputReference;

Type: ApihubApiHubInstanceConfigAOutputReference

`createTime`^Required

public readonly createTime: string;

Type: string

`effectiveLabels`^Required

public readonly effectiveLabels: StringMap;

Type: cdktf.StringMap

`name`^Required

public readonly name: string;

Type: string

`state`^Required

public readonly state: string;

Type: string

`stateMessage`^Required

public readonly stateMessage: string;

Type: string

`terraformLabels`^Required

public readonly terraformLabels: StringMap;

Type: cdktf.StringMap

`timeouts`^Required

public readonly timeouts: ApihubApiHubInstanceTimeoutsOutputReference;

Type: ApihubApiHubInstanceTimeoutsOutputReference

`updateTime`^Required

public readonly updateTime: string;

Type: string

`apiHubInstanceIdInput`^Optional

public readonly apiHubInstanceIdInput: string;

Type: string

`configInput`^Optional

public readonly configInput: ApihubApiHubInstanceConfigA;

Type: ApihubApiHubInstanceConfigA

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`labelsInput`^Optional

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

Type: {[ key: string ]: string}

`locationInput`^Optional

public readonly locationInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | ApihubApiHubInstanceTimeouts;

Type: cdktf.IResolvable | ApihubApiHubInstanceTimeouts

`apiHubInstanceId`^Required

public readonly apiHubInstanceId: string;

Type: string

`description`^Required

public readonly description: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`labels`^Required

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

Type: {[ key: string ]: 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

ApihubApiHubInstanceConfig

Initializer

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

const apihubApiHubInstanceConfig: apihubApiHubInstance.ApihubApiHubInstanceConfig = { ... }

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.
`config`	`ApihubApiHubInstanceConfigA`	config block.
`location`	`string`	Resource ID segment making up resource 'name'. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
`apiHubInstanceId`	`string`	Optional.
`description`	`string`	Optional. Description of the ApiHub instance.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/apihub_api_hub_instance#id ApihubApiHubInstance#id}.
`labels`	`{[ key: string ]: string}`	Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/apihub_api_hub_instance#project ApihubApiHubInstance#project}.
`timeouts`	`ApihubApiHubInstanceTimeouts`	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[]

`config`^Required

public readonly config: ApihubApiHubInstanceConfigA;

Type: ApihubApiHubInstanceConfigA

config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/apihub_api_hub_instance#config ApihubApiHubInstance#config}

`location`^Required

public readonly location: string;

Type: string

Resource ID segment making up resource 'name'. It identifies the resource within its parent collection as described in https://google.aip.dev/122.

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

`apiHubInstanceId`^Optional

public readonly apiHubInstanceId: string;

Type: string

Optional.

Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field is not provided, system generated id will be used.

This value should be 4-40 characters, and valid characters are '/a-z[0-9]-_/'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/apihub_api_hub_instance#api_hub_instance_id ApihubApiHubInstance#api_hub_instance_id}

`description`^Optional

public readonly description: string;

Type: string

Optional. Description of the ApiHub instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/apihub_api_hub_instance#description ApihubApiHubInstance#description}

`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/apihub_api_hub_instance#id ApihubApiHubInstance#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}

Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources.

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.32.0/docs/resources/apihub_api_hub_instance#labels ApihubApiHubInstance#labels}

`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/apihub_api_hub_instance#project ApihubApiHubInstance#project}.

`timeouts`^Optional

public readonly timeouts: ApihubApiHubInstanceTimeouts;

Type: ApihubApiHubInstanceTimeouts

timeouts block.

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

ApihubApiHubInstanceConfigA

Initializer

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

const apihubApiHubInstanceConfigA: apihubApiHubInstance.ApihubApiHubInstanceConfigA = { ... }

Properties

Name	Type	Description
`cmekKeyName`	`string`	Optional.
`disableSearch`	`boolean \| cdktf.IResolvable`	Optional. If true, the search will be disabled for the instance. The default value is false.
`encryptionType`	`string`	Optional.
`vertexLocation`	`string`	Optional. The name of the Vertex AI location where the data store is stored.

`cmekKeyName`^Optional

public readonly cmekKeyName: string;

Type: string

Optional.

The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of 'projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)', where the location must match the instance location. If the CMEK is not provided, a GMEK will be created for the instance.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/apihub_api_hub_instance#cmek_key_name ApihubApiHubInstance#cmek_key_name}

`disableSearch`^Optional

public readonly disableSearch: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Optional. If true, the search will be disabled for the instance. The default value is false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/apihub_api_hub_instance#disable_search ApihubApiHubInstance#disable_search}

`encryptionType`^Optional

public readonly encryptionType: string;

Type: string

Optional.

Encryption type for the region. If the encryption type is CMEK, the cmek_key_name must be provided. If no encryption type is provided, GMEK will be used. Possible values: ENCRYPTION_TYPE_UNSPECIFIED GMEK CMEK

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/apihub_api_hub_instance#encryption_type ApihubApiHubInstance#encryption_type}

`vertexLocation`^Optional

public readonly vertexLocation: string;

Type: string

Optional. The name of the Vertex AI location where the data store is stored.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/apihub_api_hub_instance#vertex_location ApihubApiHubInstance#vertex_location}

ApihubApiHubInstanceTimeouts

Initializer

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

const apihubApiHubInstanceTimeouts: apihubApiHubInstance.ApihubApiHubInstanceTimeouts = { ... }

Properties

Name	Type	Description
`create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/apihub_api_hub_instance#create ApihubApiHubInstance#create}.
`delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/apihub_api_hub_instance#delete ApihubApiHubInstance#delete}.
`update`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/apihub_api_hub_instance#update ApihubApiHubInstance#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/apihub_api_hub_instance#create ApihubApiHubInstance#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/apihub_api_hub_instance#delete ApihubApiHubInstance#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/apihub_api_hub_instance#update ApihubApiHubInstance#update}.

Classes

ApihubApiHubInstanceConfigAOutputReference

Initializers

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

new apihubApiHubInstance.ApihubApiHubInstanceConfigAOutputReference(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.
`resetCmekKeyName`	No description.
`resetDisableSearch`	No description.
`resetEncryptionType`	No description.
`resetVertexLocation`	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.

`resetCmekKeyName`

public resetCmekKeyName(): void

`resetDisableSearch`

public resetDisableSearch(): void

`resetEncryptionType`

public resetEncryptionType(): void

`resetVertexLocation`

public resetVertexLocation(): 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.
`cmekKeyNameInput`	`string`	No description.
`disableSearchInput`	`boolean \| cdktf.IResolvable`	No description.
`encryptionTypeInput`	`string`	No description.
`vertexLocationInput`	`string`	No description.
`cmekKeyName`	`string`	No description.
`disableSearch`	`boolean \| cdktf.IResolvable`	No description.
`encryptionType`	`string`	No description.
`vertexLocation`	`string`	No description.
`internalValue`	`ApihubApiHubInstanceConfigA`	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

`cmekKeyNameInput`^Optional

public readonly cmekKeyNameInput: string;

Type: string

`disableSearchInput`^Optional

public readonly disableSearchInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`encryptionTypeInput`^Optional

public readonly encryptionTypeInput: string;

Type: string

`vertexLocationInput`^Optional

public readonly vertexLocationInput: string;

Type: string

`cmekKeyName`^Required

public readonly cmekKeyName: string;

Type: string

`disableSearch`^Required

public readonly disableSearch: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`encryptionType`^Required

public readonly encryptionType: string;

Type: string

`vertexLocation`^Required

public readonly vertexLocation: string;

Type: string

`internalValue`^Optional

public readonly internalValue: ApihubApiHubInstanceConfigA;

Type: ApihubApiHubInstanceConfigA

ApihubApiHubInstanceTimeoutsOutputReference

Initializers

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

new apihubApiHubInstance.ApihubApiHubInstanceTimeoutsOutputReference(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 \| ApihubApiHubInstanceTimeouts`	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 | ApihubApiHubInstanceTimeouts;

Type: cdktf.IResolvable | ApihubApiHubInstanceTimeouts

Files

apihubApiHubInstance.typescript.md

Latest commit

History

apihubApiHubInstance.typescript.md

File metadata and controls

apihubApiHubInstance Submodule

Constructs