interface CfnJobProps

Language	Type name
.NET	`Amazon.CDK.AWS.DataBrew.CfnJobProps`
Java	`software.amazon.awscdk.services.databrew.CfnJobProps`
Python	`aws_cdk.aws_databrew.CfnJobProps`
TypeScript	`@aws-cdk/aws-databrew` » `CfnJobProps`

Properties for defining a CfnJob.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as databrew from '@aws-cdk/aws-databrew';
const cfnJobProps: databrew.CfnJobProps = {
  name: 'name',
  roleArn: 'roleArn',
  type: 'type',

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

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

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

    // the properties below are optional
    databaseOutputMode: 'databaseOutputMode',
  }],
  dataCatalogOutputs: [{
    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',
      },
    },
  }],
  datasetName: 'datasetName',
  encryptionKeyArn: 'encryptionKeyArn',
  encryptionMode: 'encryptionMode',
  jobSample: {
    mode: 'mode',
    size: 123,
  },
  logSubscription: 'logSubscription',
  maxCapacity: 123,
  maxRetries: 123,
  outputLocation: {
    bucket: 'bucket',

    // the properties below are optional
    bucketOwner: 'bucketOwner',
    key: 'key',
  },
  outputs: [{
    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'],
  }],
  profileConfiguration: {
    columnStatisticsConfigurations: [{
      statistics: {
        includedStatistics: ['includedStatistics'],
        overrides: [{
          parameters: {
            parametersKey: 'parameters',
          },
          statistic: 'statistic',
        }],
      },

      // the properties below are optional
      selectors: [{
        name: 'name',
        regex: 'regex',
      }],
    }],
    datasetStatisticsConfiguration: {
      includedStatistics: ['includedStatistics'],
      overrides: [{
        parameters: {
          parametersKey: 'parameters',
        },
        statistic: 'statistic',
      }],
    },
    entityDetectorConfiguration: {
      entityTypes: ['entityTypes'],

      // the properties below are optional
      allowedStatistics: {
        statistics: ['statistics'],
      },
    },
    profileColumns: [{
      name: 'name',
      regex: 'regex',
    }],
  },
  projectName: 'projectName',
  recipe: {
    name: 'name',

    // the properties below are optional
    version: 'version',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  timeout: 123,
  validationConfigurations: [{
    rulesetArn: 'rulesetArn',

    // the properties below are optional
    validationMode: 'validationMode',
  }],
};

Properties

Name	Type	Description
name	`string`	The unique name of the job.
roleArn	`string`	The Amazon Resource Name (ARN) of the role to be assumed for this job.
type	`string`	The job type of the job, which must be one of the following:.
dataCatalogOutputs?	`IResolvable` `\|` `IResolvable` `\|` `DataCatalogOutputProperty[]`	One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
databaseOutputs?	`IResolvable` `\|` `IResolvable` `\|` `DatabaseOutputProperty[]`	Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
datasetName?	`string`	A dataset that the job is to process.
encryptionKeyArn?	`string`	The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.
encryptionMode?	`string`	The encryption mode for the job, which can be one of the following:.
jobSample?	`IResolvable` `\|` `JobSampleProperty`	A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
logSubscription?	`string`	The current status of Amazon CloudWatch logging for the job.
maxCapacity?	`number`	The maximum number of nodes that can be consumed when the job processes data.
maxRetries?	`number`	The maximum number of times to retry the job after a job run fails.
outputLocation?	`IResolvable` `\|` `OutputLocationProperty`	`AWS::DataBrew::Job.OutputLocation`.
outputs?	`IResolvable` `\|` `IResolvable` `\|` `OutputProperty[]`	One or more artifacts that represent output from running the job.
profileConfiguration?	`IResolvable` `\|` `ProfileConfigurationProperty`	Configuration for profile jobs.
projectName?	`string`	The name of the project that the job is associated with.
recipe?	`IResolvable` `\|` `RecipeProperty`	A series of data transformation steps that the job runs.
tags?	`CfnTag[]`	Metadata tags that have been applied to the job.
timeout?	`number`	The job's timeout in minutes.
validationConfigurations?	`IResolvable` `\|` `IResolvable` `\|` `ValidationConfigurationProperty[]`	List of validation configurations that are applied to the profile job.

name

Type: string

The unique name of the job.

roleArn

Type: string

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

type

Type: 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.

dataCatalogOutputs?

Type: IResolvable | IResolvable | DataCatalogOutputProperty[] (optional)

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

databaseOutputs?

Type: IResolvable | IResolvable | DatabaseOutputProperty[] (optional)

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

datasetName?

Type: string (optional)

A dataset that the job is to process.

encryptionKeyArn?

Type: string (optional)

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

encryptionMode?

Type: string (optional)

The encryption mode for the job, which can be one of the following:.

SSE-KMS - Server-side encryption with keys managed by AWS KMS .
SSE-S3 - Server-side encryption with keys managed by Amazon S3.

jobSample?

Type: IResolvable | JobSampleProperty (optional)

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.

logSubscription?

Type: string (optional)

The current status of Amazon CloudWatch logging for the job.

maxCapacity?

Type: number (optional)

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

maxRetries?

Type: number (optional)

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

outputLocation?

Type: IResolvable | OutputLocationProperty (optional)

AWS::DataBrew::Job.OutputLocation.

outputs?

Type: IResolvable | IResolvable | OutputProperty[] (optional)

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

profileConfiguration?

Type: IResolvable | ProfileConfigurationProperty (optional)

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.

projectName?

Type: string (optional)

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

recipe?

Type: IResolvable | RecipeProperty (optional)

A series of data transformation steps that the job runs.

tags?

Type: CfnTag[] (optional)

Metadata tags that have been applied to the job.

timeout?

Type: number (optional)

The job's timeout in minutes.

A job that attempts to run longer than this timeout period ends with a status of TIMEOUT .

validationConfigurations?

Type: IResolvable | IResolvable | ValidationConfigurationProperty[] (optional)

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