`dataprocMetastoreFederation` Submodule

Constructs

DataprocMetastoreFederation

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

Initializers

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

new dataprocMetastoreFederation.DataprocMetastoreFederation(scope: Construct, id: string, config: DataprocMetastoreFederationConfig)

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

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".
`putBackendMetastores`	No description.
`putTimeouts`	No description.
`resetId`	No description.
`resetLabels`	No description.
`resetLocation`	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".

`putBackendMetastores`

public putBackendMetastores(value: IResolvable | DataprocMetastoreFederationBackendMetastores[]): void

`value`^Required

Type: cdktf.IResolvable | DataprocMetastoreFederationBackendMetastores[]

`putTimeouts`

public putTimeouts(value: DataprocMetastoreFederationTimeouts): void

`value`^Required

Type: DataprocMetastoreFederationTimeouts

`resetId`

public resetId(): void

`resetLabels`

public resetLabels(): void

`resetLocation`

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

`isConstruct`

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

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

dataprocMetastoreFederation.DataprocMetastoreFederation.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

dataprocMetastoreFederation.DataprocMetastoreFederation.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

dataprocMetastoreFederation.DataprocMetastoreFederation.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`importFromId`^Required

Type: string

The id of the existing DataprocMetastoreFederation that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/dataproc_metastore_federation#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 DataprocMetastoreFederation 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.
`backendMetastores`	`DataprocMetastoreFederationBackendMetastoresList`	No description.
`effectiveLabels`	`cdktf.StringMap`	No description.
`endpointUri`	`string`	No description.
`name`	`string`	No description.
`state`	`string`	No description.
`stateMessage`	`string`	No description.
`terraformLabels`	`cdktf.StringMap`	No description.
`timeouts`	`DataprocMetastoreFederationTimeoutsOutputReference`	No description.
`uid`	`string`	No description.
`backendMetastoresInput`	`cdktf.IResolvable \| DataprocMetastoreFederationBackendMetastores[]`	No description.
`federationIdInput`	`string`	No description.
`idInput`	`string`	No description.
`labelsInput`	`{[ key: string ]: string}`	No description.
`locationInput`	`string`	No description.
`projectInput`	`string`	No description.
`timeoutsInput`	`cdktf.IResolvable \| DataprocMetastoreFederationTimeouts`	No description.
`versionInput`	`string`	No description.
`federationId`	`string`	No description.
`id`	`string`	No description.
`labels`	`{[ key: string ]: string}`	No description.
`location`	`string`	No description.
`project`	`string`	No description.
`version`	`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[]

`backendMetastores`^Required

public readonly backendMetastores: DataprocMetastoreFederationBackendMetastoresList;

Type: DataprocMetastoreFederationBackendMetastoresList

`effectiveLabels`^Required

public readonly effectiveLabels: StringMap;

Type: cdktf.StringMap

`endpointUri`^Required

public readonly endpointUri: string;

Type: string

`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: DataprocMetastoreFederationTimeoutsOutputReference;

Type: DataprocMetastoreFederationTimeoutsOutputReference

`uid`^Required

public readonly uid: string;

Type: string

`backendMetastoresInput`^Optional

public readonly backendMetastoresInput: IResolvable | DataprocMetastoreFederationBackendMetastores[];

Type: cdktf.IResolvable | DataprocMetastoreFederationBackendMetastores[]

`federationIdInput`^Optional

public readonly federationIdInput: 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 | DataprocMetastoreFederationTimeouts;

Type: cdktf.IResolvable | DataprocMetastoreFederationTimeouts

`versionInput`^Optional

public readonly versionInput: string;

Type: string

`federationId`^Required

public readonly federationId: 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

`version`^Required

public readonly version: string;

Type: string

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

DataprocMetastoreFederationBackendMetastores

Initializer

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

const dataprocMetastoreFederationBackendMetastores: dataprocMetastoreFederation.DataprocMetastoreFederationBackendMetastores = { ... }

Properties

Name	Type	Description
`metastoreType`	`string`	The type of the backend metastore. Possible values: ["METASTORE_TYPE_UNSPECIFIED", "DATAPROC_METASTORE", "BIGQUERY"].
`name`	`string`	The relative resource name of the metastore that is being federated.
`rank`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/dataproc_metastore_federation#rank DataprocMetastoreFederation#rank}.

`metastoreType`^Required

public readonly metastoreType: string;

Type: string

