software.amazon.awscdk.services.sagemaker

Interface CfnDataQualityJobDefinitionProps

All Known Implementing Classes:

CfnDataQualityJobDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:25.314Z")
public interface CfnDataQualityJobDefinitionProps

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.*;
 Object json;
 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(json)
                                 .parquet(false)
                                 .build())
                         .localPath("localPath")
                         // the properties below are optional
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .build())
                 .endpointInput(EndpointInputProperty.builder()
                         .endpointName("endpointName")
                         .localPath("localPath")
                         // the properties below are optional
                         .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();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getDataQualityAppSpecification

java.lang.Object getDataQualityAppSpecification()

Specifies the container that runs the monitoring job.

getDataQualityJobInput

java.lang.Object getDataQualityJobInput()

A list of inputs for the monitoring job.

Currently endpoints are supported as monitoring inputs.

getDataQualityJobOutputConfig

java.lang.Object getDataQualityJobOutputConfig()

The output configuration for monitoring jobs.

getJobResources

java.lang.Object getJobResources()

Identifies the resources to deploy for a monitoring job.

getRoleArn

java.lang.String getRoleArn()

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

getDataQualityBaselineConfig

default java.lang.Object getDataQualityBaselineConfig()

Configures the constraints and baselines for the monitoring job.

getEndpointName

default java.lang.String getEndpointName()

`AWS::SageMaker::DataQualityJobDefinition.EndpointName`.

getJobDefinitionName

default java.lang.String getJobDefinitionName()

The name for the monitoring job definition.

getNetworkConfig

default java.lang.Object getNetworkConfig()

Specifies networking configuration for the monitoring job.

getStoppingCondition

default java.lang.Object getStoppingCondition()

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

getTags

default java.util.List<CfnTag> getTags()

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

For more information, see Tag .

builder

static CfnDataQualityJobDefinitionProps.Builder builder()

Returns:

a CfnDataQualityJobDefinitionProps.Builder of CfnDataQualityJobDefinitionProps