Interface CfnUserProfile.SharingSettingsProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnUserProfile.SharingSettingsProperty.Jsii$Proxy
- Enclosing class:
- CfnUserProfile
@Stability(Stable)
public static interface CfnUserProfile.SharingSettingsProperty
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.sagemaker.*; SharingSettingsProperty sharingSettingsProperty = SharingSettingsProperty.builder() .notebookOutputOption("notebookOutputOption") .s3KmsKeyId("s3KmsKeyId") .s3OutputPath("s3OutputPath") .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnUserProfile.SharingSettingsProperty
static final class
An implementation forCfnUserProfile.SharingSettingsProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
Whether to include the notebook cell output when sharing the notebook.default String
WhenNotebookOutputOption
isAllowed
, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.default String
WhenNotebookOutputOption
isAllowed
, the Amazon S3 bucket used to store the shared notebook snapshots.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getNotebookOutputOption
Whether to include the notebook cell output when sharing the notebook.The default is
Disabled
. -
getS3KmsKeyId
WhenNotebookOutputOption
isAllowed
, the AWS Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket. -
getS3OutputPath
WhenNotebookOutputOption
isAllowed
, the Amazon S3 bucket used to store the shared notebook snapshots. -
builder
-