The type of the backend metastore. Possible values: ["METASTORE_TYPE_UNSPECIFIED", "DATAPROC_METASTORE", "BIGQUERY"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/dataproc_metastore_federation#metastore_type DataprocMetastoreFederation#metastore_type}

`name`^Required

public readonly name: string;

Type: string

The relative resource name of the metastore that is being federated.

The formats of the relative resource names for the currently supported metastores are listed below: Dataplex: projects/{projectId}/locations/{location}/lakes/{lake_id} BigQuery: projects/{projectId} Dataproc Metastore: projects/{projectId}/locations/{location}/services/{serviceId}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/dataproc_metastore_federation#name DataprocMetastoreFederation#name}

`rank`^Required

public readonly rank: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/dataproc_metastore_federation#rank DataprocMetastoreFederation#rank}.

DataprocMetastoreFederationConfig

Initializer

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

const dataprocMetastoreFederationConfig: dataprocMetastoreFederation.DataprocMetastoreFederationConfig = { ... }

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.
`backendMetastores`	`cdktf.IResolvable \| DataprocMetastoreFederationBackendMetastores[]`	backend_metastores block.
`federationId`	`string`	The ID of the metastore federation.
`version`	`string`	The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/dataproc_metastore_federation#id DataprocMetastoreFederation#id}.
`labels`	`{[ key: string ]: string}`	User-defined labels for the metastore federation.
`location`	`string`	The location where the metastore federation should reside.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/dataproc_metastore_federation#project DataprocMetastoreFederation#project}.
`timeouts`	`DataprocMetastoreFederationTimeouts`	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[]

`backendMetastores`^Required

public readonly backendMetastores: IResolvable | DataprocMetastoreFederationBackendMetastores[];

Type: cdktf.IResolvable | DataprocMetastoreFederationBackendMetastores[]

backend_metastores block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/dataproc_metastore_federation#backend_metastores DataprocMetastoreFederation#backend_metastores}

`federationId`^Required

public readonly federationId: string;

Type: string

The ID of the metastore federation.

The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 63 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/dataproc_metastore_federation#federation_id DataprocMetastoreFederation#federation_id}

`version`^Required

public readonly version: string;

Type: string

The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/dataproc_metastore_federation#version DataprocMetastoreFederation#version}

`id`^Optional

public readonly id: string;

Type: string

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

User-defined labels for the metastore federation.

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

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

`location`^Optional

public readonly location: string;

Type: string

The location where the metastore federation should reside.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/dataproc_metastore_federation#location DataprocMetastoreFederation#location}

`project`^Optional

public readonly project: string;

Type: string

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

`timeouts`^Optional

public readonly timeouts: DataprocMetastoreFederationTimeouts;

Type: DataprocMetastoreFederationTimeouts

timeouts block.

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

DataprocMetastoreFederationTimeouts

Initializer

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

const dataprocMetastoreFederationTimeouts: dataprocMetastoreFederation.DataprocMetastoreFederationTimeouts = { ... }

Properties

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

`create`^Optional

public readonly create: string;

Type: string

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

`delete`^Optional

public readonly delete: string;

Type: string

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

`update`^Optional

public readonly update: string;

Type: string

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

Classes

DataprocMetastoreFederationBackendMetastoresList

Initializers

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

new dataprocMetastoreFederation.DataprocMetastoreFederationBackendMetastoresList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`allWithMapKey`	Creating an iterator for this complex list.
`computeFqn`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`get`	No description.

`allWithMapKey`

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): 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.

`get`

public get(index: number): DataprocMetastoreFederationBackendMetastoresOutputReference

`index`^Required

Type: number

the index of the item to return.

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.
`internalValue`	`cdktf.IResolvable \| DataprocMetastoreFederationBackendMetastores[]`	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

`internalValue`^Optional

public readonly internalValue: IResolvable | DataprocMetastoreFederationBackendMetastores[];

Type: cdktf.IResolvable | DataprocMetastoreFederationBackendMetastores[]

DataprocMetastoreFederationBackendMetastoresOutputReference

Initializers

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

new dataprocMetastoreFederation.DataprocMetastoreFederationBackendMetastoresOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`number`	the index of this item in the list.
`complexObjectIsFromSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

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.

`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.

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.
`metastoreTypeInput`	`string`	No description.
`nameInput`	`string`	No description.
`rankInput`	`string`	No description.
`metastoreType`	`string`	No description.
`name`	`string`	No description.
`rank`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| DataprocMetastoreFederationBackendMetastores`	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

`metastoreTypeInput`^Optional

public readonly metastoreTypeInput: string;

Type: string

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`rankInput`^Optional

public readonly rankInput: string;

Type: string

`metastoreType`^Required

public readonly metastoreType: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`rank`^Required

public readonly rank: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | DataprocMetastoreFederationBackendMetastores;

Type: cdktf.IResolvable | DataprocMetastoreFederationBackendMetastores

DataprocMetastoreFederationTimeoutsOutputReference

Initializers

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

new dataprocMetastoreFederation.DataprocMetastoreFederationTimeoutsOutputReference(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 \| DataprocMetastoreFederationTimeouts`	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 | DataprocMetastoreFederationTimeouts;

Type: cdktf.IResolvable | DataprocMetastoreFederationTimeouts

Files

dataprocMetastoreFederation.typescript.md

Latest commit

History

dataprocMetastoreFederation.typescript.md

File metadata and controls

dataprocMetastoreFederation Submodule

Constructs