awssolutionsconstructsawslambdasagemakerendpoint

README

aws-lambda-sagemakerendpoint module

---

All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

---

Reference Documentation:	https://docs.aws.amazon.com/solutions/latest/constructs/

Language	Package
Python	aws_solutions_constructs.aws_lambda_sagemakerendpoint
Typescript	@aws-solutions-constructs/aws-lambda-sagemakerendpoint
Java	software.amazon.awsconstructs.services.lambdasagemakerendpoint

This AWS Solutions Construct implements an AWS Lambda function connected to an Amazon Sagemaker Endpoint.

Here is a minimal deployable pattern definition in Typescript:

import { Duration } from '@aws-cdk/core';
import * as lambda from '@aws-cdk/aws-lambda';
import {
  LambdaToSagemakerEndpoint,
  LambdaToSagemakerEndpointProps,
} from '@aws-solutions-constructs/aws-lambda-sagemakerendpoint';

const constructProps: LambdaToSagemakerEndpointProps = {
  modelProps: {
    primaryContainer: {
      image: '<AccountId>.dkr.ecr.<region>.amazonaws.com/linear-learner:latest',
      modelDataUrl: 's3://<bucket-name>/<prefix>/model.tar.gz',
    },
  },
  lambdaFunctionProps: {
    runtime: lambda.Runtime.PYTHON_3_8,
    code: lambda.Code.fromAsset(`${__dirname}/lambda`),
    handler: 'index.handler',
    timeout: Duration.minutes(5),
    memorySize: 128,
  },
};

new LambdaToSagemakerEndpoint(this, 'LambdaToSagemakerEndpointPattern', constructProps);

Initializer

new LambdaToSagemakerEndpoint(scope: Construct, id: string, props: LambdaToSagemakerEndpointProps);

Parameters

• scope Construct
• id string
• props LambdaToSagemakerEndpointProps

Pattern Construct Props

Name	Type	Description
existingLambdaObj?	lambda.Function	An optional, existing Lambda function to be used instead of the default function. Providing both this and lambdaFunctionProps will cause an error.
lambdaFunctionProps?	lambda.FunctionProps	Optional user-provided properties to override the default properties for the Lambda function.
existingSagemakerEndpointObj?	sagemaker.CfnEndpoint	An optional, existing Sagemaker Enpoint to be used. Providing both this and endpointProps? will cause an error.
modelProps?	sagemaker.CfnModelProps | any	User-provided properties to override the default properties for the Sagemaker Model. At least modelProps?.primaryContainer must be provided to create a model. By default, the pattern will create a role with the minimum required permissions, but the client can provide a custom role with additional capabilities using modelProps?.executionRoleArn.
endpointConfigProps?	sagemaker.CfnEndpointConfigProps	Optional user-provided properties to override the default properties for the Sagemaker Endpoint Config.
endpointProps?	sagemaker.CfnEndpointProps	Optional user-provided properties to override the default properties for the Sagemaker Endpoint Config.
existingVpc?	ec2.IVpc	An optional, existing VPC into which this construct should be deployed. When deployed in a VPC, the Lambda function and Sagemaker Endpoint will use ENIs in the VPC to access network resources. An Interface Endpoint will be created in the VPC for Amazon Sagemaker Runtime, and Amazon S3 VPC Endpoint. If an existing VPC is provided, the deployVpc? property cannot be true.
vpcProps?	ec2.VpcProps	Optional user-provided properties to override the default properties for the new VPC. enableDnsHostnames, enableDnsSupport, natGateways and subnetConfiguration are set by the Construct, so any values for those properties supplied here will be overrriden. If deployVpc? is not true then this property will be ignored.
deployVpc?	boolean	Whether to create a new VPC based on vpcProps into which to deploy this pattern. Setting this to true will deploy the minimal, most private VPC to run the pattern: One isolated subnet in each Availability Zone used by the CDK program enableDnsHostnames and enableDnsSupport will both be set to true If this property is true then existingVpc cannot be specified. Defaults to false.
sagemakerEnvironmentVariableName?	string	Optional Name for the SageMaker endpoint environment variable set for the Lambda function.

Pattern Properties

Name	Type	Description
lambdaFunction	lambda.Function	Returns an instance of the Lambda function created by the pattern.
sagemakerEndpoint	sagemaker.CfnEndpoint	Returns an instance of the Sagemaker Endpoint created by the pattern.
sagemakerEndpointConfig?	sagemaker.CfnEndpointConfig	Returns an instance of the SageMaker EndpointConfig created by the pattern, if existingSagemakerEndpointObj? is not provided.
sagemakerModel?	sagemaker.CfnModel	Returns an instance of the Sagemaker Model created by the pattern, if existingSagemakerEndpointObj? is not provided.
vpc?	ec2.IVpc	Returns an instance of the VPC created by the pattern, if deployVpc? is true, or existingVpc? is provided.

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

AWS Lambda Function

• Configure limited privilege access IAM role for Lambda function
• Enable reusing connections with Keep-Alive for NodeJs Lambda function
• Allow the function to invoke the Sagemaker endpoint for Inferences
• Configure the function to access resources in the VPC, where the Sagemaker endpoint is deployed
• Enable X-Ray Tracing
• Set environment variables:
  • (default) SAGEMAKER_ENDPOINT_NAME
  • AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions).

Amazon Sagemaker Endpoint

• Configure limited privilege to create Sagemaker resources
• Deploy Sagemaker model, endpointConfig, and endpoint
• Configure the Sagemaker endpoint to be deployed in a VPC
• Deploy S3 VPC Endpoint and Sagemaker Runtime VPC Interface

Architecture

---

© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Documentation

Overview

CDK constructs for defining an interaction between an AWS Lambda function and an Amazon SageMaker inference endpoint.

Index

• func LambdaToSagemakerEndpoint_IsConstruct(x interface{}) *bool
• func NewLambdaToSagemakerEndpoint_Override(l LambdaToSagemakerEndpoint, scope constructs.Construct, id *string, ...)
• type LambdaToSagemakerEndpoint
  • func NewLambdaToSagemakerEndpoint(scope constructs.Construct, id *string, props *LambdaToSagemakerEndpointProps) LambdaToSagemakerEndpoint
• type LambdaToSagemakerEndpointProps

Functions

func LambdaToSagemakerEndpoint_IsConstruct

func LambdaToSagemakerEndpoint_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewLambdaToSagemakerEndpoint_Override

func NewLambdaToSagemakerEndpoint_Override(l LambdaToSagemakerEndpoint, scope constructs.Construct, id *string, props *LambdaToSagemakerEndpointProps)

Types

type LambdaToSagemakerEndpoint

type LambdaToSagemakerEndpoint interface {
	constructs.Construct
	LambdaFunction() awslambda.Function
	Node() constructs.Node
	SagemakerEndpoint() awssagemaker.CfnEndpoint
	SagemakerEndpointConfig() awssagemaker.CfnEndpointConfig
	SagemakerModel() awssagemaker.CfnModel
	Vpc() awsec2.IVpc
	ToString() *string
}

func NewLambdaToSagemakerEndpoint

func NewLambdaToSagemakerEndpoint(scope constructs.Construct, id *string, props *LambdaToSagemakerEndpointProps) LambdaToSagemakerEndpoint

type LambdaToSagemakerEndpointProps

type LambdaToSagemakerEndpointProps struct {
	// Whether to deploy a new VPC.
	DeployVpc *bool `json:"deployVpc"`
	// User provided props to create Sagemaker Endpoint Configuration.
	EndpointConfigProps *awssagemaker.CfnEndpointConfigProps `json:"endpointConfigProps"`
	// User provided props to create Sagemaker Endpoint.
	EndpointProps *awssagemaker.CfnEndpointProps `json:"endpointProps"`
	// Existing instance of Lambda Function object, Providing both this and lambdaFunctionProps will cause an error.
	ExistingLambdaObj awslambda.Function `json:"existingLambdaObj"`
	// Existing Sagemaker Enpoint object, providing both this and endpointProps will cause an error.
	ExistingSagemakerEndpointObj awssagemaker.CfnEndpoint `json:"existingSagemakerEndpointObj"`
	// An existing VPC for the construct to use (construct will NOT create a new VPC in this case).
	ExistingVpc awsec2.IVpc `json:"existingVpc"`
	// User provided props to override the default props for the Lambda function.
	LambdaFunctionProps *awslambda.FunctionProps `json:"lambdaFunctionProps"`
	// User provided props to create Sagemaker Model.
	ModelProps interface{} `json:"modelProps"`
	// Optional Name for the SageMaker endpoint environment variable set for the Lambda function.
	SagemakerEnvironmentVariableName *string `json:"sagemakerEnvironmentVariableName"`
	// Properties to override default properties if deployVpc is true.
	VpcProps *awsec2.VpcProps `json:"vpcProps"`
}