CfnModelQualityJobDefinition

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.sagemaker.CfnModelQualityJobDefinition

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.903Z")
public class CfnModelQualityJobDefinition
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SageMaker::ModelQualityJobDefinition`.

Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor .

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;
 CfnModelQualityJobDefinition cfnModelQualityJobDefinition = CfnModelQualityJobDefinition.Builder.create(this, "MyCfnModelQualityJobDefinition")
         .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	Class and Description
`static interface`	`CfnModelQualityJobDefinition.BatchTransformInputProperty` Example:
`static class`	`CfnModelQualityJobDefinition.Builder` A fluent builder for `CfnModelQualityJobDefinition`.
`static interface`	`CfnModelQualityJobDefinition.ClusterConfigProperty` The configuration for the cluster of resources used to run the processing job.
`static interface`	`CfnModelQualityJobDefinition.ConstraintsResourceProperty` The constraints resource for a monitoring job.
`static interface`	`CfnModelQualityJobDefinition.CsvProperty` Example:
`static interface`	`CfnModelQualityJobDefinition.DatasetFormatProperty` Example:
`static interface`	`CfnModelQualityJobDefinition.EndpointInputProperty` Input object for the endpoint.
`static interface`	`CfnModelQualityJobDefinition.JsonProperty` Example:
`static interface`	`CfnModelQualityJobDefinition.ModelQualityAppSpecificationProperty` Container image configuration object for the monitoring job.
`static interface`	`CfnModelQualityJobDefinition.ModelQualityBaselineConfigProperty` Configuration for monitoring constraints and monitoring statistics.
`static interface`	`CfnModelQualityJobDefinition.ModelQualityJobInputProperty` The input for the model quality monitoring job.
`static interface`	`CfnModelQualityJobDefinition.MonitoringGroundTruthS3InputProperty` The ground truth labels for the dataset used for the monitoring job.
`static interface`	`CfnModelQualityJobDefinition.MonitoringOutputConfigProperty` The output configuration for monitoring jobs.
`static interface`	`CfnModelQualityJobDefinition.MonitoringOutputProperty` The output object for a monitoring job.
`static interface`	`CfnModelQualityJobDefinition.MonitoringResourcesProperty` Identifies the resources to deploy for a monitoring job.
`static interface`	`CfnModelQualityJobDefinition.NetworkConfigProperty` Networking options for a job, such as network traffic encryption between containers, whether to allow inbound and outbound network calls to and from containers, and the VPC subnets and security groups to use for VPC-enabled jobs.
`static interface`	`CfnModelQualityJobDefinition.S3OutputProperty` The Amazon S3 storage location where the results of a monitoring job are saved.
`static interface`	`CfnModelQualityJobDefinition.StoppingConditionProperty` Specifies a limit to how long a model training job or model compilation job can run.
`static interface`	`CfnModelQualityJobDefinition.VpcConfigProperty` Specifies a VPC that your training jobs and hosted models have access to.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnModelQualityJobDefinition(Construct scope, java.lang.String id, CfnModelQualityJobDefinitionProps props)` Create a new `AWS::SageMaker::ModelQualityJobDefinition`.
`protected`	`CfnModelQualityJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnModelQualityJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrCreationTime()` The time when the job definition was created.
`java.lang.String`	`getAttrJobDefinitionArn()` The Amazon Resource Name (ARN) of the job definition.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getEndpointName()` `AWS::SageMaker::ModelQualityJobDefinition.EndpointName`.
`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.
`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.
`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.
`java.lang.Object`	`getStoppingCondition()` A time limit for how long the monitoring job is allowed to run before stopping.
`TagManager`	`getTags()` An array of key-value pairs to apply to this resource.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setEndpointName(java.lang.String value)` `AWS::SageMaker::ModelQualityJobDefinition.EndpointName`.
`void`	`setJobDefinitionName(java.lang.String value)` The name of the monitoring job definition.
`void`	`setJobResources(CfnModelQualityJobDefinition.MonitoringResourcesProperty value)` Identifies the resources to deploy for a monitoring job.
`void`	`setJobResources(IResolvable value)` Identifies the resources to deploy for a monitoring job.
`void`	`setModelQualityAppSpecification(CfnModelQualityJobDefinition.ModelQualityAppSpecificationProperty value)` Container image configuration object for the monitoring job.
`void`	`setModelQualityAppSpecification(IResolvable value)` Container image configuration object for the monitoring job.
`void`	`setModelQualityBaselineConfig(CfnModelQualityJobDefinition.ModelQualityBaselineConfigProperty value)` Specifies the constraints and baselines for the monitoring job.
`void`	`setModelQualityBaselineConfig(IResolvable value)` Specifies the constraints and baselines for the monitoring job.
`void`	`setModelQualityJobInput(CfnModelQualityJobDefinition.ModelQualityJobInputProperty value)` A list of the inputs that are monitored.
`void`	`setModelQualityJobInput(IResolvable value)` A list of the inputs that are monitored.
`void`	`setModelQualityJobOutputConfig(CfnModelQualityJobDefinition.MonitoringOutputConfigProperty value)` The output configuration for monitoring jobs.
`void`	`setModelQualityJobOutputConfig(IResolvable value)` The output configuration for monitoring jobs.
`void`	`setNetworkConfig(CfnModelQualityJobDefinition.NetworkConfigProperty value)` Specifies the network configuration for the monitoring job.
`void`	`setNetworkConfig(IResolvable value)` Specifies the network configuration for the monitoring job.
`void`	`setRoleArn(java.lang.String value)` The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
`void`	`setStoppingCondition(CfnModelQualityJobDefinition.StoppingConditionProperty value)` A time limit for how long the monitoring job is allowed to run before stopping.
`void`	`setStoppingCondition(IResolvable value)` A time limit for how long the monitoring job is allowed to run before stopping.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnModelQualityJobDefinition
```
protected CfnModelQualityJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnModelQualityJobDefinition
```
protected CfnModelQualityJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnModelQualityJobDefinition
```
public CfnModelQualityJobDefinition(Construct scope,
                                    java.lang.String id,
                                    CfnModelQualityJobDefinitionProps props)
