aws-cdk-lib.aws_databrew.CfnJob.OutputProperty

interface OutputProperty

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

Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile 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 outputProperty: databrew.CfnJob.OutputProperty = {
  location: {
    bucket: 'bucket',

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

  // the properties below are optional
  compressionFormat: 'compressionFormat',
  format: 'format',
  formatOptions: {
    csv: {
      delimiter: 'delimiter',
    },
  },
  maxOutputFiles: 123,
  overwrite: false,
  partitionColumns: ['partitionColumns'],
};

Properties

NameTypeDescription
locationIResolvable | S3LocationPropertyThe location in Amazon S3 where the job writes its output.
compressionFormat?stringThe compression algorithm used to compress the output text of the job.
format?stringThe data format of the output of the job.
formatOptions?IResolvable | OutputFormatOptionsPropertyRepresents options that define how DataBrew formats job output files.
maxOutputFiles?numberThe maximum number of files to be generated by the job and written to the output folder.
overwrite?boolean | IResolvableA value that, if true, means that any data in the location specified for output is overwritten with new output.
partitionColumns?string[]The names of one or more partition columns for the output of the job.

location

Type: IResolvable | S3LocationProperty

The location in Amazon S3 where the job writes its output.


compressionFormat?

Type: string (optional)

The compression algorithm used to compress the output text of the job.


format?

Type: string (optional)

The data format of the output of the job.


formatOptions?

Type: IResolvable | OutputFormatOptionsProperty (optional)

Represents options that define how DataBrew formats job output files.


maxOutputFiles?

Type: number (optional)

The maximum number of files to be generated by the job and written to the output folder.


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.


partitionColumns?

Type: string[] (optional)

The names of one or more partition columns for the output of the job.