Package software.amazon.awscdk.services.glue

Interface DatabaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DatabaseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-17T14:54:05.022Z")
@Stability(Stable)
public interface DatabaseProps
extends software.amazon.jsii.JsiiSerializable

Example:

 Database.Builder.create(this, "MyDatabase")
         .databaseName("my_database")
         .description("my_database_description")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DatabaseProps.Builder	A builder for DatabaseProps
static final class	DatabaseProps.Jsii$Proxy	An implementation for DatabaseProps

Method Summary

Modifier and Type	Method	Description
static DatabaseProps.Builder	builder()
default ICatalog	getCatalog()	The catalog in which the database will be placed.
default String	getDatabaseName()	The name of the database.
default String	getDescription()	A description of the database.
default String	getLocationUri()	The location of the database (for example, an HDFS path).
default RemovalPolicy	getRemovalPolicy()	Policy to apply when the database is removed from the stack.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCatalog

@Stability(Stable)
@Nullable
default ICatalog getCatalog()

The catalog in which the database will be placed.

Default: The default, account-wide catalog.

getDatabaseName

@Stability(Stable)
@Nullable
default String getDatabaseName()

The name of the database.

Default: - generated by CDK.

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the database.

Default: - no database description

getLocationUri

@Stability(Stable)
@Nullable
default String getLocationUri()

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

Default: undefined. This field is optional in AWS::Glue::Database DatabaseInput

See Also:

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

getRemovalPolicy

@Stability(Stable)
@Nullable
default RemovalPolicy getRemovalPolicy()

Policy to apply when the database is removed from the stack.

A database is a container for tables and their metadata, so it is retained by default to avoid accidental data loss when it is removed from a stack.

Default: RemovalPolicy.RETAIN

builder

@Stability(Stable)
static DatabaseProps.Builder builder()

Returns:

a DatabaseProps.Builder of DatabaseProps