Struct aws_sdk_sagemaker::model::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>,
}

A collection of settings that apply to users of Amazon SageMaker Studio. 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 Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.

Amazon SageMaker adds a security group to allow NFS traffic from 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 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.

Implementations

impl UserSettings

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

The execution role for the user.

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

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.

Amazon SageMaker adds a security group to allow NFS traffic from 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) -> Option<&SharingSettings>

Specifies options for sharing 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.

impl UserSettings

pub fn builder() -> Builder

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<UserSettings> 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: &UserSettings) -> bool

This method tests for !=.

impl StructuralPartialEq for UserSettings