interface UserSettingsProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Sagemaker.CfnDomain.UserSettingsProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnDomain_UserSettingsProperty |
Java | software.amazon.awscdk.services.sagemaker.CfnDomain.UserSettingsProperty |
Python | aws_cdk.aws_sagemaker.CfnDomain.UserSettingsProperty |
TypeScript | aws-cdk-lib » aws_sagemaker » CfnDomain » UserSettingsProperty |
A collection of settings that apply to users of Amazon SageMaker Studio.
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
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const userSettingsProperty: sagemaker.CfnDomain.UserSettingsProperty = {
executionRole: 'executionRole',
// the properties below are optional
codeEditorAppSettings: {
appLifecycleManagement: {
idleSettings: {
idleTimeoutInMinutes: 123,
lifecycleManagement: 'lifecycleManagement',
maxIdleTimeoutInMinutes: 123,
minIdleTimeoutInMinutes: 123,
},
},
customImages: [{
appImageConfigName: 'appImageConfigName',
imageName: 'imageName',
// the properties below are optional
imageVersionNumber: 123,
}],
defaultResourceSpec: {
instanceType: 'instanceType',
lifecycleConfigArn: 'lifecycleConfigArn',
sageMakerImageArn: 'sageMakerImageArn',
sageMakerImageVersionArn: 'sageMakerImageVersionArn',
},
lifecycleConfigArns: ['lifecycleConfigArns'],
},
customFileSystemConfigs: [{
efsFileSystemConfig: {
fileSystemId: 'fileSystemId',
// the properties below are optional
fileSystemPath: 'fileSystemPath',
},
}],
customPosixUserConfig: {
gid: 123,
uid: 123,
},
defaultLandingUri: 'defaultLandingUri',
jupyterLabAppSettings: {
appLifecycleManagement: {
idleSettings: {
idleTimeoutInMinutes: 123,
lifecycleManagement: 'lifecycleManagement',
maxIdleTimeoutInMinutes: 123,
minIdleTimeoutInMinutes: 123,
},
},
codeRepositories: [{
repositoryUrl: 'repositoryUrl',
}],
customImages: [{
appImageConfigName: 'appImageConfigName',
imageName: 'imageName',
// the properties below are optional
imageVersionNumber: 123,
}],
defaultResourceSpec: {
instanceType: 'instanceType',
lifecycleConfigArn: 'lifecycleConfigArn',
sageMakerImageArn: 'sageMakerImageArn',
sageMakerImageVersionArn: 'sageMakerImageVersionArn',
},
lifecycleConfigArns: ['lifecycleConfigArns'],
},
jupyterServerAppSettings: {
defaultResourceSpec: {
instanceType: 'instanceType',
lifecycleConfigArn: 'lifecycleConfigArn',
sageMakerImageArn: 'sageMakerImageArn',
sageMakerImageVersionArn: 'sageMakerImageVersionArn',
},
lifecycleConfigArns: ['lifecycleConfigArns'],
},
kernelGatewayAppSettings: {
customImages: [{
appImageConfigName: 'appImageConfigName',
imageName: 'imageName',
// the properties below are optional
imageVersionNumber: 123,
}],
defaultResourceSpec: {
instanceType: 'instanceType',
lifecycleConfigArn: 'lifecycleConfigArn',
sageMakerImageArn: 'sageMakerImageArn',
sageMakerImageVersionArn: 'sageMakerImageVersionArn',
},
lifecycleConfigArns: ['lifecycleConfigArns'],
},
rSessionAppSettings: {
customImages: [{
appImageConfigName: 'appImageConfigName',
imageName: 'imageName',
// the properties below are optional
imageVersionNumber: 123,
}],
defaultResourceSpec: {
instanceType: 'instanceType',
lifecycleConfigArn: 'lifecycleConfigArn',
sageMakerImageArn: 'sageMakerImageArn',
sageMakerImageVersionArn: 'sageMakerImageVersionArn',
},
},
rStudioServerProAppSettings: {
accessStatus: 'accessStatus',
userGroup: 'userGroup',
},
securityGroups: ['securityGroups'],
sharingSettings: {
notebookOutputOption: 'notebookOutputOption',
s3KmsKeyId: 's3KmsKeyId',
s3OutputPath: 's3OutputPath',
},
spaceStorageSettings: {
defaultEbsStorageSettings: {
defaultEbsVolumeSizeInGb: 123,
maximumEbsVolumeSizeInGb: 123,
},
},
studioWebPortal: 'studioWebPortal',
studioWebPortalSettings: {
hiddenAppTypes: ['hiddenAppTypes'],
hiddenMlTools: ['hiddenMlTools'],
},
};
Properties
Name | Type | Description |
---|---|---|
execution | string | The execution role for the user. |
code | IResolvable | Code | The Code Editor application settings. |
custom | IResolvable | IResolvable | Custom [] | The settings for assigning a custom file system to a user profile. |
custom | IResolvable | Custom | Details about the POSIX identity that is used for file system operations. |
default | string | The default experience that the user is directed to when accessing the domain. The supported values are:. |
jupyter | IResolvable | Jupyter | The settings for the JupyterLab application. |
jupyter | IResolvable | Jupyter | The Jupyter server's app settings. |
kernel | IResolvable | Kernel | The kernel gateway app settings. |
r | IResolvable | RSession | A collection of settings that configure the RSessionGateway app. |
r | IResolvable | RStudio | A collection of settings that configure user interaction with the RStudioServerPro app. |
security | string[] | The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication. |
sharing | IResolvable | Sharing | Specifies options for sharing Amazon SageMaker Studio notebooks. |
space | IResolvable | Default | The storage settings for a space. |
studio | string | Whether the user can access Studio. |
studio | IResolvable | Studio | Studio settings. |
executionRole
Type:
string
The execution role for the user.
codeEditorAppSettings?
Type:
IResolvable
|
Code
(optional)
The Code Editor application settings.
customFileSystemConfigs?
Type:
IResolvable
|
IResolvable
|
Custom
[]
(optional)
The settings for assigning a custom file system to a user profile.
Permitted users can access this file system in Amazon SageMaker Studio.
customPosixUserConfig?
Type:
IResolvable
|
Custom
(optional)
Details about the POSIX identity that is used for file system operations.
defaultLandingUri?
Type:
string
(optional)
The default experience that the user is directed to when accessing the domain. The supported values are:.
studio::
: Indicates that Studio is the default experience. This value can only be passed ifStudioWebPortal
is set toENABLED
.app:JupyterServer:
: Indicates that Studio Classic is the default experience.
jupyterLabAppSettings?
Type:
IResolvable
|
Jupyter
(optional)
The settings for the JupyterLab application.
jupyterServerAppSettings?
Type:
IResolvable
|
Jupyter
(optional)
The Jupyter server's app settings.
kernelGatewayAppSettings?
Type:
IResolvable
|
Kernel
(optional)
The kernel gateway app settings.
rSessionAppSettings?
Type:
IResolvable
|
RSession
(optional)
A collection of settings that configure the RSessionGateway
app.
rStudioServerProAppSettings?
Type:
IResolvable
|
RStudio
(optional)
A collection of settings that configure user interaction with the RStudioServerPro
app.
securityGroups?
Type:
string[]
(optional)
The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
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 adds a security group to allow NFS traffic from Amazon SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.
sharingSettings?
Type:
IResolvable
|
Sharing
(optional)
Specifies options for sharing Amazon SageMaker Studio notebooks.
spaceStorageSettings?
Type:
IResolvable
|
Default
(optional)
The storage settings for a space.
studioWebPortal?
Type:
string
(optional)
Whether the user can access Studio.
If this value is set to DISABLED
, the user cannot access Studio, even if that is the default experience for the domain.
studioWebPortalSettings?
Type:
IResolvable
|
Studio
(optional)
Studio settings.
If these settings are applied on a user level, they take priority over the settings applied on a domain level.