Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnUserProfilePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnUserProfilePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.196Z")
@Stability(Stable)
public class CfnUserProfilePropsMixin
extends Mixin
implements software.constructs.IMixin

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 . After assignment is complete, a user profile can be created for that user in SSO 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.cfnpropertymixins.services.sagemaker.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnUserProfilePropsMixin cfnUserProfilePropsMixin = CfnUserProfilePropsMixin.Builder.create(CfnUserProfileMixinProps.builder()
         .domainId("domainId")
         .singleSignOnUserIdentifier("singleSignOnUserIdentifier")
         .singleSignOnUserValue("singleSignOnUserValue")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userProfileName("userProfileName")
         .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")
                                 .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")
                                 .fileSystemPath("fileSystemPath")
                                 .build())
                         .fSxLustreFileSystemConfig(FSxLustreFileSystemConfigProperty.builder()
                                 .fileSystemId("fileSystemId")
                                 .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")
                                 .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")
                                 .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())
 .strategy(mergeStrategy)
 .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	CfnUserProfilePropsMixin.AppLifecycleManagementProperty	Settings that are used to configure and manage the lifecycle of Amazon SageMaker Studio applications.
static final class	CfnUserProfilePropsMixin.Builder	A fluent builder for CfnUserProfilePropsMixin.
static interface	CfnUserProfilePropsMixin.CodeEditorAppSettingsProperty	The Code Editor application settings.
static interface	CfnUserProfilePropsMixin.CodeRepositoryProperty	A Git repository that SageMaker AI automatically displays to users for cloning in the JupyterServer application.
static interface	CfnUserProfilePropsMixin.CustomFileSystemConfigProperty	The settings for assigning a custom file system to a user profile or space for an Amazon SageMaker AI Domain.
static interface	CfnUserProfilePropsMixin.CustomImageProperty	A custom SageMaker AI image.
static interface	CfnUserProfilePropsMixin.CustomPosixUserConfigProperty	Details about the POSIX identity that is used for file system operations.
static interface	CfnUserProfilePropsMixin.DefaultEbsStorageSettingsProperty	A collection of default EBS storage settings that apply to spaces created within a domain or user profile.
static interface	CfnUserProfilePropsMixin.DefaultSpaceStorageSettingsProperty	The default storage settings for a space.
static interface	CfnUserProfilePropsMixin.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	CfnUserProfilePropsMixin.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	CfnUserProfilePropsMixin.HiddenSageMakerImageProperty	The SageMaker images that are hidden from the Studio user interface.
static interface	CfnUserProfilePropsMixin.IdleSettingsProperty	Settings related to idle shutdown of Studio applications.
static interface	CfnUserProfilePropsMixin.JupyterLabAppSettingsProperty	The settings for the JupyterLab application.
static interface	CfnUserProfilePropsMixin.JupyterServerAppSettingsProperty	The JupyterServer app settings.
static interface	CfnUserProfilePropsMixin.KernelGatewayAppSettingsProperty	The KernelGateway app settings.
static interface	CfnUserProfilePropsMixin.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	CfnUserProfilePropsMixin.RStudioServerProAppSettingsProperty	A collection of settings that configure user interaction with the RStudioServerPro app.
static interface	CfnUserProfilePropsMixin.S3FileSystemConfigProperty	Configuration for the custom Amazon S3 file system.
static interface	CfnUserProfilePropsMixin.SharingSettingsProperty	Specifies options when sharing an Amazon SageMaker Studio notebook.
static interface	CfnUserProfilePropsMixin.StudioWebPortalSettingsProperty	Studio settings.
static interface	CfnUserProfilePropsMixin.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.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnUserProfilePropsMixin(CfnUserProfileMixinProps props)	Create a mixin to apply properties to AWS::SageMaker::UserProfile.
	CfnUserProfilePropsMixin(CfnUserProfileMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::SageMaker::UserProfile.
protected	CfnUserProfilePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserProfilePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnUserProfileMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnUserProfilePropsMixin

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

CfnUserProfilePropsMixin

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

CfnUserProfilePropsMixin

@Stability(Stable)
public CfnUserProfilePropsMixin(@NotNull
 CfnUserProfileMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::SageMaker::UserProfile.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnUserProfilePropsMixin

@Stability(Stable)
public CfnUserProfilePropsMixin(@NotNull
 CfnUserProfileMixinProps props)

Create a mixin to apply properties to AWS::SageMaker::UserProfile.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnUserProfileMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()