dataPostgresqlTables.typescript.md

dataPostgresqlTables Submodule

Constructs

DataPostgresqlTables

Represents a {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.26.0/docs/data-sources/tables postgresql_tables}.

Initializers

import { dataPostgresqlTables } from '@cdktn/provider-postgresql'

new dataPostgresqlTables.DataPostgresqlTables(scope: Construct, id: string, config: DataPostgresqlTablesConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	DataPostgresqlTablesConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: DataPostgresqlTablesConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to 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	Adds this resource to the terraform JSON output.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
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.
resetId	No description.
resetLikeAllPatterns	No description.
resetLikeAnyPatterns	No description.
resetNotLikeAllPatterns	No description.
resetRegexPattern	No description.
resetSchemas	No description.
resetTableTypes	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

with

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixins^Required

• Type: ...constructs.IMixin[]

The mixins to apply.

---

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

Adds this resource to the terraform JSON output.

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

resetId

public resetId(): void

resetLikeAllPatterns

public resetLikeAllPatterns(): void

resetLikeAnyPatterns

public resetLikeAnyPatterns(): void

resetNotLikeAllPatterns

public resetNotLikeAllPatterns(): void

resetRegexPattern

public resetRegexPattern(): void

resetSchemas

public resetSchemas(): void

resetTableTypes

public resetTableTypes(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformDataSource	No description.
generateConfigForImport	Generates CDKTN code for importing a DataPostgresqlTables resource upon running "cdktn plan ".

---

isConstruct

import { dataPostgresqlTables } from '@cdktn/provider-postgresql'

dataPostgresqlTables.DataPostgresqlTables.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { dataPostgresqlTables } from '@cdktn/provider-postgresql'

dataPostgresqlTables.DataPostgresqlTables.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

import { dataPostgresqlTables } from '@cdktn/provider-postgresql'

dataPostgresqlTables.DataPostgresqlTables.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { dataPostgresqlTables } from '@cdktn/provider-postgresql'

dataPostgresqlTables.DataPostgresqlTables.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTN code for importing a DataPostgresqlTables resource upon running "cdktn plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing DataPostgresqlTables that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.26.0/docs/data-sources/tables#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktn.TerraformProvider

? Optional instance of the provider where the DataPostgresqlTables to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktn.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktn.TerraformProviderGeneratorMetadata	No description.
count	number | cdktn.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktn.ITerraformIterator	No description.
lifecycle	cdktn.TerraformResourceLifecycle	No description.
provider	cdktn.TerraformProvider	No description.
tables	DataPostgresqlTablesTablesList	No description.
databaseInput	string	No description.
idInput	string	No description.
likeAllPatternsInput	string[]	No description.
likeAnyPatternsInput	string[]	No description.
notLikeAllPatternsInput	string[]	No description.
regexPatternInput	string	No description.
schemasInput	string[]	No description.
tableTypesInput	string[]	No description.
database	string	No description.
id	string	No description.
likeAllPatterns	string[]	No description.
likeAnyPatterns	string[]	No description.
notLikeAllPatterns	string[]	No description.
regexPattern	string	No description.
schemas	string[]	No description.
tableTypes	string[]	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktn.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

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

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktn.TerraformProviderGeneratorMetadata

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktn.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktn.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktn.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktn.TerraformProvider

---

tables^Required

public readonly tables: DataPostgresqlTablesTablesList;

• Type: DataPostgresqlTablesTablesList

---

databaseInput^Optional

public readonly databaseInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

likeAllPatternsInput^Optional

public readonly likeAllPatternsInput: string[];

• Type: string[]

---

likeAnyPatternsInput^Optional

public readonly likeAnyPatternsInput: string[];

• Type: string[]

---

notLikeAllPatternsInput^Optional

public readonly notLikeAllPatternsInput: string[];

• Type: string[]

---

regexPatternInput^Optional

public readonly regexPatternInput: string;

• Type: string

---

schemasInput^Optional

public readonly schemasInput: string[];

• Type: string[]

---

tableTypesInput^Optional

public readonly tableTypesInput: string[];

• Type: string[]

---

database^Required

public readonly database: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

likeAllPatterns^Required

public readonly likeAllPatterns: string[];

• Type: string[]

---

likeAnyPatterns^Required

public readonly likeAnyPatterns: string[];

• Type: string[]

---

notLikeAllPatterns^Required

public readonly notLikeAllPatterns: string[];

• Type: string[]

---

regexPattern^Required

public readonly regexPattern: string;

• Type: string

---

schemas^Required

public readonly schemas: string[];

• Type: string[]

---

tableTypes^Required

public readonly tableTypes: string[];

• Type: string[]

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataPostgresqlTablesConfig

Initializer

import { dataPostgresqlTables } from '@cdktn/provider-postgresql'

const dataPostgresqlTablesConfig: dataPostgresqlTables.DataPostgresqlTablesConfig = { ... }

Properties

Name	Type	Description
connection	cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection	No description.
count	number | cdktn.TerraformCount	No description.
dependsOn	cdktn.ITerraformDependable[]	No description.
forEach	cdktn.ITerraformIterator	No description.
lifecycle	cdktn.TerraformResourceLifecycle	No description.
provider	cdktn.TerraformProvider	No description.
provisioners	cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]	No description.
database	string	The PostgreSQL database which will be queried for table names.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.26.0/docs/data-sources/tables#id DataPostgresqlTables#id}.
likeAllPatterns	string[]	Expression(s) which will be pattern matched against table names in the query using the PostgreSQL LIKE ALL operator.
likeAnyPatterns	string[]	Expression(s) which will be pattern matched against table names in the query using the PostgreSQL LIKE ANY operator.
notLikeAllPatterns	string[]	Expression(s) which will be pattern matched against table names in the query using the PostgreSQL NOT LIKE ALL operator.
regexPattern	string	Expression which will be pattern matched against table names in the query using the PostgreSQL ~ (regular expression match) operator.
schemas	string[]	The PostgreSQL schema(s) which will be queried for table names. Queries all schemas in the database by default.
tableTypes	string[]	The PostgreSQL table types which will be queried for table names.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktn.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktn.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktn.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktn.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktn.TerraformProvider

---

provisioners^Optional

public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];

• Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

---

database^Required

public readonly database: string;

• Type: string

The PostgreSQL database which will be queried for table names.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.26.0/docs/data-sources/tables#database DataPostgresqlTables#database}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.26.0/docs/data-sources/tables#id DataPostgresqlTables#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.

---

likeAllPatterns^Optional

public readonly likeAllPatterns: string[];

• Type: string[]

Expression(s) which will be pattern matched against table names in the query using the PostgreSQL LIKE ALL operator.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.26.0/docs/data-sources/tables#like_all_patterns DataPostgresqlTables#like_all_patterns}

---

likeAnyPatterns^Optional

public readonly likeAnyPatterns: string[];

• Type: string[]

Expression(s) which will be pattern matched against table names in the query using the PostgreSQL LIKE ANY operator.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.26.0/docs/data-sources/tables#like_any_patterns DataPostgresqlTables#like_any_patterns}

---

notLikeAllPatterns^Optional

public readonly notLikeAllPatterns: string[];

• Type: string[]

Expression(s) which will be pattern matched against table names in the query using the PostgreSQL NOT LIKE ALL operator.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.26.0/docs/data-sources/tables#not_like_all_patterns DataPostgresqlTables#not_like_all_patterns}

---

regexPattern^Optional

public readonly regexPattern: string;

• Type: string

Expression which will be pattern matched against table names in the query using the PostgreSQL ~ (regular expression match) operator.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.26.0/docs/data-sources/tables#regex_pattern DataPostgresqlTables#regex_pattern}

---

schemas^Optional

public readonly schemas: string[];

• Type: string[]

The PostgreSQL schema(s) which will be queried for table names. Queries all schemas in the database by default.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.26.0/docs/data-sources/tables#schemas DataPostgresqlTables#schemas}

---

tableTypes^Optional

public readonly tableTypes: string[];

• Type: string[]

The PostgreSQL table types which will be queried for table names.

Includes all table types by default. Use 'BASE TABLE' for normal tables only

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.26.0/docs/data-sources/tables#table_types DataPostgresqlTables#table_types}

---

DataPostgresqlTablesTables

Initializer

import { dataPostgresqlTables } from '@cdktn/provider-postgresql'

const dataPostgresqlTablesTables: dataPostgresqlTables.DataPostgresqlTablesTables = { ... }

Classes

DataPostgresqlTablesTablesList

Initializers

import { dataPostgresqlTables } from '@cdktn/provider-postgresql'

new dataPostgresqlTables.DataPostgresqlTablesTablesList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

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

---

terraformResource^Required

• Type: cdktn.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: boolean

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

---

Methods

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

---

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

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

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktn.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): DataPostgresqlTablesTablesOutputReference

index^Required

• Type: number

the index of the item to return.

---

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

DataPostgresqlTablesTablesOutputReference

Initializers

import { dataPostgresqlTables } from '@cdktn/provider-postgresql'

new dataPostgresqlTables.DataPostgresqlTablesTablesOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

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

---

terraformResource^Required

• Type: cdktn.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: boolean

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

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktn.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.
objectName	string	No description.
schemaName	string	No description.
tableType	string	No description.
internalValue	DataPostgresqlTablesTables	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

objectName^Required

public readonly objectName: string;

• Type: string

---

schemaName^Required

public readonly schemaName: string;

• Type: string

---

tableType^Required

public readonly tableType: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: DataPostgresqlTablesTables;

• Type: DataPostgresqlTablesTables

---