Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnProcessingJobPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnProcessingJobPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:05.155Z") @Stability(Stable) public class CfnProcessingJobPropsMixin extends Mixin implements software.constructs.IMixin
An Amazon SageMaker processing job that is used to analyze data and evaluate models.

For more information, see Process Data and Evaluate Models .

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 API but not deleted. Any tags associated with the processing job are deleted using the DeleteTags 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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnProcessingJobPropsMixin cfnProcessingJobPropsMixin = CfnProcessingJobPropsMixin.Builder.create(CfnProcessingJobMixinProps.builder()
         .appSpecification(AppSpecificationProperty.builder()
                 .containerArguments(List.of("containerArguments"))
                 .containerEntrypoint(List.of("containerEntrypoint"))
                 .imageUri("imageUri")
                 .build())
         .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()
                 .appManaged(false)
                 .datasetDefinition(DatasetDefinitionProperty.builder()
                         .athenaDatasetDefinition(AthenaDatasetDefinitionProperty.builder()
                                 .catalog("catalog")
                                 .database("database")
                                 .kmsKeyId("kmsKeyId")
                                 .outputCompression("outputCompression")
                                 .outputFormat("outputFormat")
                                 .outputS3Uri("outputS3Uri")
                                 .queryString("queryString")
                                 .workGroup("workGroup")
                                 .build())
                         .dataDistributionType("dataDistributionType")
                         .inputMode("inputMode")
                         .localPath("localPath")
                         .redshiftDatasetDefinition(RedshiftDatasetDefinitionProperty.builder()
                                 .clusterId("clusterId")
                                 .clusterRoleArn("clusterRoleArn")
                                 .database("database")
                                 .dbUser("dbUser")
                                 .kmsKeyId("kmsKeyId")
                                 .outputCompression("outputCompression")
                                 .outputFormat("outputFormat")
                                 .outputS3Uri("outputS3Uri")
                                 .queryString("queryString")
                                 .build())
                         .build())
                 .inputName("inputName")
                 .s3Input(S3InputProperty.builder()
                         .localPath("localPath")
                         .s3CompressionType("s3CompressionType")
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3DataType("s3DataType")
                         .s3InputMode("s3InputMode")
                         .s3Uri("s3Uri")
                         .build())
                 .build()))
         .processingJobName("processingJobName")
         .processingOutputConfig(ProcessingOutputConfigProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .outputs(List.of(ProcessingOutputsObjectProperty.builder()
                         .appManaged(false)
                         .featureStoreOutput(FeatureStoreOutputProperty.builder()
                                 .featureGroupName("featureGroupName")
                                 .build())
                         .outputName("outputName")
                         .s3Output(S3OutputProperty.builder()
                                 .localPath("localPath")
                                 .s3UploadMode("s3UploadMode")
                                 .s3Uri("s3Uri")
                                 .build())
                         .build()))
                 .build())
         .processingResources(ProcessingResourcesProperty.builder()
                 .clusterConfig(ClusterConfigProperty.builder()
                         .instanceCount(123)
                         .instanceType("instanceType")
                         .volumeKmsKeyId("volumeKmsKeyId")
                         .volumeSizeInGb(123)
                         .build())
                 .build())
         .roleArn("roleArn")
         .stoppingCondition(StoppingConditionProperty.builder()
                 .maxRuntimeInSeconds(123)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnProcessingJobPropsMixin

      protected CfnProcessingJobPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnProcessingJobPropsMixin

      protected CfnProcessingJobPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnProcessingJobPropsMixin

      @Stability(Stable) public CfnProcessingJobPropsMixin(@NotNull CfnProcessingJobMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::SageMaker::ProcessingJob.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnProcessingJobPropsMixin

      @Stability(Stable) public CfnProcessingJobPropsMixin(@NotNull CfnProcessingJobMixinProps props)
      Create a mixin to apply properties to AWS::SageMaker::ProcessingJob.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnProcessingJobMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()