interface CfnModelQualityJobDefinitionMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins.CfnModelQualityJobDefinitionMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awssagemaker/mixins#CfnModelQualityJobDefinitionMixinProps
Java	software.amazon.awscdk.mixins.preview.services.sagemaker.mixins.CfnModelQualityJobDefinitionMixinProps
Python	aws_cdk.mixins_preview.aws_sagemaker.mixins.CfnModelQualityJobDefinitionMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_sagemaker » mixins » CfnModelQualityJobDefinitionMixinProps

Properties for CfnModelQualityJobDefinitionPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as sagemaker_mixins } from '@aws-cdk/mixins-preview/aws-sagemaker';
const cfnModelQualityJobDefinitionMixinProps: sagemaker_mixins.CfnModelQualityJobDefinitionMixinProps = {
  endpointName: 'endpointName',
  jobDefinitionName: 'jobDefinitionName',
  jobResources: {
    clusterConfig: {
      instanceCount: 123,
      instanceType: 'instanceType',
      volumeKmsKeyId: 'volumeKmsKeyId',
      volumeSizeInGb: 123,
    },
  },
  modelQualityAppSpecification: {
    containerArguments: ['containerArguments'],
    containerEntrypoint: ['containerEntrypoint'],
    environment: {
      environmentKey: 'environment',
    },
    imageUri: 'imageUri',
    postAnalyticsProcessorSourceUri: 'postAnalyticsProcessorSourceUri',
    problemType: 'problemType',
    recordPreprocessorSourceUri: 'recordPreprocessorSourceUri',
  },
  modelQualityBaselineConfig: {
    baseliningJobName: 'baseliningJobName',
    constraintsResource: {
      s3Uri: 's3Uri',
    },
  },
  modelQualityJobInput: {
    batchTransformInput: {
      dataCapturedDestinationS3Uri: 'dataCapturedDestinationS3Uri',
      datasetFormat: {
        csv: {
          header: false,
        },
        json: {
          line: false,
        },
        parquet: false,
      },
      endTimeOffset: 'endTimeOffset',
      inferenceAttribute: 'inferenceAttribute',
      localPath: 'localPath',
      probabilityAttribute: 'probabilityAttribute',
      probabilityThresholdAttribute: 123,
      s3DataDistributionType: 's3DataDistributionType',
      s3InputMode: 's3InputMode',
      startTimeOffset: 'startTimeOffset',
    },
    endpointInput: {
      endpointName: 'endpointName',
      endTimeOffset: 'endTimeOffset',
      inferenceAttribute: 'inferenceAttribute',
      localPath: 'localPath',
      probabilityAttribute: 'probabilityAttribute',
      probabilityThresholdAttribute: 123,
      s3DataDistributionType: 's3DataDistributionType',
      s3InputMode: 's3InputMode',
      startTimeOffset: 'startTimeOffset',
    },
    groundTruthS3Input: {
      s3Uri: 's3Uri',
    },
  },
  modelQualityJobOutputConfig: {
    kmsKeyId: 'kmsKeyId',
    monitoringOutputs: [{
      s3Output: {
        localPath: 'localPath',
        s3UploadMode: 's3UploadMode',
        s3Uri: 's3Uri',
      },
    }],
  },
  networkConfig: {
    enableInterContainerTrafficEncryption: false,
    enableNetworkIsolation: false,
    vpcConfig: {
      securityGroupIds: ['securityGroupIds'],
      subnets: ['subnets'],
    },
  },
  roleArn: 'roleArn',
  stoppingCondition: {
    maxRuntimeInSeconds: 123,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
endpointName?	string	The name of the endpoint used to run the monitoring job.
jobDefinitionName?	string	The name of the monitoring job definition.
jobResources?	IResolvable | MonitoringResourcesProperty	Identifies the resources to deploy for a monitoring job.
modelQualityAppSpecification?	IResolvable | ModelQualityAppSpecificationProperty	Container image configuration object for the monitoring job.
modelQualityBaselineConfig?	IResolvable | ModelQualityBaselineConfigProperty	Specifies the constraints and baselines for the monitoring job.
modelQualityJobInput?	IResolvable | ModelQualityJobInputProperty	A list of the inputs that are monitored.
modelQualityJobOutputConfig?	IResolvable | MonitoringOutputConfigProperty	The output configuration for monitoring jobs.
networkConfig?	IResolvable | NetworkConfigProperty	Specifies the network configuration for the monitoring job.
roleArn?	string	The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
stoppingCondition?	IResolvable | StoppingConditionProperty	A time limit for how long the monitoring job is allowed to run before stopping.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

endpointName?

Type: string (optional)

The name of the endpoint used to run the monitoring job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-endpointname

---

jobDefinitionName?

Type: string (optional)

The name of the monitoring job definition.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-jobdefinitionname

---

jobResources?

Type: IResolvable | MonitoringResourcesProperty (optional)

Identifies the resources to deploy for a monitoring job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-jobresources

---

modelQualityAppSpecification?

Type: IResolvable | ModelQualityAppSpecificationProperty (optional)

Container image configuration object for the monitoring job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityappspecification

---

modelQualityBaselineConfig?

Type: IResolvable | ModelQualityBaselineConfigProperty (optional)

Specifies the constraints and baselines for the monitoring job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-modelqualitybaselineconfig

---

modelQualityJobInput?

Type: IResolvable | ModelQualityJobInputProperty (optional)

A list of the inputs that are monitored.

Currently endpoints are supported.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityjobinput

---

modelQualityJobOutputConfig?

Type: IResolvable | MonitoringOutputConfigProperty (optional)

The output configuration for monitoring jobs.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-modelqualityjoboutputconfig

---

networkConfig?

Type: IResolvable | NetworkConfigProperty (optional)

Specifies the network configuration for the monitoring job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-networkconfig

---

roleArn?

Type: string (optional)

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-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-rolearn

---

stoppingCondition?

Type: IResolvable | StoppingConditionProperty (optional)

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-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-stoppingcondition

---

tags?

Type: CfnTag[] (optional)

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-modelqualityjobdefinition.html#cfn-sagemaker-modelqualityjobdefinition-tags