# CfnProcessingJob

An Amazon SageMaker processing job that is used to analyze data and evaluate models.

For more information, see [Process Data and Evaluate Models](https://docs.aws.amazon.com/sagemaker/latest/dg/processing-job.html) .

Also, note the following details specific to processing jobs created using CloudFormation stacks:

- When you delete a CloudFormation stack with a processing job resource, the processing job is stopped using the [StopProcessingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopProcessingJob.html) API but not deleted. Any tags associated with the processing job are deleted using the [DeleteTags](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteTags.html) API.
- If any part of your CloudFormation stack deployment fails and a rollback initiates, processing jobs with a specified `ProcessingJobName` value might cause the stack to become stuck in a failed state. This occurs because during a rollback, CloudFormation attempts to recreate the stack resources. Processing job names must be unique, so when CloudFormation attempts to recreate a processing job using the already defined name, this results in an `AlreadyExists` error. To prevent this, we recommend that you don't specify the optional `ProcessingJobName` property, thereby allowing SageMaker to auto-generate a unique name for your processing job. This ensures successful stack rollbacks when necessary. If you must use custom job names, you have to manually modify the `ProcessingJobName` and redeploy the stack to recover from a failed rollback.

Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnProcessingJob
Implements: IInspectable, ITaggableV2, IEnvironmentAware, IProcessingJobRef, IConstruct, IDependable

- CloudFormation: [`AWS::SageMaker::ProcessingJob`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-sagemaker-processingjob.html)
- Source: Generated code
- Type last changed: v2.252.0 · 30 Apr 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnProcessingJob = new sagemaker.CfnProcessingJob(this, 'MyCfnProcessingJob', {
  appSpecification: {
    imageUri: 'imageUri',

    // the properties below are optional
    containerArguments: ['containerArguments'],
    containerEntrypoint: ['containerEntrypoint'],
  },
  processingResources: {
    clusterConfig: {
      instanceCount: 123,
      instanceType: 'instanceType',
      volumeSizeInGb: 123,

      // the properties below are optional
      volumeKmsKeyId: 'volumeKmsKeyId',
    },
  },
  roleArn: 'roleArn',

  // the properties below are optional
  environment: {
    environmentKey: 'environment',
  },
  experimentConfig: {
    experimentName: 'experimentName',
    runName: 'runName',
    trialComponentDisplayName: 'trialComponentDisplayName',
    trialName: 'trialName',
  },
  networkConfig: {
    enableInterContainerTrafficEncryption: false,
    enableNetworkIsolation: false,
    vpcConfig: {
      securityGroupIds: ['securityGroupIds'],
      subnets: ['subnets'],
    },
  },
  processingInputs: [{
    inputName: 'inputName',

    // the properties below are optional
    appManaged: false,
    datasetDefinition: {
      athenaDatasetDefinition: {
        catalog: 'catalog',
        database: 'database',
        outputFormat: 'outputFormat',
        outputS3Uri: 'outputS3Uri',
        queryString: 'queryString',

        // the properties below are optional
        kmsKeyId: 'kmsKeyId',
        outputCompression: 'outputCompression',
        workGroup: 'workGroup',
      },
      dataDistributionType: 'dataDistributionType',
      inputMode: 'inputMode',
      localPath: 'localPath',
      redshiftDatasetDefinition: {
        clusterId: 'clusterId',
        clusterRoleArn: 'clusterRoleArn',
        database: 'database',
        dbUser: 'dbUser',
        outputFormat: 'outputFormat',
        outputS3Uri: 'outputS3Uri',
        queryString: 'queryString',

        // the properties below are optional
        kmsKeyId: 'kmsKeyId',
        outputCompression: 'outputCompression',
      },
    },
    s3Input: {
      s3DataType: 's3DataType',
      s3Uri: 's3Uri',

      // the properties below are optional
      localPath: 'localPath',
      s3CompressionType: 's3CompressionType',
      s3DataDistributionType: 's3DataDistributionType',
      s3InputMode: 's3InputMode',
    },
  }],
  processingJobName: 'processingJobName',
  processingOutputConfig: {
    outputs: [{
      outputName: 'outputName',

      // the properties below are optional
      appManaged: false,
      featureStoreOutput: {
        featureGroupName: 'featureGroupName',
      },
      s3Output: {
        s3UploadMode: 's3UploadMode',
        s3Uri: 's3Uri',

        // the properties below are optional
        localPath: 'localPath',
      },
    }],

    // the properties below are optional
    kmsKeyId: 'kmsKeyId',
  },
  stoppingCondition: {
    maxRuntimeInSeconds: 123,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
});
```

## Initializer

```ts
new CfnProcessingJob(scope: Construct, id: string, props: CfnProcessingJobProps)
```

## Construct Props

- `appSpecification`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProcessingJob.AppSpecificationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnProcessingJob.AppSpecificationProperty.html) (required) — Configuration to run a processing job in a specified container image.

- `environment`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | { [key: string]: string } — Sets the environment variables in the Docker container.

- `experimentConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProcessingJob.ExperimentConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnProcessingJob.ExperimentConfigProperty.html) — Associates a SageMaker job as a trial component with an experiment and trial.

  Specified when you call the [CreateProcessingJob](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html) API.

- `networkConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProcessingJob.NetworkConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnProcessingJob.NetworkConfigProperty.html) — Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

- `processingInputs`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProcessingJob.ProcessingInputsObjectProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnProcessingJob.ProcessingInputsObjectProperty.html)[] — List of input configurations for the processing job.

- `processingJobName`: string — The name of the processing job.

  If you don't provide a job name, then a unique name is automatically created for the job.

- `processingOutputConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProcessingJob.ProcessingOutputConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnProcessingJob.ProcessingOutputConfigProperty.html) — Contains information about the output location for the compiled model and the target device that the model runs on.

  `TargetDevice` and `TargetPlatform` are mutually exclusive, so you need to choose one between the two to specify your target device or platform. If you cannot find your device you want to use from the `TargetDevice` list, use `TargetPlatform` to describe the platform of your edge device and `CompilerOptions` if there are specific settings that are required or recommended to use for particular TargetPlatform.

- `processingResources`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProcessingJob.ProcessingResourcesProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnProcessingJob.ProcessingResourcesProperty.html) (required) — Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job.

  In distributed training, you specify more than one instance.

- `roleArn`: string (required) — The ARN of the role used to create the processing job.

- `stoppingCondition`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProcessingJob.StoppingConditionProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnProcessingJob.StoppingConditionProperty.html) — Configures conditions under which the processing job should be stopped, such as how long the processing job has been running.

  After the condition is met, the processing job is stopped.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — An array of key-value pairs.

  For more information, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL) in the *AWS Billing and Cost Management User Guide* .

## Properties

- `appSpecification`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProcessingJob.AppSpecificationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnProcessingJob.AppSpecificationProperty.html) (required) — Configuration to run a processing job in a specified container image.

- `attrAutoMlJobArn`: string (required) — The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.

- `attrCreationTime`: string (required) — The time the processing job was created.

- `attrExitMessage`: string (required) — A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

- `attrFailureReason`: string (required) — A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

- `attrLastModifiedTime`: string (required) — The time the processing job was last modified.

- `attrMonitoringScheduleArn`: string (required) — The ARN of a monitoring schedule for an endpoint associated with this processing job.

- `attrProcessingEndTime`: string (required) — The time that the processing job ended.

- `attrProcessingJobArn`: string (required) — The ARN of the processing job.

- `attrProcessingJobStatus`: string (required) — The status of the processing job.

- `attrProcessingStartTime`: string (required) — The time that the processing job started.

- `attrTrainingJobArn`: string (required) — The ARN of the training job associated with this processing job.

- `cdkTagManager`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) (required) — Tag Manager which manages the tags for this resource.

- `CFN_RESOURCE_TYPE_NAME`: string (required) (static) — The CloudFormation resource type name for this resource class.

