AWS SDK for C++  1.9.105
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMaker::Model::UserSettings Class Reference

#include <UserSettings.h>

Public Member Functions

 UserSettings ()
 
 UserSettings (Aws::Utils::Json::JsonView jsonValue)
 
UserSettingsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetExecutionRole () const
 
bool ExecutionRoleHasBeenSet () const
 
void SetExecutionRole (const Aws::String &value)
 
void SetExecutionRole (Aws::String &&value)
 
void SetExecutionRole (const char *value)
 
UserSettingsWithExecutionRole (const Aws::String &value)
 
UserSettingsWithExecutionRole (Aws::String &&value)
 
UserSettingsWithExecutionRole (const char *value)
 
const Aws::Vector< Aws::String > & GetSecurityGroups () const
 
bool SecurityGroupsHasBeenSet () const
 
void SetSecurityGroups (const Aws::Vector< Aws::String > &value)
 
void SetSecurityGroups (Aws::Vector< Aws::String > &&value)
 
UserSettingsWithSecurityGroups (const Aws::Vector< Aws::String > &value)
 
UserSettingsWithSecurityGroups (Aws::Vector< Aws::String > &&value)
 
UserSettingsAddSecurityGroups (const Aws::String &value)
 
UserSettingsAddSecurityGroups (Aws::String &&value)
 
UserSettingsAddSecurityGroups (const char *value)
 
const SharingSettingsGetSharingSettings () const
 
bool SharingSettingsHasBeenSet () const
 
void SetSharingSettings (const SharingSettings &value)
 
void SetSharingSettings (SharingSettings &&value)
 
UserSettingsWithSharingSettings (const SharingSettings &value)
 
UserSettingsWithSharingSettings (SharingSettings &&value)
 
const JupyterServerAppSettingsGetJupyterServerAppSettings () const
 
bool JupyterServerAppSettingsHasBeenSet () const
 
void SetJupyterServerAppSettings (const JupyterServerAppSettings &value)
 
void SetJupyterServerAppSettings (JupyterServerAppSettings &&value)
 
UserSettingsWithJupyterServerAppSettings (const JupyterServerAppSettings &value)
 
UserSettingsWithJupyterServerAppSettings (JupyterServerAppSettings &&value)
 
const KernelGatewayAppSettingsGetKernelGatewayAppSettings () const
 
bool KernelGatewayAppSettingsHasBeenSet () const
 
void SetKernelGatewayAppSettings (const KernelGatewayAppSettings &value)
 
void SetKernelGatewayAppSettings (KernelGatewayAppSettings &&value)
 
UserSettingsWithKernelGatewayAppSettings (const KernelGatewayAppSettings &value)
 
UserSettingsWithKernelGatewayAppSettings (KernelGatewayAppSettings &&value)
 
const TensorBoardAppSettingsGetTensorBoardAppSettings () const
 
bool TensorBoardAppSettingsHasBeenSet () const
 
void SetTensorBoardAppSettings (const TensorBoardAppSettings &value)
 
void SetTensorBoardAppSettings (TensorBoardAppSettings &&value)
 
UserSettingsWithTensorBoardAppSettings (const TensorBoardAppSettings &value)
 
UserSettingsWithTensorBoardAppSettings (TensorBoardAppSettings &&value)
 

Detailed Description

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 Also:

AWS API Reference

Definition at line 43 of file UserSettings.h.

Constructor & Destructor Documentation

◆ UserSettings() [1/2]

Aws::SageMaker::Model::UserSettings::UserSettings ( )

◆ UserSettings() [2/2]

Aws::SageMaker::Model::UserSettings::UserSettings ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddSecurityGroups() [1/3]

UserSettings& Aws::SageMaker::Model::UserSettings::AddSecurityGroups ( Aws::String &&  value)
inline

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.

Definition at line 187 of file UserSettings.h.

◆ AddSecurityGroups() [2/3]

UserSettings& Aws::SageMaker::Model::UserSettings::AddSecurityGroups ( const Aws::String value)
inline

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.

Definition at line 175 of file UserSettings.h.

◆ AddSecurityGroups() [3/3]

UserSettings& Aws::SageMaker::Model::UserSettings::AddSecurityGroups ( const char *  value)
inline

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.

Definition at line 199 of file UserSettings.h.

◆ ExecutionRoleHasBeenSet()

bool Aws::SageMaker::Model::UserSettings::ExecutionRoleHasBeenSet ( ) const
inline

The execution role for the user.

Definition at line 60 of file UserSettings.h.

◆ GetExecutionRole()

const Aws::String& Aws::SageMaker::Model::UserSettings::GetExecutionRole ( ) const
inline

