Interface CfnUserProfile.IUserSettingsProperty
A collection of settings that apply to users of Amazon SageMaker Studio.
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnUserProfile.IUserSettingsPropertySyntax (vb)
Public Interface CfnUserProfile.IUserSettingsPropertyRemarks
These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.
SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings , the values specified in CreateUserProfile take precedence over those specified in CreateDomain .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var userSettingsProperty = new UserSettingsProperty {
AutoMountHomeEfs = "autoMountHomeEfs",
CodeEditorAppSettings = new CodeEditorAppSettingsProperty {
AppLifecycleManagement = new AppLifecycleManagementProperty {
IdleSettings = new IdleSettingsProperty {
IdleTimeoutInMinutes = 123,
LifecycleManagement = "lifecycleManagement",
MaxIdleTimeoutInMinutes = 123,
MinIdleTimeoutInMinutes = 123
}
},
BuiltInLifecycleConfigArn = "builtInLifecycleConfigArn",
CustomImages = new [] { new CustomImageProperty {
AppImageConfigName = "appImageConfigName",
ImageName = "imageName",
// the properties below are optional
ImageVersionNumber = 123
} },
DefaultResourceSpec = new ResourceSpecProperty {
InstanceType = "instanceType",
LifecycleConfigArn = "lifecycleConfigArn",
SageMakerImageArn = "sageMakerImageArn",
SageMakerImageVersionArn = "sageMakerImageVersionArn"
},
LifecycleConfigArns = new [] { "lifecycleConfigArns" }
},
CustomFileSystemConfigs = new [] { new CustomFileSystemConfigProperty {
EfsFileSystemConfig = new EFSFileSystemConfigProperty {
FileSystemId = "fileSystemId",
// the properties below are optional
FileSystemPath = "fileSystemPath"
},
FSxLustreFileSystemConfig = new FSxLustreFileSystemConfigProperty {
FileSystemId = "fileSystemId",
// the properties below are optional
FileSystemPath = "fileSystemPath"
},
S3FileSystemConfig = new S3FileSystemConfigProperty {
MountPath = "mountPath",
S3Uri = "s3Uri"
}
} },
CustomPosixUserConfig = new CustomPosixUserConfigProperty {
Gid = 123,
Uid = 123
},
DefaultLandingUri = "defaultLandingUri",
ExecutionRole = "executionRole",
JupyterLabAppSettings = new JupyterLabAppSettingsProperty {
AppLifecycleManagement = new AppLifecycleManagementProperty {
IdleSettings = new IdleSettingsProperty {
IdleTimeoutInMinutes = 123,
LifecycleManagement = "lifecycleManagement",
MaxIdleTimeoutInMinutes = 123,
MinIdleTimeoutInMinutes = 123
}
},
BuiltInLifecycleConfigArn = "builtInLifecycleConfigArn",
CodeRepositories = new [] { new CodeRepositoryProperty {
RepositoryUrl = "repositoryUrl"
} },
CustomImages = new [] { new CustomImageProperty {
AppImageConfigName = "appImageConfigName",
ImageName = "imageName",
// the properties below are optional
ImageVersionNumber = 123
} },
DefaultResourceSpec = new ResourceSpecProperty {
InstanceType = "instanceType",
LifecycleConfigArn = "lifecycleConfigArn",
SageMakerImageArn = "sageMakerImageArn",
SageMakerImageVersionArn = "sageMakerImageVersionArn"
},
LifecycleConfigArns = new [] { "lifecycleConfigArns" }
},
JupyterServerAppSettings = new JupyterServerAppSettingsProperty {
DefaultResourceSpec = new ResourceSpecProperty {
InstanceType = "instanceType",
LifecycleConfigArn = "lifecycleConfigArn",
SageMakerImageArn = "sageMakerImageArn",
SageMakerImageVersionArn = "sageMakerImageVersionArn"
},
LifecycleConfigArns = new [] { "lifecycleConfigArns" }
},
KernelGatewayAppSettings = new KernelGatewayAppSettingsProperty {
CustomImages = new [] { new CustomImageProperty {
AppImageConfigName = "appImageConfigName",
ImageName = "imageName",
// the properties below are optional
ImageVersionNumber = 123
} },
DefaultResourceSpec = new ResourceSpecProperty {
InstanceType = "instanceType",
LifecycleConfigArn = "lifecycleConfigArn",
SageMakerImageArn = "sageMakerImageArn",
SageMakerImageVersionArn = "sageMakerImageVersionArn"
},
LifecycleConfigArns = new [] { "lifecycleConfigArns" }
},
RStudioServerProAppSettings = new RStudioServerProAppSettingsProperty {
AccessStatus = "accessStatus",
UserGroup = "userGroup"
},
SecurityGroups = new [] { "securityGroups" },
SharingSettings = new SharingSettingsProperty {
NotebookOutputOption = "notebookOutputOption",
S3KmsKeyId = "s3KmsKeyId",
S3OutputPath = "s3OutputPath"
},
SpaceStorageSettings = new DefaultSpaceStorageSettingsProperty {
DefaultEbsStorageSettings = new DefaultEbsStorageSettingsProperty {
DefaultEbsVolumeSizeInGb = 123,
MaximumEbsVolumeSizeInGb = 123
}
},
StudioWebPortal = "studioWebPortal",
StudioWebPortalSettings = new StudioWebPortalSettingsProperty {
HiddenAppTypes = new [] { "hiddenAppTypes" },
HiddenInstanceTypes = new [] { "hiddenInstanceTypes" },
HiddenMlTools = new [] { "hiddenMlTools" },
HiddenSageMakerImageVersionAliases = new [] { new HiddenSageMakerImageProperty {
SageMakerImageName = "sageMakerImageName",
VersionAliases = new [] { "versionAliases" }
} }
}
};Synopsis
Properties
| AutoMountHomeEfs | Indicates whether auto-mounting of an EFS volume is supported for the user profile. |
| CodeEditorAppSettings | The Code Editor application settings. |
| CustomFileSystemConfigs | The settings for assigning a custom file system to a user profile. |
| CustomPosixUserConfig | Details about the POSIX identity that is used for file system operations. |
| DefaultLandingUri | The default experience that the user is directed to when accessing the domain. The supported values are:. |
| ExecutionRole | The execution role for the user. |
| JupyterLabAppSettings | The settings for the JupyterLab application. |
| JupyterServerAppSettings | The Jupyter server's app settings. |
| KernelGatewayAppSettings | The kernel gateway app settings. |
| RStudioServerProAppSettings | A collection of settings that configure user interaction with the |
| SecurityGroups | The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication. |
| SharingSettings | Specifies options for sharing Amazon SageMaker AI Studio notebooks. |
| SpaceStorageSettings | The storage settings for a space. |
| StudioWebPortal | Whether the user can access Studio. |
| StudioWebPortalSettings | Studio settings. |
Properties
AutoMountHomeEfs
Indicates whether auto-mounting of an EFS volume is supported for the user profile.
string? AutoMountHomeEfs { get; }Property Value
Remarks
The DefaultAsDomain value is only supported for user profiles. Do not use the DefaultAsDomain value when setting this parameter for a domain.
SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
CodeEditorAppSettings
The Code Editor application settings.
object? CodeEditorAppSettings { get; }Property Value
Remarks
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
Type union: either IResolvable or CfnUserProfile.ICodeEditorAppSettingsProperty
CustomFileSystemConfigs
The settings for assigning a custom file system to a user profile.
object? CustomFileSystemConfigs { get; }Property Value
Remarks
Permitted users can access this file system in Amazon SageMaker AI Studio.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
Type union: either IResolvable or (either IResolvable or CfnUserProfile.ICustomFileSystemConfigProperty)[]
CustomPosixUserConfig
Details about the POSIX identity that is used for file system operations.
object? CustomPosixUserConfig { get; }Property Value
Remarks
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
Type union: either IResolvable or CfnUserProfile.ICustomPosixUserConfigProperty
DefaultLandingUri
The default experience that the user is directed to when accessing the domain. The supported values are:.
string? DefaultLandingUri { get; }Property Value
Remarks
ExecutionRole
The execution role for the user.
string? ExecutionRole { get; }Property Value
Remarks
SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
JupyterLabAppSettings
The settings for the JupyterLab application.
object? JupyterLabAppSettings { get; }Property Value
Remarks
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
Type union: either IResolvable or CfnUserProfile.IJupyterLabAppSettingsProperty
JupyterServerAppSettings
The Jupyter server's app settings.
object? JupyterServerAppSettings { get; }Property Value
Remarks
KernelGatewayAppSettings
The kernel gateway app settings.
object? KernelGatewayAppSettings { get; }Property Value
Remarks
RStudioServerProAppSettings
A collection of settings that configure user interaction with the RStudioServerPro app.
object? RStudioServerProAppSettings { get; }Property Value
Remarks
SecurityGroups
The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
string[]? SecurityGroups { get; }Property Value
string[]
Remarks
Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly .
Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly , unless specified as part of the DefaultUserSettings for the domain.
Amazon SageMaker AI adds a security group to allow NFS traffic from Amazon SageMaker AI Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
SharingSettings
Specifies options for sharing Amazon SageMaker AI Studio notebooks.
object? SharingSettings { get; }Property Value
Remarks
SpaceStorageSettings
The storage settings for a space.
object? SpaceStorageSettings { get; }Property Value
Remarks
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
Type union: either IResolvable or CfnUserProfile.IDefaultSpaceStorageSettingsProperty
StudioWebPortal
Whether the user can access Studio.
string? StudioWebPortal { get; }Property Value
Remarks
If this value is set to DISABLED , the user cannot access Studio, even if that is the default experience for the domain.
StudioWebPortalSettings
Studio settings.
object? StudioWebPortalSettings { get; }Property Value
Remarks
If these settings are applied on a user level, they take priority over the settings applied on a domain level.
Type union: either IResolvable or CfnUserProfile.IStudioWebPortalSettingsProperty