Struct aws_sdk_sagemaker :: types :: builders :: UserSettingsBuilder Copy item path

impl UserSettingsBuilder

pub fn execution_role(self, input: impl Into<String>) -> Self

The execution role for the user.

pub fn set_execution_role(self, input: Option<String>) -> Self

The execution role for the user.

pub fn get_execution_role(&self) -> &Option<String>

The execution role for the user.

pub fn security_groups(self, input: impl Into<String>) -> Self

Appends an item to security_groups.

To override the contents of this collection use set_security_groups.

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.

pub fn set_security_groups(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_security_groups(&self) -> &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.

pub fn sharing_settings(self, input: SharingSettings) -> Self

Specifies options for sharing Amazon SageMaker Studio notebooks.

pub fn set_sharing_settings(self, input: Option<SharingSettings>) -> Self

Specifies options for sharing Amazon SageMaker Studio notebooks.

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

Specifies options for sharing Amazon SageMaker Studio notebooks.

pub fn jupyter_server_app_settings( self, input: JupyterServerAppSettings, ) -> Self

The Jupyter server's app settings.

pub fn set_jupyter_server_app_settings( self, input: Option<JupyterServerAppSettings>, ) -> Self

The Jupyter server's app settings.

pub fn get_jupyter_server_app_settings( &self, ) -> &Option<JupyterServerAppSettings>

The Jupyter server's app settings.

pub fn kernel_gateway_app_settings( self, input: KernelGatewayAppSettings, ) -> Self

The kernel gateway app settings.

pub fn set_kernel_gateway_app_settings( self, input: Option<KernelGatewayAppSettings>, ) -> Self

The kernel gateway app settings.

pub fn get_kernel_gateway_app_settings( &self, ) -> &Option<KernelGatewayAppSettings>

The kernel gateway app settings.

pub fn tensor_board_app_settings(self, input: TensorBoardAppSettings) -> Self

The TensorBoard app settings.

pub fn set_tensor_board_app_settings( self, input: Option<TensorBoardAppSettings>, ) -> Self

The TensorBoard app settings.

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

The TensorBoard app settings.

pub fn r_studio_server_pro_app_settings( self, input: RStudioServerProAppSettings, ) -> Self

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

pub fn set_r_studio_server_pro_app_settings( self, input: Option<RStudioServerProAppSettings>, ) -> Self

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

pub fn get_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, input: RSessionAppSettings) -> Self

A collection of settings that configure the RSessionGateway app.

pub fn set_r_session_app_settings( self, input: Option<RSessionAppSettings>, ) -> Self

A collection of settings that configure the RSessionGateway app.

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

A collection of settings that configure the RSessionGateway app.

pub fn canvas_app_settings(self, input: CanvasAppSettings) -> Self

The Canvas app settings.

pub fn set_canvas_app_settings(self, input: Option<CanvasAppSettings>) -> Self

The Canvas app settings.

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

The Canvas app settings.

pub fn code_editor_app_settings(self, input: CodeEditorAppSettings) -> Self

The Code Editor application settings.

pub fn set_code_editor_app_settings( self, input: Option<CodeEditorAppSettings>, ) -> Self

The Code Editor application settings.

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

The Code Editor application settings.

pub fn jupyter_lab_app_settings(self, input: JupyterLabAppSettings) -> Self

The settings for the JupyterLab application.

pub fn set_jupyter_lab_app_settings( self, input: Option<JupyterLabAppSettings>, ) -> Self

The settings for the JupyterLab application.

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

The settings for the JupyterLab application.

pub fn space_storage_settings(self, input: DefaultSpaceStorageSettings) -> Self

The storage settings for a space.

pub fn set_space_storage_settings( self, input: Option<DefaultSpaceStorageSettings>, ) -> Self

The storage settings for a space.

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

The storage settings for a space.

pub fn default_landing_uri(self, input: impl Into<String>) -> Self

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 set_default_landing_uri(self, input: Option<String>) -> Self

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 get_default_landing_uri(&self) -> &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.

pub fn studio_web_portal(self, input: StudioWebPortal) -> Self

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 set_studio_web_portal(self, input: Option<StudioWebPortal>) -> Self

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 get_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, input: CustomPosixUserConfig) -> Self

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

pub fn set_custom_posix_user_config( self, input: Option<CustomPosixUserConfig>, ) -> Self

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

pub fn get_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, input: CustomFileSystemConfig) -> Self

Appends an item to custom_file_system_configs.

To override the contents of this collection use set_custom_file_system_configs.

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

pub fn set_custom_file_system_configs( self, input: Option<Vec<CustomFileSystemConfig>>, ) -> Self

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

pub fn get_custom_file_system_configs( &self, ) -> &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.

pub fn studio_web_portal_settings(self, input: StudioWebPortalSettings) -> Self

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

pub fn set_studio_web_portal_settings( self, input: Option<StudioWebPortalSettings>, ) -> Self

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

pub fn get_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.

pub fn build(self) -> UserSettings

Consumes the builder and constructs a UserSettings.

Trait Implementations§

impl Clone for UserSettingsBuilder

fn clone(&self) -> UserSettingsBuilder

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for UserSettingsBuilder

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

Formats the value using the given formatter. Read more

impl Default for UserSettingsBuilder

fn default() -> UserSettingsBuilder

Returns the “default value” for a type. Read more

impl PartialEq for UserSettingsBuilder

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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

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

impl StructuralPartialEq for UserSettingsBuilder

Auto Trait Implementations§

impl UnwindSafe for UserSettingsBuilder

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more