CfnEndpointConfigProps

All Known Implementing Classes:: CfnEndpointConfigProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:25.378Z")
public interface CfnEndpointConfigProps

Properties for defining a `CfnEndpointConfig`.

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.*;
 CfnEndpointConfigProps cfnEndpointConfigProps = CfnEndpointConfigProps.builder()
         .productionVariants(List.of(ProductionVariantProperty.builder()
                 .initialVariantWeight(123)
                 .modelName("modelName")
                 .variantName("variantName")
                 // the properties below are optional
                 .acceleratorType("acceleratorType")
                 .containerStartupHealthCheckTimeoutInSeconds(123)
                 .initialInstanceCount(123)
                 .instanceType("instanceType")
                 .modelDataDownloadTimeoutInSeconds(123)
                 .serverlessConfig(ServerlessConfigProperty.builder()
                         .maxConcurrency(123)
                         .memorySizeInMb(123)
                         .build())
                 .volumeSizeInGb(123)
                 .build()))
         // the properties below are optional
         .asyncInferenceConfig(AsyncInferenceConfigProperty.builder()
                 .outputConfig(AsyncInferenceOutputConfigProperty.builder()
                         .s3OutputPath("s3OutputPath")
                         // the properties below are optional
                         .kmsKeyId("kmsKeyId")
                         .notificationConfig(AsyncInferenceNotificationConfigProperty.builder()
                                 .errorTopic("errorTopic")
                                 .successTopic("successTopic")
                                 .build())
                         .build())
                 // the properties below are optional
                 .clientConfig(AsyncInferenceClientConfigProperty.builder()
                         .maxConcurrentInvocationsPerInstance(123)
                         .build())
                 .build())
         .dataCaptureConfig(DataCaptureConfigProperty.builder()
                 .captureOptions(List.of(CaptureOptionProperty.builder()
                         .captureMode("captureMode")
                         .build()))
                 .destinationS3Uri("destinationS3Uri")
                 .initialSamplingPercentage(123)
                 // the properties below are optional
                 .captureContentTypeHeader(CaptureContentTypeHeaderProperty.builder()
                         .csvContentTypes(List.of("csvContentTypes"))
                         .jsonContentTypes(List.of("jsonContentTypes"))
                         .build())
                 .enableCapture(false)
                 .kmsKeyId("kmsKeyId")
                 .build())
         .endpointConfigName("endpointConfigName")
         .explainerConfig(ExplainerConfigProperty.builder()
                 .clarifyExplainerConfig(ClarifyExplainerConfigProperty.builder()
                         .shapConfig(ClarifyShapConfigProperty.builder()
                                 .shapBaselineConfig(ClarifyShapBaselineConfigProperty.builder()
                                         .mimeType("mimeType")
                                         .shapBaseline("shapBaseline")
                                         .shapBaselineUri("shapBaselineUri")
                                         .build())
                                 // the properties below are optional
                                 .numberOfSamples(123)
                                 .seed(123)
                                 .textConfig(ClarifyTextConfigProperty.builder()
                                         .granularity("granularity")
                                         .language("language")
                                         .build())
                                 .useLogit(false)
                                 .build())
                         // the properties below are optional
                         .enableExplanations("enableExplanations")
                         .inferenceConfig(ClarifyInferenceConfigProperty.builder()
                                 .contentTemplate("contentTemplate")
                                 .featureHeaders(List.of("featureHeaders"))
                                 .featuresAttribute("featuresAttribute")
                                 .featureTypes(List.of("featureTypes"))
                                 .labelAttribute("labelAttribute")
                                 .labelHeaders(List.of("labelHeaders"))
                                 .labelIndex(123)
                                 .maxPayloadInMb(123)
                                 .maxRecordCount(123)
                                 .probabilityAttribute("probabilityAttribute")
                                 .probabilityIndex(123)
                                 .build())
                         .build())
                 .build())
         .kmsKeyId("kmsKeyId")
         .shadowProductionVariants(List.of(ProductionVariantProperty.builder()
                 .initialVariantWeight(123)
                 .modelName("modelName")
                 .variantName("variantName")
                 // the properties below are optional
                 .acceleratorType("acceleratorType")
                 .containerStartupHealthCheckTimeoutInSeconds(123)
                 .initialInstanceCount(123)
                 .instanceType("instanceType")
                 .modelDataDownloadTimeoutInSeconds(123)
                 .serverlessConfig(ServerlessConfigProperty.builder()
                         .maxConcurrency(123)
                         .memorySizeInMb(123)
                         .build())
                 .volumeSizeInGb(123)
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnEndpointConfigProps.Builder` A builder for `CfnEndpointConfigProps`
`static class`	`CfnEndpointConfigProps.Jsii$Proxy` An implementation for `CfnEndpointConfigProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnEndpointConfigProps.Builder`	`builder()`
`default java.lang.Object`	`getAsyncInferenceConfig()` Specifies configuration for how an endpoint performs asynchronous inference.
`default java.lang.Object`	`getDataCaptureConfig()` Specifies how to capture endpoint data for model monitor.
`default java.lang.String`	`getEndpointConfigName()` The name of the endpoint configuration.
`default java.lang.Object`	`getExplainerConfig()` `AWS::SageMaker::EndpointConfig.ExplainerConfig`.
`default java.lang.String`	`getKmsKeyId()` The Amazon Resource Name (ARN) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
`java.lang.Object`	`getProductionVariants()` A list of `ProductionVariant` objects, one for each model that you want to host at this endpoint.
`default java.lang.Object`	`getShadowProductionVariants()` Array of `ProductionVariant` objects.
`default java.util.List<CfnTag>`	`getTags()` A list of key-value pairs to apply to this resource.

- Method Detail
  - getProductionVariants
```
java.lang.Object getProductionVariants()
```
    A list of `ProductionVariant` objects, one for each model that you want to host at this endpoint.
  - getAsyncInferenceConfig
```
default java.lang.Object getAsyncInferenceConfig()
```
    Specifies configuration for how an endpoint performs asynchronous inference.
  - getDataCaptureConfig
```
default java.lang.Object getDataCaptureConfig()
```
    Specifies how to capture endpoint data for model monitor.
    The data capture configuration applies to all production variants hosted at the endpoint.
  - getEndpointConfigName
```
default java.lang.String getEndpointConfigName()
```
    The name of the endpoint configuration.
  - getExplainerConfig
```
default java.lang.Object getExplainerConfig()
```
    `AWS::SageMaker::EndpointConfig.ExplainerConfig`.
  - getKmsKeyId
```
default java.lang.String getKmsKeyId()
```
    The Amazon Resource Name (ARN) of an AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    - Alias name: alias/ExampleAlias
    - Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
    The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint , UpdateEndpoint requests. For more information, refer to the AWS Key Management Service section Using Key Policies in AWS KMS
    
    Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.
    For a list of instance types that support local instance storage, see Instance Store Volumes .
    For more information about local instance storage encryption, see SSD Instance Store Volumes .
  - getShadowProductionVariants
```
default java.lang.Object getShadowProductionVariants()
```
    Array of `ProductionVariant` objects.
    There is one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants . If you use this field, you can only specify one variant for ProductionVariants and one variant for ShadowProductionVariants .
  - getTags
```
default java.util.List<CfnTag> getTags()
```
    A list of key-value pairs to apply to this resource.
    For more information, see Resource Tag and Using Cost Allocation Tags .
  - builder
```
static CfnEndpointConfigProps.Builder builder()
```
    Returns:
    
    a CfnEndpointConfigProps.Builder of CfnEndpointConfigProps

Interface CfnEndpointConfigProps

Nested Class Summary

Method Summary

Method Detail

getProductionVariants

getAsyncInferenceConfig

getDataCaptureConfig

getEndpointConfigName

getExplainerConfig

getKmsKeyId

getShadowProductionVariants

getTags

builder