The execution role for the user.

Definition at line 55 of file UserSettings.h.

◆ GetJupyterServerAppSettings()

const JupyterServerAppSettings& Aws::SageMaker::Model::UserSettings::GetJupyterServerAppSettings ( ) const
inline

The Jupyter server's app settings.

Definition at line 236 of file UserSettings.h.

◆ GetKernelGatewayAppSettings()

const KernelGatewayAppSettings& Aws::SageMaker::Model::UserSettings::GetKernelGatewayAppSettings ( ) const
inline

The kernel gateway app settings.

Definition at line 267 of file UserSettings.h.

◆ GetSecurityGroups()

const Aws::Vector<Aws::String>& Aws::SageMaker::Model::UserSettings::GetSecurityGroups ( ) const
inline

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.

Definition at line 103 of file UserSettings.h.

◆ GetSharingSettings()

const SharingSettings& Aws::SageMaker::Model::UserSettings::GetSharingSettings ( ) const
inline

Specifies options for sharing SageMaker Studio notebooks.

Definition at line 205 of file UserSettings.h.

◆ GetTensorBoardAppSettings()

const TensorBoardAppSettings& Aws::SageMaker::Model::UserSettings::GetTensorBoardAppSettings ( ) const
inline

The TensorBoard app settings.

Definition at line 298 of file UserSettings.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SageMaker::Model::UserSettings::Jsonize ( ) const

◆ JupyterServerAppSettingsHasBeenSet()

bool Aws::SageMaker::Model::UserSettings::JupyterServerAppSettingsHasBeenSet ( ) const
inline

The Jupyter server's app settings.

Definition at line 241 of file UserSettings.h.

◆ KernelGatewayAppSettingsHasBeenSet()

bool Aws::SageMaker::Model::UserSettings::KernelGatewayAppSettingsHasBeenSet ( ) const
inline

The kernel gateway app settings.

Definition at line 272 of file UserSettings.h.

◆ operator=()

UserSettings& Aws::SageMaker::Model::UserSettings::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SecurityGroupsHasBeenSet()

bool Aws::SageMaker::Model::UserSettings::SecurityGroupsHasBeenSet ( ) const
inline

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.

Definition at line 115 of file UserSettings.h.

◆ SetExecutionRole() [1/3]

void Aws::SageMaker::Model::UserSettings::SetExecutionRole ( Aws::String &&  value)
inline

The execution role for the user.

Definition at line 70 of file UserSettings.h.

◆ SetExecutionRole() [2/3]

void Aws::SageMaker::Model::UserSettings::SetExecutionRole ( const Aws::String value)
inline

The execution role for the user.

Definition at line 65 of file UserSettings.h.

◆ SetExecutionRole() [3/3]

void Aws::SageMaker::Model::UserSettings::SetExecutionRole ( const char *  value)
inline

The execution role for the user.

Definition at line 75 of file UserSettings.h.

◆ SetJupyterServerAppSettings() [1/2]

void Aws::SageMaker::Model::UserSettings::SetJupyterServerAppSettings ( const JupyterServerAppSettings value)
inline

The Jupyter server's app settings.

Definition at line 246 of file UserSettings.h.

◆ SetJupyterServerAppSettings() [2/2]

void Aws::SageMaker::Model::UserSettings::SetJupyterServerAppSettings ( JupyterServerAppSettings &&  value)
inline

The Jupyter server's app settings.

Definition at line 251 of file UserSettings.h.

◆ SetKernelGatewayAppSettings() [1/2]

void Aws::SageMaker::Model::UserSettings::SetKernelGatewayAppSettings ( const KernelGatewayAppSettings value)
inline

The kernel gateway app settings.

Definition at line 277 of file UserSettings.h.

◆ SetKernelGatewayAppSettings() [2/2]

void Aws::SageMaker::Model::UserSettings::SetKernelGatewayAppSettings ( KernelGatewayAppSettings &&  value)
inline

The kernel gateway app settings.

Definition at line 282 of file UserSettings.h.

◆ SetSecurityGroups() [1/2]

void Aws::SageMaker::Model::UserSettings::SetSecurityGroups ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 139 of file UserSettings.h.

◆ SetSecurityGroups() [2/2]

void Aws::SageMaker::Model::UserSettings::SetSecurityGroups ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 127 of file UserSettings.h.

◆ SetSharingSettings() [1/2]

void Aws::SageMaker::Model::UserSettings::SetSharingSettings ( const SharingSettings value)
inline

Specifies options for sharing SageMaker Studio notebooks.

Definition at line 215 of file UserSettings.h.

◆ SetSharingSettings() [2/2]

