AWS::SageMaker::Domain SharingSettings - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::SageMaker::Domain SharingSettings

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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "NotebookOutputOption" : String,
  "S3KmsKeyId" : String,
  "S3OutputPath" : String
}

YAML

  NotebookOutputOption: String
  S3KmsKeyId: String
  S3OutputPath: String

Properties

NotebookOutputOption

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

Required: No

Type: String

Allowed values: Allowed | Disabled

Update requires: No interruption

S3KmsKeyId

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

Required: No

Type: String

Pattern: .*

Maximum: 2048

Update requires: No interruption

S3OutputPath

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

Required: No

Type: String

Pattern: ^(https|s3)://([^/]+)/?(.*)$

Maximum: 1024

Update requires: No interruption