Interface CfnDomain.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 IUserSettingsProperty
Syntax (vb)
Public Interface IUserSettingsProperty
Remarks
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 {
ExecutionRole = "executionRole",
// the properties below are optional
CodeEditorAppSettings = new CodeEditorAppSettingsProperty {
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"
}
} },
CustomPosixUserConfig = new CustomPosixUserConfigProperty {
Gid = 123,
Uid = 123
},
DefaultLandingUri = "defaultLandingUri",
JupyterLabAppSettings = new JupyterLabAppSettingsProperty {
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"
}
},
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"
}
},
RSessionAppSettings = new RSessionAppSettingsProperty {
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"
}
},
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"
};
Synopsis
Properties
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. |
RSessionAppSettings | A collection of settings that configure the |
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 Studio notebooks. |
SpaceStorageSettings | The storage settings for a space. |
StudioWebPortal | Whether the user can access Studio. |
Properties
CodeEditorAppSettings
The Code Editor application settings.
virtual object CodeEditorAppSettings { get; }
Property Value
System.Object
Remarks
CustomFileSystemConfigs
The settings for assigning a custom file system to a user profile.
virtual object CustomFileSystemConfigs { get; }
Property Value
System.Object
Remarks
Permitted users can access this file system in Amazon SageMaker Studio.
CustomPosixUserConfig
Details about the POSIX identity that is used for file system operations.
virtual object CustomPosixUserConfig { get; }
Property Value
System.Object
Remarks
DefaultLandingUri
The default experience that the user is directed to when accessing the domain. The supported values are:.
virtual string DefaultLandingUri { get; }
Property Value
System.String
Remarks
ExecutionRole
The execution role for the user.
string ExecutionRole { get; }
Property Value
System.String
Remarks
JupyterLabAppSettings
The settings for the JupyterLab application.
virtual object JupyterLabAppSettings { get; }
Property Value
System.Object
Remarks
JupyterServerAppSettings
The Jupyter server's app settings.
virtual object JupyterServerAppSettings { get; }
Property Value
System.Object
Remarks
KernelGatewayAppSettings
The kernel gateway app settings.
virtual object KernelGatewayAppSettings { get; }
Property Value
System.Object
Remarks
RSessionAppSettings
A collection of settings that configure the RSessionGateway
app.
virtual object RSessionAppSettings { get; }
Property Value
System.Object
Remarks
RStudioServerProAppSettings
A collection of settings that configure user interaction with the RStudioServerPro
app.
virtual object RStudioServerProAppSettings { get; }
Property Value
System.Object
Remarks
SecurityGroups
The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.
virtual string[] SecurityGroups { get; }
Property Value
System.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 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
Specifies options for sharing Amazon SageMaker Studio notebooks.
virtual object SharingSettings { get; }
Property Value
System.Object
Remarks
SpaceStorageSettings
The storage settings for a space.
virtual object SpaceStorageSettings { get; }
Property Value
System.Object
Remarks
StudioWebPortal
Whether the user can access Studio.
virtual string StudioWebPortal { get; }
Property Value
System.String
Remarks
If this value is set to DISABLED
, the user cannot access Studio, even if that is the default experience for the domain.