Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.Types.UserSettings

Description

Synopsis

Documentation

data UserSettings Source #

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.

See: newUserSettings smart constructor.

Constructors

UserSettings'

Fields

canvasAppSettings :: Maybe CanvasAppSettings
The Canvas app settings.
executionRole :: Maybe Text
The execution role for the user.
jupyterServerAppSettings :: Maybe JupyterServerAppSettings
The Jupyter server's app settings.
kernelGatewayAppSettings :: Maybe KernelGatewayAppSettings
The kernel gateway app settings.
rSessionAppSettings :: Maybe RSessionAppSettings
A collection of settings that configure the RSessionGateway app.
rStudioServerProAppSettings :: Maybe RStudioServerProAppSettings
A collection of settings that configure user interaction with the RStudioServerPro app.
securityGroups :: Maybe [Text]
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.
sharingSettings :: Maybe SharingSettings
Specifies options for sharing SageMaker Studio notebooks.
tensorBoardAppSettings :: Maybe TensorBoardAppSettings
The TensorBoard app settings.

Instances

Instances details

FromJSON UserSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.UserSettings Methods parseJSON :: Value -> Parser UserSettings # parseJSONList :: Value -> Parser [UserSettings] #
ToJSON UserSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.UserSettings Methods toJSON :: UserSettings -> Value # toEncoding :: UserSettings -> Encoding # toJSONList :: [UserSettings] -> Value # toEncodingList :: [UserSettings] -> Encoding #
Generic UserSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.UserSettings Associated Types type Rep UserSettings :: Type -> Type # Methods from :: UserSettings -> Rep UserSettings x # to :: Rep UserSettings x -> UserSettings #
Read UserSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.UserSettings Methods readsPrec :: Int -> ReadS UserSettings # readList :: ReadS [UserSettings] # readPrec :: ReadPrec UserSettings # readListPrec :: ReadPrec [UserSettings] #
Show UserSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.UserSettings Methods showsPrec :: Int -> UserSettings -> ShowS # show :: UserSettings -> String # showList :: [UserSettings] -> ShowS #
NFData UserSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.UserSettings Methods rnf :: UserSettings -> () #
Eq UserSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.UserSettings Methods (==) :: UserSettings -> UserSettings -> Bool # (/=) :: UserSettings -> UserSettings -> Bool #
Hashable UserSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.UserSettings Methods hashWithSalt :: Int -> UserSettings -> Int # hash :: UserSettings -> Int #
type Rep UserSettings Source #
Instance details Defined in Amazonka.SageMaker.Types.UserSettings type Rep UserSettings = D1 ('MetaData "UserSettings" "Amazonka.SageMaker.Types.UserSettings" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "UserSettings'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "canvasAppSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CanvasAppSettings)) :: S1 ('MetaSel ('Just "executionRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "jupyterServerAppSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JupyterServerAppSettings)) :: S1 ('MetaSel ('Just "kernelGatewayAppSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KernelGatewayAppSettings)))) :: ((S1 ('MetaSel ('Just "rSessionAppSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RSessionAppSettings)) :: S1 ('MetaSel ('Just "rStudioServerProAppSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RStudioServerProAppSettings))) :: (S1 ('MetaSel ('Just "securityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "sharingSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SharingSettings)) :: S1 ('MetaSel ('Just "tensorBoardAppSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TensorBoardAppSettings)))))))

newUserSettings :: UserSettings Source #

Create a value of UserSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:canvasAppSettings:UserSettings', userSettings_canvasAppSettings - The Canvas app settings.

$sel:executionRole:UserSettings', userSettings_executionRole - The execution role for the user.

$sel:jupyterServerAppSettings:UserSettings', userSettings_jupyterServerAppSettings - The Jupyter server's app settings.

$sel:kernelGatewayAppSettings:UserSettings', userSettings_kernelGatewayAppSettings - The kernel gateway app settings.

$sel:rSessionAppSettings:UserSettings', userSettings_rSessionAppSettings - A collection of settings that configure the RSessionGateway app.

$sel:rStudioServerProAppSettings:UserSettings', userSettings_rStudioServerProAppSettings - A collection of settings that configure user interaction with the RStudioServerPro app.

$sel:securityGroups:UserSettings', userSettings_securityGroups - 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.

$sel:sharingSettings:UserSettings', userSettings_sharingSettings - Specifies options for sharing SageMaker Studio notebooks.

$sel:tensorBoardAppSettings:UserSettings', userSettings_tensorBoardAppSettings - The TensorBoard app settings.

userSettings_canvasAppSettings :: Lens' UserSettings (Maybe CanvasAppSettings) Source #

The Canvas app settings.

userSettings_executionRole :: Lens' UserSettings (Maybe Text) Source #

The execution role for the user.

userSettings_jupyterServerAppSettings :: Lens' UserSettings (Maybe JupyterServerAppSettings) Source #

The Jupyter server's app settings.

userSettings_kernelGatewayAppSettings :: Lens' UserSettings (Maybe KernelGatewayAppSettings) Source #

The kernel gateway app settings.

userSettings_rSessionAppSettings :: Lens' UserSettings (Maybe RSessionAppSettings) Source #

A collection of settings that configure the RSessionGateway app.

userSettings_rStudioServerProAppSettings :: Lens' UserSettings (Maybe RStudioServerProAppSettings) Source #

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

userSettings_securityGroups :: Lens' UserSettings (Maybe [Text]) Source #

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.

userSettings_sharingSettings :: Lens' UserSettings (Maybe SharingSettings) Source #

Specifies options for sharing SageMaker Studio notebooks.

userSettings_tensorBoardAppSettings :: Lens' UserSettings (Maybe TensorBoardAppSettings) Source #

The TensorBoard app settings.