feat(eula): expose the eula property for SageMaker JumpStart model deployment (#257)

* chore(deps): upgrade cdk to 2.122.0

* chore(construct): expose new accepteula property

* chore(eula): fail synth if eula not explicitly set to true

* chore(doc): update related documentation

* chore(test): add test to cover eula acceptance set to false

* fix(commitlint): downgrade commitlint as issue with latest version

* chore(commitlint): upgrade version

* chore(sg): verify if model requires eula acceptance

Author: krokoko

.projen/deps.json

@@ -29,7 +29,7 @@ import {
 const GITHUB_USER = 'awslabs';
 const PUBLICATION_NAMESPACE = 'cdklabs';
 const PROJECT_NAME = 'generative-ai-cdk-constructs';
-const CDK_VERSION: string = '2.116.0';
+const CDK_VERSION: string = '2.122.0';
 
 const project = new awscdk.AwsCdkConstructLibrary({
   author: 'Amazon Web Services - Prototyping and Cloud Engineering',

.projenrc.ts

@@ -1,3 +1,7 @@
+# CDK Generative AI Constructs V0.1.60 (2024-02-13)
+
+Based on CDK library version 2.122.0
+
 # CDK Generative AI Constructs V0.1.35 (2024-01-24)
 
 Based on CDK library version 2.116.0

CHANGELOG.md

@@ -16,7 +16,7 @@ Default output format [None]: json
 ```
 
 - [Node](https://nodejs.org/en) >= v20.9.0
-- [AWS CDK](https://github.com/aws/aws-cdk/releases/tag/v2.102.0) >= 2.114.0
+- [AWS CDK](https://github.com/aws/aws-cdk/releases/tag/v2.122.0) >= 2.122.0
 - [Python](https://www.python.org/downloads/) >=3.9
 - [Projen](https://github.com/projen/projen) >= 0.78.8
 - [Yarn](https://classic.yarnpkg.com/lang/en/docs/cli/install/) >= 1.22.19

DEVELOPER_GUIDE.md

@@ -20,6 +20,7 @@ The JumpStartSageMakerEndpoint class.
 
 ### Properties
 
+- [acceptEula](JumpStartSageMakerEndpoint.md#accepteula)
 - [cfnEndpoint](JumpStartSageMakerEndpoint.md#cfnendpoint)
 - [cfnEndpointConfig](JumpStartSageMakerEndpoint.md#cfnendpointconfig)
 - [cfnModel](JumpStartSageMakerEndpoint.md#cfnmodel)
@@ -71,6 +72,12 @@ The JumpStartSageMakerEndpoint class.
 
 ## Properties
 
+### acceptEula
+
+• `Private` `Readonly` **acceptEula**: `boolean`
+
+___
+
 ### cfnEndpoint
 
 • `Readonly` **cfnEndpoint**: `CfnEndpoint`

apidocs/classes/JumpStartSageMakerEndpoint.md

@@ -15,6 +15,7 @@
 - [modelId](IJumpStartModelSpec.md#modelid)
 - [modelPackageArns](IJumpStartModelSpec.md#modelpackagearns)
 - [prepackedArtifactKey](IJumpStartModelSpec.md#prepackedartifactkey)
+- [requiresEula](IJumpStartModelSpec.md#requireseula)
 - [version](IJumpStartModelSpec.md#version)
 
 ## Properties
@@ -81,6 +82,12 @@ ___
 
 ___
 
+### requiresEula
+
+• **requiresEula**: `boolean`
+
+___
+
 ### version
 
 • **version**: `string`

apidocs/interfaces/IJumpStartModelSpec.md

@@ -6,6 +6,7 @@
 
 ### Properties
 
+- [acceptEula](JumpStartSageMakerEndpointProps.md#accepteula)
 - [endpointName](JumpStartSageMakerEndpointProps.md#endpointname)
 - [environment](JumpStartSageMakerEndpointProps.md#environment)
 - [instanceCount](JumpStartSageMakerEndpointProps.md#instancecount)
@@ -17,6 +18,12 @@
 
 ## Properties
 
+### acceptEula
+
+• `Optional` `Readonly` **acceptEula**: `boolean`
+
+___
+
 ### endpointName
 
 • `Optional` `Readonly` **endpointName**: `string`

apidocs/interfaces/JumpStartSageMakerEndpointProps.md

@@ -56,6 +56,7 @@ import { JumpStartSageMakerEndpoint, JumpStartModel, SageMakerInstanceType } fro
 // Deploy a model from SageMaker Foundation Models or SageMaker JumpStart
 new JumpStartSageMakerEndpoint(this, 'LLAMA2', {
   model: JumpStartModel.META_TEXTGENERATION_LLAMA_2_7B_F_2_0_2,
+  acceptEula: true,
   instanceType: SageMakerInstanceType.ML_G5_2XLARGE,
 });
 ```
@@ -73,6 +74,7 @@ JumpStartSageMakerEndpoint(
     self,
     'LLAMA2',
     model=JumpStartModel.META_TEXTGENERATION_LLAMA_2_7_B_F_2_0_2,
+    accept_eula=True,
     instance_type=SageMakerInstanceType.ML_G5_2_XLARGE,
 )
 ```
@@ -97,6 +99,7 @@ Parameters
 |:-------------|:----------------|-----------------|-----------------|
 | model | JumpStartModel | ![Required](https://img.shields.io/badge/required-ff0000) | The model to deploy |
 | endpointName | string| ![Optional](https://img.shields.io/badge/optional-4169E1) | Name of the SageMaker endpoint created by the construct |
+| acceptEula | boolean| ![Optional](https://img.shields.io/badge/optional-4169E1) | Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that the model requires. The user is responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for their use case before downloading or using a model. |
 | instanceType | SageMakerInstanceType | ![Optional](https://img.shields.io/badge/optional-4169E1) | The ML compute instance type. If not provided, the default instance type will be used. This value is available in the [models spec](./jumpstart-model.ts) |
 | instanceCount | Integer | ![Optional](https://img.shields.io/badge/optional-4169E1) | Number of instances to launch initially |
 | role | [iam.Role](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html) | ![Optional](https://img.shields.io/badge/optional-4169E1) | The IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. If not provided, this construct will create a new role with Full access to SageMaker.|

package.json

@@ -34,6 +34,7 @@ interface JumpStartModelSpec {
   hosting_artifact_key?: string;
   hosting_script_key?: string;
   hosting_prepacked_artifact_key?: string;
+  hosting_eula_key?: string;
   inference_environment_variables: {
     name: string;
     type: string;
@@ -114,6 +115,7 @@ export async function download_data() {
         hosting_prepacked_artifact_key,
         inference_environment_variables,
         hosting_instance_type_variants,
+        hosting_eula_key,
       } = modelSpec;
 
       const allowedFramework = ALLOWED_FRAMEWORKS.includes(hosting_ecr_specs.framework);
@@ -149,6 +151,7 @@ export async function download_data() {
         hosting_prepacked_artifact_key,
         inference_environment_variables,
         hosting_instance_type_variants,
+        hosting_eula_key,
       };
     }
   }
@@ -180,6 +183,7 @@ function generateCode() {
         environment[env.name] = env.default;
       }
 
+      const hosting_eula_key = specSource.hosting_eula_key;
       const instanceVariants = specSource.hosting_instance_type_variants?.variants;
       const instanceAliases = specSource.hosting_instance_type_variants?.regional_aliases;
       let instanceVariantsArr: any[] | undefined;
@@ -220,6 +224,7 @@ function generateCode() {
         environment,
         instanceAliases: instanceAliasesArr,
         instanceVariants: instanceVariantsArr,
+        requiresEula: hosting_eula_key,
       };
 
       if (spec.modelPackageArns) {
@@ -269,6 +274,7 @@ export interface IJumpStartModelSpec {
   environment: { [key: string]: string | number | boolean };
   instanceAliases?: IInstanceAliase[];
   instanceVariants?: IInstanceValiant[];
+  requiresEula: boolean;
 }
 
 export class JumpStartModel {

src/patterns/gen-ai/aws-model-deployment-sagemaker/README_jumpstart.md

@@ -35,6 +35,7 @@ export interface IJumpStartModelSpec {
   environment: { [key: string]: string | number | boolean };
   instanceAliases?: IInstanceAliase[];
   instanceVariants?: IInstanceValiant[];
+  requiresEula: boolean;
 }
 
 export class JumpStartModel {

src/patterns/gen-ai/aws-model-deployment-sagemaker/code-generation/generate-jumpstart-models.ts

@@ -28,6 +28,7 @@ export interface JumpStartSageMakerEndpointProps {
   readonly vpcConfig?: sagemaker.CfnModel.VpcConfigProperty | undefined;
   readonly environment?: { [key: string]: string };
   readonly startupHealthCheckTimeoutInSeconds?: number;
+  readonly acceptEula?: boolean;
 }
 
 /**
@@ -45,6 +46,7 @@ export class JumpStartSageMakerEndpoint extends SageMakerEndpointBase {
   public readonly instanceCount: number;
   public readonly role: iam.Role;
 
+  private readonly acceptEula: boolean;
   private readonly region: string;
   private readonly spec: IJumpStartModelSpec;
   private readonly startupHealthCheckTimeoutInSeconds: number;
@@ -56,12 +58,21 @@ export class JumpStartSageMakerEndpoint extends SageMakerEndpointBase {
     this.model = props.model;
     this.instanceType = props.instanceType;
     this.instanceCount = Math.max(1, props.instanceCount ?? 1);
+    this.acceptEula = props.acceptEula ?? false;
+
     this.role = props.role ?? this.createSageMakerRole();
     this.grantPrincipal = this.role;
 
     this.startupHealthCheckTimeoutInSeconds = props.startupHealthCheckTimeoutInSeconds ?? 600;
     this.environment = props.environment;
     this.spec = this.model.bind();
+
+    if (!this.acceptEula && this.spec.requiresEula) {
+      throw new Error(
+        'The AcceptEula value must be explicitly defined as True in order to accept the EULA for the model '+this.spec.modelId+'. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.',
+      );
+    }
+
     this.region = Stack.of(this).region;
 
     if (Token.isUnresolved(this.region)) {
@@ -211,6 +222,9 @@ export class JumpStartSageMakerEndpoint extends SageMakerEndpointBase {
             compressionType: 'None',
             s3DataType: 'S3Prefix',
             s3Uri: modelArtifactUrl,
+            modelAccessConfig: {
+              acceptEula: this.acceptEula,
+            },
           },
         },
         environment,

src/patterns/gen-ai/aws-model-deployment-sagemaker/jumpstart-model.ts

@@ -39,6 +39,7 @@ describe('JumpStartSageMakerEndpoint construct', () => {
 
     JmpStrtTestConstruct = new JumpStartSageMakerEndpoint(JmpStrtTestStack, 'test', {
       model: JumpStartModel.META_TEXTGENERATION_LLAMA_2_7B_F_2_0_2,
+      acceptEula: true,
       instanceType: SageMakerInstanceType.ML_G5_2XLARGE,
     });
     JmpStrtTestTemplate = Template.fromStack(JmpStrtTestStack);
@@ -90,6 +91,64 @@ describe('JumpStartSageMakerEndpoint construct', () => {
   });
 });
 
+describe('JumpStartSageMakerEndpoint eula validation', () => {
+
+  let JmpStrtTestStack: cdk.Stack;
+
+  afterAll(() => {
+    console.log('Test completed');
+  });
+
+  beforeAll(() => {
+
+    JmpStrtTestStack = new cdk.Stack(undefined, undefined, {
+      env: { account: cdk.Aws.ACCOUNT_ID, region: 'us-east-1' },
+    });
+
+  });
+
+  test('SageMaker endpoint fails to synth', () => {
+
+    //wrapping code in a function, otherwise the error will not be caught and the assertion will fail.
+    const t = () => {
+      new JumpStartSageMakerEndpoint(JmpStrtTestStack, 'test', {
+        model: JumpStartModel.META_TEXTGENERATION_LLAMA_2_7B_F_2_0_2,
+        acceptEula: false, // should fail synth
+        instanceType: SageMakerInstanceType.ML_G5_2XLARGE,
+      });
+    };
+
+    expect(t).toThrow('The AcceptEula value must be explicitly defined as True in order to accept the EULA for the model meta-textgeneration-llama-2-7b-f. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.');
+  });
+
+  test('SageMaker endpoint succeeds to synth', () => {
+
+    //wrapping code in a function, otherwise the error will not be caught and the assertion will fail.
+    const t = () => {
+      new JumpStartSageMakerEndpoint(JmpStrtTestStack, 'test2', {
+        model: JumpStartModel.META_TEXTGENERATION_LLAMA_2_7B_F_2_0_2,
+        acceptEula: true, // should succeed synth
+        instanceType: SageMakerInstanceType.ML_G5_2XLARGE,
+      });
+    };
+
+    expect(t).not.toThrow();
+  });
+
+  test('SageMaker endpoint doesnt require eula succeeds to synth', () => {
+
+    //wrapping code in a function, otherwise the error will not be caught and the assertion will fail.
+    const t = () => {
+      new JumpStartSageMakerEndpoint(JmpStrtTestStack, 'test3', {
+        model: JumpStartModel.MODEL_DEPTH2IMG_STABLE_DIFFUSION_V1_5_CONTROLNET_1_0_0, // eula not defined
+        instanceType: SageMakerInstanceType.ML_G5_2XLARGE,
+      });
+    };
+
+    expect(t).not.toThrow();
+  });
+});
+
 describe('JumpStartSageMakerEndpoint VPC construct', () => {
 
   let JmpStrtTestTemplate: Template;
@@ -140,6 +199,7 @@ describe('JumpStartSageMakerEndpoint VPC construct', () => {
     JmpStrtTestConstruct = new JumpStartSageMakerEndpoint(JmpStrtTestStack, 'test', {
       model: JumpStartModel.META_TEXTGENERATION_LLAMA_2_7B_F_2_0_2,
       instanceType: SageMakerInstanceType.ML_G5_2XLARGE,
+      acceptEula: true,
       vpcConfig: {
         securityGroupIds: securityGroups.map(s => s.securityGroupId),
         subnets: vpc.privateSubnets.map((subnet) => subnet.subnetId),