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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::SageMaker::UserProfile SharingSettings
<a name="aws-properties-sagemaker-userprofile-sharingsettings"></a>

Specifies options when sharing an Amazon SageMaker Studio notebook. These settings are specified as part of `DefaultUserSettings` when the [CreateDomain](https://docs.amazonaws.cn/sagemaker/latest/APIReference/API_CreateDomain.html) API is called, and as part of `UserSettings` when the [CreateUserProfile](https://docs.amazonaws.cn/sagemaker/latest/APIReference/API_CreateUserProfile.html) API is called.

## Syntax
<a name="aws-properties-sagemaker-userprofile-sharingsettings-syntax"></a>

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

### JSON
<a name="aws-properties-sagemaker-userprofile-sharingsettings-syntax.json"></a>

```
{
  "[NotebookOutputOption](#cfn-sagemaker-userprofile-sharingsettings-notebookoutputoption)" : {{String}},
  "[S3KmsKeyId](#cfn-sagemaker-userprofile-sharingsettings-s3kmskeyid)" : {{String}},
  "[S3OutputPath](#cfn-sagemaker-userprofile-sharingsettings-s3outputpath)" : {{String}}
}
```

### YAML
<a name="aws-properties-sagemaker-userprofile-sharingsettings-syntax.yaml"></a>

```
  [NotebookOutputOption](#cfn-sagemaker-userprofile-sharingsettings-notebookoutputoption): {{String}}
  [S3KmsKeyId](#cfn-sagemaker-userprofile-sharingsettings-s3kmskeyid): {{String}}
  [S3OutputPath](#cfn-sagemaker-userprofile-sharingsettings-s3outputpath): {{String}}
```

## Properties
<a name="aws-properties-sagemaker-userprofile-sharingsettings-properties"></a>

`NotebookOutputOption`  <a name="cfn-sagemaker-userprofile-sharingsettings-notebookoutputoption"></a>
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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3KmsKeyId`  <a name="cfn-sagemaker-userprofile-sharingsettings-s3kmskeyid"></a>
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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3OutputPath`  <a name="cfn-sagemaker-userprofile-sharingsettings-s3outputpath"></a>
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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)