[Enhancement]: aws_sagemaker_domain customize user interface

[jmeisele]

Description

You can now customize the sagemaker domain user interface at either the domain level or the user profile level, this request is specifically for the aws_sagemaker_domain level. boto3 equivalent create & update command has the new argument under DefaultUserSettings

StudioWebPortalSettings

This allows you to "hide" UI elements from your sagemaker domain instance.

        'StudioWebPortalSettings': {
            'HiddenMlTools': [
                'DataWrangler'|'FeatureStore'|'EmrClusters'|'AutoMl'|'Experiments'|'Training'|'ModelEvaluation'|'Pipelines'|'Models'|'JumpStart'|'InferenceRecommender'|'Endpoints'|'Projects',
            ],
            'HiddenAppTypes': [
                'JupyterServer'|'KernelGateway'|'DetailedProfiler'|'TensorBoard'|'CodeEditor'|'JupyterLab'|'RStudioServerPro'|'RSessionGateway'|'Canvas',
            ]
        }

https://docs.aws.amazon.com/sagemaker/latest/dg/studio-updated-ui-customize.html

Affected Resource(s) and/or Data Source(s)

aws_sagemaker_domain

Potential Terraform Configuration

resource "aws_sagemaker_domain" "example" {
  domain_name = "example"
  auth_mode   = "IAM"
  vpc_id      = aws_vpc.example.id
  subnet_ids  = [aws_subnet.example.id]

  default_user_settings {
    execution_role = aws_iam_role.example.arn
    studio_web_portal_settings {
      hidden_ml_tools = ['DataWrangler', 'FeatureStore']
      hidden_app_types = ['Canvas', 'TensorBoard']
    }
  }
}

References

AWS Docs Here

boto3 comparable commands here:

• update domain
• create domain

go comparable references here:

• CreateDomain
  -- CreateDomainInput
  --- UserSettings
  --- StudioWebPortalSettings

Would you like to implement a fix?

None

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
• Please see our prioritization guide for information on how we prioritize.
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

Volunteering to Work on This Issue

• If you are interested in working on this issue, please leave a comment.
• If this would be your first contribution, please review the contribution guide.

[jmeisele]

Tagging @DrFaust92 since he's been so helpful with other sagemaker related terraform requests 🫶

[deepakbshetty]

For information, Hidden App types and ML Tools feature is only available for Sagemaker studio domain and not User profile.

[jmeisele]

For information, Hidden App types and ML Tools feature is only available for Sagemaker studio domain and not User profile.

@deepakbshetty thank you for implementing this enhancement 🚀

Where were you reading the domain is the only place to customize? The AWS docs show you can customize at both the domain level and user profile level, but this issue I raised was only for the domain resource.

https://docs.aws.amazon.com/sagemaker/latest/dg/studio-updated-ui-customize.html

[deepakbshetty]

@jmeisele Apologies you are right. Might have referred to out of date docs. I will raise PR for user profile when I can

[jmeisele]

@jmeisele Apologies you are right. Might have referred to out of date docs. I will raise PR for user profile when I can

No rush on the user profile changes, this issue I raised was just for the domain resource. Regardless, thank you for taking the time to implement this enhancement 🤝

[github-actions]

Warning

This issue has been closed, meaning that any additional comments are hard for our team to see. Please assume that the maintainers will not see them.

Ongoing conversations amongst community members are welcome, however, the issue will be locked after 30 days. Moving conversations to another venue, such as the AWS Provider forum, is recommended. If you have additional concerns, please open a new issue, referencing this one where needed.

[github-actions]

This functionality has been released in v5.67.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!