#[non_exhaustive]pub struct UserSettings {Show 18 fields
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>,
pub auto_mount_home_efs: Option<AutoMountHomeEfs>,
}Expand description
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)§
This struct is marked as non-exhaustive
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.
SageMaker applies this setting only to private spaces that the user creates in the domain. SageMaker doesn't apply this setting to shared spaces.
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 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.
sharing_settings: Option<SharingSettings>Specifies options for sharing Amazon SageMaker AI 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.
SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas app.
code_editor_app_settings: Option<CodeEditorAppSettings>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.
jupyter_lab_app_settings: Option<JupyterLabAppSettings>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.
space_storage_settings: Option<DefaultSpaceStorageSettings>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.
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 ifStudioWebPortalis set toENABLED. -
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.
SageMaker applies these settings only to private spaces that the user creates in the domain. SageMaker doesn't apply these settings to shared spaces.
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 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.
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.
auto_mount_home_efs: Option<AutoMountHomeEfs>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.
Implementations§
Source§impl UserSettings
impl UserSettings
Sourcepub fn execution_role(&self) -> Option<&str>
pub fn execution_role(&self) -> Option<&str>
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.
Sourcepub fn security_groups(&self) -> &[String]
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 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.
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().
Sourcepub fn sharing_settings(&self) -> Option<&SharingSettings>
pub fn sharing_settings(&self) -> Option<&SharingSettings>
Specifies options for sharing Amazon SageMaker AI Studio notebooks.
Sourcepub fn jupyter_server_app_settings(&self) -> Option<&JupyterServerAppSettings>
pub fn jupyter_server_app_settings(&self) -> Option<&JupyterServerAppSettings>
The Jupyter server's app settings.
Sourcepub fn kernel_gateway_app_settings(&self) -> Option<&KernelGatewayAppSettings>
pub fn kernel_gateway_app_settings(&self) -> Option<&KernelGatewayAppSettings>
The kernel gateway app settings.
Sourcepub fn tensor_board_app_settings(&self) -> Option<&TensorBoardAppSettings>
pub fn tensor_board_app_settings(&self) -> Option<&TensorBoardAppSettings>
The TensorBoard app settings.
Sourcepub fn r_studio_server_pro_app_settings(
&self,
) -> Option<&RStudioServerProAppSettings>
pub fn r_studio_server_pro_app_settings( &self, ) -> Option<&RStudioServerProAppSettings>
A collection of settings that configure user interaction with the RStudioServerPro app.
Sourcepub fn r_session_app_settings(&self) -> Option<&RSessionAppSettings>
pub fn r_session_app_settings(&self) -> Option<&RSessionAppSettings>
A collection of settings that configure the RSessionGateway app.
Sourcepub fn canvas_app_settings(&self) -> Option<&CanvasAppSettings>
pub fn canvas_app_settings(&self) -> Option<&CanvasAppSettings>
The Canvas app settings.
SageMaker applies these settings only to private spaces that SageMaker creates for the Canvas app.
Sourcepub fn code_editor_app_settings(&self) -> Option<&CodeEditorAppSettings>
pub fn code_editor_app_settings(&self) -> Option<&CodeEditorAppSettings>
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.
Sourcepub fn jupyter_lab_app_settings(&self) -> Option<&JupyterLabAppSettings>
pub fn jupyter_lab_app_settings(&self) -> Option<&JupyterLabAppSettings>
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.
Sourcepub fn space_storage_settings(&self) -> Option<&DefaultSpaceStorageSettings>
pub fn space_storage_settings(&self) -> Option<&DefaultSpaceStorageSettings>
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.
Sourcepub fn default_landing_uri(&self) -> Option<&str>
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 ifStudioWebPortalis set toENABLED. -
app:JupyterServer:: Indicates that Studio Classic is the default experience.
Sourcepub fn studio_web_portal(&self) -> Option<&StudioWebPortal>
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.
Sourcepub fn custom_posix_user_config(&self) -> Option<&CustomPosixUserConfig>
pub fn custom_posix_user_config(&self) -> Option<&CustomPosixUserConfig>
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.
Sourcepub fn custom_file_system_configs(&self) -> &[CustomFileSystemConfig]
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 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.
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().
Sourcepub fn studio_web_portal_settings(&self) -> Option<&StudioWebPortalSettings>
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.
Sourcepub fn auto_mount_home_efs(&self) -> Option<&AutoMountHomeEfs>
pub fn auto_mount_home_efs(&self) -> Option<&AutoMountHomeEfs>
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.
Source§impl UserSettings
impl UserSettings
Sourcepub fn builder() -> UserSettingsBuilder
pub fn builder() -> UserSettingsBuilder
Creates a new builder-style object to manufacture UserSettings.
Trait Implementations§
Source§impl Clone for UserSettings
impl Clone for UserSettings
Source§fn clone(&self) -> UserSettings
fn clone(&self) -> UserSettings
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for UserSettings
impl Debug for UserSettings
Source§impl PartialEq for UserSettings
impl PartialEq for UserSettings
impl StructuralPartialEq for UserSettings
Auto Trait Implementations§
impl Freeze for UserSettings
impl RefUnwindSafe for UserSettings
impl Send for UserSettings
impl Sync for UserSettings
impl Unpin for UserSettings
impl UnwindSafe for UserSettings
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);