class Database (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Glue.Alpha.Database |
![]() | github.com/aws/aws-cdk-go/awscdkgluealpha/v2#Database |
![]() | software.amazon.awscdk.services.glue.alpha.Database |
![]() | aws_cdk.aws_glue_alpha.Database |
![]() | @aws-cdk/aws-glue-alpha ยป Database |
Implements
IConstruct
, IDependable
, IResource
, IDatabase
A Glue database.
Example
import * as cdk from 'aws-cdk-lib';
import { S3Table, Database, DataFormat, Schema } from '@aws-cdk/aws-glue-alpha';
import { CfnDataLakeSettings, CfnTag, CfnTagAssociation } from 'aws-cdk-lib/aws-lakeformation';
declare const stack: cdk.Stack;
declare const accountId: string;
const tagKey = 'aws';
const tagValues = ['dev'];
const database = new Database(this, 'Database');
const table = new S3Table(this, 'Table', {
database,
columns: [
{
name: 'col1',
type: Schema.STRING,
},
{
name: 'col2',
type: Schema.STRING,
}
],
dataFormat: DataFormat.CSV,
});
const synthesizer = stack.synthesizer as cdk.DefaultStackSynthesizer;
new CfnDataLakeSettings(this, 'DataLakeSettings', {
admins: [
{
dataLakePrincipalIdentifier: stack.formatArn({
service: 'iam',
resource: 'role',
region: '',
account: accountId,
resourceName: 'Admin',
}),
},
{
// The CDK cloudformation execution role.
dataLakePrincipalIdentifier: synthesizer.cloudFormationExecutionRoleArn.replace('${AWS::Partition}', 'aws'),
},
],
});
const tag = new CfnTag(this, 'Tag', {
catalogId: accountId,
tagKey,
tagValues,
});
const lfTagPairProperty: CfnTagAssociation.LFTagPairProperty = {
catalogId: accountId,
tagKey,
tagValues,
};
const tagAssociation = new CfnTagAssociation(this, 'TagAssociation', {
lfTags: [lfTagPairProperty],
resource: {
tableWithColumns: {
databaseName: database.databaseName,
columnNames: ['col1', 'col2'],
catalogId: accountId,
name: table.tableName,
}
}
});
tagAssociation.node.addDependency(tag);
tagAssociation.node.addDependency(table);
Initializer
new Database(scope: Construct, id: string, props?: DatabaseProps)
Parameters
- scope
Construct
- id
string
- props
Database
Props
Construct Props
Name | Type | Description |
---|---|---|
database | string | The name of the database. |
description? | string | A description of the database. |
location | string | The location of the database (for example, an HDFS path). |
databaseName?
Type:
string
(optional, default: generated by CDK.)
The name of the database.
description?
Type:
string
(optional, default: no database description)
A description 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).
Properties
Name | Type | Description |
---|---|---|
catalog | string | ARN of the Glue catalog in which this database is stored. |
catalog | string | The catalog id of the database (usually, the AWS account id). |
database | string | ARN of this database. |
database | string | Name of this database. |
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
location | 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:
Resource
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
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
static from |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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