Skip to content

Files

Latest commit

 

History

History
6071 lines (3758 loc) · 279 KB

bigqueryDataset.typescript.md

File metadata and controls

6071 lines (3758 loc) · 279 KB

bigqueryDataset Submodule

Constructs

BigqueryDataset

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset google_bigquery_dataset}.

Initializers

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

new bigqueryDataset.BigqueryDataset(scope: Construct, id: string, config: BigqueryDatasetConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config BigqueryDatasetConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

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".
putAccess No description.
putDefaultEncryptionConfiguration No description.
putExternalCatalogDatasetOptions No description.
putExternalDatasetReference No description.
putTimeouts No description.
resetAccess No description.
resetDefaultCollation No description.
resetDefaultEncryptionConfiguration No description.
resetDefaultPartitionExpirationMs No description.
resetDefaultTableExpirationMs No description.
resetDeleteContentsOnDestroy No description.
resetDescription No description.
resetExternalCatalogDatasetOptions No description.
resetExternalDatasetReference No description.
resetFriendlyName No description.
resetId No description.
resetIsCaseInsensitive No description.
resetLabels No description.
resetLocation No description.
resetMaxTimeTravelHours No description.
resetProject No description.
resetResourceTags No description.
resetStorageBillingModel No description.
resetTimeouts No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • 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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

idRequired
  • 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.

moveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


indexOptional
  • 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".

idRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


putAccess
public putAccess(value: IResolvable | BigqueryDatasetAccess[]): void
valueRequired

putDefaultEncryptionConfiguration
public putDefaultEncryptionConfiguration(value: BigqueryDatasetDefaultEncryptionConfiguration): void
valueRequired

putExternalCatalogDatasetOptions
public putExternalCatalogDatasetOptions(value: BigqueryDatasetExternalCatalogDatasetOptions): void
valueRequired

putExternalDatasetReference
public putExternalDatasetReference(value: BigqueryDatasetExternalDatasetReference): void
valueRequired

putTimeouts
public putTimeouts(value: BigqueryDatasetTimeouts): void
valueRequired

resetAccess
public resetAccess(): void
resetDefaultCollation
public resetDefaultCollation(): void
resetDefaultEncryptionConfiguration
public resetDefaultEncryptionConfiguration(): void
resetDefaultPartitionExpirationMs
public resetDefaultPartitionExpirationMs(): void
resetDefaultTableExpirationMs
public resetDefaultTableExpirationMs(): void
resetDeleteContentsOnDestroy
public resetDeleteContentsOnDestroy(): void
resetDescription
public resetDescription(): void
resetExternalCatalogDatasetOptions
public resetExternalCatalogDatasetOptions(): void
resetExternalDatasetReference
public resetExternalDatasetReference(): void
resetFriendlyName
public resetFriendlyName(): void
resetId
public resetId(): void
resetIsCaseInsensitive
public resetIsCaseInsensitive(): void
resetLabels
public resetLabels(): void
resetLocation
public resetLocation(): void
resetMaxTimeTravelHours
public resetMaxTimeTravelHours(): void
resetProject
public resetProject(): void
resetResourceTags
public resetResourceTags(): void
resetStorageBillingModel
public resetStorageBillingModel(): 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 BigqueryDataset resource upon running "cdktf plan ".

isConstruct
import { bigqueryDataset } from '@cdktf/provider-google'

bigqueryDataset.BigqueryDataset.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.

xRequired
  • Type: any

Any object.


isTerraformElement
import { bigqueryDataset } from '@cdktf/provider-google'

bigqueryDataset.BigqueryDataset.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { bigqueryDataset } from '@cdktf/provider-google'

bigqueryDataset.BigqueryDataset.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { bigqueryDataset } from '@cdktf/provider-google'

bigqueryDataset.BigqueryDataset.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a BigqueryDataset resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

The construct id used in the generated config for the BigqueryDataset to import.


importFromIdRequired
  • Type: string

The id of the existing BigqueryDataset that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the BigqueryDataset 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.
access BigqueryDatasetAccessList No description.
creationTime number No description.
defaultEncryptionConfiguration BigqueryDatasetDefaultEncryptionConfigurationOutputReference No description.
effectiveLabels cdktf.StringMap No description.
etag string No description.
externalCatalogDatasetOptions BigqueryDatasetExternalCatalogDatasetOptionsOutputReference No description.
externalDatasetReference BigqueryDatasetExternalDatasetReferenceOutputReference No description.
lastModifiedTime number No description.
selfLink string No description.
terraformLabels cdktf.StringMap No description.
timeouts BigqueryDatasetTimeoutsOutputReference No description.
accessInput cdktf.IResolvable | BigqueryDatasetAccess[] No description.
datasetIdInput string No description.
defaultCollationInput string No description.
defaultEncryptionConfigurationInput BigqueryDatasetDefaultEncryptionConfiguration No description.
defaultPartitionExpirationMsInput number No description.
defaultTableExpirationMsInput number No description.
deleteContentsOnDestroyInput boolean | cdktf.IResolvable No description.
descriptionInput string No description.
externalCatalogDatasetOptionsInput BigqueryDatasetExternalCatalogDatasetOptions No description.
externalDatasetReferenceInput BigqueryDatasetExternalDatasetReference No description.
friendlyNameInput string No description.
idInput string No description.
isCaseInsensitiveInput boolean | cdktf.IResolvable No description.
labelsInput {[ key: string ]: string} No description.
locationInput string No description.
maxTimeTravelHoursInput string No description.
projectInput string No description.
resourceTagsInput {[ key: string ]: string} No description.
storageBillingModelInput string No description.
timeoutsInput cdktf.IResolvable | BigqueryDatasetTimeouts No description.
datasetId string No description.
defaultCollation string No description.
defaultPartitionExpirationMs number No description.
defaultTableExpirationMs number No description.
deleteContentsOnDestroy boolean | cdktf.IResolvable No description.
description string No description.
friendlyName string No description.
id string No description.
isCaseInsensitive boolean | cdktf.IResolvable No description.
labels {[ key: string ]: string} No description.
location string No description.
maxTimeTravelHours string No description.
project string No description.
resourceTags {[ key: string ]: string} No description.
storageBillingModel string No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

terraformMetaArgumentsRequired
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

accessRequired
public readonly access: BigqueryDatasetAccessList;

creationTimeRequired
public readonly creationTime: number;
  • Type: number

defaultEncryptionConfigurationRequired
public readonly defaultEncryptionConfiguration: BigqueryDatasetDefaultEncryptionConfigurationOutputReference;

effectiveLabelsRequired
public readonly effectiveLabels: StringMap;
  • Type: cdktf.StringMap

etagRequired
public readonly etag: string;
  • Type: string

externalCatalogDatasetOptionsRequired
public readonly externalCatalogDatasetOptions: BigqueryDatasetExternalCatalogDatasetOptionsOutputReference;

externalDatasetReferenceRequired
public readonly externalDatasetReference: BigqueryDatasetExternalDatasetReferenceOutputReference;

lastModifiedTimeRequired
public readonly lastModifiedTime: number;
  • Type: number

selfLinkRequired
public readonly selfLink: string;
  • Type: string

terraformLabelsRequired
public readonly terraformLabels: StringMap;
  • Type: cdktf.StringMap

timeoutsRequired
public readonly timeouts: BigqueryDatasetTimeoutsOutputReference;

accessInputOptional
public readonly accessInput: IResolvable | BigqueryDatasetAccess[];

datasetIdInputOptional
public readonly datasetIdInput: string;
  • Type: string

defaultCollationInputOptional
public readonly defaultCollationInput: string;
  • Type: string

defaultEncryptionConfigurationInputOptional
public readonly defaultEncryptionConfigurationInput: BigqueryDatasetDefaultEncryptionConfiguration;

defaultPartitionExpirationMsInputOptional
public readonly defaultPartitionExpirationMsInput: number;
  • Type: number

defaultTableExpirationMsInputOptional
public readonly defaultTableExpirationMsInput: number;
  • Type: number

deleteContentsOnDestroyInputOptional
public readonly deleteContentsOnDestroyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

externalCatalogDatasetOptionsInputOptional
public readonly externalCatalogDatasetOptionsInput: BigqueryDatasetExternalCatalogDatasetOptions;

externalDatasetReferenceInputOptional
public readonly externalDatasetReferenceInput: BigqueryDatasetExternalDatasetReference;

friendlyNameInputOptional
public readonly friendlyNameInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

isCaseInsensitiveInputOptional
public readonly isCaseInsensitiveInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

labelsInputOptional
public readonly labelsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

locationInputOptional
public readonly locationInput: string;
  • Type: string

maxTimeTravelHoursInputOptional
public readonly maxTimeTravelHoursInput: string;
  • Type: string

projectInputOptional
public readonly projectInput: string;
  • Type: string

resourceTagsInputOptional
public readonly resourceTagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

storageBillingModelInputOptional
public readonly storageBillingModelInput: string;
  • Type: string

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | BigqueryDatasetTimeouts;

datasetIdRequired
public readonly datasetId: string;
  • Type: string

defaultCollationRequired
public readonly defaultCollation: string;
  • Type: string

defaultPartitionExpirationMsRequired
public readonly defaultPartitionExpirationMs: number;
  • Type: number

defaultTableExpirationMsRequired
public readonly defaultTableExpirationMs: number;
  • Type: number

deleteContentsOnDestroyRequired
public readonly deleteContentsOnDestroy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

descriptionRequired
public readonly description: string;
  • Type: string

friendlyNameRequired
public readonly friendlyName: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

isCaseInsensitiveRequired
public readonly isCaseInsensitive: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

labelsRequired
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

locationRequired
public readonly location: string;
  • Type: string

maxTimeTravelHoursRequired
public readonly maxTimeTravelHours: string;
  • Type: string

projectRequired
public readonly project: string;
  • Type: string

resourceTagsRequired
public readonly resourceTags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

storageBillingModelRequired
public readonly storageBillingModel: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

BigqueryDatasetAccess

Initializer

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

const bigqueryDatasetAccess: bigqueryDataset.BigqueryDatasetAccess = { ... }

Properties

Name Type Description
condition BigqueryDatasetAccessCondition condition block.
dataset BigqueryDatasetAccessDataset dataset block.
domain string A domain to grant access to. Any users signed in with the domain specified will be granted the specified access.
groupByEmail string An email address of a Google Group to grant access to.
iamMember string Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
role string Describes the rights granted to the user specified by the other member of the access object.
routine BigqueryDatasetAccessRoutine routine block.
specialGroup string A special group to grant access to.
userByEmail string An email address of a user to grant access to. For example: fred@example.com.
view BigqueryDatasetAccessView view block.

conditionOptional
public readonly condition: BigqueryDatasetAccessCondition;

condition block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#condition BigqueryDataset#condition}


datasetOptional
public readonly dataset: BigqueryDatasetAccessDataset;

dataset block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#dataset BigqueryDataset#dataset}


domainOptional
public readonly domain: string;
  • Type: string

A domain to grant access to. Any users signed in with the domain specified will be granted the specified access.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#domain BigqueryDataset#domain}


groupByEmailOptional
public readonly groupByEmail: string;
  • Type: string

An email address of a Google Group to grant access to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#group_by_email BigqueryDataset#group_by_email}


iamMemberOptional
public readonly iamMember: string;
  • Type: string

Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.

For example: 'allUsers'

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#iam_member BigqueryDataset#iam_member}


roleOptional
public readonly role: string;
  • Type: string

Describes the rights granted to the user specified by the other member of the access object.

Basic, predefined, and custom roles are supported. Predefined roles that have equivalent basic roles are swapped by the API to their basic counterparts. See official docs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#role BigqueryDataset#role}


routineOptional
public readonly routine: BigqueryDatasetAccessRoutine;

routine block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#routine BigqueryDataset#routine}


specialGroupOptional
public readonly specialGroup: string;
  • Type: string

A special group to grant access to.

Possible values include:

  • 'projectOwners': Owners of the enclosing project.
  • 'projectReaders': Readers of the enclosing project.
  • 'projectWriters': Writers of the enclosing project.
  • 'allAuthenticatedUsers': All authenticated BigQuery users.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#special_group BigqueryDataset#special_group}


userByEmailOptional
public readonly userByEmail: string;
  • Type: string

An email address of a user to grant access to. For example: fred@example.com.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#user_by_email BigqueryDataset#user_by_email}


viewOptional
public readonly view: BigqueryDatasetAccessView;

view block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#view BigqueryDataset#view}


BigqueryDatasetAccessCondition

Initializer

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

const bigqueryDatasetAccessCondition: bigqueryDataset.BigqueryDatasetAccessCondition = { ... }

Properties

Name Type Description
expression string Textual representation of an expression in Common Expression Language syntax.
description string Description of the expression.
location string String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
title string Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

expressionRequired
public readonly expression: string;
  • Type: string

Textual representation of an expression in Common Expression Language syntax.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#expression BigqueryDataset#expression}


descriptionOptional
public readonly description: string;
  • Type: string

Description of the expression.

This is a longer text which describes the expression, e.g. when hovered over it in a UI.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#description BigqueryDataset#description}


locationOptional
public readonly location: string;
  • Type: string

String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#location BigqueryDataset#location}


titleOptional
public readonly title: string;
  • Type: string

Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#title BigqueryDataset#title}


BigqueryDatasetAccessDataset

Initializer

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

const bigqueryDatasetAccessDataset: bigqueryDataset.BigqueryDatasetAccessDataset = { ... }

Properties

Name Type Description
dataset BigqueryDatasetAccessDatasetDataset dataset block.
targetTypes string[] Which resources in the dataset this entry applies to.

datasetRequired
public readonly dataset: BigqueryDatasetAccessDatasetDataset;

dataset block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#dataset BigqueryDataset#dataset}


targetTypesRequired
public readonly targetTypes: string[];
  • Type: string[]

Which resources in the dataset this entry applies to.

Currently, only views are supported, but additional target types may be added in the future. Possible values: VIEWS

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#target_types BigqueryDataset#target_types}


BigqueryDatasetAccessDatasetDataset

Initializer

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

const bigqueryDatasetAccessDatasetDataset: bigqueryDataset.BigqueryDatasetAccessDatasetDataset = { ... }

Properties

Name Type Description
datasetId string The ID of the dataset containing this table.
projectId string The ID of the project containing this table.

datasetIdRequired
public readonly datasetId: string;
  • Type: string

The ID of the dataset containing this table.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#dataset_id BigqueryDataset#dataset_id}


projectIdRequired
public readonly projectId: string;
  • Type: string

The ID of the project containing this table.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#project_id BigqueryDataset#project_id}


BigqueryDatasetAccessRoutine

Initializer

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

const bigqueryDatasetAccessRoutine: bigqueryDataset.BigqueryDatasetAccessRoutine = { ... }

Properties

Name Type Description
datasetId string The ID of the dataset containing this table.
projectId string The ID of the project containing this table.
routineId string The ID of the routine.

datasetIdRequired
public readonly datasetId: string;
  • Type: string

The ID of the dataset containing this table.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#dataset_id BigqueryDataset#dataset_id}


projectIdRequired
public readonly projectId: string;
  • Type: string

The ID of the project containing this table.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#project_id BigqueryDataset#project_id}


routineIdRequired
public readonly routineId: string;
  • Type: string

The ID of the routine.

The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#routine_id BigqueryDataset#routine_id}


BigqueryDatasetAccessView

Initializer

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

const bigqueryDatasetAccessView: bigqueryDataset.BigqueryDatasetAccessView = { ... }

Properties

Name Type Description
datasetId string The ID of the dataset containing this table.
projectId string The ID of the project containing this table.
tableId string The ID of the table.

datasetIdRequired
public readonly datasetId: string;
  • Type: string

The ID of the dataset containing this table.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#dataset_id BigqueryDataset#dataset_id}


projectIdRequired
public readonly projectId: string;
  • Type: string

The ID of the project containing this table.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#project_id BigqueryDataset#project_id}


tableIdRequired
public readonly tableId: string;
  • Type: string

The ID of the table.

The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#table_id BigqueryDataset#table_id}


BigqueryDatasetConfig

Initializer

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

const bigqueryDatasetConfig: bigqueryDataset.BigqueryDatasetConfig = { ... }

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.
datasetId string A unique ID for this dataset, without the project name.
access cdktf.IResolvable | BigqueryDatasetAccess[] access block.
defaultCollation string Defines the default collation specification of future tables created in the dataset.
defaultEncryptionConfiguration BigqueryDatasetDefaultEncryptionConfiguration default_encryption_configuration block.
defaultPartitionExpirationMs number The default partition expiration for all partitioned tables in the dataset, in milliseconds.
defaultTableExpirationMs number The default lifetime of all tables in the dataset, in milliseconds.
deleteContentsOnDestroy boolean | cdktf.IResolvable If set to 'true', delete all the tables in the dataset when destroying the resource;
description string A user-friendly description of the dataset.
externalCatalogDatasetOptions BigqueryDatasetExternalCatalogDatasetOptions external_catalog_dataset_options block.
externalDatasetReference BigqueryDatasetExternalDatasetReference external_dataset_reference block.
friendlyName string A descriptive name for the dataset.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#id BigqueryDataset#id}.
isCaseInsensitive boolean | cdktf.IResolvable TRUE if the dataset and its table names are case-insensitive, otherwise FALSE.
labels {[ key: string ]: string} The labels associated with this dataset. You can use these to organize and group your datasets.
location string The geographic location where the dataset should reside.
maxTimeTravelHours string Defines the time travel window in hours.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#project BigqueryDataset#project}.
resourceTags {[ key: string ]: string} The tags attached to this table.
storageBillingModel string Specifies the storage billing model for the dataset.
timeouts BigqueryDatasetTimeouts timeouts block.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

datasetIdRequired
public readonly datasetId: string;
  • Type: string

A unique ID for this dataset, without the project name.

The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#dataset_id BigqueryDataset#dataset_id}


accessOptional
public readonly access: IResolvable | BigqueryDatasetAccess[];

access block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#access BigqueryDataset#access}


defaultCollationOptional
public readonly defaultCollation: string;
  • Type: string

Defines the default collation specification of future tables created in the dataset.

If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables.

The following values are supported:

  • 'und:ci': undetermined locale, case insensitive.
  • '': empty string. Default to case-sensitive behavior.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#default_collation BigqueryDataset#default_collation}


defaultEncryptionConfigurationOptional
public readonly defaultEncryptionConfiguration: BigqueryDatasetDefaultEncryptionConfiguration;

default_encryption_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#default_encryption_configuration BigqueryDataset#default_encryption_configuration}


defaultPartitionExpirationMsOptional
public readonly defaultPartitionExpirationMs: number;
  • Type: number

The default partition expiration for all partitioned tables in the dataset, in milliseconds.

Once this property is set, all newly-created partitioned tables in the dataset will have an 'expirationMs' property in the 'timePartitioning' settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of 'defaultTableExpirationMs' for partitioned tables: only one of 'defaultTableExpirationMs' and 'defaultPartitionExpirationMs' will be used for any new partitioned table. If you provide an explicit 'timePartitioning.expirationMs' when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#default_partition_expiration_ms BigqueryDataset#default_partition_expiration_ms}


defaultTableExpirationMsOptional
public readonly defaultTableExpirationMs: number;
  • Type: number

The default lifetime of all tables in the dataset, in milliseconds.

The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an 'expirationTime' property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the 'expirationTime' for a given table is reached, that table will be deleted automatically. If a table's 'expirationTime' is modified or removed before the table expires, or if you provide an explicit 'expirationTime' when creating a table, that value takes precedence over the default expiration time indicated by this property.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#default_table_expiration_ms BigqueryDataset#default_table_expiration_ms}


deleteContentsOnDestroyOptional
public readonly deleteContentsOnDestroy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

If set to 'true', delete all the tables in the dataset when destroying the resource;

otherwise, destroying the resource will fail if tables are present.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#delete_contents_on_destroy BigqueryDataset#delete_contents_on_destroy}


descriptionOptional
public readonly description: string;
  • Type: string

A user-friendly description of the dataset.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#description BigqueryDataset#description}


externalCatalogDatasetOptionsOptional
public readonly externalCatalogDatasetOptions: BigqueryDatasetExternalCatalogDatasetOptions;

external_catalog_dataset_options block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#external_catalog_dataset_options BigqueryDataset#external_catalog_dataset_options}


externalDatasetReferenceOptional
public readonly externalDatasetReference: BigqueryDatasetExternalDatasetReference;

external_dataset_reference block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#external_dataset_reference BigqueryDataset#external_dataset_reference}


friendlyNameOptional
public readonly friendlyName: string;
  • Type: string

A descriptive name for the dataset.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#friendly_name BigqueryDataset#friendly_name}


idOptional
public readonly id: string;
  • Type: string

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


isCaseInsensitiveOptional
public readonly isCaseInsensitive: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

TRUE if the dataset and its table names are case-insensitive, otherwise FALSE.

By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#is_case_insensitive BigqueryDataset#is_case_insensitive}


labelsOptional
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

The labels associated with this dataset. You can use these to organize and group your datasets.

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.35.0/docs/resources/bigquery_dataset#labels BigqueryDataset#labels}


locationOptional
public readonly location: string;
  • Type: string

The geographic location where the dataset should reside.

See official docs. There are two types of locations, regional or multi-regional. A regional location is a specific geographic place, such as Tokyo, and a multi-regional location is a large geographic area, such as the United States, that contains at least two geographic places. The default value is multi-regional location 'US'. Changing this forces a new resource to be created.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#location BigqueryDataset#location}


maxTimeTravelHoursOptional
public readonly maxTimeTravelHours: string;
  • Type: string

Defines the time travel window in hours.

The value can be from 48 to 168 hours (2 to 7 days).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#max_time_travel_hours BigqueryDataset#max_time_travel_hours}


projectOptional
public readonly project: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#project BigqueryDataset#project}.


resourceTagsOptional
public readonly resourceTags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

The tags attached to this table.

Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See Tag definitions for more details.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#resource_tags BigqueryDataset#resource_tags}


storageBillingModelOptional
public readonly storageBillingModel: string;
  • Type: string

Specifies the storage billing model for the dataset.

Set this flag value to LOGICAL to use logical bytes for storage billing, or to PHYSICAL to use physical bytes instead.

LOGICAL is the default if this flag isn't specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#storage_billing_model BigqueryDataset#storage_billing_model}


timeoutsOptional
public readonly timeouts: BigqueryDatasetTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#timeouts BigqueryDataset#timeouts}


BigqueryDatasetDefaultEncryptionConfiguration

Initializer

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

const bigqueryDatasetDefaultEncryptionConfiguration: bigqueryDataset.BigqueryDatasetDefaultEncryptionConfiguration = { ... }

Properties

Name Type Description
kmsKeyName string Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table.

kmsKeyNameRequired
public readonly kmsKeyName: string;
  • Type: string

Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table.

The BigQuery Service Account associated with your project requires access to this encryption key.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#kms_key_name BigqueryDataset#kms_key_name}


BigqueryDatasetExternalCatalogDatasetOptions

Initializer

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

const bigqueryDatasetExternalCatalogDatasetOptions: bigqueryDataset.BigqueryDatasetExternalCatalogDatasetOptions = { ... }

Properties

Name Type Description
defaultStorageLocationUri string The storage location URI for all tables in the dataset.
parameters {[ key: string ]: string} A map of key value pairs defining the parameters and properties of the open source schema. Maximum size of 2Mib.

defaultStorageLocationUriOptional
public readonly defaultStorageLocationUri: string;
  • Type: string

The storage location URI for all tables in the dataset.

Equivalent to hive metastore's database locationUri. Maximum length of 1024 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#default_storage_location_uri BigqueryDataset#default_storage_location_uri}


parametersOptional
public readonly parameters: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

A map of key value pairs defining the parameters and properties of the open source schema. Maximum size of 2Mib.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#parameters BigqueryDataset#parameters}


BigqueryDatasetExternalDatasetReference

Initializer

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

const bigqueryDatasetExternalDatasetReference: bigqueryDataset.BigqueryDatasetExternalDatasetReference = { ... }

Properties

Name Type Description
connection string The connection id that is used to access the externalSource. Format: projects/{projectId}/locations/{locationId}/connections/{connectionId}.
externalSource string External source that backs this dataset.

connectionRequired
public readonly connection: string;
  • Type: string

The connection id that is used to access the externalSource. Format: projects/{projectId}/locations/{locationId}/connections/{connectionId}.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#connection BigqueryDataset#connection}


externalSourceRequired
public readonly externalSource: string;
  • Type: string

External source that backs this dataset.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#external_source BigqueryDataset#external_source}


BigqueryDatasetTimeouts

Initializer

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

const bigqueryDatasetTimeouts: bigqueryDataset.BigqueryDatasetTimeouts = { ... }

Properties

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

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#create BigqueryDataset#create}.


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#delete BigqueryDataset#delete}.


updateOptional
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/bigquery_dataset#update BigqueryDataset#update}.


Classes

BigqueryDatasetAccessConditionOutputReference

Initializers

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

new bigqueryDataset.BigqueryDatasetAccessConditionOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.
resetDescription No description.
resetLocation No description.
resetTitle No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetDescription
public resetDescription(): void
resetLocation
public resetLocation(): void
resetTitle
public resetTitle(): 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.
descriptionInput string No description.
expressionInput string No description.
locationInput string No description.
titleInput string No description.
description string No description.
expression string No description.
location string No description.
title string No description.
internalValue BigqueryDatasetAccessCondition No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

expressionInputOptional
public readonly expressionInput: string;
  • Type: string

locationInputOptional
public readonly locationInput: string;
  • Type: string

titleInputOptional
public readonly titleInput: string;
  • Type: string

descriptionRequired
public readonly description: string;
  • Type: string

expressionRequired
public readonly expression: string;
  • Type: string

locationRequired
public readonly location: string;
  • Type: string

titleRequired
public readonly title: string;
  • Type: string

internalValueOptional
public readonly internalValue: BigqueryDatasetAccessCondition;

BigqueryDatasetAccessDatasetDatasetOutputReference

Initializers

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

new bigqueryDataset.BigqueryDatasetAccessDatasetDatasetOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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.
datasetIdInput string No description.
projectIdInput string No description.
datasetId string No description.
projectId string No description.
internalValue BigqueryDatasetAccessDatasetDataset No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

datasetIdInputOptional
public readonly datasetIdInput: string;
  • Type: string

projectIdInputOptional
public readonly projectIdInput: string;
  • Type: string

datasetIdRequired
public readonly datasetId: string;
  • Type: string

projectIdRequired
public readonly projectId: string;
  • Type: string

internalValueOptional
public readonly internalValue: BigqueryDatasetAccessDatasetDataset;

BigqueryDatasetAccessDatasetOutputReference

Initializers

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

new bigqueryDataset.BigqueryDatasetAccessDatasetOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.
putDataset No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

putDataset
public putDataset(value: BigqueryDatasetAccessDatasetDataset): void
valueRequired

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.
dataset BigqueryDatasetAccessDatasetDatasetOutputReference No description.
datasetInput BigqueryDatasetAccessDatasetDataset No description.
targetTypesInput string[] No description.
targetTypes string[] No description.
internalValue BigqueryDatasetAccessDataset No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

datasetRequired
public readonly dataset: BigqueryDatasetAccessDatasetDatasetOutputReference;

datasetInputOptional
public readonly datasetInput: BigqueryDatasetAccessDatasetDataset;

targetTypesInputOptional
public readonly targetTypesInput: string[];
  • Type: string[]

targetTypesRequired
public readonly targetTypes: string[];
  • Type: string[]

internalValueOptional
public readonly internalValue: BigqueryDatasetAccessDataset;

BigqueryDatasetAccessList

Initializers

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

new bigqueryDataset.BigqueryDatasetAccessList(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • 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.

mapKeyAttributeNameRequired
  • Type: string

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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): BigqueryDatasetAccessOutputReference
indexRequired
  • 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 | BigqueryDatasetAccess[] No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | BigqueryDatasetAccess[];

BigqueryDatasetAccessOutputReference

Initializers

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

new bigqueryDataset.BigqueryDatasetAccessOutputReference(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • 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.
putCondition No description.
putDataset No description.
putRoutine No description.
putView No description.
resetCondition No description.
resetDataset No description.
resetDomain No description.
resetGroupByEmail No description.
resetIamMember No description.
resetRole No description.
resetRoutine No description.
resetSpecialGroup No description.
resetUserByEmail No description.
resetView No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

putCondition
public putCondition(value: BigqueryDatasetAccessCondition): void
valueRequired

putDataset
public putDataset(value: BigqueryDatasetAccessDataset): void
valueRequired

putRoutine
public putRoutine(value: BigqueryDatasetAccessRoutine): void
valueRequired

putView
public putView(value: BigqueryDatasetAccessView): void
valueRequired

resetCondition
public resetCondition(): void
resetDataset
public resetDataset(): void
resetDomain
public resetDomain(): void
resetGroupByEmail
public resetGroupByEmail(): void
resetIamMember
public resetIamMember(): void
resetRole
public resetRole(): void
resetRoutine
public resetRoutine(): void
resetSpecialGroup
public resetSpecialGroup(): void
resetUserByEmail
public resetUserByEmail(): void
resetView
public resetView(): 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.
condition BigqueryDatasetAccessConditionOutputReference No description.
dataset BigqueryDatasetAccessDatasetOutputReference No description.
routine BigqueryDatasetAccessRoutineOutputReference No description.
view BigqueryDatasetAccessViewOutputReference No description.
conditionInput BigqueryDatasetAccessCondition No description.
datasetInput BigqueryDatasetAccessDataset No description.
domainInput string No description.
groupByEmailInput string No description.
iamMemberInput string No description.
roleInput string No description.
routineInput BigqueryDatasetAccessRoutine No description.
specialGroupInput string No description.
userByEmailInput string No description.
viewInput BigqueryDatasetAccessView No description.
domain string No description.
groupByEmail string No description.
iamMember string No description.
role string No description.
specialGroup string No description.
userByEmail string No description.
internalValue cdktf.IResolvable | BigqueryDatasetAccess No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

conditionRequired
public readonly condition: BigqueryDatasetAccessConditionOutputReference;

datasetRequired
public readonly dataset: BigqueryDatasetAccessDatasetOutputReference;

routineRequired
public readonly routine: BigqueryDatasetAccessRoutineOutputReference;

viewRequired
public readonly view: BigqueryDatasetAccessViewOutputReference;

conditionInputOptional
public readonly conditionInput: BigqueryDatasetAccessCondition;

datasetInputOptional
public readonly datasetInput: BigqueryDatasetAccessDataset;

domainInputOptional
public readonly domainInput: string;
  • Type: string

groupByEmailInputOptional
public readonly groupByEmailInput: string;
  • Type: string

iamMemberInputOptional
public readonly iamMemberInput: string;
  • Type: string

roleInputOptional
public readonly roleInput: string;
  • Type: string

routineInputOptional
public readonly routineInput: BigqueryDatasetAccessRoutine;

specialGroupInputOptional
public readonly specialGroupInput: string;
  • Type: string

userByEmailInputOptional
public readonly userByEmailInput: string;
  • Type: string

viewInputOptional
public readonly viewInput: BigqueryDatasetAccessView;

domainRequired
public readonly domain: string;
  • Type: string

groupByEmailRequired
public readonly groupByEmail: string;
  • Type: string

iamMemberRequired
public readonly iamMember: string;
  • Type: string

roleRequired
public readonly role: string;
  • Type: string

specialGroupRequired
public readonly specialGroup: string;
  • Type: string

userByEmailRequired
public readonly userByEmail: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | BigqueryDatasetAccess;

BigqueryDatasetAccessRoutineOutputReference

Initializers

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

new bigqueryDataset.BigqueryDatasetAccessRoutineOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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.
datasetIdInput string No description.
projectIdInput string No description.
routineIdInput string No description.
datasetId string No description.
projectId string No description.
routineId string No description.
internalValue BigqueryDatasetAccessRoutine No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

datasetIdInputOptional
public readonly datasetIdInput: string;
  • Type: string

projectIdInputOptional
public readonly projectIdInput: string;
  • Type: string

routineIdInputOptional
public readonly routineIdInput: string;
  • Type: string

datasetIdRequired
public readonly datasetId: string;
  • Type: string

projectIdRequired
public readonly projectId: string;
  • Type: string

routineIdRequired
public readonly routineId: string;
  • Type: string

internalValueOptional
public readonly internalValue: BigqueryDatasetAccessRoutine;

BigqueryDatasetAccessViewOutputReference

Initializers

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

new bigqueryDataset.BigqueryDatasetAccessViewOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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.
datasetIdInput string No description.
projectIdInput string No description.
tableIdInput string No description.
datasetId string No description.
projectId string No description.
tableId string No description.
internalValue BigqueryDatasetAccessView No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

datasetIdInputOptional
public readonly datasetIdInput: string;
  • Type: string

projectIdInputOptional
public readonly projectIdInput: string;
  • Type: string

tableIdInputOptional
public readonly tableIdInput: string;
  • Type: string

datasetIdRequired
public readonly datasetId: string;
  • Type: string

projectIdRequired
public readonly projectId: string;
  • Type: string

tableIdRequired
public readonly tableId: string;
  • Type: string

internalValueOptional
public readonly internalValue: BigqueryDatasetAccessView;

BigqueryDatasetDefaultEncryptionConfigurationOutputReference

Initializers

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

new bigqueryDataset.BigqueryDatasetDefaultEncryptionConfigurationOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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.
kmsKeyNameInput string No description.
kmsKeyName string No description.
internalValue BigqueryDatasetDefaultEncryptionConfiguration No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

kmsKeyNameInputOptional
public readonly kmsKeyNameInput: string;
  • Type: string

kmsKeyNameRequired
public readonly kmsKeyName: string;
  • Type: string

internalValueOptional
public readonly internalValue: BigqueryDatasetDefaultEncryptionConfiguration;

BigqueryDatasetExternalCatalogDatasetOptionsOutputReference

Initializers

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

new bigqueryDataset.BigqueryDatasetExternalCatalogDatasetOptionsOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.
resetDefaultStorageLocationUri No description.
resetParameters No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetDefaultStorageLocationUri
public resetDefaultStorageLocationUri(): void
resetParameters
public resetParameters(): 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.
defaultStorageLocationUriInput string No description.
parametersInput {[ key: string ]: string} No description.
defaultStorageLocationUri string No description.
parameters {[ key: string ]: string} No description.
internalValue BigqueryDatasetExternalCatalogDatasetOptions No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

defaultStorageLocationUriInputOptional
public readonly defaultStorageLocationUriInput: string;
  • Type: string

parametersInputOptional
public readonly parametersInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

defaultStorageLocationUriRequired
public readonly defaultStorageLocationUri: string;
  • Type: string

parametersRequired
public readonly parameters: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

internalValueOptional
public readonly internalValue: BigqueryDatasetExternalCatalogDatasetOptions;

BigqueryDatasetExternalDatasetReferenceOutputReference

Initializers

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

new bigqueryDataset.BigqueryDatasetExternalDatasetReferenceOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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.
connectionInput string No description.
externalSourceInput string No description.
connection string No description.
externalSource string No description.
internalValue BigqueryDatasetExternalDatasetReference No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

connectionInputOptional
public readonly connectionInput: string;
  • Type: string

externalSourceInputOptional
public readonly externalSourceInput: string;
  • Type: string

connectionRequired
public readonly connection: string;
  • Type: string

externalSourceRequired
public readonly externalSource: string;
  • Type: string

internalValueOptional
public readonly internalValue: BigqueryDatasetExternalDatasetReference;

BigqueryDatasetTimeoutsOutputReference

Initializers

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

new bigqueryDataset.BigqueryDatasetTimeoutsOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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 | BigqueryDatasetTimeouts No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

createInputOptional
public readonly createInput: string;
  • Type: string

deleteInputOptional
public readonly deleteInput: string;
  • Type: string

updateInputOptional
public readonly updateInput: string;
  • Type: string

createRequired
public readonly create: string;
  • Type: string

deleteRequired
public readonly delete: string;
  • Type: string

updateRequired
public readonly update: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | BigqueryDatasetTimeouts;