Struct aws_sdk_sagemaker::types::UserSettings

#[non_exhaustive]
pub struct UserSettings {

    pub execution_role: Option<String>,
    pub security_groups: Option<Vec<String>>,
    pub sharing_settings: Option<SharingSettings>,
    pub jupyter_server_app_settings: Option<JupyterServerAppSettings>,
    pub kernel_gateway_app_settings: Option<KernelGatewayAppSettings>,
    pub tensor_board_app_settings: Option<TensorBoardAppSettings>,
    pub r_studio_server_pro_app_settings: Option<RStudioServerProAppSettings>,
    pub r_session_app_settings: Option<RSessionAppSettings>,
    pub canvas_app_settings: Option<CanvasAppSettings>,
    pub code_editor_app_settings: Option<CodeEditorAppSettings>,
    pub jupyter_lab_app_settings: Option<JupyterLabAppSettings>,
    pub space_storage_settings: Option<DefaultSpaceStorageSettings>,
    pub default_landing_uri: Option<String>,
    pub studio_web_portal: Option<StudioWebPortal>,
    pub custom_posix_user_config: Option<CustomPosixUserConfig>,
    pub custom_file_system_configs: Option<Vec<CustomFileSystemConfig>>,
    pub studio_web_portal_settings: Option<StudioWebPortalSettings>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

execution_role: Option<String>

The execution role for the user.

security_groups: Option<Vec<String>>

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.

sharing_settings: Option<SharingSettings>

Specifies options for sharing Amazon SageMaker Studio notebooks.

jupyter_server_app_settings: Option<JupyterServerAppSettings>

The Jupyter server's app settings.

kernel_gateway_app_settings: Option<KernelGatewayAppSettings>

The kernel gateway app settings.

tensor_board_app_settings: Option<TensorBoardAppSettings>

The TensorBoard app settings.

r_studio_server_pro_app_settings: Option<RStudioServerProAppSettings>

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

r_session_app_settings: Option<RSessionAppSettings>

A collection of settings that configure the RSessionGateway app.

canvas_app_settings: Option<CanvasAppSettings>

The Canvas app settings.

code_editor_app_settings: Option<CodeEditorAppSettings>

The Code Editor application settings.

jupyter_lab_app_settings: Option<JupyterLabAppSettings>

The settings for the JupyterLab application.

space_storage_settings: Option<DefaultSpaceStorageSettings>

The storage settings for a space.

default_landing_uri: Option<String>

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.

studio_web_portal: Option<StudioWebPortal>

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.

custom_posix_user_config: Option<CustomPosixUserConfig>

Details about the POSIX identity that is used for file system operations.

custom_file_system_configs: Option<Vec<CustomFileSystemConfig>>

The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

studio_web_portal_settings: Option<StudioWebPortalSettings>

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

Implementations

impl UserSettings

pub fn execution_role(&self) -> Option<&str>

The execution role for the user.

pub fn security_groups(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .security_groups.is_none().

pub fn sharing_settings(&self) -> Option<&SharingSettings>

Specifies options for sharing Amazon SageMaker Studio notebooks.

pub fn jupyter_server_app_settings(&self) -> Option<&JupyterServerAppSettings>

The Jupyter server's app settings.

pub fn kernel_gateway_app_settings(&self) -> Option<&KernelGatewayAppSettings>

The kernel gateway app settings.

pub fn tensor_board_app_settings(&self) -> Option<&TensorBoardAppSettings>

The TensorBoard app settings.

pub fn r_studio_server_pro_app_settings( &self, ) -> Option<&RStudioServerProAppSettings>

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

pub fn r_session_app_settings(&self) -> Option<&RSessionAppSettings>

A collection of settings that configure the RSessionGateway app.

pub fn canvas_app_settings(&self) -> Option<&CanvasAppSettings>

The Canvas app settings.

pub fn code_editor_app_settings(&self) -> Option<&CodeEditorAppSettings>

The Code Editor application settings.

pub fn jupyter_lab_app_settings(&self) -> Option<&JupyterLabAppSettings>

The settings for the JupyterLab application.

pub fn space_storage_settings(&self) -> Option<&DefaultSpaceStorageSettings>

The storage settings for a space.

pub fn default_landing_uri(&self) -> Option<&str>

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.

pub fn studio_web_portal(&self) -> Option<&StudioWebPortal>

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.

pub fn custom_posix_user_config(&self) -> Option<&CustomPosixUserConfig>

Details about the POSIX identity that is used for file system operations.

pub fn custom_file_system_configs(&self) -> &[CustomFileSystemConfig]

The settings for assigning a custom file system to a user profile. Permitted users can access this file system in Amazon SageMaker Studio.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .custom_file_system_configs.is_none().

pub fn studio_web_portal_settings(&self) -> Option<&StudioWebPortalSettings>

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

impl UserSettings

pub fn builder() -> UserSettingsBuilder

Creates a new builder-style object to manufacture UserSettings.

Trait Implementations

impl Clone for UserSettings

fn clone(&self) -> UserSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UserSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for UserSettings

fn eq(&self, other: &UserSettings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UserSettings