aws-cdk-lib.aws_sagemaker.CfnDomain.SharingSettingsProperty

SharingSettingsProperty Struct

Specifies options when sharing an Amazon SageMaker Studio notebook.

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.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const sharingSettingsProperty: sagemaker.CfnDomain.SharingSettingsProperty = {
  notebookOutputOption: 'notebookOutputOption',
  s3KmsKeyId: 's3KmsKeyId',
  s3OutputPath: 's3OutputPath',
};

Properties

notebookOutputOptionstringnotebook_output_optionstrnotebookOutputOptionStringNotebookOutputOptionstringNotebookOutputOption*string#

Whether to include the notebook cell output when sharing the notebook.

The default is Disabled .

s3KmsKeyIdstrings3_kms_key_idstrs3KmsKeyIdStringS3KmsKeyIdstringS3KmsKeyId*string#

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

s3OutputPathstrings3_output_pathstrs3OutputPathStringS3OutputPathstringS3OutputPath*string#

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