class Database (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Glue.Database
Java	software.amazon.awscdk.services.glue.Database
Python	aws_cdk.aws_glue.Database
TypeScript (source)	@aws-cdk/aws-glue » Database

Implements IConstruct, IConstruct, IDependable, IResource, IDatabase

A Glue database.

Example

new glue.Database(this, 'MyDatabase', {
  databaseName: 'my_database',
});

Initializer

new Database(scope: Construct, id: string, props: DatabaseProps)

Parameters

• scope Construct
• id string
• props DatabaseProps

Construct Props

Name	Type	Description
databaseName🔹	string	The name of the database.
locationUri?🔹	string	The location of the database (for example, an HDFS path).

---

databaseName🔹

Type: string

The name of the database.

---

locationUri?🔹

Type: string (optional, default: undefined. This field is optional in AWS::Glue::Database DatabaseInput)

The location of the database (for example, an HDFS path).

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html

Properties

Name	Type	Description
catalogArn🔹	string	ARN of the Glue catalog in which this database is stored.
catalogId🔹	string	The catalog id of the database (usually, the AWS account id).
databaseArn🔹	string	ARN of this database.
databaseName🔹	string	Name of this database.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	ConstructNode	The construct tree node associated with this construct.
stack🔹	Stack	The stack in which this resource is defined.
locationUri?🔹	string	Location URI of this database.

---

catalogArn🔹

Type: string

ARN of the Glue catalog in which this database is stored.

---

catalogId🔹

Type: string

The catalog id of the database (usually, the AWS account id).

---

databaseArn🔹

Type: string

ARN of this database.

---

databaseName🔹

Type: string

Name of this database.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node🔹

Type: ConstructNode

The construct tree node associated with this construct.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

locationUri?🔹

Type: string (optional)

Location URI of this database.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
static fromDatabaseArn(scope, id, databaseArn)🔹

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromDatabaseArn(scope, id, databaseArn)🔹

public static fromDatabaseArn(scope: Construct, id: string, databaseArn: string): IDatabase

Parameters

• scope Construct
• id string
• databaseArn string

Returns

• IDatabase