Package software.amazon.awscdk.services.sagemaker

Class CfnUserProfile

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sagemaker.CfnUserProfile

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IUserProfileRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:29.872Z")
@Stability(Stable)
public class CfnUserProfile
extends CfnResource
implements IInspectable, IUserProfileRef, ITaggable

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 IAM Identity Center , 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 IAM Identity Center authentication, a user in IAM Identity Center , or a group in IAM Identity Center containing that user, must be assigned to the Amazon SageMaker Studio application from the IAM Identity Center Console to create a user profile. For more information about application assignment, see Assign user access . After assignment is complete, a user profile can be created for that user in IAM Identity Center with AWS CloudFormation.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 CfnUserProfile cfnUserProfile = CfnUserProfile.Builder.create(this, "MyCfnUserProfile")
         .domainId("domainId")
         .userProfileName("userProfileName")
         // the properties below are optional
         .singleSignOnUserIdentifier("singleSignOnUserIdentifier")
         .singleSignOnUserValue("singleSignOnUserValue")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userSettings(UserSettingsProperty.builder()
                 .autoMountHomeEfs("autoMountHomeEfs")
                 .codeEditorAppSettings(CodeEditorAppSettingsProperty.builder()
                         .appLifecycleManagement(AppLifecycleManagementProperty.builder()
                                 .idleSettings(IdleSettingsProperty.builder()
                                         .idleTimeoutInMinutes(123)
                                         .lifecycleManagement("lifecycleManagement")
                                         .maxIdleTimeoutInMinutes(123)
                                         .minIdleTimeoutInMinutes(123)
                                         .build())
                                 .build())
                         .builtInLifecycleConfigArn("builtInLifecycleConfigArn")
                         .customImages(List.of(CustomImageProperty.builder()
                                 .appImageConfigName("appImageConfigName")
                                 .imageName("imageName")
                                 // the properties below are optional
                                 .imageVersionNumber(123)
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                         .build())
                 .customFileSystemConfigs(List.of(CustomFileSystemConfigProperty.builder()
                         .efsFileSystemConfig(EFSFileSystemConfigProperty.builder()
                                 .fileSystemId("fileSystemId")
                                 // the properties below are optional
                                 .fileSystemPath("fileSystemPath")
                                 .build())
                         .fSxLustreFileSystemConfig(FSxLustreFileSystemConfigProperty.builder()
                                 .fileSystemId("fileSystemId")
                                 // the properties below are optional
                                 .fileSystemPath("fileSystemPath")
                                 .build())
                         .s3FileSystemConfig(S3FileSystemConfigProperty.builder()
                                 .mountPath("mountPath")
                                 .s3Uri("s3Uri")
                                 .build())
                         .build()))
                 .customPosixUserConfig(CustomPosixUserConfigProperty.builder()
                         .gid(123)
                         .uid(123)
                         .build())
                 .defaultLandingUri("defaultLandingUri")
                 .executionRole("executionRole")
                 .jupyterLabAppSettings(JupyterLabAppSettingsProperty.builder()
                         .appLifecycleManagement(AppLifecycleManagementProperty.builder()
                                 .idleSettings(IdleSettingsProperty.builder()
                                         .idleTimeoutInMinutes(123)
                                         .lifecycleManagement("lifecycleManagement")
                                         .maxIdleTimeoutInMinutes(123)
                                         .minIdleTimeoutInMinutes(123)
                                         .build())
                                 .build())
                         .builtInLifecycleConfigArn("builtInLifecycleConfigArn")
                         .codeRepositories(List.of(CodeRepositoryProperty.builder()
                                 .repositoryUrl("repositoryUrl")
                                 .build()))
                         .customImages(List.of(CustomImageProperty.builder()
                                 .appImageConfigName("appImageConfigName")
                                 .imageName("imageName")
                                 // the properties below are optional
                                 .imageVersionNumber(123)
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                         .build())
                 .jupyterServerAppSettings(JupyterServerAppSettingsProperty.builder()
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                         .build())
                 .kernelGatewayAppSettings(KernelGatewayAppSettingsProperty.builder()
                         .customImages(List.of(CustomImageProperty.builder()
                                 .appImageConfigName("appImageConfigName")
                                 .imageName("imageName")
                                 // the properties below are optional
                                 .imageVersionNumber(123)
                                 .build()))
                         .defaultResourceSpec(ResourceSpecProperty.builder()
                                 .instanceType("instanceType")
                                 .lifecycleConfigArn("lifecycleConfigArn")
                                 .sageMakerImageArn("sageMakerImageArn")
                                 .sageMakerImageVersionArn("sageMakerImageVersionArn")
                                 .build())
                         .lifecycleConfigArns(List.of("lifecycleConfigArns"))
                         .build())
                 .rStudioServerProAppSettings(RStudioServerProAppSettingsProperty.builder()
                         .accessStatus("accessStatus")
                         .userGroup("userGroup")
                         .build())
                 .securityGroups(List.of("securityGroups"))
                 .sharingSettings(SharingSettingsProperty.builder()
                         .notebookOutputOption("notebookOutputOption")
                         .s3KmsKeyId("s3KmsKeyId")
                         .s3OutputPath("s3OutputPath")
                         .build())
                 .spaceStorageSettings(DefaultSpaceStorageSettingsProperty.builder()
                         .defaultEbsStorageSettings(DefaultEbsStorageSettingsProperty.builder()
                                 .defaultEbsVolumeSizeInGb(123)
                                 .maximumEbsVolumeSizeInGb(123)
                                 .build())
                         .build())
                 .studioWebPortal("studioWebPortal")
                 .studioWebPortalSettings(StudioWebPortalSettingsProperty.builder()
                         .hiddenAppTypes(List.of("hiddenAppTypes"))
                         .hiddenInstanceTypes(List.of("hiddenInstanceTypes"))
                         .hiddenMlTools(List.of("hiddenMlTools"))
                         .hiddenSageMakerImageVersionAliases(List.of(HiddenSageMakerImageProperty.builder()
                                 .sageMakerImageName("sageMakerImageName")
                                 .versionAliases(List.of("versionAliases"))
                                 .build()))
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-userprofile.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnUserProfile.AppLifecycleManagementProperty	Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications.
static final class	CfnUserProfile.Builder	A fluent builder for CfnUserProfile.
static interface	CfnUserProfile.CodeEditorAppSettingsProperty	The Code Editor application settings.
static interface	CfnUserProfile.CodeRepositoryProperty	A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.
static interface	CfnUserProfile.CustomFileSystemConfigProperty	The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain.
static interface	CfnUserProfile.CustomImageProperty	A custom SageMaker AI image.
static interface	CfnUserProfile.CustomPosixUserConfigProperty	Details about the POSIX identity that is used for file system operations.
static interface	CfnUserProfile.DefaultEbsStorageSettingsProperty	A collection of default EBS storage settings that apply to spaces created within a domain or user profile.
static interface	CfnUserProfile.DefaultSpaceStorageSettingsProperty	The default storage settings for a space.
static interface	CfnUserProfile.EFSFileSystemConfigProperty	The settings for assigning a custom Amazon EFS file system to a user profile or space for an Amazon SageMaker AI Domain.
static interface	CfnUserProfile.FSxLustreFileSystemConfigProperty	The settings for assigning a custom Amazon FSx for Lustre file system to a user profile or space for an Amazon SageMaker Domain.
static interface	CfnUserProfile.HiddenSageMakerImageProperty	The SageMaker images that are hidden from the Studio user interface.
static interface	CfnUserProfile.IdleSettingsProperty	Settings related to idle shutdown of Studio applications.
static interface	CfnUserProfile.JupyterLabAppSettingsProperty	The settings for the JupyterLab application.
static interface	CfnUserProfile.JupyterServerAppSettingsProperty	The JupyterServer app settings.
static interface	CfnUserProfile.KernelGatewayAppSettingsProperty	The KernelGateway app settings.
static interface	CfnUserProfile.ResourceSpecProperty	Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.
static interface	CfnUserProfile.RStudioServerProAppSettingsProperty	A collection of settings that configure user interaction with the RStudioServerPro app.
static interface	CfnUserProfile.S3FileSystemConfigProperty	Configuration for the custom Amazon S3 file system.
static interface	CfnUserProfile.SharingSettingsProperty	Specifies options when sharing an Amazon SageMaker Studio notebook.
static interface	CfnUserProfile.StudioWebPortalSettingsProperty	Studio settings.
static interface	CfnUserProfile.UserSettingsProperty	A collection of settings that apply to users of Amazon SageMaker Studio.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.sagemaker.IUserProfileRef

IUserProfileRef.Jsii$Default, IUserProfileRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnUserProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserProfile(software.amazon.jsii.JsiiObjectRef objRef)
	CfnUserProfile(software.constructs.Construct scope, String id, CfnUserProfileProps props)	Create a new AWS::SageMaker::UserProfile.

Method Summary

Modifier and Type	Method	Description
static String	arnForUserProfile(IUserProfileRef resource)
String	getAttrUserProfileArn()	The Amazon Resource Name (ARN) of the user profile, such as arn:aws:sagemaker:region:account-id:user-profile/domain-id/user-profile-name .
protected Map<String,Object>	getCfnProperties()
String	getDomainId()	The domain ID.
String	getSingleSignOnUserIdentifier()	A specifier for the type of value specified in SingleSignOnUserValue.
String	getSingleSignOnUserValue()	The username of the associated AWS Single Sign-On User for this UserProfile.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	An array of key-value pairs to apply to this resource.
String	getUserProfileName()	The user profile name.
UserProfileReference	getUserProfileRef()	A reference to a UserProfile resource.
Object	getUserSettings()	A collection of settings that apply to users of Amazon SageMaker Studio.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDomainId(String value)	The domain ID.
void	setSingleSignOnUserIdentifier(String value)	A specifier for the type of value specified in SingleSignOnUserValue.
void	setSingleSignOnUserValue(String value)	The username of the associated AWS Single Sign-On User for this UserProfile.
void	setTagsRaw(List<CfnTag> value)	An array of key-value pairs to apply to this resource.
void	setUserProfileName(String value)	The user profile name.
void	setUserSettings(IResolvable value)	A collection of settings that apply to users of Amazon SageMaker Studio.
void	setUserSettings(CfnUserProfile.UserSettingsProperty value)	A collection of settings that apply to users of Amazon SageMaker Studio.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnUserProfile

protected CfnUserProfile(software.amazon.jsii.JsiiObjectRef objRef)

CfnUserProfile

protected CfnUserProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUserProfile

@Stability(Stable)
public CfnUserProfile(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnUserProfileProps props)

Create a new AWS::SageMaker::UserProfile.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

arnForUserProfile

@Stability(Stable)
@NotNull
public static String arnForUserProfile(@NotNull
 IUserProfileRef resource)

Parameters:

resource - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrUserProfileArn

@Stability(Stable)
@NotNull
public String getAttrUserProfileArn()

The Amazon Resource Name (ARN) of the user profile, such as arn:aws:sagemaker:region:account-id:user-profile/domain-id/user-profile-name .

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getUserProfileRef

@Stability(Stable)
@NotNull
public UserProfileReference getUserProfileRef()

A reference to a UserProfile resource.

Specified by:

getUserProfileRef in interface IUserProfileRef

getDomainId

@Stability(Stable)
@NotNull
public String getDomainId()

The domain ID.

setDomainId

@Stability(Stable)
public void setDomainId(@NotNull
 String value)

The domain ID.

getUserProfileName

@Stability(Stable)
@NotNull
public String getUserProfileName()

The user profile name.

setUserProfileName

@Stability(Stable)
public void setUserProfileName(@NotNull
 String value)

The user profile name.

getSingleSignOnUserIdentifier

@Stability(Stable)
@Nullable
public String getSingleSignOnUserIdentifier()

A specifier for the type of value specified in SingleSignOnUserValue.

setSingleSignOnUserIdentifier

@Stability(Stable)
public void setSingleSignOnUserIdentifier(@Nullable
 String value)

A specifier for the type of value specified in SingleSignOnUserValue.

getSingleSignOnUserValue

@Stability(Stable)
@Nullable
public String getSingleSignOnUserValue()

The username of the associated AWS Single Sign-On User for this UserProfile.

setSingleSignOnUserValue

@Stability(Stable)
public void setSingleSignOnUserValue(@Nullable
 String value)

The username of the associated AWS Single Sign-On User for this UserProfile.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

An array of key-value pairs to apply to this resource.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

An array of key-value pairs to apply to this resource.

getUserSettings

@Stability(Stable)
@Nullable
public Object getUserSettings()

A collection of settings that apply to users of Amazon SageMaker Studio.

Returns union: either IResolvable or CfnUserProfile.UserSettingsProperty

setUserSettings

@Stability(Stable)
public void setUserSettings(@Nullable
 IResolvable value)

A collection of settings that apply to users of Amazon SageMaker Studio.

setUserSettings

@Stability(Stable)
public void setUserSettings(@Nullable
 CfnUserProfile.UserSettingsProperty value)

A collection of settings that apply to users of Amazon SageMaker Studio.