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

Interface CfnDataQualityJobDefinitionMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataQualityJobDefinitionMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:04.890Z")
@Stability(Stable)
public interface CfnDataQualityJobDefinitionMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnDataQualityJobDefinitionPropsMixin.

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.*;
 CfnDataQualityJobDefinitionMixinProps cfnDataQualityJobDefinitionMixinProps = CfnDataQualityJobDefinitionMixinProps.builder()
         .dataQualityAppSpecification(DataQualityAppSpecificationProperty.builder()
                 .containerArguments(List.of("containerArguments"))
                 .containerEntrypoint(List.of("containerEntrypoint"))
                 .environment(Map.of(
                         "environmentKey", "environment"))
                 .imageUri("imageUri")
                 .postAnalyticsProcessorSourceUri("postAnalyticsProcessorSourceUri")
                 .recordPreprocessorSourceUri("recordPreprocessorSourceUri")
                 .build())
         .dataQualityBaselineConfig(DataQualityBaselineConfigProperty.builder()
                 .baseliningJobName("baseliningJobName")
                 .constraintsResource(ConstraintsResourceProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 .statisticsResource(StatisticsResourceProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 .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())
                         .excludeFeaturesAttribute("excludeFeaturesAttribute")
                         .localPath("localPath")
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .build())
                 .endpointInput(EndpointInputProperty.builder()
                         .endpointName("endpointName")
                         .excludeFeaturesAttribute("excludeFeaturesAttribute")
                         .localPath("localPath")
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .build())
                 .build())
         .dataQualityJobOutputConfig(MonitoringOutputConfigProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .monitoringOutputs(List.of(MonitoringOutputProperty.builder()
                         .s3Output(S3OutputProperty.builder()
                                 .localPath("localPath")
                                 .s3UploadMode("s3UploadMode")
                                 .s3Uri("s3Uri")
                                 .build())
                         .build()))
                 .build())
         .endpointName("endpointName")
         .jobDefinitionName("jobDefinitionName")
         .jobResources(MonitoringResourcesProperty.builder()
                 .clusterConfig(ClusterConfigProperty.builder()
                         .instanceCount(123)
                         .instanceType("instanceType")
                         .volumeKmsKeyId("volumeKmsKeyId")
                         .volumeSizeInGb(123)
                         .build())
                 .build())
         .networkConfig(NetworkConfigProperty.builder()
                 .enableInterContainerTrafficEncryption(false)
                 .enableNetworkIsolation(false)
                 .vpcConfig(VpcConfigProperty.builder()
                         .securityGroupIds(List.of("securityGroupIds"))
                         .subnets(List.of("subnets"))
                         .build())
                 .build())
         .roleArn("roleArn")
         .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-dataqualityjobdefinition.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataQualityJobDefinitionMixinProps.Builder	builder()
default Object	getDataQualityAppSpecification()	Specifies the container that runs the monitoring job.
default Object	getDataQualityBaselineConfig()	Configures the constraints and baselines for the monitoring job.
default Object	getDataQualityJobInput()	A list of inputs for the monitoring job.
default Object	getDataQualityJobOutputConfig()	The output configuration for monitoring jobs.
default String	getEndpointName()	The name of the endpoint used to run the monitoring job.
default String	getJobDefinitionName()	The name for the monitoring job definition.
default Object	getJobResources()	Identifies the resources to deploy for a monitoring job.
default Object	getNetworkConfig()	Specifies networking configuration for the monitoring job.
default Object	getRoleArn()	The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
default Object	getStoppingCondition()	A time limit for how long the monitoring job is allowed to run before stopping.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataQualityAppSpecification

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

Specifies the container that runs the monitoring job.

Returns union: either IResolvable or CfnDataQualityJobDefinitionPropsMixin.DataQualityAppSpecificationProperty

See Also:

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

getDataQualityBaselineConfig

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

Configures the constraints and baselines for the monitoring job.

Returns union: either IResolvable or CfnDataQualityJobDefinitionPropsMixin.DataQualityBaselineConfigProperty

See Also:

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

getDataQualityJobInput

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

A list of inputs for the monitoring job.

Currently endpoints are supported as monitoring inputs.

Returns union: either IResolvable or CfnDataQualityJobDefinitionPropsMixin.DataQualityJobInputProperty

See Also:

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

getDataQualityJobOutputConfig

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

The output configuration for monitoring jobs.

Returns union: either IResolvable or CfnDataQualityJobDefinitionPropsMixin.MonitoringOutputConfigProperty

See Also:

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

getEndpointName

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

The name of the endpoint used to run the monitoring job.

See Also:

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

getJobDefinitionName

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

The name for the monitoring job definition.

See Also:

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

getJobResources

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

Identifies the resources to deploy for a monitoring job.

Returns union: either IResolvable or CfnDataQualityJobDefinitionPropsMixin.MonitoringResourcesProperty

See Also:

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

getNetworkConfig

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

Specifies networking configuration for the monitoring job.

Returns union: either IResolvable or CfnDataQualityJobDefinitionPropsMixin.NetworkConfigProperty

See Also:

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

getRoleArn

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

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

Returns union: either String or IRoleRef

See Also:

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

getStoppingCondition

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

A time limit for how long the monitoring job is allowed to run before stopping.

Returns union: either IResolvable or CfnDataQualityJobDefinitionPropsMixin.StoppingConditionProperty

See Also:

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

getTags

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

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See Also:

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

builder

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

Returns:

a CfnDataQualityJobDefinitionMixinProps.Builder of CfnDataQualityJobDefinitionMixinProps