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

#include <SharingSettings.h>

Public Member Functions

 SharingSettings ()
 
 SharingSettings (Aws::Utils::Json::JsonView jsonValue)
 
SharingSettingsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const NotebookOutputOptionGetNotebookOutputOption () const
 
bool NotebookOutputOptionHasBeenSet () const
 
void SetNotebookOutputOption (const NotebookOutputOption &value)
 
void SetNotebookOutputOption (NotebookOutputOption &&value)
 
SharingSettingsWithNotebookOutputOption (const NotebookOutputOption &value)
 
SharingSettingsWithNotebookOutputOption (NotebookOutputOption &&value)
 
const Aws::StringGetS3OutputPath () const
 
bool S3OutputPathHasBeenSet () const
 
void SetS3OutputPath (const Aws::String &value)
 
void SetS3OutputPath (Aws::String &&value)
 
void SetS3OutputPath (const char *value)
 
SharingSettingsWithS3OutputPath (const Aws::String &value)
 
SharingSettingsWithS3OutputPath (Aws::String &&value)
 
SharingSettingsWithS3OutputPath (const char *value)
 
const Aws::StringGetS3KmsKeyId () const
 
bool S3KmsKeyIdHasBeenSet () const
 
void SetS3KmsKeyId (const Aws::String &value)
 
void SetS3KmsKeyId (Aws::String &&value)
 
void SetS3KmsKeyId (const char *value)
 
SharingSettingsWithS3KmsKeyId (const Aws::String &value)
 
SharingSettingsWithS3KmsKeyId (Aws::String &&value)
 
SharingSettingsWithS3KmsKeyId (const char *value)
 

Detailed Description

Specifies options for sharing SageMaker Studio notebooks. These settings are specified as part of DefaultUserSettings when the CreateDomain API is called, and as part of UserSettings when the CreateUserProfile API is called. When SharingSettings is not specified, notebook sharing isn't allowed.

See Also:

AWS API Reference

Definition at line 37 of file SharingSettings.h.

Constructor & Destructor Documentation

◆ SharingSettings() [1/2]

Aws::SageMaker::Model::SharingSettings::SharingSettings ( )

◆ SharingSettings() [2/2]

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

Member Function Documentation

◆ GetNotebookOutputOption()

const NotebookOutputOption& Aws::SageMaker::Model::SharingSettings::GetNotebookOutputOption ( ) const
inline

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

Definition at line 50 of file SharingSettings.h.

◆ GetS3KmsKeyId()

const Aws::String& Aws::SageMaker::Model::SharingSettings::GetS3KmsKeyId ( ) const
inline

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

Definition at line 137 of file SharingSettings.h.

◆ GetS3OutputPath()

const Aws::String& Aws::SageMaker::Model::SharingSettings::GetS3OutputPath ( ) const
inline

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Definition at line 87 of file SharingSettings.h.

◆ Jsonize()

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

◆ NotebookOutputOptionHasBeenSet()

bool Aws::SageMaker::Model::SharingSettings::NotebookOutputOptionHasBeenSet ( ) const
inline

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

Definition at line 56 of file SharingSettings.h.

◆ operator=()

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

◆ S3KmsKeyIdHasBeenSet()

bool Aws::SageMaker::Model::SharingSettings::S3KmsKeyIdHasBeenSet ( ) const
inline

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

Definition at line 144 of file SharingSettings.h.

◆ S3OutputPathHasBeenSet()

bool Aws::SageMaker::Model::SharingSettings::S3OutputPathHasBeenSet ( ) const
inline

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Definition at line 93 of file SharingSettings.h.

◆ SetNotebookOutputOption() [1/2]

void Aws::SageMaker::Model::SharingSettings::SetNotebookOutputOption ( const NotebookOutputOption value)
inline

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

Definition at line 62 of file SharingSettings.h.

◆ SetNotebookOutputOption() [2/2]

void Aws::SageMaker::Model::SharingSettings::SetNotebookOutputOption ( NotebookOutputOption &&  value)
inline

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

Definition at line 68 of file SharingSettings.h.

◆ SetS3KmsKeyId() [1/3]

void Aws::SageMaker::Model::SharingSettings::SetS3KmsKeyId ( Aws::String &&  value)
inline

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

Definition at line 158 of file SharingSettings.h.

◆ SetS3KmsKeyId() [2/3]

void Aws::SageMaker::Model::SharingSettings::SetS3KmsKeyId ( const Aws::String value)
inline

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

Definition at line 151 of file SharingSettings.h.

◆ SetS3KmsKeyId() [3/3]

void Aws::SageMaker::Model::SharingSettings::SetS3KmsKeyId ( const char *  value)
inline

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

Definition at line 165 of file SharingSettings.h.

◆ SetS3OutputPath() [1/3]

void Aws::SageMaker::Model::SharingSettings::SetS3OutputPath ( Aws::String &&  value)
inline

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Definition at line 105 of file SharingSettings.h.

◆ SetS3OutputPath() [2/3]

void Aws::SageMaker::Model::SharingSettings::SetS3OutputPath ( const Aws::String value)
inline

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Definition at line 99 of file SharingSettings.h.

◆ SetS3OutputPath() [3/3]

void Aws::SageMaker::Model::SharingSettings::SetS3OutputPath ( const char *  value)
inline

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Definition at line 111 of file SharingSettings.h.

◆ WithNotebookOutputOption() [1/2]

SharingSettings& Aws::SageMaker::Model::SharingSettings::WithNotebookOutputOption ( const NotebookOutputOption value)
inline

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

Definition at line 74 of file SharingSettings.h.

◆ WithNotebookOutputOption() [2/2]

SharingSettings& Aws::SageMaker::Model::SharingSettings::WithNotebookOutputOption ( NotebookOutputOption &&  value)
inline

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

Definition at line 80 of file SharingSettings.h.

◆ WithS3KmsKeyId() [1/3]

SharingSettings& Aws::SageMaker::Model::SharingSettings::WithS3KmsKeyId ( Aws::String &&  value)
inline

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

Definition at line 179 of file SharingSettings.h.

◆ WithS3KmsKeyId() [2/3]

SharingSettings& Aws::SageMaker::Model::SharingSettings::WithS3KmsKeyId ( const Aws::String value)
inline

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

Definition at line 172 of file SharingSettings.h.

◆ WithS3KmsKeyId() [3/3]

SharingSettings& Aws::SageMaker::Model::SharingSettings::WithS3KmsKeyId ( const char *  value)
inline

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

Definition at line 186 of file SharingSettings.h.

◆ WithS3OutputPath() [1/3]

SharingSettings& Aws::SageMaker::Model::SharingSettings::WithS3OutputPath ( Aws::String &&  value)
inline

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Definition at line 123 of file SharingSettings.h.

◆ WithS3OutputPath() [2/3]

SharingSettings& Aws::SageMaker::Model::SharingSettings::WithS3OutputPath ( const Aws::String value)
inline

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Definition at line 117 of file SharingSettings.h.

◆ WithS3OutputPath() [3/3]

SharingSettings& Aws::SageMaker::Model::SharingSettings::WithS3OutputPath ( const char *  value)
inline

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

Definition at line 129 of file SharingSettings.h.


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