AWS Amazon SageMaker User Profile
This page shows how to write Terraform and CloudFormation for Amazon SageMaker User Profile and write them securely.
aws_sagemaker_user_profile (Terraform)
The User Profile in Amazon SageMaker can be configured in Terraform with the resource name aws_sagemaker_user_profile. The following sections describe 2 examples of how to use the resource and its parameters.
Example Usage from GitHub
resource "aws_sagemaker_user_profile" "sagemaker_user_profile" {
user_profile_name = "datascientist"
domain_id = aws_sagemaker_domain.domain.id
#single_sign_on_user_value = var.sagemaker_user_profile_single_sign_on_user_value
resource "aws_sagemaker_user_profile" "user" {
for_each = { for user in local.user_profiles : user.name => user }
domain_id = aws_sagemaker_domain.studio.0.id
user_profile_name = format("%s", local.name)
user_settings {
execution_role = aws_iam_role.ni.arn
Parameters
-
arnoptional computed - string -
domain_idrequired - string -
home_efs_file_system_uidoptional computed - string -
idoptional computed - string -
single_sign_on_user_identifieroptional - string -
single_sign_on_user_valueoptional - string -
tagsoptional - map from string to string -
user_profile_namerequired - string -
user_settingslist block-
execution_rolerequired - string -
security_groupsoptional - set of string -
jupyter_server_app_settingslist block-
default_resource_speclist block-
instance_typeoptional - string -
sagemaker_image_arnoptional - string
-
-
-
kernel_gateway_app_settingslist block-
custom_imagelist block-
app_image_config_namerequired - string -
image_namerequired - string -
image_version_numberoptional - number
-
-
default_resource_speclist block-
instance_typeoptional - string -
sagemaker_image_arnoptional - string
-
-
-
sharing_settingslist block-
notebook_output_optionoptional - string -
s3_kms_key_idoptional - string -
s3_output_pathoptional - string
-
-
tensor_board_app_settingslist block-
default_resource_speclist block-
instance_typeoptional - string -
sagemaker_image_arnoptional - string
-
-
-
Explanation in Terraform Registry
Provides a Sagemaker User Profile resource.
AWS::SageMaker::UserProfile (CloudFormation)
The UserProfile in SageMaker can be configured in CloudFormation with the resource name AWS::SageMaker::UserProfile. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
-
DomainIdrequired - String -
SingleSignOnUserIdentifieroptional - String -
SingleSignOnUserValueoptional - String -
UserProfileNamerequired - String -
UserSettingsoptional - UserSettings -
Tagsoptional - List of Tag
Explanation in CloudFormation Registry
Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from SSO, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.
Frequently asked questions
What is AWS Amazon SageMaker User Profile?
AWS Amazon SageMaker User Profile is a resource for Amazon SageMaker of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.
Where can I find the example code for the AWS Amazon SageMaker User Profile?
For Terraform, the DNXLabs/terraform-aws-sagemaker and Young-ook/terraform-aws-sagemaker source code examples are useful. See the Terraform Example section for further details.
