Skip to content

Latest commit

 

History

History
1474 lines (912 loc) · 64.6 KB

dataPostgresqlTables.csharp.md

File metadata and controls

1474 lines (912 loc) · 64.6 KB

dataPostgresqlTables Submodule

Constructs

DataPostgresqlTables

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

Initializers

using HashiCorp.Cdktf.Providers.Postgresql;

new DataPostgresqlTables(Construct Scope, string Id, DataPostgresqlTablesConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DataPostgresqlTablesConfig 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 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
private string ToString()

Returns a string representation of this construct.

AddOverride
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string

ValueRequired
  • Type: object

OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
private void ResetOverrideLogicalId()

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

ToHclTerraform
private object ToHclTerraform()

Adds this resource to the terraform JSON output.

ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()

Adds this resource to the terraform JSON output.

GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

ResetId
private void ResetId()
ResetLikeAllPatterns
private void ResetLikeAllPatterns()
ResetLikeAnyPatterns
private void ResetLikeAnyPatterns()
ResetNotLikeAllPatterns
private void ResetNotLikeAllPatterns()
ResetRegexPattern
private void ResetRegexPattern()
ResetSchemas
private void ResetSchemas()
ResetTableTypes
private void ResetTableTypes()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformDataSource No description.
GenerateConfigForImport Generates CDKTF code for importing a DataPostgresqlTables resource upon running "cdktf plan ".

IsConstruct
using HashiCorp.Cdktf.Providers.Postgresql;

DataPostgresqlTables.IsConstruct(object X);

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: object

Any object.


IsTerraformElement
using HashiCorp.Cdktf.Providers.Postgresql;

DataPostgresqlTables.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformDataSource
using HashiCorp.Cdktf.Providers.Postgresql;

DataPostgresqlTables.IsTerraformDataSource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Postgresql;

DataPostgresqlTables.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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


ImportFromIdRequired
  • Type: string

The id of the existing DataPostgresqlTables that should be imported.

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


ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

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


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.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.

NodeRequired
public Node Node { get; }
  • Type: Constructs.Node

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack

FqnRequired
public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
  • Type: string

TerraformMetaArgumentsRequired
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>

TerraformResourceTypeRequired
public string TerraformResourceType { get; }
  • Type: string

TerraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

CountOptional
public object Count { get; }
  • Type: object

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider

TablesRequired
public DataPostgresqlTablesTablesList Tables { get; }

DatabaseInputOptional
public string DatabaseInput { get; }
  • Type: string

IdInputOptional
public string IdInput { get; }
  • Type: string

LikeAllPatternsInputOptional
public string[] LikeAllPatternsInput { get; }
  • Type: string[]

LikeAnyPatternsInputOptional
public string[] LikeAnyPatternsInput { get; }
  • Type: string[]

NotLikeAllPatternsInputOptional
public string[] NotLikeAllPatternsInput { get; }
  • Type: string[]

RegexPatternInputOptional
public string RegexPatternInput { get; }
  • Type: string

SchemasInputOptional
public string[] SchemasInput { get; }
  • Type: string[]

TableTypesInputOptional
public string[] TableTypesInput { get; }
  • Type: string[]

DatabaseRequired
public string Database { get; }
  • Type: string

IdRequired
public string Id { get; }
  • Type: string

LikeAllPatternsRequired
public string[] LikeAllPatterns { get; }
  • Type: string[]

LikeAnyPatternsRequired
public string[] LikeAnyPatterns { get; }
  • Type: string[]

NotLikeAllPatternsRequired
public string[] NotLikeAllPatterns { get; }
  • Type: string[]

RegexPatternRequired
public string RegexPattern { get; }
  • Type: string

SchemasRequired
public string[] Schemas { get; }
  • Type: string[]

TableTypesRequired
public string[] TableTypes { get; }
  • Type: string[]

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

DataPostgresqlTablesConfig

Initializer

using HashiCorp.Cdktf.Providers.Postgresql;

new DataPostgresqlTablesConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Database,
    string Id = null,
    string[] LikeAllPatterns = null,
    string[] LikeAnyPatterns = null,
    string[] NotLikeAllPatterns = null,
    string RegexPattern = null,
    string[] Schemas = null,
    string[] TableTypes = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] 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.25.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.

ConnectionOptional
public object Connection { get; set; }
  • Type: object

CountOptional
public object Count { get; set; }
  • Type: object

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; set; }
  • Type: object[]

DatabaseRequired
public string Database { get; set; }
  • 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.25.0/docs/data-sources/tables#database DataPostgresqlTables#database}


IdOptional
public string Id { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.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.


LikeAllPatternsOptional
public string[] LikeAllPatterns { get; set; }
  • 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.25.0/docs/data-sources/tables#like_all_patterns DataPostgresqlTables#like_all_patterns}


LikeAnyPatternsOptional
public string[] LikeAnyPatterns { get; set; }
  • 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.25.0/docs/data-sources/tables#like_any_patterns DataPostgresqlTables#like_any_patterns}


NotLikeAllPatternsOptional
public string[] NotLikeAllPatterns { get; set; }
  • 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.25.0/docs/data-sources/tables#not_like_all_patterns DataPostgresqlTables#not_like_all_patterns}


RegexPatternOptional
public string RegexPattern { get; set; }
  • 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.25.0/docs/data-sources/tables#regex_pattern DataPostgresqlTables#regex_pattern}


SchemasOptional
public string[] Schemas { get; set; }
  • 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.25.0/docs/data-sources/tables#schemas DataPostgresqlTables#schemas}


TableTypesOptional
public string[] TableTypes { get; set; }
  • 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.25.0/docs/data-sources/tables#table_types DataPostgresqlTables#table_types}


DataPostgresqlTablesTables

Initializer

using HashiCorp.Cdktf.Providers.Postgresql;

new DataPostgresqlTablesTables {

};

Classes

DataPostgresqlTablesTablesList

Initializers

using HashiCorp.Cdktf.Providers.Postgresql;

new DataPostgresqlTablesTablesList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
WrapsSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


WrapsSetRequired
  • Type: bool

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
private DynamicListTerraformIterator AllWithMapKey(string MapKeyAttributeName)

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
private string ComputeFqn()
Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get
private DataPostgresqlTablesTablesOutputReference Get(double Index)
IndexRequired
  • Type: double

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.

CreationStackRequired
public string[] CreationStack { get; }
  • 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 string Fqn { get; }
  • Type: string

DataPostgresqlTablesTablesOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Postgresql;

new DataPostgresqlTablesTablesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
ComplexObjectIndex double the index of this item in the list.
ComplexObjectIsFromSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


ComplexObjectIndexRequired
  • Type: double

the index of this item in the list.


ComplexObjectIsFromSetRequired
  • Type: bool

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
private string ComputeFqn()
GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

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.

CreationStackRequired
public string[] CreationStack { get; }
  • 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 string Fqn { get; }
  • Type: string

ObjectNameRequired
public string ObjectName { get; }
  • Type: string

SchemaNameRequired
public string SchemaName { get; }
  • Type: string

TableTypeRequired
public string TableType { get; }
  • Type: string

InternalValueOptional
public DataPostgresqlTablesTables InternalValue { get; }