interface CfnInferenceExperimentProps

Language	Type name
.NET	`Amazon.CDK.AWS.Sagemaker.CfnInferenceExperimentProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnInferenceExperimentProps`
Java	`software.amazon.awscdk.services.sagemaker.CfnInferenceExperimentProps`
Python	`aws_cdk.aws_sagemaker.CfnInferenceExperimentProps`
TypeScript	`aws-cdk-lib` » `aws_sagemaker` » `CfnInferenceExperimentProps`

Properties for defining a CfnInferenceExperiment.

Example

// 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 cfnInferenceExperimentProps: sagemaker.CfnInferenceExperimentProps = {
  endpointName: 'endpointName',
  modelVariants: [{
    infrastructureConfig: {
      infrastructureType: 'infrastructureType',
      realTimeInferenceConfig: {
        instanceCount: 123,
        instanceType: 'instanceType',
      },
    },
    modelName: 'modelName',
    variantName: 'variantName',
  }],
  name: 'name',
  roleArn: 'roleArn',
  type: 'type',

  // the properties below are optional
  dataStorageConfig: {
    destination: 'destination',

    // the properties below are optional
    contentType: {
      csvContentTypes: ['csvContentTypes'],
      jsonContentTypes: ['jsonContentTypes'],
    },
    kmsKey: 'kmsKey',
  },
  description: 'description',
  desiredState: 'desiredState',
  kmsKey: 'kmsKey',
  schedule: {
    endTime: 'endTime',
    startTime: 'startTime',
  },
  shadowModeConfig: {
    shadowModelVariants: [{
      samplingPercentage: 123,
      shadowModelVariantName: 'shadowModelVariantName',
    }],
    sourceModelVariantName: 'sourceModelVariantName',
  },
  statusReason: 'statusReason',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
endpointName	`string`	The name of the endpoint.
modelVariants	`IResolvable` `\|` `IResolvable` `\|` `ModelVariantConfigProperty[]`	An array of `ModelVariantConfigSummary` objects.
name	`string`	The name of the inference experiment.
roleArn	`string`	The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
type	`string`	The type of the inference experiment.
dataStorageConfig?	`IResolvable` `\|` `DataStorageConfigProperty`	The Amazon S3 location and configuration for storing inference request and response data.
description?	`string`	The description of the inference experiment.
desiredState?	`string`	The desired state of the experiment after stopping. The possible states are the following:.
kmsKey?	`string`	The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.
schedule?	`IResolvable` `\|` `InferenceExperimentScheduleProperty`	The duration for which the inference experiment ran or will run.
shadowModeConfig?	`IResolvable` `\|` `ShadowModeConfigProperty`	The configuration of `ShadowMode` inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests.
statusReason?	`string`	The error message for the inference experiment status result.
tags?	`CfnTag[]`	An array of key-value pairs to apply to this resource.

endpointName

Type: string

The name of the endpoint.

modelVariants

Type: IResolvable | IResolvable | ModelVariantConfigProperty[]

An array of ModelVariantConfigSummary objects.

There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

name

Type: string

The name of the inference experiment.

roleArn

Type: string

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

type

Type: string

The type of the inference experiment.

dataStorageConfig?

Type: IResolvable | DataStorageConfigProperty (optional)

The Amazon S3 location and configuration for storing inference request and response data.

description?

Type: string (optional)

The description of the inference experiment.

desiredState?

Type: string (optional)

The desired state of the experiment after stopping. The possible states are the following:.

Completed : The experiment completed successfully
Cancelled : The experiment was canceled

kmsKey?

Type: string (optional)

The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.

schedule?

Type: IResolvable | InferenceExperimentScheduleProperty (optional)

The duration for which the inference experiment ran or will run.

The maximum duration that you can set for an inference experiment is 30 days.

shadowModeConfig?

Type: IResolvable | ShadowModeConfigProperty (optional)

The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests.

For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

statusReason?

Type: string (optional)

The error message for the inference experiment status result.

tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag .