Interface CfnUserProfile.SharingSettingsProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnUserProfile.SharingSettingsProperty extends
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.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 SharingSettingsProperty sharingSettingsProperty = SharingSettingsProperty.builder()
  • Method Details

    • getNotebookOutputOption

      @Stability(Stable) @Nullable default String getNotebookOutputOption()
      Whether to include the notebook cell output when sharing the notebook.

      The default is Disabled .

    • getS3KmsKeyId

      @Stability(Stable) @Nullable default String getS3KmsKeyId()
      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.
    • getS3OutputPath

      @Stability(Stable) @Nullable default String getS3OutputPath()
      When NotebookOutputOption is Allowed , the Amazon S3 bucket used to store the shared notebook snapshots.
    • builder

      @Stability(Stable) static CfnUserProfile.SharingSettingsProperty.Builder builder()
      a CfnUserProfile.SharingSettingsProperty.Builder of CfnUserProfile.SharingSettingsProperty