Package software.amazon.awscdk.services.sagemaker

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-sharingsettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserProfile.SharingSettingsProperty.Builder	A builder for CfnUserProfile.SharingSettingsProperty
static final class	CfnUserProfile.SharingSettingsProperty.Jsii$Proxy	An implementation for CfnUserProfile.SharingSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserProfile.SharingSettingsProperty.Builder	builder()
default String	getNotebookOutputOption()	Whether to include the notebook cell output when sharing the notebook.
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.
default String	getS3OutputPath()	When NotebookOutputOption is Allowed , the Amazon S3 bucket used to store the shared notebook snapshots.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNotebookOutputOption

@Stability(Stable)
@Nullable
default String getNotebookOutputOption()

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

The default is Disabled .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-sharingsettings.html#cfn-sagemaker-userprofile-sharingsettings-notebookoutputoption

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-sharingsettings.html#cfn-sagemaker-userprofile-sharingsettings-s3kmskeyid

getS3OutputPath

@Stability(Stable)
@Nullable
default String getS3OutputPath()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-userprofile-sharingsettings.html#cfn-sagemaker-userprofile-sharingsettings-s3outputpath

builder

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

Returns:

a CfnUserProfile.SharingSettingsProperty.Builder of CfnUserProfile.SharingSettingsProperty