1.204.0

class CfnJob (construct)

LanguageType name
.NETAmazon.CDK.AWS.DataBrew.CfnJob
Javasoftware.amazon.awscdk.services.databrew.CfnJob
Pythonaws_cdk.aws_databrew.CfnJob
TypeScript @aws-cdk/aws-databrew » CfnJob

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::DataBrew::Job.

Specifies a new DataBrew job.

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 cfnJob = new databrew.CfnJob(this, 'MyCfnJob', {
  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',
  }],
});

Initializer

new CfnJob(scope: Construct, id: string, props: CfnJobProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnJobProps — - resource properties.

Create a new AWS::DataBrew::Job.

Construct Props

NameTypeDescription
namestringThe unique name of the job.
roleArnstringThe Amazon Resource Name (ARN) of the role to be assumed for this job.
typestringThe 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?stringA dataset that the job is to process.
encryptionKeyArn?stringThe Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.
encryptionMode?stringThe encryption mode for the job, which can be one of the following:.
jobSample?IResolvable | JobSamplePropertyA sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
logSubscription?stringThe current status of Amazon CloudWatch logging for the job.
maxCapacity?numberThe maximum number of nodes that can be consumed when the job processes data.
maxRetries?numberThe maximum number of times to retry the job after a job run fails.
outputLocation?IResolvable | OutputLocationPropertyAWS::DataBrew::Job.OutputLocation.
outputs?IResolvable | IResolvable | OutputProperty[]One or more artifacts that represent output from running the job.
profileConfiguration?IResolvable | ProfileConfigurationPropertyConfiguration for profile jobs.
projectName?stringThe name of the project that the job is associated with.
recipe?IResolvable | RecipePropertyA series of data transformation steps that the job runs.
tags?CfnTag[]Metadata tags that have been applied to the job.
timeout?numberThe 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.

Properties

NameTypeDescription
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
logicalIdstringThe logical ID for this CloudFormation stack element.
namestringThe unique name of the job.
nodeConstructNodeThe construct tree node associated with this construct.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
roleArnstringThe Amazon Resource Name (ARN) of the role to be assumed for this job.
stackStackThe stack in which this element is defined.
tagsTagManagerMetadata tags that have been applied to the job.
typestringThe 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?stringA dataset that the job is to process.
encryptionKeyArn?stringThe Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.
encryptionMode?stringThe encryption mode for the job, which can be one of the following:.
jobSample?IResolvable | JobSamplePropertyA sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
logSubscription?stringThe current status of Amazon CloudWatch logging for the job.
maxCapacity?numberThe maximum number of nodes that can be consumed when the job processes data.
maxRetries?numberThe maximum number of times to retry the job after a job run fails.
outputLocation?IResolvable | OutputLocationPropertyAWS::DataBrew::Job.OutputLocation.
outputs?IResolvable | IResolvable | OutputProperty[]One or more artifacts that represent output from running the job.
profileConfiguration?IResolvable | ProfileConfigurationPropertyConfiguration for profile jobs.
projectName?stringThe name of the project that the job is associated with.
recipe?IResolvable | RecipePropertyA series of data transformation steps that the job runs.
timeout?numberThe job's timeout in minutes.
validationConfigurations?IResolvable | IResolvable | ValidationConfigurationProperty[]List of validation configurations that are applied to the profile job.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name

Type: string

The unique name of the job.

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

roleArn

Type: string

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

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Type: TagManager

Metadata tags that have been applied to the 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.

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.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

  • attributeName string — The name of the attribute.

Returns

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }
← PreviousNext →