@aws-cdk_aws-glue-alpha.Database

class Database (construct) ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Glue.Alpha.Database
Gogithub.com/aws/aws-cdk-go/awscdkgluealpha/v2#Database
Javasoftware.amazon.awscdk.services.glue.alpha.Database
Pythonaws_cdk.aws_glue_alpha.Database
TypeScript (source)@aws-cdk/aws-glue-alpha ยป Database

Implements IConstruct, IDependable, IResource, IDatabase

A Glue database.

Example

new glue.Database(this, 'MyDatabase');

Initializer

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

Parameters

  • scope Construct
  • id string
  • props DatabaseProps

Construct Props

NameTypeDescription
databaseName?๐Ÿ”นstringThe name of the database.
locationUri?๐Ÿ”นstringThe location of the database (for example, an HDFS path).

databaseName?๐Ÿ”น

Type: string (optional, default: generated by CDK.)

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

NameTypeDescription
catalogArn๐Ÿ”นstringARN of the Glue catalog in which this database is stored.
catalogId๐Ÿ”นstringThe catalog id of the database (usually, the AWS account id).
databaseArn๐Ÿ”นstringARN of this database.
databaseName๐Ÿ”นstringName of this database.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.
locationUri?๐Ÿ”นstringLocation 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: Node

The tree node.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.


locationUri?๐Ÿ”น

Type: string (optional)

Location URI of this database.

Methods

NameDescription
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