aws-cloudformation / aws-cloudformation/cloudformation-coverage-roadmap

Unable to add SageMaker Studio KernelGatewayApp LifeCycleConfig

Open
#1,392 4 comments 4 reactions 0 assignees View on GitHub
bug
Dominant language
No language data
Stars
1.1k
Forks
62
PR merge metrics
No merged PRs in 30d

Description

### Name of the resource

AWS::SageMaker::Domain

### Resource Name

_No response_

### Issue Description

I want to add a LifeCycleConfig to the SageMaker Studio Domain KernelGatewayApp, however the CFN fails.

The ARN pattern for a LifeCycleConfig is documented here: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-resourcespec.html#cfn-sagemaker-domain-resourcespec-lifecycleconfigarn

Here is the code Snippet:

```
AWSTemplateFormatVersion: "2010-09-09"

Resources:
StudioDomain:
Type: AWS::SageMaker::Domain
Properties:
VpcId: "vpc-xxx"
SubnetIds: ["subnet-xxx"]
DomainName: "MyDomainName"
AuthMode: SSO
DefaultUserSettings:
ExecutionRole: "arn:aws:iam::xxx:role/AmazonSageMaker-ExecutionRole-20210903T143299"
KernelGatewayAppSettings:
DefaultResourceSpec:
LifecycleConfigArn: "arn:aws:sagemaker:eu-central-1:xxx:studio-lifecycle-config/test-config"
```

### Expected Behavior

The Studio Domain with a LifeCycleConfig added to the KernelGatewayApp

### Observed Behavior

CloudFormation errors out with the message:

```
Properties validation failed for resource StudioDomain with message:

#/DefaultUserSettings/KernelGatewayAppSettings/DefaultResourceSpec/LifecycleConfigArn: failed validation constraint for keyword [pattern]
```

### Test Cases

ARN for LifeCycleConfig: `arn:aws:sagemaker:eu-central-1:xxx:studio-lifecycle-config/test-config`
Follows the pattern : `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*`

### Other Details

_No response_

Contributor guide

Open the contributing guide

Research direction

Start with the AWS::SageMaker::Domain DefaultUserSettings KernelGatewayAppSettings DefaultResourceSpec property and compare the documented LifecycleConfigArn ARN pattern with the failing test case. Check how the CloudFormation resource schema validates this value. Done means the supplied SageMaker lifecycle-config ARN is accepted and the Studio Domain can be created.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws
Domain
cloud
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.