UserSettings ¶

class UserSettings(TypedDict, closed=True):
    execution_role: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The execution role for the user.</p> <p>SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.</p>"""
    security_groups: NotRequired[
        "capo_sagemaker.types.security_group_ids.SecurityGroupIds"
    ]
    """<p>The security groups for the Amazon Virtual Private Cloud (VPC) that the domain uses for communication.</p> <p>Optional when the <code>CreateDomain.AppNetworkAccessType</code> parameter is set to <code>PublicInternetOnly</code>.</p> <p>Required when the <code>CreateDomain.AppNetworkAccessType</code> parameter is set to <code>VpcOnly</code>, unless specified as part of the <code>DefaultUserSettings</code> for the domain.</p> <p>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.</p> <p>SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.</p>"""
    sharing_settings: NotRequired[
        "capo_sagemaker.types.sharing_settings.SharingSettings"
    ]
    """<p>Specifies options for sharing Amazon SageMaker AI Studio notebooks.</p>"""
    jupyter_server_app_settings: NotRequired[
        "capo_sagemaker.types.jupyter_server_app_settings.JupyterServerAppSettings"
    ]
    """<p>The Jupyter server's app settings.</p>"""
    kernel_gateway_app_settings: NotRequired[
        "capo_sagemaker.types.kernel_gateway_app_settings.KernelGatewayAppSettings"
    ]
    """<p>The kernel gateway app settings.</p>"""
    tensor_board_app_settings: NotRequired[
        "capo_sagemaker.types.tensor_board_app_settings.TensorBoardAppSettings"
    ]
    """<p>The TensorBoard app settings.</p>"""
    r_studio_server_pro_app_settings: NotRequired[
        "capo_sagemaker.types.r_studio_server_pro_app_settings.RStudioServerProAppSettings"
    ]
    """<p>A collection of settings that configure user interaction with the <code>RStudioServerPro</code> app.</p>"""
    r_session_app_settings: NotRequired[
        "capo_sagemaker.types.r_session_app_settings.RSessionAppSettings"
    ]
    """<p>A collection of settings that configure the <code>RSessionGateway</code> app.</p>"""
    canvas_app_settings: NotRequired[
        "capo_sagemaker.types.canvas_app_settings.CanvasAppSettings"
    ]
    """<p>The Canvas app settings.</p> <p>SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas app.</p>"""
    code_editor_app_settings: NotRequired[
        "capo_sagemaker.types.code_editor_app_settings.CodeEditorAppSettings"
    ]
    """<p>The Code Editor application settings.</p> <p>SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.</p>"""
    jupyter_lab_app_settings: NotRequired[
        "capo_sagemaker.types.jupyter_lab_app_settings.JupyterLabAppSettings"
    ]
    """<p>The settings for the JupyterLab application.</p> <p>SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.</p>"""
    space_storage_settings: NotRequired[
        "capo_sagemaker.types.default_space_storage_settings.DefaultSpaceStorageSettings"
    ]
    """<p>The storage settings for a space.</p> <p>SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.</p>"""
    default_landing_uri: NotRequired["capo_sagemaker.types.landing_uri.LandingUri"]
    """<p>The default experience that the user is directed to when accessing the domain. The supported values are:</p> <ul> <li> <p> <code>studio::</code>: Indicates that Studio is the default experience. This value can only be passed if <code>StudioWebPortal</code> is set to <code>ENABLED</code>.</p> </li> <li> <p> <code>app:JupyterServer:</code>: Indicates that Studio Classic is the default experience.</p> </li> </ul>"""
    studio_web_portal: NotRequired[
        "capo_sagemaker.types.studio_web_portal.StudioWebPortal"
    ]
    """<p>Whether the user can access Studio. If this value is set to <code>DISABLED</code>, the user cannot access Studio, even if that is the default experience for the domain.</p>"""
    custom_posix_user_config: NotRequired[
        "capo_sagemaker.types.custom_posix_user_config.CustomPosixUserConfig"
    ]
    """<p>Details about the POSIX identity that is used for file system operations.</p> <p>SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.</p>"""
    custom_file_system_configs: NotRequired[
        "capo_sagemaker.types.custom_file_system_configs.CustomFileSystemConfigs"
    ]
    """<p>The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker AI Studio.</p> <p>SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.</p>"""
    studio_web_portal_settings: NotRequired[
        "capo_sagemaker.types.studio_web_portal_settings.StudioWebPortalSettings"
    ]
    """<p>Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.</p>"""
    auto_mount_home_efs: NotRequired[
        "capo_sagemaker.types.auto_mount_home_efs.AutoMountHomeEFS"
    ]
    """<p>Indicates whether auto-mounting of an EFS volume is supported for the user profile. The <code>DefaultAsDomain</code> value is only supported for user profiles. Do not use the <code>DefaultAsDomain</code> value when setting this parameter for a domain.</p> <p>SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.</p>"""