AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::DataBrew::Job

CfnJob

Specifies a new DataBrew job.

Import

import { CfnJob } from 'aws-cdk-lib/aws-databrew';

Or use the module namespace:

import * as databrew from 'aws-cdk-lib/aws-databrew';
// databrew.CfnJob

Properties

Configuration passed to the constructor as CfnJobProps.

nameRequired
string

The unique name of the job.

roleArnRequired
string

The Amazon Resource Name (ARN) of the role to be assumed for this job.

typeRequired
string

The job type of the job, which must be one of the following:. - `PROFILE` - A job to analyze a dataset, to determine its size, data types, data distribution, and more. - `RECIPE` - A job to apply one or more transformations to a dataset.

databaseOutputsOptional
IResolvable | IResolvable | DatabaseOutputProperty[]

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

dataCatalogOutputsOptional
IResolvable | IResolvable | DataCatalogOutputProperty[]

One or more artifacts that represent the AWS Glue Data Catalog output from running the job.

datasetNameOptional
string

A dataset that the job is to process.

encryptionKeyArnOptional
string

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see [Encrypting data written by DataBrew jobs](https://docs.aws.amazon.com/databrew/latest/dg/encryption-security-configuration.html)

encryptionModeOptional
string

The encryption mode for the job, which can be one of the following:. - `SSE-KMS` - Server-side encryption with keys managed by AWS . - `SSE-S3` - Server-side encryption with keys managed by Amazon S3.

jobSampleOptional
IResolvable | JobSampleProperty

A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a `JobSample` value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.

logSubscriptionOptional
string

The current status of Amazon CloudWatch logging for the job.

maxCapacityOptional
number

The maximum number of nodes that can be consumed when the job processes data.

maxRetriesOptional
number

The maximum number of times to retry the job after a job run fails.

outputLocationOptional
IResolvable | OutputLocationProperty

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

outputsOptional
IResolvable | IResolvable | OutputProperty[]

One or more artifacts that represent output from running the job.

profileConfigurationOptional
IResolvable | ProfileConfigurationProperty

Configuration for profile jobs. Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns.

projectNameOptional
string

The name of the project that the job is associated with.

recipeOptional
IResolvable | RecipeProperty

A series of data transformation steps that the job runs.

tagsOptional
CfnTag[]

Metadata tags that have been applied to the job.

timeoutOptional
number

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of `TIMEOUT` .

validationConfigurationsOptional
IResolvable | IResolvable | ValidationConfigurationProperty[]

List of validation configurations that are applied to the profile job.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::DataBrew::JobView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-databrew
CFN TypeAWS::DataBrew::Job
Properties20

Related Constructs

Explore This Service

External Links