Module Values_0.UserSettingsSource

A collection of settings that apply to users in a domain. 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.

Sourcetype nonrec t = {
  1. executionRole : RoleArn.t option;
    (*

    The execution role for the user. SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.

    *)
  2. securityGroups : SecurityGroupIds.t option;
    (*

    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 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.

    *)
  3. sharingSettings : SharingSettings.t option;
    (*

    Specifies options for sharing Amazon SageMaker AI Studio notebooks.

    *)
  4. jupyterServerAppSettings : JupyterServerAppSettings.t option;
    (*

    The Jupyter server's app settings.

    *)
  5. kernelGatewayAppSettings : KernelGatewayAppSettings.t option;
    (*

    The kernel gateway app settings.

    *)
  6. tensorBoardAppSettings : TensorBoardAppSettings.t option;
    (*

    The TensorBoard app settings.

    *)
  7. rStudioServerProAppSettings : RStudioServerProAppSettings.t option;
    (*

    A collection of settings that configure user interaction with the RStudioServerPro app.

    *)
  8. rSessionAppSettings : RSessionAppSettings.t option;
    (*

    A collection of settings that configure the RSessionGateway app.

    *)
  9. canvasAppSettings : CanvasAppSettings.t option;
    (*

    The Canvas app settings. SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas app.

    *)
  10. codeEditorAppSettings : CodeEditorAppSettings.t option;
    (*

    The Code Editor application settings. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    *)
  11. jupyterLabAppSettings : JupyterLabAppSettings.t option;
    (*

    The settings for the JupyterLab application. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    *)
  12. spaceStorageSettings : DefaultSpaceStorageSettings.t option;
    (*

    The storage settings for a space. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    *)
  13. defaultLandingUri : LandingUri.t option;
    (*

    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 if StudioWebPortal is set to ENABLED. app:JupyterServer:: Indicates that Studio Classic is the default experience.

    *)
  14. studioWebPortal : StudioWebPortal.t option;
    (*

    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.

    *)
  15. customPosixUserConfig : CustomPosixUserConfig.t option;
    (*

    Details about the POSIX identity that is used for file system operations. SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.

    *)
  16. customFileSystemConfigs : CustomFileSystemConfigs.t option;
    (*

    The settings for assigning a custom file system to a user profile. 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.

    *)
  17. studioWebPortalSettings : StudioWebPortalSettings.t option;
    (*

    Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.

    *)
  18. autoMountHomeEFS : AutoMountHomeEFS.t option;
    (*

    Indicates whether auto-mounting of an EFS volume is supported for the user profile. 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.

    *)
}
Sourceval make : ?executionRole:??? -> ?securityGroups:??? -> ?sharingSettings:??? -> ?jupyterServerAppSettings:??? -> ?kernelGatewayAppSettings:??? -> ?tensorBoardAppSettings:??? -> ?rStudioServerProAppSettings:??? -> ?rSessionAppSettings:??? -> ?canvasAppSettings:??? -> ?codeEditorAppSettings:??? -> ?jupyterLabAppSettings:??? -> ?spaceStorageSettings:??? -> ?defaultLandingUri:??? -> ?studioWebPortal:??? -> ?customPosixUserConfig:??? -> ?customFileSystemConfigs:??? -> ?studioWebPortalSettings:??? -> ?autoMountHomeEFS:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `String of SecurityGroupId.t | `Structure of (string * [> `Structure of (string * [> `String of FileSystemId.t ]) list ]) list ] list | `String of RoleArn.t | `Structure of (string * [> `Enum of string | `List of [> `Enum of string | `String of StudioLifecycleConfigArn.t | `Structure of (string * [> `Enum of string | `Integer of ImageVersionNumber.t | `List of [> `String of ImageVersionAliasPattern.t ] list | `String of RepositoryUrl.t ]) list ] list | `Long of Uid.t | `String of S3Uri.t | `Structure of (string * [> `Enum of string | `Integer of SpaceEbsVolumeSizeInGb.t | `List of [> `String of RoleArn.t ] list | `String of ImageArn.t | `Structure of (string * [> `Enum of string | `Integer of IdleTimeoutInMinutes.t ]) list ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t