class CfnInferenceExperiment (construct)

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnInferenceExperiment
Java	software.amazon.awscdk.services.sagemaker.CfnInferenceExperiment
Python	aws_cdk.aws_sagemaker.CfnInferenceExperiment
TypeScript	@aws-cdk/aws-sagemaker » CfnInferenceExperiment

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::SageMaker::InferenceExperiment.

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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as sagemaker from '@aws-cdk/aws-sagemaker';
const cfnInferenceExperiment = new sagemaker.CfnInferenceExperiment(this, 'MyCfnInferenceExperiment', {
  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',
  }],
});

Initializer

new CfnInferenceExperiment(scope: Construct, id: string, props: CfnInferenceExperimentProps)

Parameters

• scope Construct — - scope in which this resource is defined.
• id string — - scoped id of the resource.
• props CfnInferenceExperimentProps — - resource properties.

Create a new AWS::SageMaker::InferenceExperiment.

Construct Props

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 .

Properties

Name	Type	Description
attrArn	string
attrCreationTime	string
attrEndpointMetadataEndpointConfigName	string
attrEndpointMetadataEndpointName	string
attrEndpointMetadataEndpointStatus	string
attrLastModifiedTime	string
attrStatus	string
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
endpointName	string	The name of the endpoint.
logicalId	string	The logical ID for this CloudFormation stack element.
modelVariants	IResolvable | IResolvable | ModelVariantConfigProperty[]	An array of ModelVariantConfigSummary objects.
name	string	The name of the inference experiment.
node	ConstructNode	The construct tree node associated with this construct.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
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.
stack	Stack	The stack in which this element is defined.
tags	TagManager	An array of key-value pairs to apply to this resource.
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.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrArn

Type: string

---

attrCreationTime

Type: string

---

attrEndpointMetadataEndpointConfigName

Type: string

---

attrEndpointMetadataEndpointName

Type: string

---

attrEndpointMetadataEndpointStatus

Type: string

---

attrLastModifiedTime

Type: string

---

attrStatus

Type: string

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

endpointName

Type: string

The name of the endpoint.

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

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.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

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.

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

tags

Type: TagManager

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

For more information, see Tag .

---

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.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

• attributeName string — The name of the attribute.

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }