Package software.amazon.awscdk.services.sagemaker

Interface CfnDataQualityJobDefinitionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataQualityJobDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:36.855Z")
@Stability(Stable)
public interface CfnDataQualityJobDefinitionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDataQualityJobDefinition.

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.*;
 CfnDataQualityJobDefinitionProps cfnDataQualityJobDefinitionProps = CfnDataQualityJobDefinitionProps.builder()
         .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:

• 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	CfnDataQualityJobDefinitionProps.Builder	A builder for CfnDataQualityJobDefinitionProps
static final class	CfnDataQualityJobDefinitionProps.Jsii$Proxy	An implementation for CfnDataQualityJobDefinitionProps

Method Summary

Modifier and Type	Method	Description
static CfnDataQualityJobDefinitionProps.Builder	builder()
Object	getDataQualityAppSpecification()	Specifies the container that runs the monitoring job.
default Object	getDataQualityBaselineConfig()	Configures the constraints and baselines for the monitoring job.
Object	getDataQualityJobInput()	A list of inputs for the monitoring job.
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.
Object	getJobResources()	Identifies the resources to deploy for a monitoring job.
default Object	getNetworkConfig()	Specifies networking configuration for the monitoring job.
String	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)
@NotNull
Object getDataQualityAppSpecification()

Specifies the container that runs the monitoring job.

See Also:

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

getDataQualityJobInput

@Stability(Stable)
@NotNull
Object getDataQualityJobInput()

A list of inputs for the monitoring job.

Currently endpoints are supported as monitoring inputs.

See Also:

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

getDataQualityJobOutputConfig

@Stability(Stable)
@NotNull
Object getDataQualityJobOutputConfig()

The output configuration for monitoring jobs.

See Also:

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

getJobResources

@Stability(Stable)
@NotNull
Object getJobResources()

Identifies the resources to deploy for a monitoring job.

See Also:

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

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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

See Also:

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

getDataQualityBaselineConfig

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

Configures the constraints and baselines for the monitoring job.

See Also:

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

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

getNetworkConfig

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

Specifies networking configuration for the monitoring job.

See Also:

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

getStoppingCondition

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

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

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 CfnDataQualityJobDefinitionProps.Builder builder()

Returns:

a CfnDataQualityJobDefinitionProps.Builder of CfnDataQualityJobDefinitionProps