void Aws::SageMaker::Model::UserSettings::SetSharingSettings ( SharingSettings &&  value)
inline

Specifies options for sharing SageMaker Studio notebooks.

Definition at line 220 of file UserSettings.h.

◆ SetTensorBoardAppSettings() [1/2]

void Aws::SageMaker::Model::UserSettings::SetTensorBoardAppSettings ( const TensorBoardAppSettings value)
inline

The TensorBoard app settings.

Definition at line 308 of file UserSettings.h.

◆ SetTensorBoardAppSettings() [2/2]

void Aws::SageMaker::Model::UserSettings::SetTensorBoardAppSettings ( TensorBoardAppSettings &&  value)
inline

The TensorBoard app settings.

Definition at line 313 of file UserSettings.h.

◆ SharingSettingsHasBeenSet()

bool Aws::SageMaker::Model::UserSettings::SharingSettingsHasBeenSet ( ) const
inline

Specifies options for sharing SageMaker Studio notebooks.

Definition at line 210 of file UserSettings.h.

◆ TensorBoardAppSettingsHasBeenSet()

bool Aws::SageMaker::Model::UserSettings::TensorBoardAppSettingsHasBeenSet ( ) const
inline

The TensorBoard app settings.

Definition at line 303 of file UserSettings.h.

◆ WithExecutionRole() [1/3]

UserSettings& Aws::SageMaker::Model::UserSettings::WithExecutionRole ( Aws::String &&  value)
inline

The execution role for the user.

Definition at line 85 of file UserSettings.h.

◆ WithExecutionRole() [2/3]

UserSettings& Aws::SageMaker::Model::UserSettings::WithExecutionRole ( const Aws::String value)
inline

The execution role for the user.

Definition at line 80 of file UserSettings.h.

◆ WithExecutionRole() [3/3]

UserSettings& Aws::SageMaker::Model::UserSettings::WithExecutionRole ( const char *  value)
inline

The execution role for the user.

Definition at line 90 of file UserSettings.h.

◆ WithJupyterServerAppSettings() [1/2]

UserSettings& Aws::SageMaker::Model::UserSettings::WithJupyterServerAppSettings ( const JupyterServerAppSettings value)
inline

The Jupyter server's app settings.

Definition at line 256 of file UserSettings.h.

◆ WithJupyterServerAppSettings() [2/2]

UserSettings& Aws::SageMaker::Model::UserSettings::WithJupyterServerAppSettings ( JupyterServerAppSettings &&  value)
inline

The Jupyter server's app settings.

Definition at line 261 of file UserSettings.h.

◆ WithKernelGatewayAppSettings() [1/2]

UserSettings& Aws::SageMaker::Model::UserSettings::WithKernelGatewayAppSettings ( const KernelGatewayAppSettings value)
inline

The kernel gateway app settings.

Definition at line 287 of file UserSettings.h.

◆ WithKernelGatewayAppSettings() [2/2]

UserSettings& Aws::SageMaker::Model::UserSettings::WithKernelGatewayAppSettings ( KernelGatewayAppSettings &&  value)
inline

The kernel gateway app settings.

Definition at line 292 of file UserSettings.h.

◆ WithSecurityGroups() [1/2]

UserSettings& Aws::SageMaker::Model::UserSettings::WithSecurityGroups ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 163 of file UserSettings.h.

◆ WithSecurityGroups() [2/2]

UserSettings& Aws::SageMaker::Model::UserSettings::WithSecurityGroups ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 151 of file UserSettings.h.

◆ WithSharingSettings() [1/2]

UserSettings& Aws::SageMaker::Model::UserSettings::WithSharingSettings ( const SharingSettings value)
inline

Specifies options for sharing SageMaker Studio notebooks.

Definition at line 225 of file UserSettings.h.

◆ WithSharingSettings() [2/2]

UserSettings& Aws::SageMaker::Model::UserSettings::WithSharingSettings ( SharingSettings &&  value)
inline

Specifies options for sharing SageMaker Studio notebooks.

Definition at line 230 of file UserSettings.h.

◆ WithTensorBoardAppSettings() [1/2]

UserSettings& Aws::SageMaker::Model::UserSettings::WithTensorBoardAppSettings ( const TensorBoardAppSettings value)
inline

The TensorBoard app settings.

Definition at line 318 of file UserSettings.h.

◆ WithTensorBoardAppSettings() [2/2]

UserSettings& Aws::SageMaker::Model::UserSettings::WithTensorBoardAppSettings ( TensorBoardAppSettings &&  value)
inline

The TensorBoard app settings.

Definition at line 323 of file UserSettings.h.


The documentation for this class was generated from the following file: