interface CfnProcessingJobProps

Language	Type name
.NET	`Amazon.CDK.AWS.Sagemaker.CfnProcessingJobProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnProcessingJobProps`
Java	`software.amazon.awscdk.services.sagemaker.CfnProcessingJobProps`
Python	`aws_cdk.aws_sagemaker.CfnProcessingJobProps`
TypeScript	`aws-cdk-lib` » `aws_sagemaker` » `CfnProcessingJobProps`

Properties for defining a CfnProcessingJob.

Example

// 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 cfnProcessingJobProps: sagemaker.CfnProcessingJobProps = {
  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',
  }],
};

Properties

Name	Type	Description
appSpecification	`IResolvable` `\|` `AppSpecificationProperty`	Configuration to run a processing job in a specified container image.
processingResources	`IResolvable` `\|` `ProcessingResourcesProperty`	Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job.
roleArn	`string`	The ARN of the role used to create the processing job.
environment?	`{ [string]: string } \|` `IResolvable`	Sets the environment variables in the Docker container.
experimentConfig?	`IResolvable` `\|` `ExperimentConfigProperty`	Associates a SageMaker job as a trial component with an experiment and trial.
networkConfig?	`IResolvable` `\|` `NetworkConfigProperty`	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` `\|` `IResolvable` `\|` `ProcessingInputsObjectProperty[]`	List of input configurations for the processing job.
processingJobName?	`string`	The name of the processing job.
processingOutputConfig?	`IResolvable` `\|` `ProcessingOutputConfigProperty`	Contains information about the output location for the compiled model and the target device that the model runs on.
stoppingCondition?	`IResolvable` `\|` `StoppingConditionProperty`	Configures conditions under which the processing job should be stopped, such as how long the processing job has been running.
tags?	`CfnTag[]`	An array of key-value pairs.

appSpecification

Type: IResolvable | AppSpecificationProperty

Configuration to run a processing job in a specified container image.

processingResources

Type: IResolvable | ProcessingResourcesProperty

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

Type: string

The ARN of the role used to create the processing job.

environment?

Type: { [string]: string } | IResolvable (optional)

Sets the environment variables in the Docker container.

experimentConfig?

Type: IResolvable | ExperimentConfigProperty (optional)

Associates a SageMaker job as a trial component with an experiment and trial.

Specified when you call the CreateProcessingJob API.

networkConfig?

Type: IResolvable | NetworkConfigProperty (optional)

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?

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

List of input configurations for the processing job.

processingJobName?

Type: string (optional)

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?

Type: IResolvable | ProcessingOutputConfigProperty (optional)

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.

stoppingCondition?

Type: IResolvable | StoppingConditionProperty (optional)

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?

Type: CfnTag[] (optional)

An array of key-value pairs.

For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide .