aws-cdk-lib.aws_databrew.CfnJob.DataCatalogOutputProperty

interface DataCatalogOutputProperty

LanguageType name
.NETAmazon.CDK.AWS.DataBrew.CfnJob.DataCatalogOutputProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdatabrew#CfnJob_DataCatalogOutputProperty
Javasoftware.amazon.awscdk.services.databrew.CfnJob.DataCatalogOutputProperty
Pythonaws_cdk.aws_databrew.CfnJob.DataCatalogOutputProperty
TypeScript aws-cdk-lib » aws_databrew » CfnJob » DataCatalogOutputProperty

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

Example

// 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

NameTypeDescription
databaseNamestringThe name of a database in the Data Catalog.
tableNamestringThe name of a table in the Data Catalog.
catalogId?stringThe unique identifier of the AWS account that holds the Data Catalog that stores the data.
databaseOptions?IResolvable | DatabaseTableOutputOptionsPropertyRepresents options that specify how and where DataBrew writes the database output generated by recipe jobs.
overwrite?boolean | IResolvableA value that, if true, means that any data in the location specified for output is overwritten with new output.
s3Options?IResolvable | S3TableOutputOptionsPropertyRepresents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.

databaseName

Type: string

The name of a database in the Data Catalog.


tableName

Type: string

The name of a table in the Data Catalog.


catalogId?

Type: string (optional)

The unique identifier of the AWS account that holds the Data Catalog that stores the data.


databaseOptions?

Type: IResolvable | DatabaseTableOutputOptionsProperty (optional)

Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.


overwrite?

Type: boolean | IResolvable (optional)

A value that, if true, means that any data in the location specified for output is overwritten with new output.

Not supported with DatabaseOptions.


s3Options?

Type: IResolvable | S3TableOutputOptionsProperty (optional)

Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.