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

[AWS::SageMaker::Domain] - [Coverage] - Missing support to HiddenInstanceTypes property in StudioWebPortalSettings on CloudFormation

Open
#2,250 0 comments 0 reactions 0 assignees View on GitHub
Coverage
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_

### Description

[AWS::SageMaker::Domain StudioWebPortalSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-domain-studiowebportalsettings.html) currently does not support ` HiddenInstanceTypes ` property.

This is supported in [API](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StudioWebPortalSettings.html) and CLI
[create-domain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sagemaker/create-domain.html)
[update-domain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sagemaker/update-domain.html)

When using the `HiddenInstanceTypes` property, CloudFormation gives the following error:
```
[#/DefaultUserSettings/StudioWebPortalSettings: extraneous key [HiddenInstanceTypes] is not permitted]
```

Sample template to replicate the issue:
```
Resources:
SageMakerResource:
Type: AWS::SageMaker::Domain
Properties:
AuthMode: IAM
DefaultUserSettings:
StudioWebPortalSettings:
HiddenInstanceTypes:
- ml.r6id.32xlarge
DomainName: domainname
SubnetIds:
- subnet-abc
VpcId: vpc-abc
```

### Other Details

_No response_

Contributor guide

Open the contributing guide

Research direction

Start with the AWS::SageMaker::Domain StudioWebPortalSettings documentation and the provided CloudFormation template, then compare them with the linked SageMaker API and create-domain/update-domain references. Done means HiddenInstanceTypes is accepted in that nested property and the sample no longer produces the extraneous-key validation error.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws
Domain
cloud
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.