Interface CfnUserProfilePropsMixin.ISharingSettingsProperty

Specifies options when sharing an Amazon SageMaker Studio notebook.

Namespace: Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public interface CfnUserProfilePropsMixin.ISharingSettingsProperty

Syntax (vb)

Public Interface CfnUserProfilePropsMixin.ISharingSettingsProperty

Remarks

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.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins;

             var sharingSettingsProperty = new SharingSettingsProperty {
                 NotebookOutputOption = "notebookOutputOption",
                 S3KmsKeyId = "s3KmsKeyId",
                 S3OutputPath = "s3OutputPath"
             };

Synopsis

Properties

NotebookOutputOption	Whether to include the notebook cell output when sharing the notebook.
S3KmsKeyId	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	When NotebookOutputOption is Allowed , the Amazon S3 bucket used to store the shared notebook snapshots.

Properties

NotebookOutputOption

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

string? NotebookOutputOption { get; }

Property Value

string

Remarks

The default is Disabled .

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

S3KmsKeyId

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.

string? S3KmsKeyId { get; }

Property Value

string

Remarks

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

S3OutputPath

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

string? S3OutputPath { get; }

Property Value

string

Remarks

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