Package software.amazon.awscdk.services.sagemaker

Interface CfnProcessingJobProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProcessingJobProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-12-01T16:02:29.328Z")
@Stability(Stable)
public interface CfnProcessingJobProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.sagemaker.*;
 CfnProcessingJobProps cfnProcessingJobProps = CfnProcessingJobProps.builder()
         .appSpecification(AppSpecificationProperty.builder()
                 .imageUri("imageUri")
                 // the properties below are optional
                 .containerArguments(List.of("containerArguments"))
                 .containerEntrypoint(List.of("containerEntrypoint"))
                 .build())
         .processingResources(ProcessingResourcesProperty.builder()
                 .clusterConfig(ClusterConfigProperty.builder()
                         .instanceCount(123)
                         .instanceType("instanceType")
                         .volumeSizeInGb(123)
                         // the properties below are optional
                         .volumeKmsKeyId("volumeKmsKeyId")
                         .build())
                 .build())
         .roleArn("roleArn")
         // the properties below are optional
         .environment(Map.of(
                 "environmentKey", "environment"))
         .experimentConfig(ExperimentConfigProperty.builder()
                 .experimentName("experimentName")
                 .runName("runName")
                 .trialComponentDisplayName("trialComponentDisplayName")
                 .trialName("trialName")
                 .build())
         .networkConfig(NetworkConfigProperty.builder()
                 .enableInterContainerTrafficEncryption(false)
                 .enableNetworkIsolation(false)
                 .vpcConfig(VpcConfigProperty.builder()
                         .securityGroupIds(List.of("securityGroupIds"))
                         .subnets(List.of("subnets"))
                         .build())
                 .build())
         .processingInputs(List.of(ProcessingInputsObjectProperty.builder()
                 .inputName("inputName")
                 // the properties below are optional
                 .appManaged(false)
                 .datasetDefinition(DatasetDefinitionProperty.builder()
                         .athenaDatasetDefinition(AthenaDatasetDefinitionProperty.builder()
                                 .catalog("catalog")
                                 .database("database")
                                 .outputFormat("outputFormat")
                                 .outputS3Uri("outputS3Uri")
                                 .queryString("queryString")
                                 // the properties below are optional
                                 .kmsKeyId("kmsKeyId")
                                 .outputCompression("outputCompression")
                                 .workGroup("workGroup")
                                 .build())
                         .dataDistributionType("dataDistributionType")
                         .inputMode("inputMode")
                         .localPath("localPath")
                         .redshiftDatasetDefinition(RedshiftDatasetDefinitionProperty.builder()
                                 .clusterId("clusterId")
                                 .clusterRoleArn("clusterRoleArn")
                                 .database("database")
                                 .dbUser("dbUser")
                                 .outputFormat("outputFormat")
                                 .outputS3Uri("outputS3Uri")
                                 .queryString("queryString")
                                 // the properties below are optional
                                 .kmsKeyId("kmsKeyId")
                                 .outputCompression("outputCompression")
                                 .build())
                         .build())
                 .s3Input(S3InputProperty.builder()
                         .s3DataType("s3DataType")
                         .s3Uri("s3Uri")
                         // the properties below are optional
                         .localPath("localPath")
                         .s3CompressionType("s3CompressionType")
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .build())
                 .build()))
         .processingJobName("processingJobName")
         .processingOutputConfig(ProcessingOutputConfigProperty.builder()
                 .outputs(List.of(ProcessingOutputsObjectProperty.builder()
                         .outputName("outputName")
                         // the properties below are optional
                         .appManaged(false)
                         .featureStoreOutput(FeatureStoreOutputProperty.builder()
                                 .featureGroupName("featureGroupName")
                                 .build())
                         .s3Output(S3OutputProperty.builder()
                                 .s3UploadMode("s3UploadMode")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .localPath("localPath")
                                 .build())
                         .build()))
                 // the properties below are optional
                 .kmsKeyId("kmsKeyId")
                 .build())
         .stoppingCondition(StoppingConditionProperty.builder()
                 .maxRuntimeInSeconds(123)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProcessingJobProps.Builder	A builder for CfnProcessingJobProps
static final class	CfnProcessingJobProps.Jsii$Proxy	An implementation for CfnProcessingJobProps

Method Summary

Modifier and Type	Method	Description
static CfnProcessingJobProps.Builder	builder()
Object	getAppSpecification()	Configuration to run a processing job in a specified container image.
default Object	getEnvironment()	Sets the environment variables in the Docker container.
default Object	getExperimentConfig()	Associates a SageMaker job as a trial component with an experiment and trial.
default Object	getNetworkConfig()	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.
default Object	getProcessingInputs()	List of input configurations for the processing job.
default String	getProcessingJobName()	The name of the processing job.
default Object	getProcessingOutputConfig()	Contains information about the output location for the compiled model and the target device that the model runs on.
Object	getProcessingResources()	Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job.
String	getRoleArn()	The ARN of the role used to create the processing job.
default Object	getStoppingCondition()	Configures conditions under which the processing job should be stopped, such as how long the processing job has been running.
default List<CfnTag>	getTags()	An array of key-value pairs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppSpecification

@Stability(Stable)
@NotNull
Object getAppSpecification()

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

Returns union: either IResolvable or CfnProcessingJob.AppSpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-appspecification

getProcessingResources

@Stability(Stable)
@NotNull
Object getProcessingResources()

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.

Returns union: either IResolvable or CfnProcessingJob.ProcessingResourcesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processingresources

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-rolearn

getEnvironment

@Stability(Stable)
@Nullable
default Object getEnvironment()

Sets the environment variables in the Docker container.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-environment

getExperimentConfig

@Stability(Stable)
@Nullable
default Object getExperimentConfig()

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

Specified when you call the CreateProcessingJob API.

Returns union: either IResolvable or CfnProcessingJob.ExperimentConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-experimentconfig

getNetworkConfig

@Stability(Stable)
@Nullable
default Object getNetworkConfig()

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.

Returns union: either IResolvable or CfnProcessingJob.NetworkConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-networkconfig

getProcessingInputs

@Stability(Stable)
@Nullable
default Object getProcessingInputs()

List of input configurations for the processing job.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnProcessingJob.ProcessingInputsObjectProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processinginputs

getProcessingJobName

@Stability(Stable)
@Nullable
default String getProcessingJobName()

The name of the processing job.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processingjobname

getProcessingOutputConfig

@Stability(Stable)
@Nullable
default Object getProcessingOutputConfig()

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.

Returns union: either IResolvable or CfnProcessingJob.ProcessingOutputConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-processingoutputconfig

getStoppingCondition

@Stability(Stable)
@Nullable
default Object getStoppingCondition()

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.

Returns union: either IResolvable or CfnProcessingJob.StoppingConditionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-stoppingcondition

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-processingjob.html#cfn-sagemaker-processingjob-tags

builder

@Stability(Stable)
static CfnProcessingJobProps.Builder builder()

Returns:

a CfnProcessingJobProps.Builder of CfnProcessingJobProps