interface CfnModelExplainabilityJobDefinitionMixinProps

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

Properties for CfnModelExplainabilityJobDefinitionPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.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 cfnModelExplainabilityJobDefinitionMixinProps: sagemaker_mixins.CfnModelExplainabilityJobDefinitionMixinProps = {
  endpointName: 'endpointName',
  jobDefinitionName: 'jobDefinitionName',
  jobResources: {
    clusterConfig: {
      instanceCount: 123,
      instanceType: 'instanceType',
      volumeKmsKeyId: 'volumeKmsKeyId',
      volumeSizeInGb: 123,
    },
  },
  modelExplainabilityAppSpecification: {
    configUri: 'configUri',
    environment: {
      environmentKey: 'environment',
    },
    imageUri: 'imageUri',
  },
  modelExplainabilityBaselineConfig: {
    baseliningJobName: 'baseliningJobName',
    constraintsResource: {
      s3Uri: 's3Uri',
    },
  },
  modelExplainabilityJobInput: {
    batchTransformInput: {
      dataCapturedDestinationS3Uri: 'dataCapturedDestinationS3Uri',
      datasetFormat: {
        csv: {
          header: false,
        },
        json: {
          line: false,
        },
        parquet: false,
      },
      featuresAttribute: 'featuresAttribute',
      inferenceAttribute: 'inferenceAttribute',
      localPath: 'localPath',
      probabilityAttribute: 'probabilityAttribute',
      s3DataDistributionType: 's3DataDistributionType',
      s3InputMode: 's3InputMode',
    },
    endpointInput: {
      endpointName: 'endpointName',
      featuresAttribute: 'featuresAttribute',
      inferenceAttribute: 'inferenceAttribute',
      localPath: 'localPath',
      probabilityAttribute: 'probabilityAttribute',
      s3DataDistributionType: 's3DataDistributionType',
      s3InputMode: 's3InputMode',
    },
  },
  modelExplainabilityJobOutputConfig: {
    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 model explainability job definition.
jobResources?	IResolvable | MonitoringResourcesProperty	Identifies the resources to deploy for a monitoring job.
modelExplainabilityAppSpecification?	IResolvable | ModelExplainabilityAppSpecificationProperty	Configures the model explainability job to run a specified Docker container image.
modelExplainabilityBaselineConfig?	IResolvable | ModelExplainabilityBaselineConfigProperty	The baseline configuration for a model explainability job.
modelExplainabilityJobInput?	IResolvable | ModelExplainabilityJobInputProperty	Inputs for the model explainability job.
modelExplainabilityJobOutputConfig?	IResolvable | MonitoringOutputConfigProperty	The output configuration for monitoring jobs.
networkConfig?	IResolvable | NetworkConfigProperty	Networking options for a model explainability 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-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-endpointname

---

jobDefinitionName?

Type: string (optional)

The name of the model explainability job definition.

The name must be unique within an AWS Region in the AWS account.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-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-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-jobresources

---

modelExplainabilityAppSpecification?

Type: IResolvable | ModelExplainabilityAppSpecificationProperty (optional)

Configures the model explainability job to run a specified Docker container image.

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

---

modelExplainabilityBaselineConfig?

Type: IResolvable | ModelExplainabilityBaselineConfigProperty (optional)

The baseline configuration for a model explainability job.

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

---

modelExplainabilityJobInput?

Type: IResolvable | ModelExplainabilityJobInputProperty (optional)

Inputs for the model explainability job.

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

---

modelExplainabilityJobOutputConfig?

Type: IResolvable | MonitoringOutputConfigProperty (optional)

The output configuration for monitoring jobs.

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

---

networkConfig?

Type: IResolvable | NetworkConfigProperty (optional)

Networking options for a model explainability job.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-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-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-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-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-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-modelexplainabilityjobdefinition.html#cfn-sagemaker-modelexplainabilityjobdefinition-tags