libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Instances

Instances details
Eq UserSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.UserSettings

Read UserSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.UserSettings

Show UserSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.UserSettings

Generic UserSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.UserSettings

Associated Types

type Rep UserSettings :: Type -> Type #

NFData UserSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.UserSettings

Methods

rnf :: UserSettings -> () #

Hashable UserSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.UserSettings

ToJSON UserSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.UserSettings

FromJSON UserSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.UserSettings

type Rep UserSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.UserSettings

type Rep UserSettings = D1 ('MetaData "UserSettings" "Amazonka.SageMaker.Types.UserSettings" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "UserSettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tensorBoardAppSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TensorBoardAppSettings)) :*: (S1 ('MetaSel ('Just "kernelGatewayAppSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KernelGatewayAppSettings)) :*: S1 ('MetaSel ('Just "securityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: (S1 ('MetaSel ('Just "jupyterServerAppSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JupyterServerAppSettings)) :*: (S1 ('MetaSel ('Just "sharingSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SharingSettings)) :*: S1 ('MetaSel ('Just "executionRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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:tensorBoardAppSettings:UserSettings', userSettings_tensorBoardAppSettings - The TensorBoard app settings.

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

$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:jupyterServerAppSettings:UserSettings', userSettings_jupyterServerAppSettings - The Jupyter server's app settings.

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

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

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_executionRole :: Lens' UserSettings (Maybe Text) Source #

The execution role for the user.