class CfnInferenceExperimentPropsMixin

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

Implements IMixin

Extends Mixin

Creates an inference experiment using the configurations specified in the request.

Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests .

Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration.

While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see View, monitor, and edit shadow tests .

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as sagemaker_mixins } from '@aws-cdk/mixins-preview/aws-sagemaker';
const cfnInferenceExperimentPropsMixin = new sagemaker_mixins.CfnInferenceExperimentPropsMixin({
  dataStorageConfig: {
    contentType: {
      csvContentTypes: ['csvContentTypes'],
      jsonContentTypes: ['jsonContentTypes'],
    },
    destination: 'destination',
    kmsKey: 'kmsKey',
  },
  description: 'description',
  desiredState: 'desiredState',
  endpointName: 'endpointName',
  kmsKey: 'kmsKey',
  modelVariants: [{
    infrastructureConfig: {
      infrastructureType: 'infrastructureType',
      realTimeInferenceConfig: {
        instanceCount: 123,
        instanceType: 'instanceType',
      },
    },
    modelName: 'modelName',
    variantName: 'variantName',
  }],
  name: 'name',
  roleArn: 'roleArn',
  schedule: {
    endTime: 'endTime',
    startTime: 'startTime',
  },
  shadowModeConfig: {
    shadowModelVariants: [{
      samplingPercentage: 123,
      shadowModelVariantName: 'shadowModelVariantName',
    }],
    sourceModelVariantName: 'sourceModelVariantName',
  },
  statusReason: 'statusReason',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnInferenceExperimentPropsMixin(props: CfnInferenceExperimentMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnInferenceExperimentMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::SageMaker::InferenceExperiment.

Properties

Name	Type	Description
props	CfnInferenceExperimentMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnInferenceExperimentMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.