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	aws.sagemaker.user_profiles

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DomainId, UserProfileName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all user_profiles in a region.

SELECT
region,
user_profile_arn,
domain_id,
single_sign_on_user_identifier,
single_sign_on_user_value,
user_profile_name,
user_settings,
tags
FROM aws.sagemaker.user_profiles
WHERE region = 'us-east-1';

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 aws.sagemaker.user_profiles
WHERE region = 'us-east-1' AND data__Identifier = '<UserProfileName>|<DomainId>';

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 aws.sagemaker.user_profiles (
 DomainId,
 UserProfileName,
 region
)
SELECT 
'{{ DomainId }}',
 '{{ UserProfileName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sagemaker.user_profiles (
 DomainId,
 SingleSignOnUserIdentifier,
 SingleSignOnUserValue,
 UserProfileName,
 UserSettings,
 Tags,
 region
)
SELECT 
 '{{ DomainId }}',
 '{{ SingleSignOnUserIdentifier }}',
 '{{ SingleSignOnUserValue }}',
 '{{ UserProfileName }}',
 '{{ UserSettings }}',
 '{{ 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: DomainId
        value: '{{ DomainId }}'
      - name: SingleSignOnUserIdentifier
        value: '{{ SingleSignOnUserIdentifier }}'
      - name: SingleSignOnUserValue
        value: '{{ SingleSignOnUserValue }}'
      - name: UserProfileName
        value: '{{ UserProfileName }}'
      - name: UserSettings
        value:
          ExecutionRole: '{{ ExecutionRole }}'
          JupyterServerAppSettings:
            DefaultResourceSpec:
              InstanceType: '{{ InstanceType }}'
              SageMakerImageArn: '{{ SageMakerImageArn }}'
              SageMakerImageVersionArn: '{{ SageMakerImageVersionArn }}'
          KernelGatewayAppSettings:
            CustomImages:
              - AppImageConfigName: '{{ AppImageConfigName }}'
                ImageName: '{{ ImageName }}'
                ImageVersionNumber: '{{ ImageVersionNumber }}'
            DefaultResourceSpec: null
          RStudioServerProAppSettings:
            AccessStatus: '{{ AccessStatus }}'
            UserGroup: '{{ UserGroup }}'
          JupyterLabAppSettings:
            DefaultResourceSpec: null
            LifecycleConfigArns:
              - '{{ LifecycleConfigArns[0] }}'
            CodeRepositories:
              - RepositoryUrl: '{{ RepositoryUrl }}'
            CustomImages:
              - null
          SpaceStorageSettings:
            DefaultEbsStorageSettings:
              DefaultEbsVolumeSizeInGb: '{{ DefaultEbsVolumeSizeInGb }}'
              MaximumEbsVolumeSizeInGb: null
          CodeEditorAppSettings:
            DefaultResourceSpec: null
            LifecycleConfigArns:
              - null
            CustomImages:
              - null
          DefaultLandingUri: '{{ DefaultLandingUri }}'
          StudioWebPortal: '{{ StudioWebPortal }}'
          CustomPosixUserConfig:
            Uid: '{{ Uid }}'
            Gid: '{{ Gid }}'
          CustomFileSystemConfigs:
            - EFSFileSystemConfig:
                FileSystemPath: '{{ FileSystemPath }}'
                FileSystemId: '{{ FileSystemId }}'
          SecurityGroups:
            - '{{ SecurityGroups[0] }}'
          SharingSettings:
            NotebookOutputOption: '{{ NotebookOutputOption }}'
            S3KmsKeyId: '{{ S3KmsKeyId }}'
            S3OutputPath: '{{ S3OutputPath }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM aws.sagemaker.user_profiles
WHERE data__Identifier = '<UserProfileName|DomainId>'
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