Package software.amazon.awscdk.services.sagemaker

Interface CfnInferenceExperimentProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnInferenceExperimentProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.244Z") @Stability(Stable) public interface CfnInferenceExperimentProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnInferenceExperiment.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 CfnInferenceExperimentProps cfnInferenceExperimentProps = CfnInferenceExperimentProps.builder()
         .endpointName("endpointName")
         .modelVariants(List.of(ModelVariantConfigProperty.builder()
                 .infrastructureConfig(ModelInfrastructureConfigProperty.builder()
                         .infrastructureType("infrastructureType")
                         .realTimeInferenceConfig(RealTimeInferenceConfigProperty.builder()
                                 .instanceCount(123)
                                 .instanceType("instanceType")
                                 .build())
                         .build())
                 .modelName("modelName")
                 .variantName("variantName")
                 .build()))
         .name("name")
         .roleArn("roleArn")
         .type("type")
         // the properties below are optional
         .dataStorageConfig(DataStorageConfigProperty.builder()
                 .destination("destination")
                 // the properties below are optional
                 .contentType(CaptureContentTypeHeaderProperty.builder()
                         .csvContentTypes(List.of("csvContentTypes"))
                         .jsonContentTypes(List.of("jsonContentTypes"))
                         .build())
                 .kmsKey("kmsKey")
                 .build())
         .description("description")
         .desiredState("desiredState")
         .kmsKey("kmsKey")
         .schedule(InferenceExperimentScheduleProperty.builder()
                 .endTime("endTime")
                 .startTime("startTime")
                 .build())
         .shadowModeConfig(ShadowModeConfigProperty.builder()
                 .shadowModelVariants(List.of(ShadowModelVariantConfigProperty.builder()
                         .samplingPercentage(123)
                         .shadowModelVariantName("shadowModelVariantName")
                         .build()))
                 .sourceModelVariantName("sourceModelVariantName")
                 .build())
         .statusReason("statusReason")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Method Details

    • getEndpointName

      @Stability(Stable) @NotNull String getEndpointName()
      The name of the endpoint.

    • getModelVariants

      @Stability(Stable) @NotNull Object getModelVariants()
      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.

    • getName

      @Stability(Stable) @NotNull String getName()
      The name of the inference experiment.

    • getRoleArn

      @Stability(Stable) @NotNull String getRoleArn()
      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.

    • getType

      @Stability(Stable) @NotNull String getType()
      The type of the inference experiment.

    • getDataStorageConfig

      @Stability(Stable) @Nullable default Object getDataStorageConfig()
      The Amazon S3 location and configuration for storing inference request and response data.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description of the inference experiment.

    • getDesiredState

      @Stability(Stable) @Nullable default String getDesiredState()
      The desired state of the experiment after stopping. The possible states are the following:.

      • Completed : The experiment completed successfully
      • Cancelled : The experiment was canceled

    • getKmsKey

      @Stability(Stable) @Nullable default String getKmsKey()
      The AWS Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.

    • getSchedule

      @Stability(Stable) @Nullable default Object getSchedule()
      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.

    • getShadowModeConfig

      @Stability(Stable) @Nullable default Object getShadowModeConfig()
      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.

    • getStatusReason

      @Stability(Stable) @Nullable default String getStatusReason()
      The error message for the inference experiment status result.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • builder

      @Stability(Stable) static CfnInferenceExperimentProps.Builder builder()
      Returns:
      a CfnInferenceExperimentProps.Builder of CfnInferenceExperimentProps