interface SharingSettingsProperty

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnDomain.SharingSettingsProperty
Java	software.amazon.awscdk.services.sagemaker.CfnDomain.SharingSettingsProperty
Python	aws_cdk.aws_sagemaker.CfnDomain.SharingSettingsProperty
TypeScript	@aws-cdk/aws-sagemaker » CfnDomain » SharingSettingsProperty

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.

Example

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

Properties

Name	Type	Description
notebookOutputOption?	string	Whether to include the notebook cell output when sharing the notebook.
s3KmsKeyId?	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.
s3OutputPath?	string	When NotebookOutputOption is Allowed , the Amazon S3 bucket used to store the shared notebook snapshots.

---

notebookOutputOption?

Type: string (optional)

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

The default is Disabled .

---

s3KmsKeyId?

Type: string (optional)

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.

---

s3OutputPath?

Type: string (optional)

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