Skip to content
v2.275.0

DatabaseInputProperty Struct ​

The structure used to create or update a database.

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 databaseInputProperty: glue.CfnDatabase.DatabaseInputProperty = {
  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',
  },
};

Properties ​

createTableDefaultPermissionsoptionalIResolvable | IResolvable | CfnDatabase.PrincipalPrivilegesProperty[]create_table_default_permissionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PrincipalPrivilegesProperty]]]createTableDefaultPermissionsoptionalIResolvableCreateTableDefaultPermissionsoptionalIResolvableCreateTableDefaultPermissionsoptionalinterface{}#
Creates a set of default permissions on the table for principals.

Used by AWS Lake Formation . Not used in the normal course of AWS Glue operations.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the database.
federatedDatabaseoptionalIResolvable | CfnDatabase.FederatedDatabasePropertyfederated_databaseoptionaltyping.Union[IResolvable, FederatedDatabaseProperty]federatedDatabaseoptionalIResolvableFederatedDatabaseoptionalIResolvableFederatedDatabaseoptionalinterface{}#
A `FederatedDatabase` structure that references an entity outside the AWS Glue Data Catalog .
locationUrioptionalstringlocation_urioptionalstrlocationUrioptionalStringLocationUrioptionalstringLocationUrioptional*string#
The location of the database (for example, an HDFS path).
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name of the database.

For Hive compatibility, this is folded to lowercase when it is stored.

parametersoptionalanyparametersoptionalAnyparametersoptionalObjectParametersoptionalobjectParametersoptionalinterface{}#
These key-value pairs define parameters and properties of the database.
targetDatabaseoptionalIResolvable | CfnDatabase.DatabaseIdentifierPropertytarget_databaseoptionaltyping.Union[IResolvable, DatabaseIdentifierProperty]targetDatabaseoptionalIResolvableTargetDatabaseoptionalIResolvableTargetDatabaseoptionalinterface{}#
A `DatabaseIdentifier` structure that describes a target database for resource linking.