```
    Create a new `AWS::SageMaker::ModelQualityJobDefinition`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrCreationTime
```
public java.lang.String getAttrCreationTime()
```
    The time when the job definition was created.
  - getAttrJobDefinitionArn
```
public java.lang.String getAttrJobDefinitionArn()
```
    The Amazon Resource Name (ARN) of the job definition.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    An array of key-value pairs to apply to this resource.
    For more information, see Tag .
  - getJobResources
```
public java.lang.Object getJobResources()
```
    Identifies the resources to deploy for a monitoring job.
  - setJobResources
```
public void setJobResources(IResolvable value)
```
    Identifies the resources to deploy for a monitoring job.
  - setJobResources
```
public void setJobResources(CfnModelQualityJobDefinition.MonitoringResourcesProperty value)
```
    Identifies the resources to deploy for a monitoring job.
  - getModelQualityAppSpecification
```
public java.lang.Object getModelQualityAppSpecification()
```
    Container image configuration object for the monitoring job.
  - setModelQualityAppSpecification
```
public void setModelQualityAppSpecification(IResolvable value)
```
    Container image configuration object for the monitoring job.
  - setModelQualityAppSpecification
```
public void setModelQualityAppSpecification(CfnModelQualityJobDefinition.ModelQualityAppSpecificationProperty value)
```
    Container image configuration object for the monitoring job.
  - getModelQualityJobInput
```
public java.lang.Object getModelQualityJobInput()
```
    A list of the inputs that are monitored.
    Currently endpoints are supported.
  - setModelQualityJobInput
```
public void setModelQualityJobInput(IResolvable value)
```
    A list of the inputs that are monitored.
    Currently endpoints are supported.
  - setModelQualityJobInput
```
public void setModelQualityJobInput(CfnModelQualityJobDefinition.ModelQualityJobInputProperty value)
```
    A list of the inputs that are monitored.
    Currently endpoints are supported.
  - getModelQualityJobOutputConfig
```
public java.lang.Object getModelQualityJobOutputConfig()
```
    The output configuration for monitoring jobs.
  - setModelQualityJobOutputConfig
```
public void setModelQualityJobOutputConfig(IResolvable value)
```
    The output configuration for monitoring jobs.
  - setModelQualityJobOutputConfig
```
public void setModelQualityJobOutputConfig(CfnModelQualityJobDefinition.MonitoringOutputConfigProperty value)
```
    The output configuration for monitoring jobs.
  - getRoleArn
```
public java.lang.String getRoleArn()
```
    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
  - setRoleArn
```
public void setRoleArn(java.lang.String value)
```
    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
  - getEndpointName
```
public java.lang.String getEndpointName()
```
    `AWS::SageMaker::ModelQualityJobDefinition.EndpointName`.
  - setEndpointName
```
public void setEndpointName(java.lang.String value)
```
    `AWS::SageMaker::ModelQualityJobDefinition.EndpointName`.
  - getJobDefinitionName
```
public java.lang.String getJobDefinitionName()
```
    The name of the monitoring job definition.
  - setJobDefinitionName
```
public void setJobDefinitionName(java.lang.String value)
```
    The name of the monitoring job definition.
  - getModelQualityBaselineConfig
```
public java.lang.Object getModelQualityBaselineConfig()
```
    Specifies the constraints and baselines for the monitoring job.
  - setModelQualityBaselineConfig
```
public void setModelQualityBaselineConfig(IResolvable value)
```
    Specifies the constraints and baselines for the monitoring job.
  - setModelQualityBaselineConfig
```
public void setModelQualityBaselineConfig(CfnModelQualityJobDefinition.ModelQualityBaselineConfigProperty value)
```
    Specifies the constraints and baselines for the monitoring job.
  - getNetworkConfig
```
public java.lang.Object getNetworkConfig()
```
    Specifies the network configuration for the monitoring job.
  - setNetworkConfig
```
public void setNetworkConfig(IResolvable value)
```
    Specifies the network configuration for the monitoring job.
  - setNetworkConfig
```
public void setNetworkConfig(CfnModelQualityJobDefinition.NetworkConfigProperty value)
```
    Specifies the network configuration for the monitoring job.
  - getStoppingCondition
```
public java.lang.Object getStoppingCondition()
```
    A time limit for how long the monitoring job is allowed to run before stopping.
  - setStoppingCondition
```
public void setStoppingCondition(IResolvable value)
```
    A time limit for how long the monitoring job is allowed to run before stopping.
  - setStoppingCondition
```
public void setStoppingCondition(CfnModelQualityJobDefinition.StoppingConditionProperty value)
```
    A time limit for how long the monitoring job is allowed to run before stopping.

Class CfnModelQualityJobDefinition

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnModelQualityJobDefinition

CfnModelQualityJobDefinition

CfnModelQualityJobDefinition

Method Detail

inspect

renderProperties

getAttrCreationTime

getAttrJobDefinitionArn

getCfnProperties

getTags

getJobResources

setJobResources

setJobResources

getModelQualityAppSpecification

setModelQualityAppSpecification

setModelQualityAppSpecification

getModelQualityJobInput

setModelQualityJobInput

setModelQualityJobInput

getModelQualityJobOutputConfig

setModelQualityJobOutputConfig

setModelQualityJobOutputConfig

getRoleArn

setRoleArn

getEndpointName

setEndpointName

getJobDefinitionName

setJobDefinitionName

getModelQualityBaselineConfig

setModelQualityBaselineConfig

setModelQualityBaselineConfig

getNetworkConfig

setNetworkConfig

setNetworkConfig

getStoppingCondition

setStoppingCondition

setStoppingCondition