CfnModelBiasJobDefinitionProps Struct
Properties for defining a CfnModelBiasJobDefinition.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const cfnModelBiasJobDefinitionProps: sagemaker.CfnModelBiasJobDefinitionProps = {
jobResources: {
clusterConfig: {
instanceCount: 123,
instanceType: 'instanceType',
volumeSizeInGb: 123,
// the properties below are optional
volumeKmsKeyId: 'volumeKmsKeyId',
},
},
modelBiasAppSpecification: {
configUri: 'configUri',
imageUri: 'imageUri',
// the properties below are optional
environment: {
environmentKey: 'environment',
},
},
modelBiasJobInput: {
groundTruthS3Input: {
s3Uri: 's3Uri',
},
// the properties below are optional
batchTransformInput: {
dataCapturedDestinationS3Uri: 'dataCapturedDestinationS3Uri',
datasetFormat: {
csv: {
header: false,
},
json: {
line: false,
},
parquet: false,
},
localPath: 'localPath',
// the properties below are optional
endTimeOffset: 'endTimeOffset',
featuresAttribute: 'featuresAttribute',
inferenceAttribute: 'inferenceAttribute',
probabilityAttribute: 'probabilityAttribute',
probabilityThresholdAttribute: 123,
s3DataDistributionType: 's3DataDistributionType',
s3InputMode: 's3InputMode',
startTimeOffset: 'startTimeOffset',
},
endpointInput: {
endpointName: 'endpointName',
localPath: 'localPath',
// the properties below are optional
endTimeOffset: 'endTimeOffset',
featuresAttribute: 'featuresAttribute',
inferenceAttribute: 'inferenceAttribute',
probabilityAttribute: 'probabilityAttribute',
probabilityThresholdAttribute: 123,
s3DataDistributionType: 's3DataDistributionType',
s3InputMode: 's3InputMode',
startTimeOffset: 'startTimeOffset',
},
},
modelBiasJobOutputConfig: {
monitoringOutputs: [{
s3Output: {
localPath: 'localPath',
s3Uri: 's3Uri',
// the properties below are optional
s3UploadMode: 's3UploadMode',
},
}],
// the properties below are optional
kmsKeyId: 'kmsKeyId',
},
roleArn: 'roleArn',
// the properties below are optional
endpointName: 'endpointName',
jobDefinitionName: 'jobDefinitionName',
modelBiasBaselineConfig: {
baseliningJobName: 'baseliningJobName',
constraintsResource: {
s3Uri: 's3Uri',
},
},
networkConfig: {
enableInterContainerTrafficEncryption: false,
enableNetworkIsolation: false,
vpcConfig: {
securityGroupIds: ['securityGroupIds'],
subnets: ['subnets'],
},
},
stoppingCondition: {
maxRuntimeInSeconds: 123,
},
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
endpointNameoptionalstringendpoint_nameoptionalstrendpointNameoptionalStringEndpointNameoptionalstringEndpointNameoptional*string#The name of the endpoint used to run the monitoring job.
jobDefinitionNameoptionalstringjob_definition_nameoptionalstrjobDefinitionNameoptionalStringJobDefinitionNameoptionalstringJobDefinitionNameoptional*string#The name of the bias job definition.
The name must be unique within an AWS Region in the AWS account.
jobResourcesIResolvable | CfnModelBiasJobDefinition.MonitoringResourcesPropertyjob_resourcestyping.Union[IResolvable, MonitoringResourcesProperty]jobResourcesIResolvableJobResourcesIResolvableJobResourcesinterface{}required#Identifies the resources to deploy for a monitoring job.
modelBiasAppSpecificationIResolvable | CfnModelBiasJobDefinition.ModelBiasAppSpecificationPropertymodel_bias_app_specificationtyping.Union[IResolvable, ModelBiasAppSpecificationProperty]modelBiasAppSpecificationIResolvableModelBiasAppSpecificationIResolvableModelBiasAppSpecificationinterface{}required#Configures the model bias job to run a specified Docker container image.
modelBiasBaselineConfigoptionalIResolvable | CfnModelBiasJobDefinition.ModelBiasBaselineConfigPropertymodel_bias_baseline_configoptionaltyping.Union[IResolvable, ModelBiasBaselineConfigProperty]modelBiasBaselineConfigoptionalIResolvableModelBiasBaselineConfigoptionalIResolvableModelBiasBaselineConfigoptionalinterface{}#The baseline configuration for a model bias job.
modelBiasJobInputIResolvable | CfnModelBiasJobDefinition.ModelBiasJobInputPropertymodel_bias_job_inputtyping.Union[IResolvable, ModelBiasJobInputProperty]modelBiasJobInputIResolvableModelBiasJobInputIResolvableModelBiasJobInputinterface{}required#Inputs for the model bias job.
modelBiasJobOutputConfigIResolvable | CfnModelBiasJobDefinition.MonitoringOutputConfigPropertymodel_bias_job_output_configtyping.Union[IResolvable, MonitoringOutputConfigProperty]modelBiasJobOutputConfigIResolvableModelBiasJobOutputConfigIResolvableModelBiasJobOutputConfiginterface{}required#The output configuration for monitoring jobs.
networkConfigoptionalIResolvable | CfnModelBiasJobDefinition.NetworkConfigPropertynetwork_configoptionaltyping.Union[IResolvable, NetworkConfigProperty]networkConfigoptionalIResolvableNetworkConfigoptionalIResolvableNetworkConfigoptionalinterface{}#Networking options for a model bias job.
roleArnstring | IRoleRefrole_arntyping.Union[str, IRoleRef]roleArnStringRoleArnstringRoleArninterface{}required#The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
stoppingConditionoptionalIResolvable | CfnModelBiasJobDefinition.StoppingConditionPropertystopping_conditionoptionaltyping.Union[IResolvable, StoppingConditionProperty]stoppingConditionoptionalIResolvableStoppingConditionoptionalIResolvableStoppingConditionoptionalinterface{}#A time limit for how long the monitoring job is allowed to run before stopping.