`glueCatalogDatabase` Submodule

Constructs

GlueCatalogDatabase

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database aws_glue_catalog_database}.

Initializers

import { glueCatalogDatabase } from '@cdktf/aws-cdk'

new glueCatalogDatabase.GlueCatalogDatabase(scope: Construct, id: string, config: GlueCatalogDatabaseConfig)

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

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".
`putTargetDatabase`	No description.
`resetCatalogId`	No description.
`resetDescription`	No description.
`resetId`	No description.
`resetLocationUri`	No description.
`resetParameters`	No description.
`resetTargetDatabase`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

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

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

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

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

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

`index`^Optional

Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`moveToId`

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: string

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

`putTargetDatabase`

public putTargetDatabase(value: GlueCatalogDatabaseTargetDatabase): void

`value`^Required

Type: GlueCatalogDatabaseTargetDatabase

`resetCatalogId`

public resetCatalogId(): void

`resetDescription`

public resetDescription(): void

`resetId`

public resetId(): void

`resetLocationUri`

public resetLocationUri(): void

`resetParameters`

public resetParameters(): void

`resetTargetDatabase`

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

`isConstruct`

import { glueCatalogDatabase } from '@cdktf/aws-cdk'

glueCatalogDatabase.GlueCatalogDatabase.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { glueCatalogDatabase } from '@cdktf/aws-cdk'

glueCatalogDatabase.GlueCatalogDatabase.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { glueCatalogDatabase } from '@cdktf/aws-cdk'

glueCatalogDatabase.GlueCatalogDatabase.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { glueCatalogDatabase } from '@cdktf/aws-cdk'

glueCatalogDatabase.GlueCatalogDatabase.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

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

`importFromId`^Required

Type: string

The id of the existing GlueCatalogDatabase that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the GlueCatalogDatabase 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.
`arn`	`string`	No description.
`targetDatabase`	`GlueCatalogDatabaseTargetDatabaseOutputReference`	No description.
`catalogIdInput`	`string`	No description.
`descriptionInput`	`string`	No description.
`idInput`	`string`	No description.
`locationUriInput`	`string`	No description.
`nameInput`	`string`	No description.
`parametersInput`	`{[ key: string ]: string}`	No description.
`targetDatabaseInput`	`GlueCatalogDatabaseTargetDatabase`	No description.
`catalogId`	`string`	No description.
`description`	`string`	No description.
`id`	`string`	No description.
`locationUri`	`string`	No description.
`name`	`string`	No description.
`parameters`	`{[ key: string ]: string}`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

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

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

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

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`arn`^Required

public readonly arn: string;

Type: string

`targetDatabase`^Required

public readonly targetDatabase: GlueCatalogDatabaseTargetDatabaseOutputReference;

Type: GlueCatalogDatabaseTargetDatabaseOutputReference

`catalogIdInput`^Optional

public readonly catalogIdInput: string;

Type: string

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`locationUriInput`^Optional

public readonly locationUriInput: string;

Type: string

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`parametersInput`^Optional

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

Type: {[ key: string ]: string}

`targetDatabaseInput`^Optional

public readonly targetDatabaseInput: GlueCatalogDatabaseTargetDatabase;

Type: GlueCatalogDatabaseTargetDatabase

`catalogId`^Required

public readonly catalogId: string;

Type: string

`description`^Required

public readonly description: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`locationUri`^Required

public readonly locationUri: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`parameters`^Required

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

Type: {[ key: string ]: string}

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

GlueCatalogDatabaseConfig

Initializer

import { glueCatalogDatabase } from '@cdktf/aws-cdk'

const glueCatalogDatabaseConfig: glueCatalogDatabase.GlueCatalogDatabaseConfig = { ... }

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.
`name`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#name GlueCatalogDatabase#name}.
`catalogId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#catalog_id GlueCatalogDatabase#catalog_id}.
`description`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#description GlueCatalogDatabase#description}.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#id GlueCatalogDatabase#id}.
`locationUri`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#location_uri GlueCatalogDatabase#location_uri}.
`parameters`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#parameters GlueCatalogDatabase#parameters}.
`targetDatabase`	`GlueCatalogDatabaseTargetDatabase`	target_database block.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

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

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`name`^Required

public readonly name: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#name GlueCatalogDatabase#name}.

`catalogId`^Optional

public readonly catalogId: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#catalog_id GlueCatalogDatabase#catalog_id}.

`description`^Optional

public readonly description: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#description GlueCatalogDatabase#description}.

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#id GlueCatalogDatabase#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.

`locationUri`^Optional

public readonly locationUri: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#location_uri GlueCatalogDatabase#location_uri}.

`parameters`^Optional

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

Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#parameters GlueCatalogDatabase#parameters}.

`targetDatabase`^Optional

public readonly targetDatabase: GlueCatalogDatabaseTargetDatabase;

Type: GlueCatalogDatabaseTargetDatabase

target_database block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#target_database GlueCatalogDatabase#target_database}

GlueCatalogDatabaseTargetDatabase

Initializer

import { glueCatalogDatabase } from '@cdktf/aws-cdk'

const glueCatalogDatabaseTargetDatabase: glueCatalogDatabase.GlueCatalogDatabaseTargetDatabase = { ... }

Properties

Name	Type	Description
`catalogId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#catalog_id GlueCatalogDatabase#catalog_id}.
`databaseName`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#database_name GlueCatalogDatabase#database_name}.

`catalogId`^Required

public readonly catalogId: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#catalog_id GlueCatalogDatabase#catalog_id}.

`databaseName`^Required

public readonly databaseName: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/glue_catalog_database#database_name GlueCatalogDatabase#database_name}.

Classes

GlueCatalogDatabaseTargetDatabaseOutputReference

Initializers

import { glueCatalogDatabase } from '@cdktf/aws-cdk'

new glueCatalogDatabase.GlueCatalogDatabaseTargetDatabaseOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

Methods

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

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`catalogIdInput`	`string`	No description.
`databaseNameInput`	`string`	No description.
`catalogId`	`string`	No description.
`databaseName`	`string`	No description.
`internalValue`	`GlueCatalogDatabaseTargetDatabase`	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

`catalogIdInput`^Optional

public readonly catalogIdInput: string;

Type: string

`databaseNameInput`^Optional

public readonly databaseNameInput: string;

Type: string

`catalogId`^Required

public readonly catalogId: string;

Type: string

`databaseName`^Required

public readonly databaseName: string;

Type: string

`internalValue`^Optional

public readonly internalValue: GlueCatalogDatabaseTargetDatabase;

Type: GlueCatalogDatabaseTargetDatabase

Files

glueCatalogDatabase.md

Latest commit

History

glueCatalogDatabase.md

File metadata and controls

glueCatalogDatabase Submodule

Constructs