Interface ICfnInferenceExperimentProps

Properties for defining a CfnInferenceExperiment.

Namespace: Amazon.CDK.AWS.Sagemaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnInferenceExperimentProps

Syntax (vb)

Public Interface ICfnInferenceExperimentProps

Remarks

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

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

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 `ModelVariantConfigSummary` objects.
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 `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	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.

Properties

DataStorageConfig

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

object? DataStorageConfig { get; }

Property Value

object

Remarks

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

Description

The description of the inference experiment.

string? Description { get; }

Property Value

string

Remarks

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

DesiredState

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

string? DesiredState { get; }

Property Value

string

Remarks

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

EndpointName

The name of the endpoint.

string EndpointName { get; }

Property Value

string

Remarks

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

KmsKey

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

string? KmsKey { get; }

Property Value

string

Remarks

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

ModelVariants

An array of ModelVariantConfigSummary objects.

object ModelVariants { get; }

Property Value

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.

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

Name

The name of the inference experiment.

string Name { get; }

Property Value

string

Remarks

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

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.

string RoleArn { get; }

Property Value

string

Remarks

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

Schedule

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

object? Schedule { get; }

Property Value

object

Remarks

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

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

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.