aws-cloudformation / aws-cloudformation/cloudformation-coverage-roadmap
AWS::SageMaker::Domain | Improve visibility on validation errors
- 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
AWS::SageMaker::Domain
### Description
When specifying an incorrect ARN for [LifecycleConfigArns](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-codeeditorappsettings.html#cfn-sagemaker-domain-codeeditorappsettings-lifecycleconfigarns), CloudFormation returns the validation error:
```
#/DefaultUserSettings/CodeEditorAppSettings/LifecycleConfigArns/0: failed validation constraint for keyword [pattern]
```
After creating an AWS support case, it was identified that the ARN passed is of a `notebook-instance-lifecycle-config` instead of the expected `StudioLifecycleConfigArn` pattern (see below):
```
arn:aws:sagemaker:us-east-1:000000000000:notebook-instance-lifecycle-config/my-config
```
As per `AWS::Sagemaker::Domain` schema, `StudioLifecycleConfigArn`:
```
"StudioLifecycleConfigArn" : {
"type" : "string",
"description" : "The Amazon Resource Name (ARN) of the Lifecycle Configuration to attach to the Resource.",
"maxLength" : 256,
"pattern" : "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:studio-lifecycle-config/.*"
},
```
We would like to request better visibility and handling of such validation errors.
### Other Details
_No response_
Contributor guide
Research direction
Start with the AWS::SageMaker::Domain schema for CodeEditorAppSettings.LifecycleConfigArns and the documented StudioLifecycleConfigArn pattern. Reproduce the invalid notebook-instance-lifecycle-config ARN case and determine the expected validation message or handling; done means the error clearly identifies the expected ARN type.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws
- Domain
- cloud
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100