AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::SageMaker::EndpointConfig

CfnEndpointConfig

The `AWS::SageMaker::EndpointConfig` resource creates a configuration for an Amazon SageMaker endpoint. For more information, see [CreateEndpointConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html) in the *SageMaker Developer Guide* .

Import

import { CfnEndpointConfig } from 'aws-cdk-lib/aws-sagemaker';

Or use the module namespace:

import * as sagemaker from 'aws-cdk-lib/aws-sagemaker';
// sagemaker.CfnEndpointConfig

Properties

Configuration passed to the constructor as CfnEndpointConfigProps.

productionVariantsRequired
IResolvable | IResolvable | ProductionVariantProperty[]

A list of `ProductionVariant` objects, one for each model that you want to host at this endpoint.

asyncInferenceConfigOptional
IResolvable | AsyncInferenceConfigProperty

Specifies configuration for how an endpoint performs asynchronous inference.

dataCaptureConfigOptional
IResolvable | DataCaptureConfigProperty

Specifies how to capture endpoint data for model monitor. The data capture configuration applies to all production variants hosted at the endpoint.

enableNetworkIsolationOptional
boolean | IResolvable
endpointConfigNameOptional
string

The name of the endpoint configuration.

executionRoleArnOptional
string
explainerConfigOptional
IResolvable | ExplainerConfigProperty

A parameter to activate explainers.

kmsKeyIdOptional
string

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](https://docs.aws.amazon.com//kms/latest/developerguide/key-policies.html) > 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes) . > > For more information about local instance storage encryption, see [SSD Instance Store Volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html) .

shadowProductionVariantsOptional
IResolvable | IResolvable | ProductionVariantProperty[]

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

tagsOptional
CfnTag[]

A list of key-value pairs to apply to this resource. For more information, see [Resource Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) and [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) .

vpcConfigOptional
IResolvable | VpcConfigProperty

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter