AWS::SageMaker::UserProfileCfnUserProfile
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. > If you're using SSO authentication, a user in SSO , or a group in SSO containing that user, must be assigned to the Amazon SageMaker Studio application from the SSO Console to create a user profile. For more information about application assignment, see [Assign user access](https://docs.aws.amazon.com/singlesignon/latest/userguide/assignuserstoapp.html) . After assignment is complete, a user profile can be created for that user in SSO with AWS CloudFormation.
Import
import { CfnUserProfile } from 'aws-cdk-lib/aws-sagemaker';Or use the module namespace:
import * as sagemaker from 'aws-cdk-lib/aws-sagemaker';
// sagemaker.CfnUserProfileProperties
Configuration passed to the constructor as CfnUserProfileProps.
domainIdRequiredstring | IDomainRefThe domain ID.
userProfileNameRequiredstringThe user profile name.
singleSignOnUserIdentifierOptionalstringA 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.
singleSignOnUserValueOptionalstringThe 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.
tagsOptionalCfnTag[]An array of key-value pairs to apply to this resource. Tags that you specify for the User Profile are also added to all apps that the User Profile launches. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
userSettingsOptionalIResolvable | UserSettingsPropertyA collection of settings that apply to users of Amazon SageMaker Studio.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-sagemakerAWS::SageMaker::UserProfile