Class CfnInferenceExperimentProps
Properties for defining a CfnInferenceExperiment
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public class CfnInferenceExperimentProps : Object, ICfnInferenceExperimentProps
Syntax (vb)
Public Class CfnInferenceExperimentProps
Inherits Object
Implements ICfnInferenceExperimentProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var cfnInferenceExperimentProps = new CfnInferenceExperimentProps {
EndpointName = "endpointName",
ModelVariants = new [] { new ModelVariantConfigProperty {
InfrastructureConfig = new ModelInfrastructureConfigProperty {
InfrastructureType = "infrastructureType",
RealTimeInferenceConfig = new RealTimeInferenceConfigProperty {
InstanceCount = 123,
InstanceType = "instanceType"
}
},
ModelName = "modelName",
VariantName = "variantName"
} },
Name = "name",
RoleArn = "roleArn",
Type = "type",
// the properties below are optional
DataStorageConfig = new DataStorageConfigProperty {
Destination = "destination",
// the properties below are optional
ContentType = new CaptureContentTypeHeaderProperty {
CsvContentTypes = new [] { "csvContentTypes" },
JsonContentTypes = new [] { "jsonContentTypes" }
},
KmsKey = "kmsKey"
},
Description = "description",
DesiredState = "desiredState",
KmsKey = "kmsKey",
Schedule = new InferenceExperimentScheduleProperty {
EndTime = "endTime",
StartTime = "startTime"
},
ShadowModeConfig = new ShadowModeConfigProperty {
ShadowModelVariants = new [] { new ShadowModelVariantConfigProperty {
SamplingPercentage = 123,
ShadowModelVariantName = "shadowModelVariantName"
} },
SourceModelVariantName = "sourceModelVariantName"
},
StatusReason = "statusReason",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Constructors
CfnInferenceExperimentProps() |
Properties
DataStorageConfig | The Amazon S3 location and configuration for storing inference request and response data. |
Description | The description of the inference experiment. |
DesiredState | The desired state of the experiment after stopping. The possible states are the following:. |
EndpointName | The name of the endpoint. |
KmsKey | The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption. |
ModelVariants | An array of |
Name | The name of the inference experiment. |
RoleArn | 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. |
Schedule | The duration for which the inference experiment ran or will run. |
ShadowModeConfig | The configuration of |
StatusReason | The error message for the inference experiment status result. |
Tags | An array of key-value pairs to apply to this resource. |
Type | The type of the inference experiment. |
Constructors
CfnInferenceExperimentProps()
public CfnInferenceExperimentProps()
Properties
DataStorageConfig
The Amazon S3 location and configuration for storing inference request and response data.
public object DataStorageConfig { get; set; }
Property Value
System.Object
Remarks
Description
The description of the inference experiment.
public string Description { get; set; }
Property Value
System.String
Remarks
DesiredState
The desired state of the experiment after stopping. The possible states are the following:.
public string DesiredState { get; set; }
Property Value
System.String
Remarks
EndpointName
The name of the endpoint.
public string EndpointName { get; set; }
Property Value
System.String
Remarks
KmsKey
The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.
public string KmsKey { get; set; }
Property Value
System.String
Remarks
ModelVariants
An array of ModelVariantConfigSummary
objects.
public object ModelVariants { get; set; }
Property Value
System.Object
Remarks
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
The name of the inference experiment.
public string Name { get; set; }
Property Value
System.String
Remarks
RoleArn
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.
public string RoleArn { get; set; }
Property Value
System.String
Remarks
Schedule
The duration for which the inference experiment ran or will run.
public object Schedule { get; set; }
Property Value
System.Object
Remarks
The maximum duration that you can set for an inference experiment is 30 days.
ShadowModeConfig
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.
public object ShadowModeConfig { get; set; }
Property Value
System.Object
Remarks
For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.
StatusReason
The error message for the inference experiment status result.
public string StatusReason { get; set; }
Property Value
System.String
Remarks
Tags
An array of key-value pairs to apply to this resource.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
Type
The type of the inference experiment.
public string Type { get; set; }
Property Value
System.String