software.amazon.awscdk.services.sagemaker

Interface CfnModelQualityJobDefinitionProps

All Known Implementing Classes:

CfnModelQualityJobDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:34.834Z")
public interface CfnModelQualityJobDefinitionProps

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.*;
 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()
                 .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())
                 .groundTruthS3Input(MonitoringGroundTruthS3InputProperty.builder()
                         .s3Uri("s3Uri")
                         .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
         .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 and Description
static class	CfnModelQualityJobDefinitionProps.Builder A builder for CfnModelQualityJobDefinitionProps
static class	CfnModelQualityJobDefinitionProps.Jsii$Proxy An implementation for CfnModelQualityJobDefinitionProps

Method Summary

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

getJobResources

java.lang.Object getJobResources()

Identifies the resources to deploy for a monitoring job.

getModelQualityAppSpecification

java.lang.Object getModelQualityAppSpecification()

Container image configuration object for the monitoring job.

getModelQualityJobInput

java.lang.Object getModelQualityJobInput()

A list of the inputs that are monitored.

Currently endpoints are supported.

getModelQualityJobOutputConfig

java.lang.Object getModelQualityJobOutputConfig()

The output configuration for monitoring jobs.

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.

getJobDefinitionName

default java.lang.String getJobDefinitionName()

The name of the monitoring job definition.

getModelQualityBaselineConfig

default java.lang.Object getModelQualityBaselineConfig()

Specifies the constraints and baselines for the monitoring job.

getNetworkConfig

default java.lang.Object getNetworkConfig()

Specifies the network 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 CfnModelQualityJobDefinitionProps.Builder builder()

Returns:

a CfnModelQualityJobDefinitionProps.Builder of CfnModelQualityJobDefinitionProps