user_profiles

Creates, updates, deletes or gets an user_profile resource or lists user_profiles in a region

Overview

Name	user_profiles
Type	Resource
Description	Resource Type definition for AWS::SageMaker::UserProfile
Id	awscc.sagemaker.user_profiles

Fields

get (all properties)

Name	Datatype	Description
user_profile_arn	string	The user profile Amazon Resource Name (ARN).
domain_id	string	The ID of the associated Domain.
single_sign_on_user_identifier	string	A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified.
single_sign_on_user_value	string	The username of the associated AWS Single Sign-On User for this UserProfile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified.
user_profile_name	string	A name for the UserProfile.
▶user_settings	object	A collection of settings.
▶tags	array	A list of tags to apply to the user profile.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
domain_id	string	The ID of the associated Domain.
user_profile_name	string	A name for the UserProfile.
region	string	AWS region.

For more information, see AWS::SageMaker::UserProfile.

Methods

Name	Resource	Accessible by	Required Params
create_resource	user_profiles	INSERT	DomainId, UserProfileName, region
delete_resource	user_profiles	DELETE	Identifier, region
update_resource	user_profiles	UPDATE	Identifier, PatchDocument, region
list_resources	user_profiles_list_only	SELECT	region
get_resource	user_profiles	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual user_profile.

SELECT
  region,
  user_profile_arn,
  domain_id,
  single_sign_on_user_identifier,
  single_sign_on_user_value,
  user_profile_name,
  user_settings,
  tags
FROM awscc.sagemaker.user_profiles
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ user_profile_name }}|{{ domain_id }}';

list (identifiers only)

Lists all user_profiles in a region.

SELECT
  region,
  user_profile_name,
  domain_id
FROM awscc.sagemaker.user_profiles_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new user_profile resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.sagemaker.user_profiles (
  DomainId,
  UserProfileName,
  region
)
SELECT
  '{{ domain_id }}',
  '{{ user_profile_name }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.sagemaker.user_profiles (
  DomainId,
  SingleSignOnUserIdentifier,
  SingleSignOnUserValue,
  UserProfileName,
  UserSettings,
  Tags,
  region
)
SELECT
  '{{ domain_id }}',
  '{{ single_sign_on_user_identifier }}',
  '{{ single_sign_on_user_value }}',
  '{{ user_profile_name }}',
  '{{ user_settings }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: user_profile
    props:
      - name: domain_id
        value: '{{ domain_id }}'
      - name: single_sign_on_user_identifier
        value: '{{ single_sign_on_user_identifier }}'
      - name: single_sign_on_user_value
        value: '{{ single_sign_on_user_value }}'
      - name: user_profile_name
        value: '{{ user_profile_name }}'
      - name: user_settings
        value:
          execution_role: '{{ execution_role }}'
          auto_mount_home_ef_s: '{{ auto_mount_home_ef_s }}'
          jupyter_server_app_settings:
            default_resource_spec:
              instance_type: '{{ instance_type }}'
              sage_maker_image_arn: '{{ sage_maker_image_arn }}'
              sage_maker_image_version_arn: '{{ sage_maker_image_version_arn }}'
              lifecycle_config_arn: '{{ lifecycle_config_arn }}'
            lifecycle_config_arns:
              - '{{ lifecycle_config_arns[0] }}'
          kernel_gateway_app_settings:
            custom_images:
              - app_image_config_name: '{{ app_image_config_name }}'
                image_name: '{{ image_name }}'
                image_version_number: '{{ image_version_number }}'
            default_resource_spec: null
            lifecycle_config_arns:
              - null
          r_studio_server_pro_app_settings:
            access_status: '{{ access_status }}'
            user_group: '{{ user_group }}'
          jupyter_lab_app_settings:
            default_resource_spec: null
            lifecycle_config_arns:
              - null
            code_repositories:
              - repository_url: '{{ repository_url }}'
            custom_images:
              - null
            app_lifecycle_management:
              idle_settings:
                lifecycle_management: '{{ lifecycle_management }}'
                idle_timeout_in_minutes: '{{ idle_timeout_in_minutes }}'
                min_idle_timeout_in_minutes: '{{ min_idle_timeout_in_minutes }}'
                max_idle_timeout_in_minutes: '{{ max_idle_timeout_in_minutes }}'
            built_in_lifecycle_config_arn: '{{ built_in_lifecycle_config_arn }}'
          space_storage_settings:
            default_ebs_storage_settings:
              default_ebs_volume_size_in_gb: '{{ default_ebs_volume_size_in_gb }}'
              maximum_ebs_volume_size_in_gb: null
          code_editor_app_settings:
            default_resource_spec: null
            lifecycle_config_arns:
              - null
            custom_images:
              - null
            app_lifecycle_management: null
            built_in_lifecycle_config_arn: '{{ built_in_lifecycle_config_arn }}'
          studio_web_portal_settings:
            hidden_ml_tools:
              - '{{ hidden_ml_tools[0] }}'
            hidden_app_types:
              - '{{ hidden_app_types[0] }}'
            hidden_instance_types:
              - '{{ hidden_instance_types[0] }}'
            hidden_sage_maker_image_version_aliases:
              - sage_maker_image_name: '{{ sage_maker_image_name }}'
                version_aliases:
                  - '{{ version_aliases[0] }}'
          default_landing_uri: '{{ default_landing_uri }}'
          studio_web_portal: '{{ studio_web_portal }}'
          custom_posix_user_config:
            uid: '{{ uid }}'
            gid: '{{ gid }}'
          custom_file_system_configs:
            - e_fs_file_system_config:
                file_system_path: '{{ file_system_path }}'
                file_system_id: '{{ file_system_id }}'
              f_sx_lustre_file_system_config:
                file_system_path: '{{ file_system_path }}'
                file_system_id: '{{ file_system_id }}'
              s3_file_system_config:
                mount_path: '{{ mount_path }}'
                s3_uri: '{{ s3_uri }}'
          security_groups:
            - '{{ security_groups[0] }}'
          sharing_settings:
            notebook_output_option: '{{ notebook_output_option }}'
            s3_kms_key_id: '{{ s3_kms_key_id }}'
            s3_output_path: '{{ s3_output_path }}'
      - name: tags
        value:
          - value: '{{ value }}'
            key: '{{ key }}'

DELETE example

/*+ delete */
DELETE FROM awscc.sagemaker.user_profiles
WHERE
  Identifier = '{{ user_profile_name }}|{{ domain_id }}' AND
  region = 'us-east-1';

Permissions

To operate on the user_profiles resource, the following permissions are required:

Create

sagemaker:CreateUserProfile,
sagemaker:DescribeUserProfile,
sagemaker:DescribeImage,
sagemaker:DescribeImageVersion,
iam:PassRole

Read

sagemaker:DescribeUserProfile

Update

sagemaker:UpdateUserProfile,
sagemaker:DescribeUserProfile,
sagemaker:DescribeImage,
sagemaker:DescribeImageVersion,
iam:PassRole

Delete

sagemaker:DeleteUserProfile,
sagemaker:DescribeUserProfile

List

sagemaker:ListUserProfiles