Class CfnInferenceExperiment.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnInferenceExperiment>
- Enclosing class:
CfnInferenceExperiment
CfnInferenceExperiment
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
dataStorageConfig
(IResolvable dataStorageConfig) The Amazon S3 location and configuration for storing inference request and response data.dataStorageConfig
(CfnInferenceExperiment.DataStorageConfigProperty dataStorageConfig) The Amazon S3 location and configuration for storing inference request and response data.description
(String description) The description of the inference experiment.desiredState
(String desiredState) The desired state of the experiment after stopping.endpointName
(String endpointName) The name of the endpoint.The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.modelVariants
(List<? extends Object> modelVariants) An array ofModelVariantConfigSummary
objects.modelVariants
(IResolvable modelVariants) An array ofModelVariantConfigSummary
objects.The name of the inference experiment.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
(IResolvable schedule) The duration for which the inference experiment ran or will run.The duration for which the inference experiment ran or will run.shadowModeConfig
(IResolvable shadowModeConfig) The configuration ofShadowMode
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.shadowModeConfig
(CfnInferenceExperiment.ShadowModeConfigProperty shadowModeConfig) The configuration ofShadowMode
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 statusReason) The error message for the inference experiment status result.An array of key-value pairs to apply to this resource.The type of the inference experiment.
-
Method Details
-
create
- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
- Returns:
- a new instance of
CfnInferenceExperiment.Builder
.
-
endpointName
The name of the endpoint.- Parameters:
endpointName
- The name of the endpoint. This parameter is required.- Returns:
this
-
modelVariants
An array ofModelVariantConfigSummary
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.- Parameters:
modelVariants
- An array ofModelVariantConfigSummary
objects. This parameter is required.- Returns:
this
-
modelVariants
@Stability(Stable) public CfnInferenceExperiment.Builder modelVariants(List<? extends Object> modelVariants) An array ofModelVariantConfigSummary
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.- Parameters:
modelVariants
- An array ofModelVariantConfigSummary
objects. This parameter is required.- Returns:
this
-
name
The name of the inference experiment.- Parameters:
name
- The name of the inference experiment. This parameter is required.- Returns:
this
-
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.- Parameters:
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. This parameter is required.- Returns:
this
-
type
The type of the inference experiment.- Parameters:
type
- The type of the inference experiment. This parameter is required.- Returns:
this
-
dataStorageConfig
@Stability(Stable) public CfnInferenceExperiment.Builder dataStorageConfig(IResolvable dataStorageConfig) The Amazon S3 location and configuration for storing inference request and response data.- Parameters:
dataStorageConfig
- The Amazon S3 location and configuration for storing inference request and response data. This parameter is required.- Returns:
this
-
dataStorageConfig
@Stability(Stable) public CfnInferenceExperiment.Builder dataStorageConfig(CfnInferenceExperiment.DataStorageConfigProperty dataStorageConfig) The Amazon S3 location and configuration for storing inference request and response data.- Parameters:
dataStorageConfig
- The Amazon S3 location and configuration for storing inference request and response data. This parameter is required.- Returns:
this
-
description
The description of the inference experiment.- Parameters:
description
- The description of the inference experiment. This parameter is required.- Returns:
this
-
desiredState
The desired state of the experiment after stopping. The possible states are the following:.Completed
: The experiment completed successfullyCancelled
: The experiment was canceled
- Parameters:
desiredState
- The desired state of the experiment after stopping. The possible states are the following:. This parameter is required.- Returns:
this
-
kmsKey
The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.- Parameters:
kmsKey
- The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption. This parameter is required.- Returns:
this
-
schedule
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.
- Parameters:
schedule
- The duration for which the inference experiment ran or will run. This parameter is required.- Returns:
this
-
schedule
@Stability(Stable) public CfnInferenceExperiment.Builder schedule(CfnInferenceExperiment.InferenceExperimentScheduleProperty schedule) 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.
- Parameters:
schedule
- The duration for which the inference experiment ran or will run. This parameter is required.- Returns:
this
-
shadowModeConfig
@Stability(Stable) public CfnInferenceExperiment.Builder shadowModeConfig(IResolvable shadowModeConfig) The configuration ofShadowMode
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.
- Parameters:
shadowModeConfig
- The configuration ofShadowMode
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. This parameter is required.- Returns:
this
-
shadowModeConfig
@Stability(Stable) public CfnInferenceExperiment.Builder shadowModeConfig(CfnInferenceExperiment.ShadowModeConfigProperty shadowModeConfig) The configuration ofShadowMode
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.
- Parameters:
shadowModeConfig
- The configuration ofShadowMode
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. This parameter is required.- Returns:
this
-
statusReason
The error message for the inference experiment status result.- Parameters:
statusReason
- The error message for the inference experiment status result. This parameter is required.- Returns:
this
-
tags
An array of key-value pairs to apply to this resource.For more information, see Tag .
- Parameters:
tags
- An array of key-value pairs to apply to this resource. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnInferenceExperiment>
- Returns:
- a newly built instance of
CfnInferenceExperiment
.
-