AWS CDK Reference

Appearance

v2.275.0

DataCatalogOutputProperty Struct ​

Represents options that specify how and where in the AWS Glue Data Catalog DataBrew writes the output generated by recipe jobs.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_databrew as databrew } from 'aws-cdk-lib';
const dataCatalogOutputProperty: databrew.CfnJob.DataCatalogOutputProperty = {
  databaseName: 'databaseName',
  tableName: 'tableName',

  // the properties below are optional
  catalogId: 'catalogId',
  databaseOptions: {
    tableName: 'tableName',

    // the properties below are optional
    tempDirectory: {
      bucket: 'bucket',

      // the properties below are optional
      bucketOwner: 'bucketOwner',
      key: 'key',
    },
  },
  overwrite: false,
  s3Options: {
    location: {
      bucket: 'bucket',

      // the properties below are optional
      bucketOwner: 'bucketOwner',
      key: 'key',
    },
  },
};

Properties ​

catalogIdoptionalstringcatalog_idoptionalstrcatalogIdoptionalStringCatalogIdoptionalstringCatalogIdoptional*string#
The unique identifier of the AWS account that holds the Data Catalog that stores the data.
databaseNamestringdatabase_namestrdatabaseNameStringDatabaseNamestringDatabaseName*stringrequired#
The name of a database in the Data Catalog.
databaseOptionsoptionalIResolvable | CfnJob.DatabaseTableOutputOptionsPropertydatabase_optionsoptionaltyping.Union[IResolvable, DatabaseTableOutputOptionsProperty]databaseOptionsoptionalIResolvableDatabaseOptionsoptionalIResolvableDatabaseOptionsoptionalinterface{}#
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
overwriteoptionalboolean | IResolvableoverwriteoptionaltyping.Union[bool, IResolvable]overwriteoptionalBooleanOverwriteoptionalboolOverwriteoptionalinterface{}#
A value that, if true, means that any data in the location specified for output is overwritten with new output.

Not supported with DatabaseOptions.

s3OptionsoptionalIResolvable | CfnJob.S3TableOutputOptionsPropertys3_optionsoptionaltyping.Union[IResolvable, S3TableOutputOptionsProperty]s3OptionsoptionalIResolvableS3OptionsoptionalIResolvableS3Optionsoptionalinterface{}#
Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
tableNamestringtable_namestrtableNameStringTableNamestringTableName*stringrequired#
The name of a table in the Data Catalog.