Struct aws_sdk_sagemaker::types::builders::UserSettingsBuilder

#[non_exhaustive]
pub struct UserSettingsBuilder { /* private fields */ }

A builder for UserSettings.

Implementations

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

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

Performs copy-assignment from source.

impl Debug for UserSettingsBuilder

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

Formats the value using the given formatter.

impl Default for UserSettingsBuilder

fn default() -> UserSettingsBuilder

Returns the “default value” for a type.

impl PartialEq for UserSettingsBuilder

fn eq(&self, other: &UserSettingsBuilder) -> 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 UserSettingsBuilder