- `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) (required) — Options for this resource, such as condition, update policy etc.

- `cfnResourceType`: string (required) — AWS resource type.

- `creationStack`: string[] (required)

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required)

- `environment`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | { [key: string]: string } — Sets the environment variables in the Docker container.

- `experimentConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProcessingJob.ExperimentConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnProcessingJob.ExperimentConfigProperty.html) — Associates a SageMaker job as a trial component with an experiment and trial.

- `logicalId`: string (required) — 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)`.

- `networkConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProcessingJob.NetworkConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnProcessingJob.NetworkConfigProperty.html) — Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `processingInputs`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProcessingJob.ProcessingInputsObjectProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnProcessingJob.ProcessingInputsObjectProperty.html)[] — List of input configurations for the processing job.

- `processingJobName`: string — The name of the processing job.

- `processingJobRef`: [ProcessingJobReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_sagemaker.ProcessingJobReference.html) (required) — A reference to a ProcessingJob resource.

- `processingOutputConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProcessingJob.ProcessingOutputConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnProcessingJob.ProcessingOutputConfigProperty.html) — Contains information about the output location for the compiled model and the target device that the model runs on.

- `processingResources`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProcessingJob.ProcessingResourcesProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnProcessingJob.ProcessingResourcesProperty.html) (required) — Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job.

- `ref`: string (required) — 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`: string (required) — The ARN of the role used to create the processing job.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this element is defined.

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

- `stoppingCondition`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProcessingJob.StoppingConditionProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sagemaker.CfnProcessingJob.StoppingConditionProperty.html) — Configures conditions under which the processing job should be stopped, such as how long the processing job has been running.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — An array of key-value pairs.

## Methods

- `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`.

  **Parameters**

  - `path` — The path of the value to delete.

- `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead.

  This method has been renamed to `addResourceDependency` to more clearly
  set it apart from `construct.node.addDependency`. See the documentation
  of that function for more details.

- `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead.

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

  This method has been renamed to `addResourceDependency`, which makes it
  more clear that this method operates at a different level from the
  construct-level `construct.node.addDependency()` mechanism.

- `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata.

- `addOverride(path: string, value: any): void` — 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,
  ```typescript
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
  ```
  would add the overrides
  ```json
  "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.

  **Parameters**

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

- `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition.

  **Parameters**

  - `propertyPath` — The path to the property.

- `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property.

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

  **Parameters**

  - `propertyPath` — The path of the property.
  - `value` — The value.

- `addResourceDependency(target: CfnResource, reason?: string): void` — 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.

  This method only adds dependencies between L1 resources. If you are
  looking for a generic construct-to-construct dependency mechanism that works
  for all constructs including L2s, use `construct.node.addDependency` instead.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Sets the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  strength instead of the global default from the consuming stack's context.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — 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`). In some
  cases, a snapshot can be taken of the resource prior to deletion
  (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
  can be found in the following link:

- `arnForProcessingJob(resource: IProcessingJobRef): string` (static)

- `cfnPropertyName(cdkPropertyName: string): string`

- `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference` — 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.

  **Parameters**

  - `attributeName` — The name of the attribute.

- `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata.

- `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes.

  **Parameters**

  - `inspector` — tree inspector to collect and process attributes.

- `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

  Uses duck-typing instead of `instanceof` to allow stack elements from different
  versions of this library to be included in the same stack.

  **Returns:** The construct as a stack element or undefined if it is not a stack element.

- `isCfnProcessingJob(x: any): boolean` (static) — Checks whether the given object is a CfnProcessingJob.

- `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on.

  For resources depended on directly, returns the `CfnResource` object. For
  dependencies on other stacks, returns the `Stack` object. The order of the
  array is not guaranteed.

- `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID.

  **Parameters**

  - `newLogicalId` — The new logical ID to use for this stack element.

- `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `removeResourceDependency(target: CfnResource): void` — Indicates that this resource no longer depends on another resource.

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `replaceDependency(target: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another.

  **Parameters**

  - `target` — The dependency to replace.
  - `newTarget` — The new dependency to add.

- `toString(): string` — Returns a string representation of this construct.

  **Returns:** a string representation of this resource

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.