Package software.amazon.awscdk.services.sagemaker

Interface CfnModelQualityJobDefinitionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelQualityJobDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:35.461Z")
@Stability(Stable)
public interface CfnModelQualityJobDefinitionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnModelQualityJobDefinition.

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;
 CfnModelQualityJobDefinitionProps cfnModelQualityJobDefinitionProps = CfnModelQualityJobDefinitionProps.builder()
         .jobResources(MonitoringResourcesProperty.builder()
                 .clusterConfig(ClusterConfigProperty.builder()
                         .instanceCount(123)
                         .instanceType("instanceType")
                         .volumeSizeInGb(123)
                         // the properties below are optional
                         .volumeKmsKeyId("volumeKmsKeyId")
                         .build())
                 .build())
         .modelQualityAppSpecification(ModelQualityAppSpecificationProperty.builder()
                 .imageUri("imageUri")
                 .problemType("problemType")
                 // the properties below are optional
                 .containerArguments(List.of("containerArguments"))
                 .containerEntrypoint(List.of("containerEntrypoint"))
                 .environment(Map.of(
                         "environmentKey", "environment"))
                 .postAnalyticsProcessorSourceUri("postAnalyticsProcessorSourceUri")
                 .recordPreprocessorSourceUri("recordPreprocessorSourceUri")
                 .build())
         .modelQualityJobInput(ModelQualityJobInputProperty.builder()
                 .groundTruthS3Input(MonitoringGroundTruthS3InputProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 // the properties below are optional
                 .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
                         .endTimeOffset("endTimeOffset")
                         .inferenceAttribute("inferenceAttribute")
                         .probabilityAttribute("probabilityAttribute")
                         .probabilityThresholdAttribute(123)
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .startTimeOffset("startTimeOffset")
                         .build())
                 .endpointInput(EndpointInputProperty.builder()
                         .endpointName("endpointName")
                         .localPath("localPath")
                         // the properties below are optional
                         .endTimeOffset("endTimeOffset")
                         .inferenceAttribute("inferenceAttribute")
                         .probabilityAttribute("probabilityAttribute")
                         .probabilityThresholdAttribute(123)
                         .s3DataDistributionType("s3DataDistributionType")
                         .s3InputMode("s3InputMode")
                         .startTimeOffset("startTimeOffset")
                         .build())
                 .build())
         .modelQualityJobOutputConfig(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())
         .roleArn("roleArn")
         // the properties below are optional
         .endpointName("endpointName")
         .jobDefinitionName("jobDefinitionName")
         .modelQualityBaselineConfig(ModelQualityBaselineConfigProperty.builder()
                 .baseliningJobName("baseliningJobName")
                 .constraintsResource(ConstraintsResourceProperty.builder()
                         .s3Uri("s3Uri")
                         .build())
                 .build())
         .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	Description
static final class	CfnModelQualityJobDefinitionProps.Builder	A builder for CfnModelQualityJobDefinitionProps
static final class	CfnModelQualityJobDefinitionProps.Jsii$Proxy	An implementation for CfnModelQualityJobDefinitionProps

Method Summary

Modifier and Type	Method	Description
static CfnModelQualityJobDefinitionProps.Builder	builder()
default String	getEndpointName()	AWS::SageMaker::ModelQualityJobDefinition.EndpointName.
default String	getJobDefinitionName()	The name of the monitoring job definition.
Object	getJobResources()	Identifies the resources to deploy for a monitoring job.
Object	getModelQualityAppSpecification()	Container image configuration object for the monitoring job.
default Object	getModelQualityBaselineConfig()	Specifies the constraints and baselines for the monitoring job.
Object	getModelQualityJobInput()	A list of the inputs that are monitored.
Object	getModelQualityJobOutputConfig()	The output configuration for monitoring jobs.
default Object	getNetworkConfig()	Specifies the network 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

getJobResources

@Stability(Stable)
@NotNull
Object getJobResources()

Identifies the resources to deploy for a monitoring job.

getModelQualityAppSpecification

@Stability(Stable)
@NotNull
Object getModelQualityAppSpecification()

Container image configuration object for the monitoring job.

getModelQualityJobInput

@Stability(Stable)
@NotNull
Object getModelQualityJobInput()

A list of the inputs that are monitored.

Currently endpoints are supported.

getModelQualityJobOutputConfig

@Stability(Stable)
@NotNull
Object getModelQualityJobOutputConfig()

The output configuration for monitoring jobs.

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.

getEndpointName

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

AWS::SageMaker::ModelQualityJobDefinition.EndpointName.

getJobDefinitionName

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

The name of the monitoring job definition.

getModelQualityBaselineConfig

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

Specifies the constraints and baselines for the monitoring job.

getNetworkConfig

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

Specifies the network configuration for the monitoring job.

getStoppingCondition

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

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

getTags

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

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

For more information, see Tag .

builder

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

Returns:

a CfnModelQualityJobDefinitionProps.Builder of CfnModelQualityJobDefinitionProps