AWS CDK Reference

Appearance

v2.274.0

CfnDatabaseProps Struct ​

Properties for defining a CfnDatabase.

Source
Generated code
Type last changed
v2.154.1 · 23 Aug 2024

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_glue as glue } from 'aws-cdk-lib';

declare const parameters: any;
const cfnDatabaseProps: glue.CfnDatabaseProps = {
  catalogId: 'catalogId',
  databaseInput: {
    createTableDefaultPermissions: [{
      permissions: ['permissions'],
      principal: {
        dataLakePrincipalIdentifier: 'dataLakePrincipalIdentifier',
      },
    }],
    description: 'description',
    federatedDatabase: {
      connectionName: 'connectionName',
      identifier: 'identifier',
    },
    locationUri: 'locationUri',
    name: 'name',
    parameters: parameters,
    targetDatabase: {
      catalogId: 'catalogId',
      databaseName: 'databaseName',
      region: 'region',
    },
  },

  // the properties below are optional
  databaseName: 'databaseName',
};

Properties ​

catalogIdstringcatalog_idstrcatalogIdStringCatalogIdstringCatalogId*stringrequired#
The AWS account ID for the account in which to create the catalog object.

To specify the account ID, you can use the Ref intrinsic function with the AWS::AccountId pseudo parameter. For example: !Ref AWS::AccountId

databaseInputIResolvable | CfnDatabase.DatabaseInputPropertydatabase_inputtyping.Union[IResolvable, DatabaseInputProperty]databaseInputIResolvableDatabaseInputIResolvableDatabaseInputinterface{}required#
The metadata for the database.
databaseNamestringdatabase_namestrdatabaseNameStringDatabaseNamestringDatabaseName*string#
The name of the catalog database.