interface OutputProperty

Language	Type name
.NET	Amazon.CDK.AWS.DataBrew.CfnJob.OutputProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdatabrew#CfnJob_OutputProperty
Java	software.amazon.awscdk.services.databrew.CfnJob.OutputProperty
Python	aws_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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html

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

Name	Type	Description
location	IResolvable | S3LocationProperty	The location in Amazon S3 where the job writes its output.
compressionFormat?	string	The compression algorithm used to compress the output text of the job.
format?	string	The data format of the output of the job.
formatOptions?	IResolvable | OutputFormatOptionsProperty	Represents options that define how DataBrew formats job output files.
maxOutputFiles?	number	The maximum number of files to be generated by the job and written to the output folder.
overwrite?	boolean | IResolvable	A 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-location

---

compressionFormat?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-compressionformat

---

format?

Type: string (optional)

The data format of the output of the job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-format

---

formatOptions?

Type: IResolvable | OutputFormatOptionsProperty (optional)

Represents options that define how DataBrew formats job output files.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-formatoptions

---

maxOutputFiles?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-maxoutputfiles

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-overwrite

---

partitionColumns?

Type: string[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-output.html#cfn-databrew-job-output-partitioncolumns