Package software.amazon.awscdk.services.sagemaker

Class CfnDataQualityJobDefinition

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.sagemaker.CfnDataQualityJobDefinition
All Implemented Interfaces:
IInspectable, ITaggable, IDataQualityJobDefinitionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:47.930Z") @Stability(Stable) public class CfnDataQualityJobDefinition extends CfnResource implements IInspectable, IDataQualityJobDefinitionRef, ITaggable
Creates a definition for a job that monitors data quality and drift.

For information about model monitor, see Amazon SageMaker AI Model Monitor .

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.*;
 CfnDataQualityJobDefinition cfnDataQualityJobDefinition = CfnDataQualityJobDefinition.Builder.create(this, "MyCfnDataQualityJobDefinition")
         .dataQualityAppSpecification(DataQualityAppSpecificationProperty.builder()
                 .imageUri("imageUri")
                 // the properties below are optional
                 .containerArguments(List.of("containerArguments"))
                 .containerEntrypoint(List.of("containerEntrypoint"))
                 .environment(Map.of(
                         "environmentKey", "environment"))
                 .postAnalyticsProcessorSourceUri("postAnalyticsProcessorSourceUri")
                 .recordPreprocessorSourceUri("recordPreprocessorSourceUri")
                 .build())
         .dataQualityJobInput(DataQualityJobInputProperty.builder()
                 .batchTransformInput(BatchTransformInputProperty.builder()
                         .dataCapturedDestinationS3Uri("dataCapturedDestinationS3Uri")
                         .datasetFormat(DatasetFormatProperty.builder()
                                 .csv(CsvProperty.builder()
                                         .header(false)
                                         .build())
                                 .json(JsonProperty.builder()
                                         .line(false)
                                         .build())
                                 .parquet(false)
                                 .build())
                         .localPath("localPath")
                         // the properties below are optional
                         .excludeFeaturesAttribute("excludeFeaturesAttribute")
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .build())
                 .endpointInput(EndpointInputProperty.builder()
                         .endpointName("endpointName")
                         .localPath("localPath")
                         // the properties below are optional
                         .excludeFeaturesAttribute("excludeFeaturesAttribute")
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .build())
                 .build())
         .dataQualityJobOutputConfig(MonitoringOutputConfigProperty.builder()
                 .monitoringOutputs(List.of(MonitoringOutputProperty.builder()
                         .s3Output(S3OutputProperty.builder()
                                 .localPath("localPath")
                                 .s3Uri("s3Uri")
                                 // the properties below are optional
                                 .s3UploadMode("s3UploadMode")
                                 .build())
                         .build()))
                 // the properties below are optional
                 .kmsKeyId("kmsKeyId")
                 .build())
         .jobResources(MonitoringResourcesProperty.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
         .dataQualityBaselineConfig(DataQualityBaselineConfigProperty.builder()
                 .baseliningJobName("baseliningJobName")
                 .constraintsResource(ConstraintsResourceProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 .statisticsResource(StatisticsResourceProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 .build())
         .endpointName("endpointName")
         .jobDefinitionName("jobDefinitionName")
         .networkConfig(NetworkConfigProperty.builder()
                 .enableInterContainerTrafficEncryption(false)
                 .enableNetworkIsolation(false)
                 .vpcConfig(VpcConfigProperty.builder()
                         .securityGroupIds(List.of("securityGroupIds"))
                         .subnets(List.of("subnets"))
                         .build())
                 .build())
         .stoppingCondition(StoppingConditionProperty.builder()
                 .maxRuntimeInSeconds(123)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDataQualityJobDefinition

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

    • CfnDataQualityJobDefinition

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

    • CfnDataQualityJobDefinition

      @Stability(Stable) public CfnDataQualityJobDefinition(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDataQualityJobDefinitionProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The time when the job definition was created.

    • getAttrJobDefinitionArn

      @Stability(Stable) @NotNull public String getAttrJobDefinitionArn()
      The Amazon Resource Name (ARN) of the job definition.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDataQualityJobDefinitionRef

      @Stability(Stable) @NotNull public DataQualityJobDefinitionReference getDataQualityJobDefinitionRef()
      A reference to a DataQualityJobDefinition resource.
      Specified by:
      getDataQualityJobDefinitionRef in interface IDataQualityJobDefinitionRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDataQualityAppSpecification

      @Stability(Stable) @NotNull public Object getDataQualityAppSpecification()
      Specifies the container that runs the monitoring job.

      Returns union: either IResolvable or CfnDataQualityJobDefinition.DataQualityAppSpecificationProperty

    • setDataQualityAppSpecification

      @Stability(Stable) public void setDataQualityAppSpecification(@NotNull IResolvable value)
      Specifies the container that runs the monitoring job.

    • setDataQualityAppSpecification

      @Stability(Stable) public void setDataQualityAppSpecification(@NotNull CfnDataQualityJobDefinition.DataQualityAppSpecificationProperty value)
      Specifies the container that runs the monitoring job.

    • getDataQualityJobInput

      @Stability(Stable) @NotNull public Object getDataQualityJobInput()
      A list of inputs for the monitoring job.

      Returns union: either IResolvable or CfnDataQualityJobDefinition.DataQualityJobInputProperty

    • setDataQualityJobInput

      @Stability(Stable) public void setDataQualityJobInput(@NotNull IResolvable value)
      A list of inputs for the monitoring job.

    • setDataQualityJobInput

      @Stability(Stable) public void setDataQualityJobInput(@NotNull CfnDataQualityJobDefinition.DataQualityJobInputProperty value)
      A list of inputs for the monitoring job.

    • getDataQualityJobOutputConfig

      @Stability(Stable) @NotNull public Object getDataQualityJobOutputConfig()
      The output configuration for monitoring jobs.

      Returns union: either IResolvable or CfnDataQualityJobDefinition.MonitoringOutputConfigProperty

    • setDataQualityJobOutputConfig

      @Stability(Stable) public void setDataQualityJobOutputConfig(@NotNull IResolvable value)
      The output configuration for monitoring jobs.

    • setDataQualityJobOutputConfig

      @Stability(Stable) public void setDataQualityJobOutputConfig(@NotNull CfnDataQualityJobDefinition.MonitoringOutputConfigProperty value)
      The output configuration for monitoring jobs.

    • getJobResources

      @Stability(Stable) @NotNull public Object getJobResources()
      Identifies the resources to deploy for a monitoring job.

      Returns union: either IResolvable or CfnDataQualityJobDefinition.MonitoringResourcesProperty

    • setJobResources

      @Stability(Stable) public void setJobResources(@NotNull IResolvable value)
      Identifies the resources to deploy for a monitoring job.

    • setJobResources

      @Stability(Stable) public void setJobResources(@NotNull CfnDataQualityJobDefinition.MonitoringResourcesProperty value)
      Identifies the resources to deploy for a monitoring job.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

    • getDataQualityBaselineConfig

      @Stability(Stable) @Nullable public Object getDataQualityBaselineConfig()
      Configures the constraints and baselines for the monitoring job.

      Returns union: either IResolvable or CfnDataQualityJobDefinition.DataQualityBaselineConfigProperty

    • setDataQualityBaselineConfig

      @Stability(Stable) public void setDataQualityBaselineConfig(@Nullable IResolvable value)
      Configures the constraints and baselines for the monitoring job.

    • setDataQualityBaselineConfig

      @Stability(Stable) public void setDataQualityBaselineConfig(@Nullable CfnDataQualityJobDefinition.DataQualityBaselineConfigProperty value)
      Configures the constraints and baselines for the monitoring job.

    • getEndpointName

      @Stability(Stable) @Nullable public String getEndpointName()
      The name of the endpoint used to run the monitoring job.

    • setEndpointName

      @Stability(Stable) public void setEndpointName(@Nullable String value)
      The name of the endpoint used to run the monitoring job.

    • getJobDefinitionName

      @Stability(Stable) @Nullable public String getJobDefinitionName()
      The name for the monitoring job definition.

    • setJobDefinitionName

      @Stability(Stable) public void setJobDefinitionName(@Nullable String value)
      The name for the monitoring job definition.

    • getNetworkConfig

      @Stability(Stable) @Nullable public Object getNetworkConfig()
      Specifies networking configuration for the monitoring job.

      Returns union: either IResolvable or CfnDataQualityJobDefinition.NetworkConfigProperty

    • setNetworkConfig

      @Stability(Stable) public void setNetworkConfig(@Nullable IResolvable value)
      Specifies networking configuration for the monitoring job.

    • setNetworkConfig

      @Stability(Stable) public void setNetworkConfig(@Nullable CfnDataQualityJobDefinition.NetworkConfigProperty value)
      Specifies networking configuration for the monitoring job.

    • getStoppingCondition

      @Stability(Stable) @Nullable public Object getStoppingCondition()
      A time limit for how long the monitoring job is allowed to run before stopping.

      Returns union: either IResolvable or CfnDataQualityJobDefinition.StoppingConditionProperty

    • setStoppingCondition

      @Stability(Stable) public void setStoppingCondition(@Nullable IResolvable value)
      A time limit for how long the monitoring job is allowed to run before stopping.

    • setStoppingCondition

      @Stability(Stable) public void setStoppingCondition(@Nullable CfnDataQualityJobDefinition.StoppingConditionProperty value)
      A time limit for how long the monitoring job is allowed to run before stopping.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.